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

Public Member Functions

 AccessibilityDictionaryTreeItemData ()
 Constructor.

 
 AccessibilityDictionaryTreeItemData (AccessibilityDictionaryTreeItemData other)
 Constructor, with another accessibility dictionary tree item data object.
More...
 
 AccessibilityDictionaryTreeItemData (String item_name, String item_id, String key, String value, int value_type, int status)
 Constructor, with parameters.
More...
 
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 
String getItem_id ()
 Get the item ID. More...
 
String getItem_name ()
 Get the item name. More...
 
String getKey ()
 Get the dictionary key. More...
 
int getStatus ()
 Get the edit status of the tree item. More...
 
String getValue ()
 Get the dictionary value. More...
 
int getValue_type ()
 Get the dictionary value type. More...
 
void set (String item_name, String item_id, String key, String value, int value_type, int status)
 Set value.
More...
 
void setItem_id (String value)
 Set the item ID. More...
 
void setItem_name (String value)
 Set the item name. More...
 
void setKey (String value)
 Set the dictionary key. More...
 
void setStatus (int value)
 Set the edit status of the tree item. More...
 
void setValue (String value)
 Set the dictionary value. More...
 
void setValue_type (int value)
 Set the dictionary value type. More...
 

Static Public Attributes

static final int e_DictionaryValueTypeArray = 0
 Dictionary value type: array.

 
static final int e_DictionaryValueTypeAttributeClassesRoot = 9
 Dictionary value type: attribute classes root.

 
static final int e_DictionaryValueTypeAttributeObject = 8
 Dictionary value type: attribute object.

 
static final int e_DictionaryValueTypeAttributeObjectsRoot = 11
 Dictionary value type: attribute objects root.

 
static final int e_DictionaryValueTypeBoolean = 1
 Dictionary value type: boolean.

 
static final int e_DictionaryValueTypeDictionary = 2
 Dictionary value type: dictionary/object.

 
static final int e_DictionaryValueTypeDocClass = 7
 Dictionary value type: document class.

 
static final int e_DictionaryValueTypeDocumentClassesRoot = 10
 Dictionary value type: document classes root.

 
static final int e_DictionaryValueTypeFixedPoint = 3
 Dictionary value type: fixed point number.

 
static final int e_DictionaryValueTypeInt = 4
 Dictionary value type: integer.

 
static final int e_DictionaryValueTypeName = 5
 Dictionary value type: name object.

 
static final int e_DictionaryValueTypeString = 6
 Dictionary value type: string object.

 
static final int e_TreeItemStatusAdd = 1
 Edit status: added, the item is newly added.

 
static final int e_TreeItemStatusChange = 3
 Edit status: changed, the item value has been modified.

 
static final int e_TreeItemStatusDelete = 2
 Edit status: deleted, the item is marked as deleted.

 
static final int e_TreeItemStatusNormal = 0
 Edit status: normal, the item is unchanged.

 

Detailed Description

This class represents accessibility dictionary tree item data.

Constructor & Destructor Documentation

◆ AccessibilityDictionaryTreeItemData() [1/2]

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.AccessibilityDictionaryTreeItemData ( String  item_name,
String  item_id,
String  key,
String  value,
int  value_type,
int  status 
)

Constructor, with parameters.

Parameters
[in]item_nameThe item name.
[in]item_idThe item ID.
[in]keyThe dictionary key.
[in]valueThe dictionary value.
[in]value_typeThe dictionary value type.
[in]statusThe status.

◆ AccessibilityDictionaryTreeItemData() [2/2]

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

Constructor, with another accessibility dictionary tree item data object.

Parameters
[in]otherAnother accessibility dictionary tree item data object.

Member Function Documentation

◆ delete()

synchronized void com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.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.AccessibilityDictionaryTreeItemData.getItem_id ( )

Get the item ID.

Returns
The item ID.

◆ getItem_name()

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

Get the item name.

Returns
The item name.

◆ getKey()

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.getKey ( )

Get the dictionary key.

Returns
The dictionary key.

◆ getStatus()

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.getStatus ( )

Get the edit status of the tree item.

Returns
The edit status of the tree item. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.e_TreeItemStatusNormal and this should be one of these values.

◆ getValue()

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.getValue ( )

Get the dictionary value.

Returns
The dictionary value.

◆ getValue_type()

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.getValue_type ( )

Get the dictionary value type.

Returns
The dictionary value type. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.e_DictionaryValueTypeArray and this should be one of these values.

◆ set()

void com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.set ( String  item_name,
String  item_id,
String  key,
String  value,
int  value_type,
int  status 
)

Set value.

Parameters
[in]item_nameThe item name.
[in]item_idThe item ID.
[in]keyThe dictionary key.
[in]valueThe dictionary value.
[in]value_typeThe dictionary value type.
[in]statusThe status.
Returns
None.

◆ setItem_id()

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

Set the item ID.

Parameters
[in]valueThe item ID.
Returns
None.

◆ setItem_name()

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

Set the item name.

Parameters
[in]valueThe item name.
Returns
None.

◆ setKey()

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.setKey ( String  value)

Set the dictionary key.

Parameters
[in]valueThe dictionary key.
Returns
None.

◆ setStatus()

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.setStatus ( int  value)

Set the edit status of the tree item.

Parameters
[in]valueThe edit status of the tree item. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.e_TreeItemStatusNormal and this should be one of these values.
Returns
None.

◆ setValue()

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.setValue ( String  value)

Set the dictionary value.

Parameters
[in]valueThe dictionary value.
Returns
None.

◆ setValue_type()

com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.setValue_type ( int  value)

Set the dictionary value type.

Parameters
[in]valueThe dictionary value type. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityDictionaryTreeItemData.e_DictionaryValueTypeArray and this should be one of these values.
Returns
None.