Package net.webpdf.wsclient.openapi

Class MetadataBackgroundContent

java.lang.Object

net.webpdf.wsclient.openapi.MetadataBackgroundContent

public class MetadataBackgroundContent
extends Object

An element of this type defines a background for a page of the document.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_BOUNDS
static String	JSON_PROPERTY_IS_IMAGE
static String	JSON_PROPERTY_OBJECT_KEY
static String	JSON_PROPERTY_ONPRINT
static String	JSON_PROPERTY_ONSCREEN
static String	JSON_PROPERTY_PAGE
static String	JSON_PROPERTY_PIECE_INFO

Constructor Summary

Constructors

Constructor	Description
MetadataBackgroundContent()

Method Summary

Modifier and Type	Method	Description
MetadataBackgroundContent	bounds(MetadataRectangle bounds)
boolean	equals(Object o)
@NotNull MetadataRectangle	getBounds()	Get bounds
@Nullable Boolean	getIsImage()	When set to true, the background is using an image resource.
@Nullable String	getObjectKey()	The object ID of the background.
@Nullable Boolean	getOnprint()	Whether the background shall be visible in printouts of the document.
@Nullable Boolean	getOnscreen()	Whether the background shall be visible in Readers.
@Nullable Integer	getPage()	The page the background shall be set for.
@Nullable MetadataPieceInfoBackgroundContent	getPieceInfo()	Get pieceInfo
int	hashCode()
MetadataBackgroundContent	isImage(Boolean isImage)
MetadataBackgroundContent	objectKey(String objectKey)
MetadataBackgroundContent	onprint(Boolean onprint)
MetadataBackgroundContent	onscreen(Boolean onscreen)
MetadataBackgroundContent	page(Integer page)
MetadataBackgroundContent	pieceInfo(MetadataPieceInfoBackgroundContent pieceInfo)
void	setBounds(MetadataRectangle bounds)
void	setIsImage(Boolean isImage)
void	setObjectKey(String objectKey)
void	setOnprint(Boolean onprint)
void	setOnscreen(Boolean onscreen)
void	setPage(Integer page)
void	setPieceInfo(MetadataPieceInfoBackgroundContent pieceInfo)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_BOUNDS

public static final String JSON_PROPERTY_BOUNDS

See Also:

Constant Field Values

JSON_PROPERTY_IS_IMAGE

public static final String JSON_PROPERTY_IS_IMAGE

See Also:

Constant Field Values

JSON_PROPERTY_OBJECT_KEY

public static final String JSON_PROPERTY_OBJECT_KEY

See Also:

Constant Field Values

JSON_PROPERTY_ONPRINT

public static final String JSON_PROPERTY_ONPRINT

See Also:

Constant Field Values

JSON_PROPERTY_ONSCREEN

public static final String JSON_PROPERTY_ONSCREEN

See Also:

Constant Field Values

JSON_PROPERTY_PAGE

public static final String JSON_PROPERTY_PAGE

See Also:

Constant Field Values

JSON_PROPERTY_PIECE_INFO

public static final String JSON_PROPERTY_PIECE_INFO

See Also:

Constant Field Values

Constructor Detail

MetadataBackgroundContent

public MetadataBackgroundContent()

Method Detail

bounds

public MetadataBackgroundContent bounds(MetadataRectangle bounds)

getBounds

@NotNull
public @NotNull MetadataRectangle getBounds()

Get bounds

Returns:

bounds

setBounds

public void setBounds(MetadataRectangle bounds)

isImage

public MetadataBackgroundContent isImage(Boolean isImage)

getIsImage

@Nullable
public @Nullable Boolean getIsImage()

When set to true, the background is using an image resource. (Otherwise it is unicolor)

Returns:

isImage

setIsImage

public void setIsImage(Boolean isImage)

objectKey

public MetadataBackgroundContent objectKey(String objectKey)

getObjectKey

@Nullable
public @Nullable String getObjectKey()

The object ID of the background. **Info:** A PDF object ID consists of two numbers, where the first number selects the object's number and the second the \"generation\" of the object. The object ID shall always be unique within the context of the document and can be used to select a specific object.

Returns:

objectKey

setObjectKey

public void setObjectKey(String objectKey)

onprint

public MetadataBackgroundContent onprint(Boolean onprint)

getOnprint

@Nullable
public @Nullable Boolean getOnprint()

Whether the background shall be visible in printouts of the document.

Returns:

onprint

setOnprint

public void setOnprint(Boolean onprint)

onscreen

public MetadataBackgroundContent onscreen(Boolean onscreen)

getOnscreen

@Nullable
public @Nullable Boolean getOnscreen()

Whether the background shall be visible in Readers.

Returns:

onscreen

setOnscreen

public void setOnscreen(Boolean onscreen)

page

public MetadataBackgroundContent page(Integer page)

getPage

@Nullable
public @Nullable Integer getPage()

The page the background shall be set for. minimum: 0

Returns:

page

setPage

public void setPage(Integer page)

pieceInfo

public MetadataBackgroundContent pieceInfo(MetadataPieceInfoBackgroundContent pieceInfo)

getPieceInfo

@Nullable
public @Nullable MetadataPieceInfoBackgroundContent getPieceInfo()

Get pieceInfo

Returns:

pieceInfo

setPieceInfo

public void setPieceInfo(MetadataPieceInfoBackgroundContent pieceInfo)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object