fsdk.ReadingOrder Class Reference

Public Member Functions
def	AddOrderDataForRect (page_index, rect)
	Add order data for selected rect. More...
def	ApplyReadingOrder (page_index, selected_rect)
	Apply reading order to the specified page based on the given selected rectangle area(s). More...
def	CanMoveDataOrder (page_index, select_info_array, dest_move_item)
	Check whether data order can be moved. More...
def	CanSelectTableCellAtPoint (page, point)
	Check whether a table cell can be selected on mouse down at the given point. More...
def	ClearPageStructInfo (page)
	Clear page structure info. More...
def	DeleteOrderDataStructInfo (page, src_order_index_array, is_loaded)
	Delete order data structure info. More...
def	DrawReadingOrderItems (page_index)
	Draw reading order items for a specified page. More...
def	EndEditTable ()
	End edit table. More...
def	GenerateTableHeaderIDs ()
	Generate table header IDs. More...
def	GetAllLeafChildrenByContentItemID (content_tree, content_item_id)
	Get all leaf children by content item ID. More...
def	GetContentTree ()
	Get content tree. More...
def	GetCurrentTableHeaderIDs ()
	Get the array header ID of current table. More...
def	GetReadingOrderTreeItems ()
	Get reading order tree items. More...
def	GetSelectedTableCellAttributes ()
	Get selected table cell attributes. More...
def	GetTableSummary (page)
	Get table summary. More...
def	HasHeaderID (header_id)
	Check whether current table header ID is existing. More...
def	HasMissingHeaderIDs ()
	Check whether current table is missing header IDs. More...
def	IsEditingTable ()
	Check whether table editing has started. More...
def	IsEmpty ()
	Check whether current object is empty or not. More...
def	MoveOrderData (page_index, src_order_index_array, dest_order_index)
	Move data order. More...
def	RemoveOrderDataForRect (page_index, rect)
	Remove order data for selected rect. More...
def	SelectTableAtPoint (page_index, point)
	Select the table at the specified point on a page, if any. More...
def	SelectTableCellAtPoint (page, point, region_selected, appended)
	Select table cell by point on mouse up. More...
def	SelectTableCellAtRect (page, rect, region_selected, appended)
	Select table cell by rect on mouse up. More...
def	SetOrderTypeForSelectedContent (structure_type)
	Set order type for selected content. More...
def	SetOrderTypeForSelectedTreeItems (structure_type, select_info_array)
	Set order type for selected tree items. More...
def	SetReadingOrderOptions (options)
	Set reading order options. More...
def	SetSelectedTableCellAttributes (cell_attribute, change_id_enabled, need_change_ids)
	Set selected table cell attributes. More...
def	SetTableSummary (page, table_summary)
	Set table summary. More...
def	StartEditTable (page)
	Start edit table. More...
def	StartEditTableAtPoint (page, point)
	Start editing the table located at the specified point on a page, if any. More...
def	SynchronizeTable ()
	Synchronize table. More...

Detailed Description

This class represents a reading order for PDF document accessibility reading order operations. Before using any class or methods in this module, please ensure Foxit PDF SDK has been initialized successfully by function fsdk.LibraryInitialize with a key including "Accessibility" module.

See also

fsdk.Library

Member Function Documentation

AddOrderDataForRect()

def fsdk.ReadingOrder.AddOrderDataForRect	(		page_index,
			rect
	)

Add order data for selected rect.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	rect	The selected rect.

Returns

The updated order rect array.

ApplyReadingOrder()

def fsdk.ReadingOrder.ApplyReadingOrder	(		page_index,
			selected_rect
	)

Apply reading order to the specified page based on the given selected rectangle area(s).

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	selected_rect	The array of selected rects which define the area(s) to be used for applying reading order.

Returns

true means success, while false means not.

CanMoveDataOrder()

def fsdk.ReadingOrder.CanMoveDataOrder	(		page_index,
			select_info_array,
			dest_move_item
	)

Check whether data order can be moved.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	select_info_array	The selected info array.
[in]	dest_move_item	The destination move item.

Returns

true means data order can be moved, while false means not.

CanSelectTableCellAtPoint()

def fsdk.ReadingOrder.CanSelectTableCellAtPoint	(		page,
			point
	)

Check whether a table cell can be selected on mouse down at the given point.

Parameters

[in]	page	A PDF page object.
[in]	point	The point, in the PDF coordinate system (PDFPage).

Returns

The table select result. Please refer to values starting from fsdk.ReadingOrderE_TableSelectResultNone .

ClearPageStructInfo()

def fsdk.ReadingOrder.ClearPageStructInfo

(

page

)

Clear page structure info.

Parameters

[in]

page

The PDF page object.

Returns

None.

DeleteOrderDataStructInfo()

def fsdk.ReadingOrder.DeleteOrderDataStructInfo	(		page,
			src_order_index_array,
			is_loaded
	)

Delete order data structure info.

Parameters

[in]	page	The PDF page object.
[in]	src_order_index_array	The source order index array.
[in]	is_loaded	Whether the page is loaded.

Returns

The deleted count.

DrawReadingOrderItems()

def fsdk.ReadingOrder.DrawReadingOrderItems

(

page_index

)

Draw reading order items for a specified page.

Parameters

[in]

page_index

The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .

Returns

true means success, while false means not.

EndEditTable()

def fsdk.ReadingOrder.EndEditTable

(

)

End edit table.

Returns

true means success, while false means not.

GenerateTableHeaderIDs()

def fsdk.ReadingOrder.GenerateTableHeaderIDs

(

)

Generate table header IDs.

Returns

true means success, while false means not.

GetAllLeafChildrenByContentItemID()

def fsdk.ReadingOrder.GetAllLeafChildrenByContentItemID	(		content_tree,
			content_item_id
	)

Get all leaf children by content item ID.

Parameters

[in]	content_tree	The content tree.
[in]	content_item_id	The content item ID.

Returns

The array of leaf children IDs.

GetContentTree()

def fsdk.ReadingOrder.GetContentTree

(

)

Get content tree.

Returns

The array of content tree items.

GetCurrentTableHeaderIDs()

def fsdk.ReadingOrder.GetCurrentTableHeaderIDs

(

)

Get the array header ID of current table.

Returns

The array of header ID.

GetReadingOrderTreeItems()

def fsdk.ReadingOrder.GetReadingOrderTreeItems

(

)

Get reading order tree items.

Returns

The array of reading order tree items.

GetSelectedTableCellAttributes()

def fsdk.ReadingOrder.GetSelectedTableCellAttributes

(

)

Get selected table cell attributes.

Returns

The array of cell attribute objects.

GetTableSummary()

def fsdk.ReadingOrder.GetTableSummary

(

page

)

Get table summary.

Parameters

[in]

page

The PDF page object.

Returns

The table summary text.

HasHeaderID()

def fsdk.ReadingOrder.HasHeaderID

(

header_id

)

Check whether current table header ID is existing.

Parameters

[in]

header_id

The header ID to check.

Returns

true means the header ID is existing, while false means not.

HasMissingHeaderIDs()

def fsdk.ReadingOrder.HasMissingHeaderIDs

(

)

Check whether current table is missing header IDs.

Returns

true means current table is missing header IDs, while false means not.

IsEditingTable()

def fsdk.ReadingOrder.IsEditingTable

(

)

Check whether table editing has started.

Returns

true means table editing has started, while false means not.

IsEmpty()

def fsdk.ReadingOrder.IsEmpty

(

)

Check whether current object is empty or not.

Returns

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

MoveOrderData()

def fsdk.ReadingOrder.MoveOrderData	(		page_index,
			src_order_index_array,
			dest_order_index
	)

Move data order.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	src_order_index_array	The source order index array.
[in]	dest_order_index	The destination order index.

Returns

The moved count.

RemoveOrderDataForRect()

def fsdk.ReadingOrder.RemoveOrderDataForRect	(		page_index,
			rect
	)

Remove order data for selected rect.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	rect	The selected rect.

Returns

The updated order rect array.

SelectTableAtPoint()

def fsdk.ReadingOrder.SelectTableAtPoint	(		page_index,
			point
	)

Select the table at the specified point on a page, if any.

Parameters

[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	point	The point used to locate the table, in PDF page coordinate system.

Returns

true means a table is found and selected at the specified point, while false means not.

SelectTableCellAtPoint()

def fsdk.ReadingOrder.SelectTableCellAtPoint	(		page,
			point,
			region_selected,
			appended
	)

Select table cell by point on mouse up.

Parameters

[in]	page	A PDF page object.
[in]	point	The point.
[out]	region_selected	The selected region array.
[in]	appended	Whether to append the selection.

Returns

The table select result. Please refer to values starting from fsdk.ReadingOrderE_TableSelectResultNone .

SelectTableCellAtRect()

def fsdk.ReadingOrder.SelectTableCellAtRect	(		page,
			rect,
			region_selected,
			appended
	)

Select table cell by rect on mouse up.

Parameters

[in]	page	A PDF page object.
[in]	rect	The rectangular area .
[out]	region_selected	The selected region array.
[in]	appended	Whether to append the selection.

Returns

The table select result. Please refer to values starting from fsdk.ReadingOrderE_TableSelectResultNone .

SetOrderTypeForSelectedContent()

def fsdk.ReadingOrder.SetOrderTypeForSelectedContent

(

structure_type

)

Set order type for selected content.

Parameters

[in]

structure_type

The structure type. Please refer to values starting from and this should be one of these values.

Returns

true means success, while false means not.

SetOrderTypeForSelectedTreeItems()

def fsdk.ReadingOrder.SetOrderTypeForSelectedTreeItems	(		structure_type,
			select_info_array
	)

Set order type for selected tree items.

Parameters

[in]	structure_type	The structure type. Please refer value .
[in]	select_info_array	The selected info array.

Returns

true means success, while false means not.

SetReadingOrderOptions()

def fsdk.ReadingOrder.SetReadingOrderOptions

(

options

)

Set reading order options.

Parameters

[in]

options

The reading order options. Please refer to ReadingOrderOptions .

Returns

None.

SetSelectedTableCellAttributes()

def fsdk.ReadingOrder.SetSelectedTableCellAttributes	(		cell_attribute,
			change_id_enabled,
			need_change_ids
	)

Set selected table cell attributes.

Parameters

[in]	cell_attribute	The cell attribute to set.
[in]	change_id_enabled	Whether to enable changing Id.
[in]	need_change_ids	Whether to change IDs.

Returns

true means success, while false means not.

SetTableSummary()

def fsdk.ReadingOrder.SetTableSummary	(		page,
			table_summary
	)

Set table summary.

Parameters

[in]	page	The PDF page object.
[in]	table_summary	The table summary text.

Returns

true means success, while false means not.

StartEditTable()

def fsdk.ReadingOrder.StartEditTable

(

page

)

Start edit table.

Parameters

[in]

page

The PDF page object.

Returns

true means success, while false means not.

StartEditTableAtPoint()

def fsdk.ReadingOrder.StartEditTableAtPoint	(		page,
			point
	)

Start editing the table located at the specified point on a page, if any.

Parameters

[in]	page	The PDF page object.
[in]	point	The point used to locate the table to be edited, in the PDF coordinate system (PDFPage).

Returns

true means a table is found at the specified point and editing has started successfully, while false means not.

SynchronizeTable()

def fsdk.ReadingOrder.SynchronizeTable

(

)

Synchronize table.

Returns

None.