org.apache.fop.pdf

Class PDFNumberTreeNode

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFDictionary

org.apache.fop.pdf.PDFNumberTreeNode

All Implemented Interfaces:

PDFWritable

Direct Known Subclasses:

PDFPageLabels, PDFParentTree

public class PDFNumberTreeNode
extends PDFDictionary

Class representing a PDF number tree node.

Field Summary

Fields inherited from class org.apache.fop.pdf.PDFDictionary

entries, order

Fields inherited from class org.apache.fop.pdf.PDFObject

log

Constructor Summary

Constructors

Constructor and Description
PDFNumberTreeNode() create a named destination

Method Summary

Modifier and Type	Method and Description
protected void	addToNums(int num, Object object) Adds a number and object to the nums array and increases the upper limit should it be required.
PDFArray	getKids() Returns the Kids array.
Integer	getLowerLimit() Returns the lower limit value of the Limits array.
PDFNumsArray	getNums() Returns the Nums array.
Integer	getUpperLimit() Returns the upper limit value of the Limits array.
void	setKids(PDFArray kids) Sets the Kids array.
void	setLowerLimit(Integer key) Sets the lower limit value of the Limits array.
void	setNums(PDFNumsArray nums) Sets the Nums array.
void	setUpperLimit(Integer key) Sets the upper limit value of the Limits array.

Methods inherited from class org.apache.fop.pdf.PDFDictionary

containsKey, get, getChildren, getChildren, keySet, output, put, put, remove, writeDictionary

Methods inherited from class org.apache.fop.pdf.PDFObject

contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PDFNumberTreeNode

public PDFNumberTreeNode()

create a named destination

Method Detail

setKids

public void setKids(PDFArray kids)

Sets the Kids array.

Parameters:

kids - the Kids array

getKids

public PDFArray getKids()

Returns the Kids array.

Returns:

the Kids array

setNums

public void setNums(PDFNumsArray nums)

Sets the Nums array.

Parameters:

nums - the Nums array

getNums

public PDFNumsArray getNums()

Returns the Nums array.

Returns:

the Nums array

setLowerLimit

public void setLowerLimit(Integer key)

Sets the lower limit value of the Limits array.

Parameters:

key - the lower limit value

getLowerLimit

public Integer getLowerLimit()

Returns the lower limit value of the Limits array.

Returns:

the lower limit value

setUpperLimit

public void setUpperLimit(Integer key)

Sets the upper limit value of the Limits array.

Parameters:

key - the upper limit value

getUpperLimit

public Integer getUpperLimit()

Returns the upper limit value of the Limits array.

Returns:

the upper limit value

addToNums

protected void addToNums(int num,
                         Object object)

Adds a number and object to the nums array and increases the upper limit should it be required.

Parameters:

num - The unique number identifying the object in the array

object - The object being added