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 StringJSON_PROPERTY_BOUNDSstatic StringJSON_PROPERTY_IS_IMAGEstatic StringJSON_PROPERTY_OBJECT_KEYstatic StringJSON_PROPERTY_ONPRINTstatic StringJSON_PROPERTY_ONSCREENstatic StringJSON_PROPERTY_PAGEstatic StringJSON_PROPERTY_PIECE_INFO
-
Constructor Summary
Constructors Constructor Description MetadataBackgroundContent()
-
Method Summary
-
-
-
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
-
-
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)
-
-