Foxit PDF SDK
Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.pdf.TabOrderMgr类 参考
类 com.foxit.sdk.pdf.TabOrderMgr 继承关系图:
com.foxit.sdk.common.Base

Public 成员函数

 TabOrderMgr (PDFPage page)
 从PDF页面对象构造。 更多...
 
 TabOrderMgr (TabOrderMgr other)
 带另一个Tab键顺序管理器对象的构造函数。 更多...
 
boolean adjustStructureOrder (AnnotArray annot_array) throws com.foxit.sdk.PDFException
 使用指定注释调整结构顺序，Tab键顺序类型将同时设置为com.foxit.sdk.pdf.TabOrderMgr.e_Structure 。 更多...
 
synchronized void delete ()
 直接清除C++相关资源。 更多...
 
Annot getFirstAnnot () throws com.foxit.sdk.PDFException
 获取当前Tab键顺序中的第一个注释。 更多...
 
Annot getLastAnnot () throws com.foxit.sdk.PDFException
 获取当前Tab键顺序中的最后一个注释。 更多...
 
Annot getNextAnnot (Annot annot) throws com.foxit.sdk.PDFException
 获取当前Tab键顺序中指定注释的下一个注释。 更多...
 
int getOrderType () throws com.foxit.sdk.PDFException
 获取Tab键顺序类型。 更多...
 
Annot getPrevAnnot (Annot annot) throws com.foxit.sdk.PDFException
 获取当前Tab键顺序中指定注释的前一个注释。 更多...
 
boolean isEmpty ()
 检查当前对象是否为空。 更多...
 
void reload () throws com.foxit.sdk.PDFException
 重新加载注释的Tab键顺序。 更多...
 
void setOrderType (int order_type) throws com.foxit.sdk.PDFException
 设置Tab键顺序类型。 更多...
 
- Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void delete ()
 直接清除C++相关资源。 更多...
 

静态 Public 属性

static final int e_Column = 0x0002
 C（列顺序）：注释按照从上到下垂直穿过页面的列顺序访问。
 
static final int e_None = 0x0000
 无（索引顺序）：注释按照其在页面中的索引顺序访问。
 
static final int e_Row = 0x0001
 R（行顺序）：注释按照从左到右横跨页面的行顺序访问。
 
static final int e_Structure = 0x0003
 S（结构顺序）：注释按照它们在结构树中出现的顺序访问。
 

详细描述

Tab键顺序是在PDF页面上使用键盘Tab键在注释间导航的顺序。 此类提供了管理在PDF页面上注释间移动键盘焦点顺序的功能。 Tab键顺序管理器将忽略以下类型的注释：
作为回复注释的备注注释、作为状态注释的备注注释、 弹出注释、标志包含com.foxit.sdk.pdf.annots.Annot.e_FlagHidden 的注释。
此类提供了获取顺序类型和按顺序类型逐个获取注释的功能。 此类还提供了更改顺序类型的功能：

在使用TabOrderMgr.setOrderType 或调用TabOrderMgr.adjustStructureOrder 函数后，应该调用TabOrderMgr.reload 函数； 否则注释的顺序可能不会按预期更改。

参见
PDFPage
com.foxit.sdk.pdf.annots.Annot

构造及析构函数说明

◆ TabOrderMgr() [1/2]

com.foxit.sdk.pdf.TabOrderMgr.TabOrderMgr ( PDFPage  page)

从PDF页面对象构造。

参数
[in]page有效的PDF页面。

◆ TabOrderMgr() [2/2]

com.foxit.sdk.pdf.TabOrderMgr.TabOrderMgr ( TabOrderMgr  other)

带另一个Tab键顺序管理器对象的构造函数。

参数
[in]other另一个Tab键顺序管理器对象。

成员函数说明

◆ adjustStructureOrder()

boolean com.foxit.sdk.pdf.TabOrderMgr.adjustStructureOrder ( AnnotArray  annot_array) throws com.foxit.sdk.PDFException

使用指定注释调整结构顺序，Tab键顺序类型将同时设置为com.foxit.sdk.pdf.TabOrderMgr.e_Structure 。

此函数用于调整结构Tab键顺序的注释顺序。 首先，根据输入数组中的顺序重新排序输入数组中的注释， 然后根据PDF文档的阅读方向重新排序其余注释（未包含在输入数组中的注释）。
此函数成功后，相关PDF页面中所有注释的索引都将更改。

参数
[in]annot_array将首先为结构Tab键顺序重新排序的注释数组。 此数组中的所有注释都应属于与当前Tab键顺序管理器相关的同一页面。 这些注释都应该是有效的，并且应该彼此不同。
返回
true表示成功，false表示失败。

◆ delete()

synchronized void com.foxit.sdk.pdf.TabOrderMgr.delete ( )

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

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

◆ getFirstAnnot()

Annot com.foxit.sdk.pdf.TabOrderMgr.getFirstAnnot ( ) throws com.foxit.sdk.PDFException

获取当前Tab键顺序中的第一个注释。

返回
第一个注释。如果返回的注释对象的annots.Annot.isEmpty 函数返回值为true， 则表示没有注释。

◆ getLastAnnot()

Annot com.foxit.sdk.pdf.TabOrderMgr.getLastAnnot ( ) throws com.foxit.sdk.PDFException

获取当前Tab键顺序中的最后一个注释。

返回
最后一个注释。如果返回的注释对象的annots.Annot.isEmpty 函数返回值为true， 则表示没有注释。

◆ getNextAnnot()

Annot com.foxit.sdk.pdf.TabOrderMgr.getNextAnnot ( Annot  annot) throws com.foxit.sdk.PDFException

获取当前Tab键顺序中指定注释的下一个注释。

参数
[in]annot有效的指定注释。
返回
下一个注释。如果返回的注释对象的annots.Annot.isEmpty 函数返回值为true， 则表示指定注释是当前Tab键顺序中的最后一个注释。

◆ getOrderType()

int com.foxit.sdk.pdf.TabOrderMgr.getOrderType ( ) throws com.foxit.sdk.PDFException

获取Tab键顺序类型。

返回
Tab键顺序类型。请参考从com.foxit.sdk.pdf.TabOrderMgr.e_None 开始的值， 这将是这些值中的一个。

◆ getPrevAnnot()

Annot com.foxit.sdk.pdf.TabOrderMgr.getPrevAnnot ( Annot  annot) throws com.foxit.sdk.PDFException

获取当前Tab键顺序中指定注释的前一个注释。

参数
[in]annot有效的指定注释。
返回
前一个注释。如果返回的注释对象的annots.Annot.isEmpty 函数返回值为true， 则表示指定注释是当前Tab键顺序中的第一个注释。

◆ isEmpty()

boolean com.foxit.sdk.pdf.TabOrderMgr.isEmpty ( )

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

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

◆ reload()

void com.foxit.sdk.pdf.TabOrderMgr.reload ( ) throws com.foxit.sdk.PDFException

重新加载注释的Tab键顺序。

在以下情况下应该调用此函数：

返回
无。

◆ setOrderType()

void com.foxit.sdk.pdf.TabOrderMgr.setOrderType ( int  order_type) throws com.foxit.sdk.PDFException

设置Tab键顺序类型。

参数
[in]order_type新的Tab键顺序类型。应为以下值之一：
返回
无。