PageLabel Class Documentation

classPageLabel

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(intstart, NumberStylens)

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(intstart, NumberStylens, Stringp, intfirst)

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

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

finalize

voidfinalize()

Returns:

void

getEndPageIndex

intgetEndPageIndex()

Returns:

int

The end index for the 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.

getFirstNumberInRange

intgetFirstNumberInRange()

Returns:

int

The first number used in the page label range. Must be greater than or equal to 1.

getNumberStyle

NumberStylegetNumberStyle()

Returns:

NumberStyle

The numbering style for the page label range

getPrefix

StringgetPrefix()

Returns:

String

The prefix string for the page label range

getStartPageIndex

intgetStartPageIndex()

Returns:

int

The start index for the page label range

setFirstNumberInRange

voidsetFirstNumberInRange(intarg0)

Parameters

arg0: int

Returns:

void

The first number used in the page label range

setNumberStyle

voidsetNumberStyle(NumberStylearg0)

Parameters

arg0: NumberStyle

Returns:

void

The numbering style for the page label range

setPrefix

voidsetPrefix(Stringarg0)

Parameters

arg0: String

Returns:

void

The prefix string for the page label range

setStartPageIndex

voidsetStartPageIndex(intndx)

Parameters

ndx: int

Returns:

void

The start index for the page label range

toString

StringtoString()

Returns:

String