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

Inheritance diagram for com.foxit.sdk.addon.accessibility.AccessibilityFixer:

Public Member Functions
	AccessibilityFixer (AccessibilityFixer other)
	Constructor, with another fixer object. More...
	AccessibilityFixer (PDFDoc pdf_doc) throws com.foxit.sdk.PDFException
	Constructor. More...
boolean	canFixPermissionRules (int check_rule, boolean is_ocr_enabled) throws com.foxit.sdk.PDFException
	Check whether permission rules can be fixed. More...
boolean	canFixRules (int check_rule, int check_state) throws com.foxit.sdk.PDFException
	Check whether specified rules can be fixed. More...
synchronized void	delete ()
	Clean up related C++ resources immediately. More...
boolean	fixDocumentBookmark (WStringArray roles_array) throws com.foxit.sdk.PDFException
	Fix document bookmark. More...
boolean	fixDocumentLanguage (String lang) throws com.foxit.sdk.PDFException
	Fix document language. More...
boolean	fixDocumentPermission () throws com.foxit.sdk.PDFException
	Fix document permission. More...
boolean	fixDocumentTag () throws com.foxit.sdk.PDFException
	Fix document tag. More...
boolean	fixDocumentTitle (String title, String subject, String author, String keywords) throws com.foxit.sdk.PDFException
	Fix document title. More...
String	fixDocumentTitleWithExistingTitle () throws com.foxit.sdk.PDFException
	Fix document title with existing title. More...
boolean	fixFigureAltText (AccessibilityCheckResultDetailDataArray detail_data_array) throws com.foxit.sdk.PDFException
	Fix figure alternate text. More...
boolean	fixFormFieldDescriptions () throws com.foxit.sdk.PDFException
	Fix form field descriptions. More...
boolean	fixFormFieldTagged () throws com.foxit.sdk.PDFException
	Fix form field tagged. More...
boolean	fixPageTabOrder () throws com.foxit.sdk.PDFException
	Fix page tab order. More...
boolean	isEmpty ()
	Check whether current object is empty or not. More...

Detailed Description

This class represents an accessibility fixer for a PDF document: query whether rules are fixable and apply automatic fixes (document language / title / bookmark / permission / tag, page tab order, figure alternate text, form field tagging and descriptions). Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function common.Library.initialize with a key including "Accessibility" module.

See also

com.foxit.sdk.common.Library

Constructor & Destructor Documentation

AccessibilityFixer() [1/2]

com.foxit.sdk.addon.accessibility.AccessibilityFixer.AccessibilityFixer

(

PDFDoc

pdf_doc

)

throws com.foxit.sdk.PDFException

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

AccessibilityFixer() [2/2]

com.foxit.sdk.addon.accessibility.AccessibilityFixer.AccessibilityFixer

(

AccessibilityFixer

other

)

Constructor, with another fixer object.

Parameters

[in]

other

Another fixer object.

Member Function Documentation

canFixPermissionRules()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.canFixPermissionRules	(	int	check_rule,
		boolean	is_ocr_enabled
	)		throws com.foxit.sdk.PDFException

Check whether permission rules can be fixed.

Parameters

[in]	check_rule	The check rule type.
[in]	is_ocr_enabled	Whether OCR is enabled.

Returns

true means permission rules can be fixed, while false means not.

canFixRules()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.canFixRules	(	int	check_rule,
		int	check_state
	)		throws com.foxit.sdk.PDFException

Check whether specified rules can be fixed.

Parameters

[in]	check_rule	The check rule type.
[in]	check_state	The check state.

Returns

true means the rules can be fixed, while false means not.

delete()

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

(

)

Clean up related C++ resources immediately.

Returns

None.

Note

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

Reimplemented from com.foxit.sdk.common.Base.

fixDocumentBookmark()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixDocumentBookmark

(

WStringArray

roles_array

)

throws com.foxit.sdk.PDFException

Fix document bookmark.

Parameters

[in]

roles_array

The roles array.

Returns

true means success, while false means not.

fixDocumentLanguage()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixDocumentLanguage

(

String

lang

)

throws com.foxit.sdk.PDFException

Fix document language.

Parameters

[in]

lang

The language to set.

Returns

true means success, while false means not.

fixDocumentPermission()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixDocumentPermission

(

)

throws com.foxit.sdk.PDFException

Fix document permission.

Returns

true means success, while false means not.

fixDocumentTag()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixDocumentTag

(

)

throws com.foxit.sdk.PDFException

Fix document tag.

Returns

true means success, while false means not.

fixDocumentTitle()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixDocumentTitle	(	String	title,
		String	subject,
		String	author,
		String	keywords
	)		throws com.foxit.sdk.PDFException

Fix document title.

Parameters

[in]	title	The title to set.
[in]	subject	The subject to set.
[in]	author	The author to set.
[in]	keywords	The keywords to set.

Returns

true means success, while false means not.

fixDocumentTitleWithExistingTitle()

String com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixDocumentTitleWithExistingTitle

(

)

throws com.foxit.sdk.PDFException

Fix document title with existing title.

Returns

The existing title text.

fixFigureAltText()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixFigureAltText

(

AccessibilityCheckResultDetailDataArray

detail_data_array

)

throws com.foxit.sdk.PDFException

Fix figure alternate text.

Parameters

[in]

detail_data_array

The check result detail data array.

Returns

true means success, while false means not.

fixFormFieldDescriptions()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixFormFieldDescriptions

(

)

throws com.foxit.sdk.PDFException

Fix form field descriptions.

Returns

true means success, while false means not.

fixFormFieldTagged()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixFormFieldTagged

(

)

throws com.foxit.sdk.PDFException

Fix form field tagged.

Returns

true means success, while false means not.

fixPageTabOrder()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.fixPageTabOrder

(

)

throws com.foxit.sdk.PDFException

Fix page tab order.

Returns

true means success, while false means not.

isEmpty()

boolean com.foxit.sdk.addon.accessibility.AccessibilityFixer.isEmpty

(

)

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns

true means current object is empty, while false means not.