Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureTreeRoot

Modifier and Type	Field and Description
private static final Log	LOG Log instance.
private static final String	TYPE

Access	Constructor and Description
public	PDStructureTreeRoot() Default Constructor.
public	PDStructureTreeRoot(COSDictionary The existing dictionary. dic) Constructor for an existing structure element.

Method Summary

Modifier and Type	Method and Description
public Map<String, Object>	Returns: the ClassMap, never null. The elements are either `PDAttributeObject` or lists of it. getClassMap() Sets the ClassMap.
public PDNameTreeNode<PDStructureElement>	Returns: the ID tree getIDTree() Returns the ID tree.
public COSBase	Returns: the K entry. getK() Returns the K entry.
public PDNumberTreeNode	Returns: the parent tree. getParentTree() Returns the parent tree.
public int	Returns: The next key for the parent tree getParentTreeNextKey() Returns The next key for the parent tree.
public Map<String, Object>	Returns: the role map getRoleMap() Returns the role map.
public void	setClassMap(Map<String, Object> null, or a map whose elements are either `PDAttributeObject` or lists of it. classMap) Sets the ClassMap.
public void	setIDTree(PDNameTreeNode<PDStructureElement> the ID tree idTree) Sets the ID tree.
public void	setK(COSBase the K value k) Sets the K entry.
public void	setParentTree(PDNumberTreeNode the parent tree parentTree) Sets the parent tree.
public void	setParentTreeNextKey(int The next key in the parent tree. parentTreeNextkey) Sets the next key in the parent tree.
public void	setRoleMap(Map<String, String> the role map roleMap) Sets the role map.

Inherited from org.apache.pdfbox.pdmodel.documentinterchange.logicalstructure.PDStructureNode:: appendKid appendKid appendObjectableKid create createObject getCOSObject getKids getType insertBefore insertBefore insertObjectableBefore removeKid removeKid removeObjectableKid setKids

LOG	back to summary
private static final Log LOG Log instance.

TYPE	back to summary
private static final String TYPE

PDStructureTreeRoot	back to summary
public PDStructureTreeRoot() Default Constructor.

PDStructureTreeRoot	back to summary
public PDStructureTreeRoot(COSDictionary dic) Constructor for an existing structure element. Parameters dic:COSDictionary The existing dictionary.

Method Detail

getClassMap back to summary

getClassMap	back to summary
public Map<String, Object> getClassMap() Sets the ClassMap. Returns:Map<String, Object> the ClassMap, never null. The elements are either `PDAttributeObject` or lists of it.

public Map<String, Object> getClassMap()

Sets the ClassMap.

Returns:Map<String, Object>: the ClassMap, never null. The elements are either PDAttributeObject or lists of it.

getIDTree	back to summary
public PDNameTreeNode<PDStructureElement> getIDTree() Returns the ID tree. Returns:PDNameTreeNode<PDStructureElement> the ID tree

getIDTree

back to summary

public PDNameTreeNode<PDStructureElement> getIDTree()

Returns the ID tree.

Returns:PDNameTreeNode<PDStructureElement>: the ID tree

getK back to summary

getK	back to summary
public COSBase getK() Returns the K entry. This can be a dictionary representing a structure element, or an array of them. To get it as a list of PDStructureElement objects, use `getKids()` instead. Returns:COSBase the K entry.

public COSBase getK()

Returns the K entry. This can be a dictionary representing a structure element, or an array of them. To get it as a list of PDStructureElement objects, use getKids() instead.

Returns:COSBase: the K entry.

getParentTree back to summary

getParentTree	back to summary
public PDNumberTreeNode getParentTree() Returns the parent tree. The keys correspond to a single page of the document or to an individual object, e.g. an annotation or an XObject, which have a /StructParent or /StructParents entry. The values of type `PDParentTreeValue` are either a dictionary or an array. It's a dictionary for individual objects like an annotation or an XObject, and an array for a page object or a content stream containing marked-content sequences identified by an MCID. Returns:PDNumberTreeNode the parent tree.

public PDNumberTreeNode getParentTree()

Returns the parent tree.

The keys correspond to a single page of the document or to an individual object, e.g. an annotation or an XObject, which have a /StructParent or /StructParents entry.

The values of type PDParentTreeValue are either a dictionary or an array. It's a dictionary for individual objects like an annotation or an XObject, and an array for a page object or a content stream containing marked-content sequences identified by an MCID.

Returns:PDNumberTreeNode: the parent tree.

getParentTreeNextKey	back to summary
public int getParentTreeNextKey() Returns The next key for the parent tree. This is a number greater than any existing key, and which shall be used for the next entry to be added to the tree. Returns:int The next key for the parent tree

getParentTreeNextKey

back to summary

public int getParentTreeNextKey()

Returns The next key for the parent tree. This is a number greater than any existing key, and which shall be used for the next entry to be added to the tree.

Returns:int: The next key for the parent tree

getRoleMap	back to summary
public Map<String, Object> getRoleMap() Returns the role map. Returns:Map<String, Object> the role map

getRoleMap

back to summary

public Map<String, Object> getRoleMap()

Returns the role map.

Returns:Map<String, Object>: the role map

setClassMap back to summary

setClassMap	back to summary
public void setClassMap(Map<String, Object> classMap) Sets the ClassMap. Parameters classMap:Map<String, Object> null, or a map whose elements are either `PDAttributeObject` or lists of it.

public void setClassMap(Map<String, Object> classMap)

Sets the ClassMap.

Parameters

classMap:Map<String, Object>: null, or a map whose elements are either PDAttributeObject or lists of it.

setIDTree	back to summary
public void setIDTree(PDNameTreeNode<PDStructureElement> idTree) Sets the ID tree. Parameters idTree:PDNameTreeNode<PDStructureElement> the ID tree

setIDTree

back to summary

public void setIDTree(PDNameTreeNode<PDStructureElement> idTree)

Sets the ID tree.

Parameters

idTree:PDNameTreeNode<PDStructureElement>: the ID tree

setK	back to summary
public void setK(COSBase k) Sets the K entry. Parameters k:COSBase the K value

setK

back to summary

public void setK(COSBase k)

Sets the K entry.

Parameters

k:COSBase: the K value

setParentTree back to summary

setParentTree	back to summary
public void setParentTree(PDNumberTreeNode parentTree) Sets the parent tree. The keys correspond to a single page of the document or to an individual object, e.g. an annotation or an XObject, which have a /StructParent or /StructParents entry. The values of type `PDParentTreeValue` are either a dictionary or an array. It's a dictionary for individual objects like an annotation or an XObject, and an array for a page object or a content stream containing marked-content sequences identified by an MCID. To create an empty parent tree, call `new PDNumberTreeNode(PDParentTreeValue.class)`. Parameters parentTree:PDNumberTreeNode the parent tree

public void setParentTree(PDNumberTreeNode parentTree)

Sets the parent tree.

The keys correspond to a single page of the document or to an individual object, e.g. an annotation or an XObject, which have a /StructParent or /StructParents entry.

To create an empty parent tree, call new PDNumberTreeNode(PDParentTreeValue.class).

Parameters

parentTree:PDNumberTreeNode: the parent tree

setParentTreeNextKey	back to summary
public void setParentTreeNextKey(int parentTreeNextkey) Sets the next key in the parent tree. This is a number greater than any existing key, and which shall be used for the next entry to be added to the tree. Parameters parentTreeNextkey:int The next key in the parent tree.

setParentTreeNextKey

back to summary

public void setParentTreeNextKey(int parentTreeNextkey)

Sets the next key in the parent tree. This is a number greater than any existing key, and which shall be used for the next entry to be added to the tree.

Parameters

parentTreeNextkey:int: The next key in the parent tree.

setRoleMap	back to summary
public void setRoleMap(Map<String, String> roleMap) Sets the role map. Parameters roleMap:Map<String, String> the role map

setRoleMap

back to summary

public void setRoleMap(Map<String, String> roleMap)

Sets the role map.

Parameters

roleMap:Map<String, String>: the role map

public Class PDStructureTreeRoot

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail