com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData Class Reference

Public Member Functions
	AccessibilityCheckResultSubItemData ()
	Constructor.
	AccessibilityCheckResultSubItemData (AccessibilityCheckResultSubItemData other)
	Constructor, with another accessibility check result sub item data object. More...
	AccessibilityCheckResultSubItemData (String item_name, String item_full_name, String explain_url, int item_rule, int item_state, AccessibilityCheckResultDetailDataArray detail_data_array)
	Constructor, with parameters. More...
synchronized void	delete ()
	Clean up related C++ resources immediately. More...
AccessibilityCheckResultDetailDataArray	getDetail_data_array ()
	Get the detail items belonging to this sub-item. More...
String	getExplain_url ()
	Get the URL for explanation or guidance related to this sub-item. More...
String	getItem_full_name ()
	Get the full descriptive name of this check sub-item. More...
String	getItem_name ()
	Get the display name of this check sub-item. More...
int	getItem_rule ()
	Get the accessibility rule associated with this sub-item. More...
int	getItem_state ()
	Get the check state of this sub-item under the associated rule. More...
void	set (String item_name, String item_full_name, String explain_url, int item_rule, int item_state, AccessibilityCheckResultDetailDataArray detail_data_array)
	Set value. More...
void	setDetail_data_array (AccessibilityCheckResultDetailDataArray value)
	Set the detail items belonging to this sub-item. More...
void	setExplain_url (String value)
	Set the URL for explanation or guidance related to this sub-item. More...
void	setItem_full_name (String value)
	Set the full descriptive name of this check sub-item. More...
void	setItem_name (String value)
	Set the display name of this check sub-item. More...
void	setItem_rule (int value)
	Set the accessibility rule associated with this sub-item. More...
void	setItem_state (int value)
	Set the check state of this sub-item under the associated rule. More...

Detailed Description

This class represents accessibility check result sub item data.

Constructor & Destructor Documentation

AccessibilityCheckResultSubItemData() [1/2]

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.AccessibilityCheckResultSubItemData	(	String	item_name,
		String	item_full_name,
		String	explain_url,
		int	item_rule,
		int	item_state,
		AccessibilityCheckResultDetailDataArray	detail_data_array
	)

Constructor, with parameters.

Parameters

[in]	item_name	The display name of this check sub-item.
[in]	item_full_name	The full descriptive name of this check sub-item.
[in]	explain_url	The URL for explanation or guidance related to this sub-item.
[in]	item_rule	The accessibility rule associated with this sub-item.
[in]	item_state	The check state of this sub-item under the associated rule.
[in]	detail_data_array	The detail items belonging to this sub-item.

AccessibilityCheckResultSubItemData() [2/2]

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.AccessibilityCheckResultSubItemData

(

AccessibilityCheckResultSubItemData

other

)

Constructor, with another accessibility check result sub item data object.

Parameters

[in]

other

Another accessibility check result sub item data object whose values are copied to initialize the current object.

Member Function Documentation

delete()

synchronized void com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.delete

(

)

Clean up related C++ resources immediately.

Returns

None.

Note

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

getDetail_data_array()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.getDetail_data_array

(

)

Get the detail items belonging to this sub-item.

Returns

The detail items belonging to this sub-item.

getExplain_url()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.getExplain_url

(

)

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

Returns

The URL for explanation or guidance related to this sub-item.

getItem_full_name()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.getItem_full_name

(

)

Get the full descriptive name of this check sub-item.

Returns

The full descriptive name of this check sub-item.

getItem_name()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.getItem_name

(

)

Get the display name of this check sub-item.

Returns

The display name of this check sub-item.

getItem_rule()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.getItem_rule

(

)

Get the accessibility rule associated with this sub-item.

Returns

The accessibility rule associated with this sub-item. Please refer to values starting from foxit::addon::accessibility::e_RuleTypeDocPermission and this should be one of these values.

getItem_state()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.getItem_state

(

)

Get the check state of this sub-item under the associated rule.

Returns

The check state of this sub-item under the associated rule. Please refer to values starting from foxit::addon::accessibility::e_CheckStateNone and this should be one of these values.

set()

void com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.set	(	String	item_name,
		String	item_full_name,
		String	explain_url,
		int	item_rule,
		int	item_state,
		AccessibilityCheckResultDetailDataArray	detail_data_array
	)

Set value.

Parameters

[in]	item_name	The display name of this check sub-item.
[in]	item_full_name	The full descriptive name of this check sub-item.
[in]	explain_url	The URL for explanation or guidance related to this sub-item.
[in]	item_rule	The accessibility rule associated with this sub-item.
[in]	item_state	The check state of this sub-item under the associated rule.
[in]	detail_data_array	The detail items belonging to this sub-item.

Returns

None.

setDetail_data_array()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.setDetail_data_array

(

AccessibilityCheckResultDetailDataArray

value

)

Set the detail items belonging to this sub-item.

Parameters

[in]

value

The detail items belonging to this sub-item.

Returns

None.

setExplain_url()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.setExplain_url

(

String

value

)

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

Parameters

[in]

value

The URL for explanation or guidance related to this sub-item.

Returns

None.

setItem_full_name()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.setItem_full_name

(

String

value

)

Set the full descriptive name of this check sub-item.

Parameters

[in]

value

The full descriptive name of this check sub-item.

Returns

None.

setItem_name()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.setItem_name

(

String

value

)

Set the display name of this check sub-item.

Parameters

[in]

value

The display name of this check sub-item.

Returns

None.

setItem_rule()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.setItem_rule

(

int

value

)

Set the accessibility rule associated with this sub-item.

Parameters

[in]

value

The accessibility rule associated with this sub-item. Please refer to values starting from foxit::addon::accessibility::e_RuleTypeDocPermission and this should be one of these values.

Returns

None.

setItem_state()

com.foxit.sdk.addon.accessibility.AccessibilityCheckResultSubItemData.setItem_state

(

int

value

)

Set the check state of this sub-item under the associated rule.

Parameters

[in]

value

The check state of this sub-item under the associated rule. Please refer to values starting from foxit::addon::accessibility::e_CheckStateNone and this should be one of these values.

Returns

None.