org.sejda.model.pdf.label
Class PdfPageLabel

java.lang.Object
  org.sejda.model.pdf.label.PdfPageLabel

public final class PdfPageLabel
extends Object

Model for a page label.
Pdf reference 1.7, Chap. 8.3.1

Author:

Andrea Vacondio

Method Summary

boolean	equals(Object other)
String	getLabelPrefix()
int	getLogicalPageNumber()
PdfLabelNumberingStyle	getNumberingStyle()
int	hashCode()
static PdfPageLabel	newInstanceWithLabel(String label, PdfLabelNumberingStyle numberingStyle, int logicalPageNumber) Creates a label with given label and given style for the given logical page number.
static PdfPageLabel	newInstanceWithoutLabel(PdfLabelNumberingStyle numberingStyle, int logicalPageNumber) Creates an empty label with the given style for the given logical page number.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getLabelPrefix

public String getLabelPrefix()

getNumberingStyle

public PdfLabelNumberingStyle getNumberingStyle()

getLogicalPageNumber

public int getLogicalPageNumber()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

newInstanceWithoutLabel

public static PdfPageLabel newInstanceWithoutLabel(PdfLabelNumberingStyle numberingStyle,
                                                   int logicalPageNumber)

Creates an empty label with the given style for the given logical page number.

Parameters:

numberingStyle -

logicalPageNumber -

Returns:

the newly created instance

Throws:

InvalidParameterException - if the input logical page number is not positive. if the input numbering style is null.

newInstanceWithLabel

public static PdfPageLabel newInstanceWithLabel(String label,
                                                PdfLabelNumberingStyle numberingStyle,
                                                int logicalPageNumber)

Creates a label with given label and given style for the given logical page number.

Parameters:

label -

numberingStyle -

logicalPageNumber -

Returns:

the newly created instance

Throws:

InvalidParameterException - if the input logical page number is not positive. if the input label or numbering style are null.