Package net.webpdf.wsclient.openapi

Class MetadataHeaderFooter

java.lang.Object

net.webpdf.wsclient.openapi.MetadataHeaderFooter

public class MetadataHeaderFooter
extends Object

An element of this type defines header and footer values for a page of the document.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_COLOR
static String	JSON_PROPERTY_FONT
static String	JSON_PROPERTY_FOOTER
static String	JSON_PROPERTY_HEADER
static String	JSON_PROPERTY_MARGIN
static String	JSON_PROPERTY_OBJECT_KEY
static String	JSON_PROPERTY_PAGE

Constructor Summary

Constructors

Constructor	Description
MetadataHeaderFooter()

Method Summary

Modifier and Type	Method	Description
MetadataHeaderFooter	color(String color)
boolean	equals(Object o)
MetadataHeaderFooter	font(MetadataFont font)
MetadataHeaderFooter	footer(MetadataFooterHeaderFooter footer)
@Nullable String	getColor()	The text of headers and footers color.
@NotNull MetadataFont	getFont()	Get font
@Nullable MetadataFooterHeaderFooter	getFooter()	Get footer
@Nullable MetadataHeaderHeaderFooter	getHeader()	Get header
@NotNull MetadataMargin	getMargin()	Get margin
@Nullable String	getObjectKey()	The object ID of the header/footer definition.
@Nullable Integer	getPage()	The page headers/footers shall be defined for.
int	hashCode()
MetadataHeaderFooter	header(MetadataHeaderHeaderFooter header)
MetadataHeaderFooter	margin(MetadataMargin margin)
MetadataHeaderFooter	objectKey(String objectKey)
MetadataHeaderFooter	page(Integer page)
void	setColor(String color)
void	setFont(MetadataFont font)
void	setFooter(MetadataFooterHeaderFooter footer)
void	setHeader(MetadataHeaderHeaderFooter header)
void	setMargin(MetadataMargin margin)
void	setObjectKey(String objectKey)
void	setPage(Integer page)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_PROPERTY_COLOR

public static final String JSON_PROPERTY_COLOR

See Also:

Constant Field Values

JSON_PROPERTY_FONT

public static final String JSON_PROPERTY_FONT

See Also:

Constant Field Values

JSON_PROPERTY_FOOTER

public static final String JSON_PROPERTY_FOOTER

See Also:

Constant Field Values

JSON_PROPERTY_HEADER

public static final String JSON_PROPERTY_HEADER

See Also:

Constant Field Values

JSON_PROPERTY_MARGIN

public static final String JSON_PROPERTY_MARGIN

See Also:

Constant Field Values

JSON_PROPERTY_OBJECT_KEY

public static final String JSON_PROPERTY_OBJECT_KEY

See Also:

Constant Field Values

JSON_PROPERTY_PAGE

public static final String JSON_PROPERTY_PAGE

See Also:

Constant Field Values

Constructor Detail

MetadataHeaderFooter

public MetadataHeaderFooter()

Method Detail

color

public MetadataHeaderFooter color(String color)

getColor

@Nullable
public @Nullable String getColor()

The text of headers and footers color.

Returns:

color

setColor

public void setColor(String color)

font

public MetadataHeaderFooter font(MetadataFont font)

getFont

@NotNull
public @NotNull MetadataFont getFont()

Get font

Returns:

font

setFont

public void setFont(MetadataFont font)

footer

public MetadataHeaderFooter footer(MetadataFooterHeaderFooter footer)

getFooter

@Nullable
public @Nullable MetadataFooterHeaderFooter getFooter()

Get footer

Returns:

footer

setFooter

public void setFooter(MetadataFooterHeaderFooter footer)

header

public MetadataHeaderFooter header(MetadataHeaderHeaderFooter header)

getHeader

@Nullable
public @Nullable MetadataHeaderHeaderFooter getHeader()

Get header

Returns:

header

setHeader

public void setHeader(MetadataHeaderHeaderFooter header)

margin

public MetadataHeaderFooter margin(MetadataMargin margin)

getMargin

@NotNull
public @NotNull MetadataMargin getMargin()

Get margin

Returns:

margin

setMargin

public void setMargin(MetadataMargin margin)

objectKey

public MetadataHeaderFooter objectKey(String objectKey)

getObjectKey

@Nullable
public @Nullable String getObjectKey()

The object ID of the header/footer definition. **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)

page

public MetadataHeaderFooter page(Integer page)

getPage

@Nullable
public @Nullable Integer getPage()

The page headers/footers shall be defined for. minimum: 0

Returns:

page

setPage

public void setPage(Integer page)

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