Foxit PDF SDK
com.foxit.sdk.addon.accessibility.TagTreeItemData Class Reference

Public Member Functions

 TagTreeItemData ()
 Constructor.

 
 TagTreeItemData (String item_name, String item_id, String item_pos, RectFArray item_rects, int page_index, int item_image_type, int item_node_type)
 Constructor, with parameters.
More...
 
 TagTreeItemData (TagTreeItemData other)
 Constructor, with another accessibility tag tree item data object.
More...
 
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 
String getItem_id ()
 Get the unique identifier of the tag tree item. More...
 
int getItem_image_type ()
 Get the image type used to represent this tag tree item. More...
 
String getItem_name ()
 Get the display name of the tag tree item. More...
 
int getItem_node_type ()
 Get the node type of this tag tree item. More...
 
String getItem_pos ()
 Get the position descriptor of the tag tree item. More...
 
RectFArray getItem_rects ()
 Get the rectangles associated with this tag tree item. More...
 
int getPage_index ()
 Get the page index where this tag tree item is located. More...
 
void set (String item_name, String item_id, String item_pos, RectFArray item_rects, int page_index, int item_image_type, int item_node_type)
 Set value.
More...
 
void setItem_id (String value)
 Set the unique identifier of the tag tree item. More...
 
void setItem_image_type (int value)
 Set the image type used to represent this tag tree item. More...
 
void setItem_name (String value)
 Set the display name of the tag tree item. More...
 
void setItem_node_type (int value)
 Set the node type of this tag tree item. More...
 
void setItem_pos (String value)
 Set the position descriptor of the tag tree item. More...
 
void setItem_rects (RectFArray value)
 Set the rectangles associated with this tag tree item. More...
 
void setPage_index (int value)
 Set the page index where this tag tree item is located. More...
 

Static Public Attributes

static final int e_TagImageTypePageObject = 1
 Tag image type : page object.

 
static final int e_TagImageTypePDF = 0
 Tag image type : PDF.

 
static final int e_TagImageTypeTable = 4
 Tag image type : table.

 
static final int e_TagImageTypeTableDataCell = 5
 Tag image type : table data cell.

 
static final int e_TagImageTypeTableHeaderCell = 6
 Tag image type : table header cell.

 
static final int e_TagImageTypeTableRow = 7
 Tag image type : table row.

 
static final int e_TagImageTypeTagNode = 8
 Tag image type : tag node.

 
static final int e_TagImageTypeTagParagraph = 2
 Tag image type : tag paragraph.

 
static final int e_TagImageTypeTagSection = 3
 Tag image type : tag section.

 
static final int e_TagNodeTypeElement = 0
 Tag node type : element.

 
static final int e_TagNodeTypeMarkedContentSeq = 1
 Tag node type : marked content sequence.

 
static final int e_TagNodeTypeObject = 2
 Tag node type : object.

 

Detailed Description

This class represents accessibility tag tree item data.

Constructor & Destructor Documentation

◆ TagTreeItemData() [1/2]

com.foxit.sdk.addon.accessibility.TagTreeItemData.TagTreeItemData ( String  item_name,
String  item_id,
String  item_pos,
RectFArray  item_rects,
int  page_index,
int  item_image_type,
int  item_node_type 
)

Constructor, with parameters.

Parameters
[in]item_nameThe display name of the tag tree item.
[in]item_idThe unique identifier of the tag tree item.
[in]item_posThe position descriptor of the tag tree item.
[in]item_rectsThe rectangles associated with this tag tree item.
[in]page_indexThe page index where this tag tree item is located. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .
[in]item_image_typeThe image type used to represent this tag tree item.
[in]item_node_typeThe node type of this tag tree item.

◆ TagTreeItemData() [2/2]

com.foxit.sdk.addon.accessibility.TagTreeItemData.TagTreeItemData ( TagTreeItemData  other)

Constructor, with another accessibility tag tree item data object.

Parameters
[in]otherAnother accessibility tag tree item data object whose values are copied to initialize the current object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.addon.accessibility.TagTreeItemData.delete ( )

Clean up related C++ resources immediately.

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

◆ getItem_id()

com.foxit.sdk.addon.accessibility.TagTreeItemData.getItem_id ( )

Get the unique identifier of the tag tree item.

Returns
The unique identifier of the tag tree item.

◆ getItem_image_type()

com.foxit.sdk.addon.accessibility.TagTreeItemData.getItem_image_type ( )

Get the image type used to represent this tag tree item.

Returns
The image type used to represent this tag tree item. Please refer to values starting from com.foxit.sdk.addon.accessibility.TagTreeItemData.e_TagImageTypePDF .

◆ getItem_name()

com.foxit.sdk.addon.accessibility.TagTreeItemData.getItem_name ( )

Get the display name of the tag tree item.

Returns
The display name of the tag tree item.

◆ getItem_node_type()

com.foxit.sdk.addon.accessibility.TagTreeItemData.getItem_node_type ( )

Get the node type of this tag tree item.

Returns
The node type of this tag tree item. Please refer to values starting from com.foxit.sdk.addon.accessibility.TagTreeItemData.e_TagNodeTypeElement .

◆ getItem_pos()

com.foxit.sdk.addon.accessibility.TagTreeItemData.getItem_pos ( )

Get the position descriptor of the tag tree item.

Returns
The position descriptor of the tag tree item.

◆ getItem_rects()

com.foxit.sdk.addon.accessibility.TagTreeItemData.getItem_rects ( )

Get the rectangles associated with this tag tree item.

Returns
The rectangles associated with this tag tree item.

◆ getPage_index()

com.foxit.sdk.addon.accessibility.TagTreeItemData.getPage_index ( )

Get the page index where this tag tree item is located.

Returns
The page index where this tag tree item is located. Valid range: from 0 to (count-1), where count is returned by function pdf.PDFDoc.getPageCount .

◆ set()

void com.foxit.sdk.addon.accessibility.TagTreeItemData.set ( String  item_name,
String  item_id,
String  item_pos,
RectFArray  item_rects,
int  page_index,
int  item_image_type,
int  item_node_type 
)

Set value.

Parameters
[in]item_nameThe display name of the tag tree item.
[in]item_idThe unique identifier of the tag tree item.
[in]item_posThe position descriptor of the tag tree item.
[in]item_rectsThe rectangles associated with this tag tree item.
[in]page_indexThe page index where this tag tree item is located. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .
[in]item_image_typeThe image type used to represent this tag tree item.
[in]item_node_typeThe node type of this tag tree item.
Returns
None.

◆ setItem_id()

com.foxit.sdk.addon.accessibility.TagTreeItemData.setItem_id ( String  value)

Set the unique identifier of the tag tree item.

Parameters
[in]valueThe unique identifier of the tag tree item.
Returns
None.

◆ setItem_image_type()

com.foxit.sdk.addon.accessibility.TagTreeItemData.setItem_image_type ( int  value)

Set the image type used to represent this tag tree item.

Parameters
[in]valueThe image type used to represent this tag tree item. Please refer to values starting from com.foxit.sdk.addon.accessibility.TagTreeItemData.e_TagImageTypePDF .
Returns
None.

◆ setItem_name()

com.foxit.sdk.addon.accessibility.TagTreeItemData.setItem_name ( String  value)

Set the display name of the tag tree item.

Parameters
[in]valueThe display name of the tag tree item.
Returns
None.

◆ setItem_node_type()

com.foxit.sdk.addon.accessibility.TagTreeItemData.setItem_node_type ( int  value)

Set the node type of this tag tree item.

Parameters
[in]valueThe node type of this tag tree item. Please refer to values starting from com.foxit.sdk.addon.accessibility.TagTreeItemData.e_TagNodeTypeElement .
Returns
None.

◆ setItem_pos()

com.foxit.sdk.addon.accessibility.TagTreeItemData.setItem_pos ( String  value)

Set the position descriptor of the tag tree item.

Parameters
[in]valueThe position descriptor of the tag tree item.
Returns
None.

◆ setItem_rects()

com.foxit.sdk.addon.accessibility.TagTreeItemData.setItem_rects ( RectFArray  value)

Set the rectangles associated with this tag tree item.

Parameters
[in]valueThe rectangles associated with this tag tree item.
Returns
None.

◆ setPage_index()

com.foxit.sdk.addon.accessibility.TagTreeItemData.setPage_index ( int  value)

Set the page index where this tag tree item is located.

Parameters
[in]valueThe page index where this tag tree item is located. Valid range: from 0 to (count-1), where count is returned by function pdf.PDFDoc.getPageCount .
Returns
None.