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

Public Member Functions

 AccessibilityCheckResultDetailData ()
 Constructor.

 
 AccessibilityCheckResultDetailData (AccessibilityCheckResultDetailData other)
 Constructor, with another accessibility check result detail data object.
More...
 
 AccessibilityCheckResultDetailData (String item_name, String item_id, String explain_url, int page_index, RectF item_rect, boolean can_show_in_tags)
 Constructor, with parameters.
More...
 
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 
boolean getCan_show_in_tags ()
 Get whether this item can be displayed in the tag tree view. More...
 
String getExplain_url ()
 Get the URL for explanation or guidance related to this item. More...
 
String getItem_id ()
 Get the unique identifier of the check result item. More...
 
String getItem_name ()
 Get the display name of the check result item. More...
 
RectF getItem_rect ()
 Get the bounding rectangle of this item on the page. More...
 
int getPage_index ()
 Get the page index where this item is located. More...
 
void set (String item_name, String item_id, String explain_url, int page_index, RectF item_rect, boolean can_show_in_tags)
 Set value.
More...
 
void setCan_show_in_tags (boolean value)
 Set whether this item can be displayed in the tag tree view. More...
 
void setExplain_url (String value)
 Set the URL for explanation or guidance related to this item. More...
 
void setItem_id (String value)
 Set the unique identifier of the check result item. More...
 
void setItem_name (String value)
 Set the display name of the check result item. More...
 
void setItem_rect (RectF value)
 Set the bounding rectangle of this item on the page. More...
 
void setPage_index (int value)
 Set the page index where this item is located. More...
 

Detailed Description

This class represents accessibility check result detail data.

Constructor & Destructor Documentation

◆ AccessibilityCheckResultDetailData() [1/2]

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultDetailData.AccessibilityCheckResultDetailData ( String  item_name,
String  item_id,
String  explain_url,
int  page_index,
RectF  item_rect,
boolean  can_show_in_tags 
)

Constructor, with parameters.

Parameters
[in]item_nameThe display name of the check result item.
[in]item_idThe unique identifier of the check result item.
[in]explain_urlThe URL for explanation or guidance related to this item.
[in]page_indexThe page index where this item is located.
[in]item_rectThe bounding rectangle of this item on the page.
[in]can_show_in_tagsWhether this item can be displayed in the tag tree view.

◆ AccessibilityCheckResultDetailData() [2/2]

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

Constructor, with another accessibility check result detail data object.

Parameters
[in]otherAnother accessibility check result detail data object whose values are copied to initialize the current object.

Member Function Documentation

◆ delete()

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

Clean up related C++ resources immediately.

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

◆ getCan_show_in_tags()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultDetailData.getCan_show_in_tags ( )

Get whether this item can be displayed in the tag tree view.

Returns
Whether this item can be displayed in the tag tree view.

◆ getExplain_url()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultDetailData.getExplain_url ( )

Get the URL for explanation or guidance related to this item.

Returns
The URL for explanation or guidance related to this item.

◆ getItem_id()

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

Get the unique identifier of the check result item.

Returns
The unique identifier of the check result item.

◆ getItem_name()

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

Get the display name of the check result item.

Returns
The display name of the check result item.

◆ getItem_rect()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultDetailData.getItem_rect ( )

Get the bounding rectangle of this item on the page.

Returns
The bounding rectangle of this item on the page.

◆ getPage_index()

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

Get the page index where this item is located.

Returns
The page index where this item is located.

◆ set()

void com.foxit.sdk.addon.accessibility.AccessibilityCheckResultDetailData.set ( String  item_name,
String  item_id,
String  explain_url,
int  page_index,
RectF  item_rect,
boolean  can_show_in_tags 
)

Set value.

Parameters
[in]item_nameThe display name of the check result item.
[in]item_idThe unique identifier of the check result item.
[in]explain_urlThe URL for explanation or guidance related to this item.
[in]page_indexThe page index where this item is located.
[in]item_rectThe bounding rectangle of this item on the page.
[in]can_show_in_tagsWhether this item can be displayed in the tag tree view.
Returns
None.

◆ setCan_show_in_tags()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultDetailData.setCan_show_in_tags ( boolean  value)

Set whether this item can be displayed in the tag tree view.

Parameters
[in]valueWhether this item can be displayed in the tag tree view.
Returns
None.

◆ setExplain_url()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultDetailData.setExplain_url ( String  value)

Set the URL for explanation or guidance related to this item.

Parameters
[in]valueThe URL for explanation or guidance related to this item.
Returns
None.

◆ setItem_id()

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

Set the unique identifier of the check result item.

Parameters
[in]valueThe unique identifier of the check result item.
Returns
None.

◆ setItem_name()

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

Set the display name of the check result item.

Parameters
[in]valueThe display name of the check result item.
Returns
None.

◆ setItem_rect()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultDetailData.setItem_rect ( RectF  value)

Set the bounding rectangle of this item on the page.

Parameters
[in]valueThe bounding rectangle of this item on the page.
Returns
None.

◆ setPage_index()

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

Set the page index where this item is located.

Parameters
[in]valueThe page index where this item is located.
Returns
None.