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

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

Public Member Functions
	AccessibilityNavigator (AccessibilityNavigator other)
	Constructor, with another navigator object. More...
	AccessibilityNavigator (PDFDoc pdf_doc) throws com.foxit.sdk.PDFException
	Constructor. More...
synchronized void	delete ()
	Clean up related C++ resources immediately. More...
AccessibilityFindResult	findNextElement (int page_index, int find_type, boolean is_search_page) throws com.foxit.sdk.PDFException
	Find next element. More...
boolean	isEmpty ()
	Check whether current object is empty or not. More...
void	startFindNextElement () throws com.foxit.sdk.PDFException
	Start to find next element. More...
void	stopFindNextElement () throws com.foxit.sdk.PDFException
	Stop finding next element. More...

Static Public Attributes
static final int	e_FinderTypeArtifacts = 1
	Finder type: artifacts (page artifacts).
static final int	e_FinderTypeInvalid = 0
	Finder type: invalid.
static final int	e_FinderTypeOcrSuspects = 6
	Finder type: OCR suspects detected by OCR.
static final int	e_FinderTypeUnmarkedAnnots = 4
	Finder type: unmarked annotations.
static final int	e_FinderTypeUnmarkedComments = 2
	Finder type: unmarked comments.
static final int	e_FinderTypeUnmarkedContent = 5
	Finder type: unmarked page content.
static final int	e_FinderTypeUnmarkedLinks = 3
	Finder type: unmarked links.

Detailed Description

This class lets user walk through the accessible elements of a PDF document one by one, used to drive "find next element" navigation in an accessibility checking / fixing UI. 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

AccessibilityNavigator() [1/2]

com.foxit.sdk.addon.accessibility.AccessibilityNavigator.AccessibilityNavigator

(

PDFDoc

pdf_doc

)

throws com.foxit.sdk.PDFException

Constructor.

Parameters

[in]

pdf_doc

A valid PDF document object.

AccessibilityNavigator() [2/2]

com.foxit.sdk.addon.accessibility.AccessibilityNavigator.AccessibilityNavigator

(

AccessibilityNavigator

other

)

Constructor, with another navigator object.

Parameters

[in]

other

Another navigator object.

Member Function Documentation

delete()

synchronized void com.foxit.sdk.addon.accessibility.AccessibilityNavigator.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.

findNextElement()

AccessibilityFindResult com.foxit.sdk.addon.accessibility.AccessibilityNavigator.findNextElement	(	int	page_index,
		int	find_type,
		boolean	is_search_page
	)		throws com.foxit.sdk.PDFException

Find next element.

Parameters

[in]	page_index	The page index.
[in]	find_type	The finder type. Please refer to values starting from com.foxit.sdk.addon.accessibility.AccessibilityNavigator.e_FinderTypeInvalid and this should be one of these values.
[in]	is_search_page	Whether to search page.

Returns

The find result object.

isEmpty()

boolean com.foxit.sdk.addon.accessibility.AccessibilityNavigator.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.

startFindNextElement()

void com.foxit.sdk.addon.accessibility.AccessibilityNavigator.startFindNextElement

(

)

throws com.foxit.sdk.PDFException

Start to find next element.

Returns

None.

stopFindNextElement()

void com.foxit.sdk.addon.accessibility.AccessibilityNavigator.stopFindNextElement

(

)

throws com.foxit.sdk.PDFException

Stop finding next element.

Returns

None.