Foxit PDF SDK
com.foxit.sdk.pdf.objects.StructTreeEntity Class Reference
Inheritance diagram for com.foxit.sdk.pdf.objects.StructTreeEntity:
com.foxit.sdk.common.Base com.foxit.sdk.pdf.objects.StructElement com.foxit.sdk.pdf.objects.StructMarkedContent com.foxit.sdk.pdf.objects.StructObjectContent

Public Member Functions

 StructTreeEntity ()
 Constructor.

 
 StructTreeEntity (StructTreeEntity other)
 Constructor, with another structure element entity object.
More...
 
synchronized void delete ()
 Clean up related resources immediately. More...
 
PDFPage getPage () throws com.foxit.sdk.PDFException
 Get the related PDF page.
More...
 
int getType () throws com.foxit.sdk.PDFException
 Get structure tree entity type.
More...
 
boolean isEmpty ()
 Check whether current object is empty or not.
More...
 

Static Public Attributes

static final int e_StructTreeEntityTypeElement = 0
 Structure tree entity type: Element, which represents a structure element.

 
static final int e_StructTreeEntityTypeMarkedContent = 1
 Structure tree entity type: MarkedContent, which represents a marked-content item.

 
static final int e_StructTreeEntityTypeObjectContent = 2
 Structure tree entity type: ObjectContent, which represents a PDF object content item, such as annotation and XObject.

 
static final int e_UnknownType = -1
 Structure tree entity type: unknown.

 

Detailed Description

This class represents structure tree entity.

Constructor & Destructor Documentation

◆ StructTreeEntity()

com.foxit.sdk.pdf.objects.StructTreeEntity.StructTreeEntity ( StructTreeEntity  other)

Constructor, with another structure element entity object.

Parameters
[in]otherAnother structure element entity object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.pdf.objects.StructTreeEntity.delete ( )

Clean up related resources immediately.

Returns
None.
Note
Once this function is called, current object cannot be used anymore.

Reimplemented from com.foxit.sdk.common.Base.

Reimplemented in com.foxit.sdk.pdf.objects.StructElement, com.foxit.sdk.pdf.objects.StructMarkedContent, and com.foxit.sdk.pdf.objects.StructObjectContent.

◆ getPage()

PDFPage com.foxit.sdk.pdf.objects.StructTreeEntity.getPage ( ) throws com.foxit.sdk.PDFException

Get the related PDF page.

Returns
A PDF page object which is the related PDF page.

◆ getType()

int com.foxit.sdk.pdf.objects.StructTreeEntity.getType ( ) throws com.foxit.sdk.PDFException

Get structure tree entity type.

Returns
Structure tree entity type. Please refer to values starting from com.foxit.sdk.pdf.objects.StructTreeEntity.e_StructTreeEntityTypeElement and this would be one of these values.

◆ isEmpty()

boolean com.foxit.sdk.pdf.objects.StructTreeEntity.isEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.