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

Public Member Functions

 ContentTreeItemData ()
 Constructor.

 
 ContentTreeItemData (ContentTreeItemData other)
 Constructor, with another content tree item data object.
More...
 
 ContentTreeItemData (String name, String id, RectFArray rect_array, int page_index, int type)
 Constructor, with parameters.
More...
 
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 
String getId ()
 Get the item ID. More...
 
String getName ()
 Get the item name. More...
 
int getPage_index ()
 Get the page index. More...
 
RectFArray getRect_array ()
 Get the item rectangle array. More...
 
int getType ()
 Get the content type. More...
 
void set (String name, String id, RectFArray rect_array, int page_index, int type)
 Set value.
More...
 
void setId (String value)
 Set the item ID. More...
 
void setName (String value)
 Set the item name. More...
 
void setPage_index (int value)
 Set the page index. More...
 
void setRect_array (RectFArray value)
 Set the item rectangle array. More...
 
void setType (int value)
 Set the content type. More...
 

Detailed Description

This class represents content tree item data.

Constructor & Destructor Documentation

◆ ContentTreeItemData() [1/2]

com.foxit.sdk.addon.accessibility.ContentTreeItemData.ContentTreeItemData ( String  name,
String  id,
RectFArray  rect_array,
int  page_index,
int  type 
)

Constructor, with parameters.

Parameters
[in]nameThe item name.
[in]idThe item ID.
[in]rect_arrayThe item rectangle array.
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .
[in]typeThe content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.

◆ ContentTreeItemData() [2/2]

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

Constructor, with another content tree item data object.

Parameters
[in]otherAnother content tree item data object.

Member Function Documentation

◆ delete()

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

Clean up related C++ resources immediately.

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

◆ getId()

com.foxit.sdk.addon.accessibility.ContentTreeItemData.getId ( )

Get the item ID.

Returns
The item ID.

◆ getName()

com.foxit.sdk.addon.accessibility.ContentTreeItemData.getName ( )

Get the item name.

Returns
The item name.

◆ getPage_index()

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

Get the page index.

Returns
The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .

◆ getRect_array()

com.foxit.sdk.addon.accessibility.ContentTreeItemData.getRect_array ( )

Get the item rectangle array.

Returns
The item rectangle array.

◆ getType()

com.foxit.sdk.addon.accessibility.ContentTreeItemData.getType ( )

Get the content type.

Returns
The content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.

◆ set()

void com.foxit.sdk.addon.accessibility.ContentTreeItemData.set ( String  name,
String  id,
RectFArray  rect_array,
int  page_index,
int  type 
)

Set value.

Parameters
[in]nameThe item name.
[in]idThe item ID.
[in]rect_arrayThe item rectangle array.
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .
[in]typeThe content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.
Returns
None.

◆ setId()

com.foxit.sdk.addon.accessibility.ContentTreeItemData.setId ( String  value)

Set the item ID.

Parameters
[in]valueThe item ID.
Returns
None.

◆ setName()

com.foxit.sdk.addon.accessibility.ContentTreeItemData.setName ( String  value)

Set the item name.

Parameters
[in]valueThe item name.
Returns
None.

◆ setPage_index()

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

Set the page index.

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

◆ setRect_array()

com.foxit.sdk.addon.accessibility.ContentTreeItemData.setRect_array ( RectFArray  value)

Set the item rectangle array.

Parameters
[in]valueThe item rectangle array.
Returns
None.

◆ setType()

com.foxit.sdk.addon.accessibility.ContentTreeItemData.setType ( int  value)

Set the content type.

Parameters
[in]valueThe content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.
Returns
None.