PageLabel Class Documentation

class PageLabel

Namespace: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

DocumentPageLabelVector

Constructor & Destructor Documentation

PageLabel

PageLabel(int start, NumberStyle ns)

Parameters

start: int

Starting page index in the Document for this range

ns: NumberStyle

Numbering style for this range

Convenience constructor creates a range with no prefix starting with number 1.

PageLabel

PageLabel(int start, NumberStyle ns, String p, int first)

Parameters

start: int

Starting page index in the Document for this range

ns: NumberStyle

Numbering style for this range

p: String

Prefix string for this range

first: int

First number appearing on a page in this range

Public constructor

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getEndPageIndex

int getEndPageIndex()

Returns:

int

The 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

int getFirstNumberInRange()

Returns:

int

The first numeric value used for page labels in this range. Must be greater than or equal to 1.

getNumberStyle

NumberStyle getNumberStyle()

Returns:

NumberStyle

The NumberStyle used for generating page labels in this range.

getPrefix

String getPrefix()

Returns:

String

The 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

int getStartPageIndex()

Returns:

int

The zero-based starting page index for this page label range in the Document.

setFirstNumberInRange

void setFirstNumberInRange(int arg0)

Parameters

arg0: int

Returns:

void

The first numeric value used for page labels in this range.

setNumberStyle

void setNumberStyle(NumberStyle arg0)

Parameters

arg0: NumberStyle

Returns:

void

The NumberStyle used for generating page labels in this range.

setPrefix

void setPrefix(String arg0)

Parameters

arg0: String

Returns:

void

The prefix string prepended to page labels in this range.

setStartPageIndex

void setStartPageIndex(int ndx)

Parameters

ndx: int

Returns:

void

The zero-based starting page index for this page label range in the Document.

toString

String toString()

Returns:

String

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.