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

Public Member Functions
	ReadingOrderOptions ()
	Constructor.
	ReadingOrderOptions (int reading_order_show_type, boolean is_show_table_figure, boolean is_display_like_element, boolean is_show_table_cells)
	Constructor.
	ReadingOrderOptions (ReadingOrderOptions other)
	Constructor, with another reading order options object. More...
synchronized void	delete ()
	Clean up related C++ resources immediately. More...
boolean	getIs_display_like_element ()
	Get whether to display like elements in a single box. More...
boolean	getIs_show_table_cells ()
	Get whether to show table cells. More...
boolean	getIs_show_table_figure ()
	Get whether to show table and figure. More...
int	getReading_order_show_type ()
	Get the type of reading order. More...
void	set (int reading_order_show_type, boolean is_show_table_figure, boolean is_display_like_element, boolean is_show_table_cells)
	Set value. More...
void	setIs_display_like_element (boolean value)
	Set whether to display like elements in a single box. More...
void	setIs_show_table_cells (boolean value)
	Set whether to show table cells. More...
void	setIs_show_table_figure (boolean value)
	Set whether to show table and figure. More...
void	setReading_order_show_type (int value)
	Set the type of reading order. More...

Static Public Attributes
static final int	e_ReadingOrderShowTypeNone = 2
	Show type: none.
static final int	e_ReadingOrderShowTypeOrder = 0
	Show type: order.
static final int	e_ReadingOrderShowTypeStruct = 1
	Show type: struct.

Detailed Description

This class represents data used for reading order options.

Constructor & Destructor Documentation

ReadingOrderOptions()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.ReadingOrderOptions

(

ReadingOrderOptions

other

)

Constructor, with another reading order options object.

Parameters

[in]

other

Another reading order options object.

Member Function Documentation

delete()

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

(

)

Clean up related C++ resources immediately.

Returns

None.

Note

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

getIs_display_like_element()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.getIs_display_like_element

(

)

Get whether to display like elements in a single box.

Returns

Whether to display like elements in a single box.

getIs_show_table_cells()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.getIs_show_table_cells

(

)

Get whether to show table cells.

Returns

Whether to show table cells.

getIs_show_table_figure()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.getIs_show_table_figure

(

)

Get whether to show table and figure.

Returns

Whether to show table and figure.

getReading_order_show_type()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.getReading_order_show_type

(

)

Get the type of reading order.

Returns

The type of reading order. Please refer to values starting from com.foxit.sdk.addon.accessibility.ReadingOrderOptions.e_ReadingOrderShowTypeOrder and this should be one of these values.

set()

void com.foxit.sdk.addon.accessibility.ReadingOrderOptions.set	(	int	reading_order_show_type,
		boolean	is_show_table_figure,
		boolean	is_display_like_element,
		boolean	is_show_table_cells
	)

Set value.

Parameters

[in]	reading_order_show_type	The reading order show type. Please refer to values starting from com.foxit.sdk.addon.accessibility.ReadingOrderOptions.e_ReadingOrderShowTypeOrder and this should be one of these values.
[in]	is_show_table_figure	Whether to show table and figure.
[in]	is_display_like_element	Whether to display like elements in a single box.
[in]	is_show_table_cells	Whether to show table cells.

Returns

None.

setIs_display_like_element()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.setIs_display_like_element

(

boolean

value

)

Set whether to display like elements in a single box.

Parameters

[in]

value

Whether to display like elements in a single box.

Returns

None.

setIs_show_table_cells()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.setIs_show_table_cells

(

boolean

value

)

Set whether to show table cells.

Parameters

[in]

value

Whether to show table cells.

Returns

None.

setIs_show_table_figure()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.setIs_show_table_figure

(

boolean

value

)

Set whether to show table and figure.

Parameters

[in]

value

Whether to show table and figure.

Returns

None.

setReading_order_show_type()

com.foxit.sdk.addon.accessibility.ReadingOrderOptions.setReading_order_show_type

(

int

value

)

Set the type of reading order.

Parameters

[in]

value

The type of reading order. Please refer to values starting from com.foxit.sdk.addon.accessibility.ReadingOrderOptions.e_ReadingOrderShowTypeOrder and this should be one of these values.

Returns

None.