Package com.dynamicpdf.api.elements

Class PageNumberingElement

java.lang.Object

com.dynamicpdf.api.elements.Element

com.dynamicpdf.api.elements.PageNumberingElement

public class PageNumberingElement
extends Element

Represents a page numbering label page element.

This class can be used to add page numbering to a PDF document. The following tokens can be used within the text of a PageNumberingLabel. They will be replaced with the appropriate value when the PDF is output.

Token	Description
CP	Current page. The default numbering style is numeric.
TP	Total pages. The default numbering style is numeric.
SP	Section page.
ST	Section Total.
PR	Prefix.

All tokens except the %%PR%% token can also contain a numbering style specifier. The numbering style specifier is placed in parenthesis after the token.

Numbering Style	Description
1	Numeric. Arabic numbers are used: 1, 2, 3, etc. Example: "%%CP(1)%%"
i	Lower Case Roman Numerals. Lower case roman numerals are used: i, ii, iii, etc. Example: "%%CP(i)%%".
I	Upper Case Roman Numerals. Upper case roman numerals are used: I, II, III, etc. Example: "%%CP(I)%%".
a	Lower Latin Letters. Lower case Latin letters are used: a, b, c, etc. After z, aa is used followed by bb, cc, ect. Example: "%%CP(a)%%".
A	Upper Latin Letters. Upper case Latin letters are used: A, B, C, etc. After Z, AA is used followed by BB, CC, ect. Example: "%%CP(A)%%".
b	Lower Latin Letters. Lower case Latin letters are used: a, b, c, etc. After z, aa is used followed by ab, ac, ect. Example: "%%CP(b)%%".
B	Lower Latin Letters. Lower case Latin letters are used: A, B, C, etc. After Z, AA is used followed by AB, AC, ect. Example: "%%CP(B)%%".

There should be no spaces within a token, only the token and optional numbering style specifier. This token is invalid %%CP ( i )%% because of the extra spaces.

Here are some examples of valid tokens:

• %%SP%%
• %%SP(I)%%
• %%PR%%
• %%ST(B)%%

Constructor Summary

Constructors

Constructor	Description
PageNumberingElement(String text, ElementPlacement placement)	Initializes a new instance of the PageNumberingElement class.
PageNumberingElement(String text, ElementPlacement placement, float xOffset, float yOffset)	Initializes a new instance of the PageNumberingElement class.

Method Summary

Modifier and Type	Method	Description
Color	getColor()	Gets the Color object to use for the text of the label
Font	getFont()	Gets the Font object to use for the text of the label.
float	getFontSize()	Gets the font size for the text of the label.
Resource	getResource()
String	getText()	Gets the text to display in the label.
Font	getTextFont()
void	setColor(Color value)	Sets the Color object to use for the text of the label
void	setFont(Font value)	Sets the Font object to use for the text of the label.
void	setFontSize(float value)	Sets the font size for the text of the label.
void	setText(String value)	Sets the text to display in the label.

Methods inherited from class com.dynamicpdf.api.elements.Element

getEvenPages, getOddPages, getPlacement, getXOffset, getYOffset, setEvenPages, setOddPages, setPlacement, setXOffset, setYOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PageNumberingElement

public PageNumberingElement(String text,
 ElementPlacement placement,
 float xOffset,
 float yOffset)

Initializes a new instance of the PageNumberingElement class.

Parameters:

text - Text to display in the label.

placement - The placement of the page numbering element on the page.

xOffset - X coordinate of the label.

yOffset - Y coordinate of the label.

PageNumberingElement

public PageNumberingElement(String text,
 ElementPlacement placement)

Initializes a new instance of the PageNumberingElement class.

Parameters:

text - Text to display in the label.

placement - The placement of the page numbering element on the page.

Method Details

getResource

public Resource getResource()

Overrides:

getResource in class Element

getTextFont

public Font getTextFont()

Overrides:

getTextFont in class Element

getColor

public Color getColor()

Gets the Color object to use for the text of the label

Returns:

The Color object to use for the text of the label

setColor

public void setColor(Color value)

Sets the Color object to use for the text of the label

Parameters:

value - The Color object to use for the text of the label

getFont

public Font getFont()

Gets the Font object to use for the text of the label.

Returns:

The Font object to use for the text of the label.

setFont

public void setFont(Font value)

Sets the Font object to use for the text of the label.

Parameters:

value - The Font object to use for the text of the label.

getFontSize

public float getFontSize()

Gets the font size for the text of the label.

Returns:

The font size for the text of the label.

setFontSize

public void setFontSize(float value)

Sets the font size for the text of the label.

Parameters:

value - The font size for the text of the label.

getText

public String getText()

Gets the text to display in the label.

Returns:

The text to display in the label.

setText

public void setText(String value)

Sets the text to display in the label.

Parameters:

value - The text to display in the label.