Foxit PDF SDK
Public Member Functions | Static Public Attributes | List of all members
com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions Class Reference

Public Member Functions

 AccessibilityCheckOptions ()
 Constructor.

 
 AccessibilityCheckOptions (AccessibilityCheckOptions other)
 Constructor, with another accessibility check options object.
More...
 
synchronized void delete ()
 Clean up related C++ resources immediately. More...
 
UInt32Array getCheck_rule_array ()
 Get the array of rules to check. More...
 
Range getPage_range ()
 Get the page range to be adjusted, if is empty represents all pages. More...
 
void set (UInt32Array check_rule_array, Range page_range)
 Set value.
More...
 
void setCheck_rule_array (UInt32Array value)
 Set the array of rules to check. More...
 
void setPage_range (Range value)
 Set the page range to be adjusted, if is empty represents all pages. More...
 

Static Public Attributes

static final int e_CheckValidateRuleTypeAltTextHasContent = 0x011D
 Check validate rule type: alt text has content.

 
static final int e_CheckValidateRuleTypeAltTextHideAnnot = 0x011E
 Check validate rule type: alt text hide annot.

 
static final int e_CheckValidateRuleTypeDocColorContrast = 0x0108
 Check validate rule type: doc color contrast.

 
static final int e_CheckValidateRuleTypeDocLanguageSpecified = 0x0105
 Check validate rule type: doc language specified.

 
static final int e_CheckValidateRuleTypeDocOutlineForLarge = 0x0107
 Check validate rule type: doc outline for large.

 
static final int e_CheckValidateRuleTypeDocPermission = 0x0101
 Check validate rule type: doc permission.

 
static final int e_CheckValidateRuleTypeDocPureImage = 0x0102
 Check validate rule type: doc pure image.

 
static final int e_CheckValidateRuleTypeDocStructTreeOrder = 0x0104
 Check validate rule type: doc struct tree order.

 
static final int e_CheckValidateRuleTypeDocTagged = 0x0103
 Check validate rule type: doc tagged.

 
static final int e_CheckValidateRuleTypeDocTitle = 0x0106
 Check validate rule type: doc title.

 
static final int e_CheckValidateRuleTypeElementAltText = 0x011F
 Check validate rule type: element alt text.

 
static final int e_CheckValidateRuleTypeFigureAltText = 0x011B
 Check validate rule type: figure alt text.

 
static final int e_CheckValidateRuleTypeFormFieldAltText = 0x0113
 Check validate rule type: form field alt text.

 
static final int e_CheckValidateRuleTypeFormFieldTagged = 0x0112
 Check validate rule type: form field tagged.

 
static final int e_CheckValidateRuleTypeHeadingProperNest = 0x0120
 Check validate rule type: heading proper nest.

 
static final int e_CheckValidateRuleTypeListItemsUsed = 0x0119
 Check validate rule type: list items proper used.

 
static final int e_CheckValidateRuleTypeListLblLbodyUsed = 0x011A
 Check validate rule type: list label and LBody proper used.

 
static final int e_CheckValidateRuleTypeNoNestedAltText = 0x011C
 Check validate rule type: no nested alt text.

 
static final int e_CheckValidateRuleTypePageAnnotTagged = 0x010A
 Check validate rule type: page annot tagged.

 
static final int e_CheckValidateRuleTypePageContentTagged = 0x0109
 Check validate rule type: page content tagged.

 
static final int e_CheckValidateRuleTypePageFontEncoding = 0x010C
 Check validate rule type: page font encoding.

 
static final int e_CheckValidateRuleTypePageMultimediaObjectTagged = 0x010D
 Check validate rule type: page multimedia object tagged.

 
static final int e_CheckValidateRuleTypePageNavigationLinkRepeat = 0x0111
 Check validate rule type: page navigation link repeat.

 
static final int e_CheckValidateRuleTypePageNoFlickering = 0x010E
 Check validate rule type: page no flickering.

 
static final int e_CheckValidateRuleTypePageNoInaccessibleScript = 0x010F
 Check validate rule type: page no inaccessible script.

 
static final int e_CheckValidateRuleTypePageNoTimedResponse = 0x0110
 Check validate rule type: page no timed response.

 
static final int e_CheckValidateRuleTypePageTabOrder = 0x010B
 Check validate rule type: page tab order.

 
static final int e_CheckValidateRuleTypeTableHeadersExist = 0x0116
 Check validate rule type: table headers exist.

 
static final int e_CheckValidateRuleTypeTableRowsUsed = 0x0114
 Check validate rule type: table rows proper used.

 
static final int e_CheckValidateRuleTypeTableSpanCorrect = 0x0117
 Check validate rule type: table span correct.

 
static final int e_CheckValidateRuleTypeTableSummary = 0x0118
 Check validate rule type: table summary.

 
static final int e_CheckValidateRuleTypeTableThTdUsed = 0x0115
 Check validate rule type: table TH and TD proper used.

 

Detailed Description

This class represents accessibility check options.

Constructor & Destructor Documentation

◆ AccessibilityCheckOptions()

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

Constructor, with another accessibility check options object.

Parameters
[in]otherAnother accessibility check options object.

Member Function Documentation

◆ delete()

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

Clean up related C++ resources immediately.

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

◆ getCheck_rule_array()

com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions.getCheck_rule_array ( )

Get the array of rules to check.

Returns
The array of rules to check. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions.e_CheckValidateRuleTypeDocPermission . You can provide a single rule or multiple rules in the array,and the array can contain one or multiple rule values.

◆ getPage_range()

com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions.getPage_range ( )

Get the page range to be adjusted, if is empty represents all pages.

Returns
The page range to be adjusted, if is empty represents all pages.

◆ set()

void com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions.set ( UInt32Array  check_rule_array,
Range  page_range 
)

Set value.

Parameters
[in]check_rule_arrayThe array of rules to check. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions.e_CheckValidateRuleTypeDocPermission . You can provide a single rule or multiple rules in the array, and the array should contain at least one valid rule value.
[in]page_rangeThe page range to be adjusted, if is empty represents all pages.
Returns
None.

◆ setCheck_rule_array()

com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions.setCheck_rule_array ( UInt32Array  value)

Set the array of rules to check.

Parameters
[in]valueThe array of rules to check. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions.e_CheckValidateRuleTypeDocPermission . You can provide a single rule or multiple rules in the array,and the array can contain one or multiple rule values.
Returns
None.

◆ setPage_range()

com.foxit.sdk.addon.accessibility.AccessibilityCheckOptions.setPage_range ( Range  value)

Set the page range to be adjusted, if is empty represents all pages.

Parameters
[in]valueThe page range to be adjusted, if is empty represents all pages.
Returns
None.