类 com.foxit.sdk.addon.accessibility.ReadingOrder 继承关系图:

Public 成员函数
	ReadingOrder (PDFDoc pdf_doc) throws com.foxit.sdk.PDFException
	构造函数。更多...

	ReadingOrder (ReadingOrder other)
	构造函数，使用另一个阅读顺序对象。更多...

RectFArray	addOrderDataForRect (int page_index, RectF rect) throws com.foxit.sdk.PDFException
	根据选中的矩形区域添加顺序数据。更多...

boolean	applyReadingOrder (int page_index, RectFArray selected_rect) throws com.foxit.sdk.PDFException
	根据选中的矩形区域，为指定页面应用阅读顺序。更多...

boolean	canMoveDataOrder (int page_index, TreeItemInfoArray select_info_array, TreeItemInfo dest_move_item) throws com.foxit.sdk.PDFException
	检查数据顺序是否可以移动。更多...

int	canSelectTableCellAtPoint (PDFPage page, PointF point) throws com.foxit.sdk.PDFException
	检查鼠标在给定点按下时是否可以选择表格单元格。更多...

void	clearPageStructInfo (PDFPage page) throws com.foxit.sdk.PDFException
	清除页面结构信息。更多...

synchronized void	delete ()
	直接清除C++相关资源。更多...

int	deleteOrderDataStructInfo (PDFPage page, Int32Array src_order_index_array, boolean is_loaded) throws com.foxit.sdk.PDFException
	删除顺序数据结构信息。更多...

boolean	drawReadingOrderItems (int page_index) throws com.foxit.sdk.PDFException
	开始绘制指定页面的阅读顺序项。更多...

boolean	endEditTable () throws com.foxit.sdk.PDFException
	结束编辑表格。更多...

boolean	generateTableHeaderIDs () throws com.foxit.sdk.PDFException
	自动生成表格表头 ID。更多...

java.util.ArrayList< java.lang.String >	getAllLeafChildrenByContentItemID (ContentTreeItemArray content_tree, String content_item_id) throws com.foxit.sdk.PDFException
	根据内容项 ID 获取所有叶子子项。更多...

ContentTreeItemArray	getContentTree () throws com.foxit.sdk.PDFException
	获取内容树。更多...

WStringArray	getCurrentTableHeaderIDs () throws com.foxit.sdk.PDFException
	获取当前表格的所有表头 ID。更多...

TreeItemArray	getReadingOrderTreeItems () throws com.foxit.sdk.PDFException
	获取阅读顺序树项。更多...

TableCellAttributeArray	getSelectedTableCellAttributes () throws com.foxit.sdk.PDFException
	获取选中的表格单元格属性。更多...

String	getTableSummary (PDFPage page) throws com.foxit.sdk.PDFException
	获取表格摘要。更多...

boolean	hasHeaderID (String header_id) throws com.foxit.sdk.PDFException
	检查当前表格表头 ID 是否已存在。更多...

boolean	hasMissingHeaderIDs () throws com.foxit.sdk.PDFException
	检查当前表格是否缺少表头 ID。更多...

boolean	isEditingTable () throws com.foxit.sdk.PDFException
	检查是否已开始表格编辑。更多...

boolean	isEmpty ()
	检查当前对象是否为空。更多...

int	moveOrderData (int page_index, Int32Array src_order_index_array, int dest_order_index) throws com.foxit.sdk.PDFException
	移动数据顺序。更多...

RectFArray	removeOrderDataForRect (int page_index, RectF rect) throws com.foxit.sdk.PDFException
	根据选中的矩形区域移除顺序数据。更多...

boolean	selectTableAtPoint (int page_index, PointF point) throws com.foxit.sdk.PDFException
	选中页面上指定点处的表格（如果存在）。更多...

int	selectTableCellAtPoint (PDFPage page, PointF point, RectFArray region_selected, boolean appended) throws com.foxit.sdk.PDFException
	鼠标抬起时通过点选择表格单元格。更多...

int	selectTableCellAtRect (PDFPage page, RectF rect, RectFArray region_selected, boolean appended) throws com.foxit.sdk.PDFException
	鼠标抬起时通过矩形区域选择表格单元格。更多...

boolean	setOrderTypeForSelectedContent (int structure_type) throws com.foxit.sdk.PDFException
	根据选中的矩形区域设置顺序类型。更多...

boolean	setOrderTypeForSelectedTreeItems (int structure_type, TreeItemInfoArray select_info_array) throws com.foxit.sdk.PDFException
	根据选中的树项设置顺序类型。更多...

void	setReadingOrderOptions (ReadingOrderOptions options) throws com.foxit.sdk.PDFException
	设置阅读顺序选项。更多...

boolean	setSelectedTableCellAttributes (TableCellAttribute cell_attribute, boolean change_id_enabled, boolean need_change_ids) throws com.foxit.sdk.PDFException
	设置选中的表格单元格属性。更多...

boolean	setTableSummary (PDFPage page, String table_summary) throws com.foxit.sdk.PDFException
	设置表格摘要。更多...

boolean	startEditTable (PDFPage page) throws com.foxit.sdk.PDFException
	开始编辑表格。更多...

boolean	startEditTableAtPoint (PDFPage page, PointF point) throws com.foxit.sdk.PDFException
	开始编辑页面上指定点处的表格（如果存在）。更多...

void	synchronizeTable () throws com.foxit.sdk.PDFException
	同步表格。更多...

静态 Public 属性
static final int	e_StructureTypeBackgroundOrArtifact = 16
	结构类型：背景或 Artifact。

static final int	e_StructureTypeCaption = 4
	结构类型：标题。

static final int	e_StructureTypeCell = 12
	结构类型：单元格。

static final int	e_StructureTypeFigure = 1
	结构类型：图形。

static final int	e_StructureTypeFigureOrCaption = 3
	结构类型：图形或标题。

static final int	e_StructureTypeFormfield = 2
	结构类型：表单域。

static final int	e_StructureTypeFormula = 13
	结构类型：公式。

static final int	e_StructureTypeH1 = 5
	结构类型：H1。

static final int	e_StructureTypeH2 = 6
	结构类型：H2。

static final int	e_StructureTypeH3 = 7
	结构类型：H3。

static final int	e_StructureTypeH4 = 8
	结构类型：H4。

static final int	e_StructureTypeH5 = 9
	结构类型：H5。

static final int	e_StructureTypeH6 = 10
	结构类型：H6。

static final int	e_StructureTypeNote = 15
	结构类型：注释。

static final int	e_StructureTypeReference = 14
	结构类型：引用。

static final int	e_StructureTypeTable = 11
	结构类型：表格。

static final int	e_StructureTypeText = 0
	结构类型：文本。

static final int	e_TableSelectResultNone = 0
	表格选择结果：无。

static final int	e_TableSelectResultNoTableExist = 3
	表格选择结果：不存在表格。

static final int	e_TableSelectResultNotInTable = 4
	表格选择结果：不在表格中。

static final int	e_TableSelectResultNotSamePage = 2
	表格选择结果：不在同一页。

static final int	e_TableSelectResultNotStarted = 1
	表格选择结果：未开始。

详细描述

此类表示用于 PDF 文档辅助功能阅读顺序操作的阅读顺序。使用此模块中的任何类或方法之前，请确保已通过带有 "Accessibility" 模块授权的 key 调用 common.Library.initialize 函数成功初始化 Foxit PDF SDK。

参见: com.foxit.sdk.common.Library

构造及析构函数说明

◆ ReadingOrder() [1/2]

com.foxit.sdk.addon.accessibility.ReadingOrder.ReadingOrder ( PDFDoc pdf_doc ) throws com.foxit.sdk.PDFException

构造函数。

参数

[in] pdf_doc 有效的 PDF 文档对象。

◆ ReadingOrder() [2/2]

com.foxit.sdk.addon.accessibility.ReadingOrder.ReadingOrder ( ReadingOrder other )

构造函数，使用另一个阅读顺序对象。

参数

[in] other 另一个阅读顺序对象。

成员函数说明

◆ addOrderDataForRect()

RectFArray com.foxit.sdk.addon.accessibility.ReadingOrder.addOrderDataForRect	(	int	page_index,
		RectF	rect
	)		throws com.foxit.sdk.PDFException

根据选中的矩形区域添加顺序数据。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
[in]	rect	选中的矩形区域。

返回: 矩形数组。

◆ applyReadingOrder()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.applyReadingOrder	(	int	page_index,
		RectFArray	selected_rect
	)		throws com.foxit.sdk.PDFException

根据选中的矩形区域，为指定页面应用阅读顺序。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
[in]	selected_rect	用于应用阅读顺序的选中矩形区域数组。

返回: true 表示成功，false 表示不成功。

◆ canMoveDataOrder()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.canMoveDataOrder	(	int	page_index,
		TreeItemInfoArray	select_info_array,
		TreeItemInfo	dest_move_item
	)		throws com.foxit.sdk.PDFException

检查数据顺序是否可以移动。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
[in]	select_info_array	选中信息数组。
[in]	dest_move_item	目标移动项。

返回: true 表示数据顺序可以移动，false 表示不可以移动。

◆ canSelectTableCellAtPoint()

int com.foxit.sdk.addon.accessibility.ReadingOrder.canSelectTableCellAtPoint	(	PDFPage	page,
		PointF	point
	)		throws com.foxit.sdk.PDFException

检查鼠标在给定点按下时是否可以选择表格单元格。

参数

[in]	page	PDF 页面对象。
[in]	point	点，采用 PDF 坐标系（PDFPage）。

返回: 表格选择结果。请参见从 com.foxit.sdk.addon.accessibility.ReadingOrder.e_TableSelectResultNone 开始的值。

◆ clearPageStructInfo()

void com.foxit.sdk.addon.accessibility.ReadingOrder.clearPageStructInfo ( PDFPage page ) throws com.foxit.sdk.PDFException

清除页面结构信息。

参数

[in] page PDF 页面对象。

返回: 无。

◆ delete()

synchronized void com.foxit.sdk.addon.accessibility.ReadingOrder.delete ( )

直接清除C++相关资源。

返回: 无。

注解: 一旦这个接口被调用，这个对象将不能再被使用。

重载 com.foxit.sdk.common.Base .

◆ deleteOrderDataStructInfo()

int com.foxit.sdk.addon.accessibility.ReadingOrder.deleteOrderDataStructInfo	(	PDFPage	page,
		Int32Array	src_order_index_array,
		boolean	is_loaded
	)		throws com.foxit.sdk.PDFException

删除顺序数据结构信息。

参数

[in]	page	PDF 页面对象。
[in]	src_order_index_array	源顺序索引数组。
[in]	is_loaded	页面是否已加载。

返回: 已删除的数量。

◆ drawReadingOrderItems()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.drawReadingOrderItems ( int page_index ) throws com.foxit.sdk.PDFException

开始绘制指定页面的阅读顺序项。

参数

[in] page_index 页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。

返回: true 表示成功，false 表示不成功。

◆ endEditTable()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.endEditTable ( ) throws com.foxit.sdk.PDFException

结束编辑表格。

返回: true 表示成功，false 表示不成功。

◆ generateTableHeaderIDs()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.generateTableHeaderIDs ( ) throws com.foxit.sdk.PDFException

自动生成表格表头 ID。

返回: true 表示成功，false 表示不成功。

◆ getAllLeafChildrenByContentItemID()

java.util.ArrayList< java.lang.String > com.foxit.sdk.addon.accessibility.ReadingOrder.getAllLeafChildrenByContentItemID	(	ContentTreeItemArray	content_tree,
		String	content_item_id
	)		throws com.foxit.sdk.PDFException

根据内容项 ID 获取所有叶子子项。

参数

[in]	content_tree	内容树。
[in]	content_item_id	内容项 ID。

返回: 叶子子项 ID 数组。

◆ getContentTree()

ContentTreeItemArray com.foxit.sdk.addon.accessibility.ReadingOrder.getContentTree ( ) throws com.foxit.sdk.PDFException

获取内容树。

返回: 内容树项数组。

◆ getCurrentTableHeaderIDs()

WStringArray com.foxit.sdk.addon.accessibility.ReadingOrder.getCurrentTableHeaderIDs ( ) throws com.foxit.sdk.PDFException

获取当前表格的所有表头 ID。

返回: 表头 ID 数组。

◆ getReadingOrderTreeItems()

TreeItemArray com.foxit.sdk.addon.accessibility.ReadingOrder.getReadingOrderTreeItems ( ) throws com.foxit.sdk.PDFException

获取阅读顺序树项。

返回: 阅读顺序树项数组。

◆ getSelectedTableCellAttributes()

TableCellAttributeArray com.foxit.sdk.addon.accessibility.ReadingOrder.getSelectedTableCellAttributes ( ) throws com.foxit.sdk.PDFException

获取选中的表格单元格属性。

返回: 单元格属性对象数组。

◆ getTableSummary()

String com.foxit.sdk.addon.accessibility.ReadingOrder.getTableSummary ( PDFPage page ) throws com.foxit.sdk.PDFException

获取表格摘要。

参数

[in] page PDF 页面对象。

返回: 表格摘要文本。

◆ hasHeaderID()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.hasHeaderID ( String header_id ) throws com.foxit.sdk.PDFException

检查当前表格表头 ID 是否已存在。

参数

[in] header_id 要检查的表头 ID。

返回: true 表示该表头 ID 已存在，false 表示不存在。

◆ hasMissingHeaderIDs()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.hasMissingHeaderIDs ( ) throws com.foxit.sdk.PDFException

检查当前表格是否缺少表头 ID。

返回: true 表示当前表格缺少表头 ID，false 表示未缺少。

◆ isEditingTable()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.isEditingTable ( ) throws com.foxit.sdk.PDFException

检查是否已开始表格编辑。

返回: true 表示已开始表格编辑，false 表示未开始。

◆ isEmpty()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.isEmpty ( )

检查当前对象是否为空。

返回: true 表示当前对象为空，false 表示非空。

◆ moveOrderData()

int com.foxit.sdk.addon.accessibility.ReadingOrder.moveOrderData	(	int	page_index,
		Int32Array	src_order_index_array,
		int	dest_order_index
	)		throws com.foxit.sdk.PDFException

移动数据顺序。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
[in]	src_order_index_array	源顺序索引数组。
[in]	dest_order_index	目标顺序索引。

返回: 已移动的数量。

◆ removeOrderDataForRect()

RectFArray com.foxit.sdk.addon.accessibility.ReadingOrder.removeOrderDataForRect	(	int	page_index,
		RectF	rect
	)		throws com.foxit.sdk.PDFException

根据选中的矩形区域移除顺序数据。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
[in]	rect	选中的矩形区域。

返回: 矩形数组。

◆ selectTableAtPoint()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.selectTableAtPoint	(	int	page_index,
		PointF	point
	)		throws com.foxit.sdk.PDFException

选中页面上指定点处的表格（如果存在）。

参数

[in]	page_index	页面索引。有效取值范围为 0 到 (count - 1)，其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
[in]	point	用于定位表格的点，使用 PDF 页面坐标系。

返回: true 表示在指定点处找到并选中了表格，false 表示未找到。

◆ selectTableCellAtPoint()

int com.foxit.sdk.addon.accessibility.ReadingOrder.selectTableCellAtPoint	(	PDFPage	page,
		PointF	point,
		RectFArray	region_selected,
		boolean	appended
	)		throws com.foxit.sdk.PDFException

鼠标抬起时通过点选择表格单元格。

参数

[in]	page	PDF 页面对象。
[in]	point	点。
[out]	region_selected	选中区域数组。
[in]	appended	是否追加选择。

返回: 表格选择结果。请参见从 com.foxit.sdk.addon.accessibility.ReadingOrder.e_TableSelectResultNone 开始的值。

◆ selectTableCellAtRect()

int com.foxit.sdk.addon.accessibility.ReadingOrder.selectTableCellAtRect	(	PDFPage	page,
		RectF	rect,
		RectFArray	region_selected,
		boolean	appended
	)		throws com.foxit.sdk.PDFException

鼠标抬起时通过矩形区域选择表格单元格。

参数

[in]	page	PDF 页面对象。
[in]	rect	矩形区域。
[out]	region_selected	选中区域数组。
[in]	appended	是否追加选择。

返回: 表格选择结果。请参见从 com.foxit.sdk.addon.accessibility.ReadingOrder.e_TableSelectResultNone 开始的值。

◆ setOrderTypeForSelectedContent()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.setOrderTypeForSelectedContent ( int structure_type ) throws com.foxit.sdk.PDFException

根据选中的矩形区域设置顺序类型。

参数

[in] structure_type 结构类型。请参见从开始的值，该值应为其中之一。

返回: true 表示成功，false 表示不成功。

◆ setOrderTypeForSelectedTreeItems()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.setOrderTypeForSelectedTreeItems	(	int	structure_type,
		TreeItemInfoArray	select_info_array
	)		throws com.foxit.sdk.PDFException

根据选中的树项设置顺序类型。

参数

[in]	structure_type	结构类型。请参见。
[in]	select_info_array	选中信息数组。

返回: true 表示成功，false 表示不成功。

◆ setReadingOrderOptions()

void com.foxit.sdk.addon.accessibility.ReadingOrder.setReadingOrderOptions ( ReadingOrderOptions options ) throws com.foxit.sdk.PDFException

设置阅读顺序选项。

参数

[in] options 阅读顺序选项。请参见 ReadingOrderOptions 。

返回: 无。

◆ setSelectedTableCellAttributes()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.setSelectedTableCellAttributes	(	TableCellAttribute	cell_attribute,
		boolean	change_id_enabled,
		boolean	need_change_ids
	)		throws com.foxit.sdk.PDFException

设置选中的表格单元格属性。

参数

[in]	cell_attribute	要设置的单元格属性。
[in]	change_id_enabled	是否允许更改 ID。
[in]	need_change_ids	是否更改 ID。

返回: true 表示成功，false 表示不成功。

◆ setTableSummary()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.setTableSummary	(	PDFPage	page,
		String	table_summary
	)		throws com.foxit.sdk.PDFException

设置表格摘要。

参数

[in]	page	PDF 页面对象。
[in]	table_summary	表格摘要文本。

返回: true 表示成功，false 表示不成功。

◆ startEditTable()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.startEditTable ( PDFPage page ) throws com.foxit.sdk.PDFException

开始编辑表格。

参数

[in] page PDF 页面对象。

返回: true 表示成功，false 表示不成功。

◆ startEditTableAtPoint()

boolean com.foxit.sdk.addon.accessibility.ReadingOrder.startEditTableAtPoint	(	PDFPage	page,
		PointF	point
	)		throws com.foxit.sdk.PDFException

开始编辑页面上指定点处的表格（如果存在）。

参数

[in]	page	PDF 页面对象。
[in]	point	用于定位待编辑表格的点，采用 PDF 坐标系（PDFPage）。

返回: true 表示在指定点处找到表格并成功开始编辑，false 表示未找到或开始编辑失败。

◆ synchronizeTable()

void com.foxit.sdk.addon.accessibility.ReadingOrder.synchronizeTable ( ) throws com.foxit.sdk.PDFException

同步表格。

返回: 无。

Public 成员函数

静态 Public 属性

详细描述

构造及析构函数说明

◆ ReadingOrder() [1/2]

◆ ReadingOrder() [2/2]

成员函数说明

◆ addOrderDataForRect()

◆ applyReadingOrder()

◆ canMoveDataOrder()

◆ canSelectTableCellAtPoint()

◆ clearPageStructInfo()

◆ delete()

◆ deleteOrderDataStructInfo()

◆ drawReadingOrderItems()

◆ endEditTable()

◆ generateTableHeaderIDs()

◆ getAllLeafChildrenByContentItemID()

◆ getContentTree()

◆ getCurrentTableHeaderIDs()

◆ getReadingOrderTreeItems()

◆ getSelectedTableCellAttributes()

◆ getTableSummary()

◆ hasHeaderID()

◆ hasMissingHeaderIDs()

◆ isEditingTable()

◆ isEmpty()

◆ moveOrderData()

◆ removeOrderDataForRect()

◆ selectTableAtPoint()

◆ selectTableCellAtPoint()

◆ selectTableCellAtRect()

◆ setOrderTypeForSelectedContent()

◆ setOrderTypeForSelectedTreeItems()

◆ setReadingOrderOptions()

◆ setSelectedTableCellAttributes()

◆ setTableSummary()

◆ startEditTable()

◆ startEditTableAtPoint()

◆ synchronizeTable()