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

Public Member Functions
	TreeItemInfo ()
	Constructor.
	TreeItemInfo (int type, int order_index, int page_index, String text, RectF rect)
	Constructor. More...
	TreeItemInfo (TreeItemInfo other)
	Constructor, with another reading order tree item info object. More...
synchronized void	delete ()
	Clean up related C++ resources immediately. More...
int	getOrder_index ()
	Get the order index of item, beginning from 0. More...
int	getPage_index ()
	Get the page index of selected item. More...
RectF	getRect ()
	Get the rect of page content item. More...
String	getText ()
	Get the text of item, shown in UI. More...
int	getType ()
	Get the type of item content. More...
void	set (int type, int order_index, int page_index, String text, RectF rect)
	Set value. More...
void	setOrder_index (int value)
	Set the order index of item, beginning from 0. More...
void	setPage_index (int value)
	Set the page index of selected item. More...
void	setRect (RectF value)
	Set the rect of page content item. More...
void	setText (String value)
	Set the text of item, shown in UI. More...
void	setType (int value)
	Set the type of item content. More...

Detailed Description

This class represents data used for reading order tree item info.

Constructor & Destructor Documentation

TreeItemInfo() [1/2]

com.foxit.sdk.addon.accessibility.TreeItemInfo.TreeItemInfo	(	int	type,
		int	order_index,
		int	page_index,
		String	text,
		RectF	rect
	)

Constructor.

Parameters

[in]	type	The content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.
[in]	order_index	The order index.
[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .
[in]	text	The item text.
[in]	rect	The rectangle.

Returns

None.

TreeItemInfo() [2/2]

com.foxit.sdk.addon.accessibility.TreeItemInfo.TreeItemInfo

(

TreeItemInfo

other

)

Constructor, with another reading order tree item info object.

Parameters

[in]

other

Another reading order tree item info object.

Member Function Documentation

delete()

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

(

)

Clean up related C++ resources immediately.

Returns

None.

Note

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

getOrder_index()

com.foxit.sdk.addon.accessibility.TreeItemInfo.getOrder_index

(

)

Get the order index of item, beginning from 0.

Returns

The order index of item, beginning from 0.

getPage_index()

com.foxit.sdk.addon.accessibility.TreeItemInfo.getPage_index

(

)

Get the page index of selected item.

Returns

The page index of selected item. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .

getRect()

com.foxit.sdk.addon.accessibility.TreeItemInfo.getRect

(

)

Get the rect of page content item.

Returns

The rect of page content item.

getText()

com.foxit.sdk.addon.accessibility.TreeItemInfo.getText

(

)

Get the text of item, shown in UI.

Returns

The text of item, shown in UI.

getType()

com.foxit.sdk.addon.accessibility.TreeItemInfo.getType

(

)

Get the type of item content.

Returns

The type of item content. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.

set()

void com.foxit.sdk.addon.accessibility.TreeItemInfo.set	(	int	type,
		int	order_index,
		int	page_index,
		String	text,
		RectF	rect
	)

Set value.

Parameters

[in]	type	The content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.
[in]	order_index	The order index.
[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .
[in]	text	The item text.
[in]	rect	The rectangle.

Returns

None.

setOrder_index()

com.foxit.sdk.addon.accessibility.TreeItemInfo.setOrder_index

(

int

value

)

Set the order index of item, beginning from 0.

Parameters

[in]

value

The order index of item, beginning from 0.

Returns

None.

setPage_index()

com.foxit.sdk.addon.accessibility.TreeItemInfo.setPage_index

(

int

value

)

Set the page index of selected item.

Parameters

[in]

value

The page index of selected item. Valid range: from 0 to (count-1). count is returned by function pdf.PDFDoc.getPageCount .

Returns

None.

setRect()

com.foxit.sdk.addon.accessibility.TreeItemInfo.setRect

(

RectF

value

)

Set the rect of page content item.

Parameters

[in]

value

The rect of page content item.

Returns

None.

setText()

com.foxit.sdk.addon.accessibility.TreeItemInfo.setText

(

String

value

)

Set the text of item, shown in UI.

Parameters

[in]

value

The text of item, shown in UI.

Returns

None.

setType()

com.foxit.sdk.addon.accessibility.TreeItemInfo.setType

(

int

value

)

Set the type of item content.

Parameters

[in]

value

The type of item content. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.

Returns

None.