Class PDFStructTreeRoot

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFDictionary

org.apache.fop.pdf.StructureHierarchyMember

org.apache.fop.pdf.PDFStructTreeRoot

All Implemented Interfaces:

Serializable, CompressedObject, PDFWritable

public class PDFStructTreeRoot
extends StructureHierarchyMember
implements Serializable

Class representing a PDF /StructTreeRoot dictionary.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	serialVersionUID

Fields inherited from class PDFDictionary

entries, order

Fields inherited from class PDFObject

log

Constructor Summary

Constructors

Constructor	Description
PDFStructTreeRoot(PDFParentTree parentTree)	Creates a new /StructTreeRoot dictionary.

Method Summary

Modifier and Type	Method	Description
void	addKid(PDFObject kid)	Adds the given object to the array of kids.
PDFArray	getKids()	Returns the children element of this StructTreeRoot.

Methods inherited from class PDFDictionary

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

Methods inherited from class PDFObject

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

Methods inherited from class Object

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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

Constructor Details

PDFStructTreeRoot

PDFStructTreeRoot(PDFParentTree parentTree)

Creates a new /StructTreeRoot dictionary.

Parameters:

parentTree - the value of the ParenTree entry

Method Details

getKids

public PDFArray getKids()

Returns the children element of this StructTreeRoot.

Returns:

the value of the K entry

addKid

public void addKid(PDFObject kid)

Adds the given object to the array of kids.

Specified by:

addKid in class StructureHierarchyMember

Parameters:

kid - an object to be added to the K entry