Foxit PDF SDK
|
Public Member Functions | |
PDFStructTree (PDFDoc document) throws com.foxit.sdk.PDFException | |
Constructor, with parameters. More... | |
PDFStructTree (PDFStructTree other) | |
Constructor, with another PDF structure tree object. More... | |
synchronized void | delete () |
Clean up related resources immediately. More... | |
StructElement | getChild (int index) throws com.foxit.sdk.PDFException |
Get the structure element by index. More... | |
int | getChildCount () throws com.foxit.sdk.PDFException |
Get count of structure elements in current PDF structure tree. More... | |
boolean | isEmpty () |
Check whether current object is empty or not. More... | |
PDF structure tree is a kind of common data structure in tagged PDF documents. A structure tree is used in PDF files to represent the organization and hierarchy of the document's content. PDF structure tree has following characteristics:
Class PDFStructTree is used to be associated with an existing PDF structure tree. It offers functions to get structure elements in the PDF structure tree.
com.foxit.sdk.pdf.objects.PDFStructTree.PDFStructTree | ( | PDFDoc | document | ) | throws com.foxit.sdk.PDFException |
Constructor, with parameters.
If there exists PDF structure tree in the PDF document, this function is just to construct a PDF structure tree object to be associated with the structure tree.
[in] | document | A valid PDF document object. |
com.foxit.sdk.pdf.objects.PDFStructTree.PDFStructTree | ( | PDFStructTree | other | ) |
Constructor, with another PDF structure tree object.
[in] | other | Another PDF structure tree object. |
synchronized void com.foxit.sdk.pdf.objects.PDFStructTree.delete | ( | ) |
Clean up related resources immediately.
Reimplemented from com.foxit.sdk.common.Base.
StructElement com.foxit.sdk.pdf.objects.PDFStructTree.getChild | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get the structure element by index.
[in] | index | Index of the structure element to be retrieved. Valid range: from 0 to (count-1). count is returned by function PDFStructTree.getChildCount . |
int com.foxit.sdk.pdf.objects.PDFStructTree.getChildCount | ( | ) | throws com.foxit.sdk.PDFException |
Get count of structure elements in current PDF structure tree.
boolean com.foxit.sdk.pdf.objects.PDFStructTree.isEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.