com.datalogics.PDFL

Class PageLabel

java.lang.Object

com.datalogics.PDFL.PageLabel

public class PageLabel
extends java.lang.Object

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.

Constructor Summary

Constructors

Constructor and Description
PageLabel(int start, NumberStyle ns) Convenience constructor creates a range with no prefix starting with number 1.
PageLabel(int start, NumberStyle ns, java.lang.String p, int first) Public constructor

Method Summary

Modifier and Type	Method and Description
void	delete()
int	getEndPageIndex() The end index for the page label range
int	getFirstNumberInRange() The first number used in the page label range.
NumberStyle	getNumberStyle() The numbering style for the page label range
java.lang.String	getPrefix() The prefix string for the page label range
int	getStartPageIndex() The start index for the page label range
void	setFirstNumberInRange(int arg0) The first number used in the page label range
void	setNumberStyle(NumberStyle arg0) The numbering style for the page label range
void	setPrefix(java.lang.String arg0) The prefix string for the page label range
void	setStartPageIndex(int ndx) The start index for the page label range
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PageLabel

public PageLabel(int start,
                 NumberStyle ns,
                 java.lang.String p,
                 int first)

Public constructor

Parameters:

start - Starting page index in the Document for this range

ns - Numbering style for this range

p - Prefix string for this range

first - First number appearing on a page in this range

PageLabel

public PageLabel(int start,
                 NumberStyle ns)

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

Parameters:

start - Starting page index in the Document for this range

ns - Numbering style for this range

Method Detail

delete

public void delete()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStartPageIndex

public int getStartPageIndex()

The start index for the page label range

setStartPageIndex

public void setStartPageIndex(int ndx)

The start index for the page label range

getEndPageIndex

public int getEndPageIndex()

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.

getPrefix

public java.lang.String getPrefix()

The prefix string for the page label range

setPrefix

public void setPrefix(java.lang.String arg0)

The prefix string for the page label range

getFirstNumberInRange

public int getFirstNumberInRange()

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

setFirstNumberInRange

public void setFirstNumberInRange(int arg0)

The first number used in the page label range

getNumberStyle

public NumberStyle getNumberStyle()

The numbering style for the page label range

setNumberStyle

public void setNumberStyle(NumberStyle arg0)

The numbering style for the page label range