PageLabel Class Documentation
classPageLabelNamespace:com::datalogics::PDFL
Detailed Description
Describes numbering labels for a range of pages. PageLabel describes how to construct a label string for a range of pages. It contains information on number style, any prefixes, and a starting position within the document.
Note that a single PageLabel describes the label string for several pages all pages up until the first page covered by the next PageLabel, or the end of the document.
Also note that if a Document has any PageLabels, there must be one that starts at page index 0. This will be automatically created if the user does not supply one.
Referenced by
Constructor & Destructor Documentation
PageLabel
PageLabel(intstart, NumberStylens)Parameters
start: intStarting page index in the Document for this range
ns: NumberStyleNumbering style for this range
Convenience constructor creates a range with no prefix starting with number 1.
PageLabel
PageLabel(intstart, NumberStylens, Stringp, intfirst)Parameters
start: intStarting page index in the Document for this range
ns: NumberStyleNumbering style for this range
p: StringPrefix string for this range
first: intFirst number appearing on a page in this range
Public constructor
Member Function Documentation
DisposeChildren
voidDisposeChildren()Returns:
void[static initializer]
static void[static initializer]()delete
synchronized voiddelete(Booleandisposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized voiddelete()Returns:
synchronized voidfinalize
voidfinalize()Returns:
voidgetEndPageIndex
intgetEndPageIndex()Returns:
intThe zero-based ending page index for this page label range. You cannot set the end index for a range; you must change the start index for the following range. A value of -1 means the end index for this PageLabel is unknown (e.g. when the label has not yet been added to a Document).
getFirstNumberInRange
intgetFirstNumberInRange()Returns:
intThe first numeric value used for page labels in this range. Must be greater than or equal to 1.
getNumberStyle
NumberStylegetNumberStyle()Returns:
NumberStyleThe NumberStyle used for generating page labels in this range.
getPrefix
StringgetPrefix()Returns:
StringThe prefix string prepended to page labels in this range. For example, a prefix of "A-" with decimal numbering starting at 1 would produce labels "A-1", "A-2", "A-3", etc.
getStartPageIndex
intgetStartPageIndex()Returns:
intThe zero-based starting page index for this page label range in the Document.
setFirstNumberInRange
voidsetFirstNumberInRange(intarg0)Parameters
arg0: int
Returns:
voidThe first numeric value used for page labels in this range.
setNumberStyle
voidsetNumberStyle(NumberStylearg0)Parameters
arg0: NumberStyle
Returns:
voidThe NumberStyle used for generating page labels in this range.
setPrefix
voidsetPrefix(Stringarg0)Parameters
arg0: String
Returns:
voidThe prefix string prepended to page labels in this range.
setStartPageIndex
voidsetStartPageIndex(intndx)Parameters
ndx: int
Returns:
voidThe zero-based starting page index for this page label range in the Document.
toString
StringtoString()Returns:
A string describing this PageLabel.Returns a string representation of this PageLabel. The string includes the start page, end page, number style, prefix, and first page number of this label range.