pdftron.PDF.Struct

Class STree

java.lang.Object

pdftron.PDF.Struct.STree

public class STree
extends java.lang.Object

STree is the root of the structure tree, which is a central repository for information related to a PDF document's logical structure. There is at most one structure tree in each document.

Constructor Summary

Constructors

Constructor and Description
STree(Obj struct_dict) Initialize a STree using an existing low-level Cos/SDF object.

Method Summary

Methods

Modifier and Type	Method and Description
static STree	__Create(long impl, java.lang.Object ref) __ create.
ClassMap	getClassMap() Get the class map.
SElement	getElement(byte[] id_buf) Get the element with give ID
SElement	getElement(java.lang.String id) Get the element with given id
SElement	getKid(int index) Get the kid at given index
int	getNumKids() Get the number of kids of the structure tree root.
RoleMap	getRoleMap() Get the role map.
Obj	getSDFObj() Get the SDFObj.
boolean	isValid() Checks if STree is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

STree

public STree(Obj struct_dict)

Initialize a STree using an existing low-level Cos/SDF object.

Parameters:

struct_dict - - a low-level (SDF/Cos) dictionary representing the .

Note:

This constructor does not copy any data, but is instead the logical equivalent of a type cast.

Method Detail

isValid

public boolean isValid()
                throws PDFNetException

Checks if STree is valid.

Returns:

true if this is a valid STree object, false otherwise.

Throws:

PDFNetException

getNumKids

public int getNumKids()
               throws PDFNetException

Get the number of kids of the structure tree root.

Returns:

The number of kids of the structure tree root.

Throws:

PDFNetException

getKid

public SElement getKid(int index)
                throws PDFNetException

Get the kid at given index

Parameters:

index - The index of the kid to obtain.

Returns:

The kid at an array index in the structure tree root.

Throws:

PDFNetException

getElement

public SElement getElement(java.lang.String id)
                    throws PDFNetException

Get the element with given id

Parameters:

id - the input Element ID

Returns:

the element associated with the given ID.

Throws:

PDFNetException

getElement

public SElement getElement(byte[] id_buf)
                    throws PDFNetException

Get the element with give ID

Parameters:

id_buf - buffer containing the ID to search for

Returns:

the element associated with the given ID

Throws:

PDFNetException

getRoleMap

public RoleMap getRoleMap()
                   throws PDFNetException

Get the role map.

Returns:

the RoleMap object from the structure tree root.

Throws:

PDFNetException

getClassMap

public ClassMap getClassMap()
                     throws PDFNetException

Get the class map.

Returns:

the ClassMap object from the structure tree root.

Throws:

PDFNetException

getSDFObj

public Obj getSDFObj()
              throws PDFNetException

Get the SDFObj.

Returns:

Pointer to the underlying SDF/Cos object.

Throws:

PDFNetException

__Create

public static STree __Create(long impl,
             java.lang.Object ref)

__ create.

Parameters:

impl - the impl

ref - the ref

Returns:

the s tree