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

Public Member Functions
	AccessibilityTextInfo ()
	Constructor.
	AccessibilityTextInfo (AccessibilityTextInfo other)
	Constructor, with another accessibility text info object. More...
synchronized void	delete ()
	Clean up related C++ resources immediately. More...
long	getBackground_color ()
	Get the background fill color of the text area. More...
long	getBorder_color ()
	Get the color used of the border of the text area. More...
int	getData_index ()
	Get index that maps this text item back to its entry in the page's reading-order data. More...
RectF	getRect ()
	Get the bounding rectangle of the text content. More...
String	getText ()
	Get the text content used for accessibility visualization. More...
long	getText_color ()
	Get the color used of the text. More...
void	set (String text, RectF rect, int data_index, long text_color, long background_color, long border_color)
	Set value. More...
void	setBackground_color (long value)
	Set the background fill color of the text area. More...
void	setBorder_color (long value)
	Set the color used of the border of the text area. More...
void	setData_index (int value)
	Set index that maps this text item back to its entry in the page's reading-order data. More...
void	setRect (RectF value)
	Set the bounding rectangle of the text content. More...
void	setText (String value)
	Set the text content used for accessibility visualization. More...
void	setText_color (long value)
	Set the color used of the text. More...

Detailed Description

This class represents accessibility text info.

Constructor & Destructor Documentation

AccessibilityTextInfo()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.AccessibilityTextInfo

(

AccessibilityTextInfo

other

)

Constructor, with another accessibility text info object.

Parameters

[in]

other

Another accessibility text info object whose values are copied to initialize the current object.

Member Function Documentation

delete()

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

(

)

Clean up related C++ resources immediately.

Returns

None.

Note

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

getBackground_color()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.getBackground_color

(

)

Get the background fill color of the text area.

Returns

The background fill color of the text area.

getBorder_color()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.getBorder_color

(

)

Get the color used of the border of the text area.

Returns

The color used of the border of the text area.

getData_index()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.getData_index

(

)

Get index that maps this text item back to its entry in the page's reading-order data.

Returns

Index that maps this text item back to its entry in the page's reading-order data. A non-negative value is a valid order-data index; -1 means this text item is not associated with any order data (the default).

getRect()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.getRect

(

)

Get the bounding rectangle of the text content.

Returns

The bounding rectangle of the text content.

getText()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.getText

(

)

Get the text content used for accessibility visualization.

Returns

The text content used for accessibility visualization.

getText_color()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.getText_color

(

)

Get the color used of the text.

Returns

The color used of the text.

set()

void com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.set	(	String	text,
		RectF	rect,
		int	data_index,
		long	text_color,
		long	background_color,
		long	border_color
	)

Set value.

Parameters

[in]	text	The text content to display for accessibility visualization.
[in]	rect	The bounding rectangle of the text content.
[in]	data_index	Index that maps this text item back to its entry in the page's reading-order data. Pass a non-negative order-data index, or -1 if this text item is not associated with any order data.
[in]	text_color	The foreground color used to draw the text.
[in]	background_color	The background fill color of the text area.
[in]	border_color	The border color of the text area.

Returns

None.

setBackground_color()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.setBackground_color

(

long

value

)

Set the background fill color of the text area.

Parameters

[in]

value

The background fill color of the text area.

Returns

None.

setBorder_color()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.setBorder_color

(

long

value

)

Set the color used of the border of the text area.

Parameters

[in]

value

The color used of the border of the text area.

Returns

None.

setData_index()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.setData_index

(

int

value

)

Set index that maps this text item back to its entry in the page's reading-order data.

Parameters

[in]

value

Index that maps this text item back to its entry in the page's reading-order data. A non-negative value is a valid order-data index; -1 means this text item is not associated with any order data (the default).

Returns

None.

setRect()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.setRect

(

RectF

value

)

Set the bounding rectangle of the text content.

Parameters

[in]

value

The bounding rectangle of the text content.

Returns

None.

setText()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.setText

(

String

value

)

Set the text content used for accessibility visualization.

Parameters

[in]

value

The text content used for accessibility visualization.

Returns

None.

setText_color()

com.foxit.sdk.addon.accessibility.AccessibilityTextInfo.setText_color

(

long

value

)

Set the color used of the text.

Parameters

[in]

value

The color used of the text.

Returns

None.