Foxit PDF SDK
FSTabOrderMgr类 参考
类 FSTabOrderMgr 继承关系图:
FSBase

构造函数

(BOOL) - adjustStructureOrder:
 使用指定注释调整结构顺序,Tab键顺序类型将同时设置为 FSTabOrderMgrStructure 。
更多...
 
(FSAnnot *) - getFirstAnnot
 获取当前Tab键顺序中的第一个注释。
更多...
 
(FSAnnot *) - getLastAnnot
 获取当前Tab键顺序中的最后一个注释。
更多...
 
(FSAnnot *) - getNextAnnot:
 获取当前Tab键顺序中指定注释的下一个注释。
更多...
 
(FSAnnot *) - getPrevAnnot:
 获取当前Tab键顺序中指定注释的前一个注释。
更多...
 
(id) - initWithOther:
 带另一个Tab键顺序管理器对象的构造函数。
更多...
 
(id) - initWithPage:
 从PDF页面对象构造。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 
(void) - reload
 重新加载注释的Tab键顺序。
更多...
 

属性

FSTabOrderMgrOrderType orderType
 获取Tab键顺序类型。

 

详细描述

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

在使用 FSTabOrderMgr::orderType 或调用 FSTabOrderMgr::adjustStructureOrder: 函数后,应该调用 FSTabOrderMgr::reload 函数; 否则注释的顺序可能不会按预期更改。

参见
FSPDFPage
FSAnnot

函数文档

◆ adjustStructureOrder:()

- (BOOL) adjustStructureOrder: (FSAnnotArray*)  annot_array

使用指定注释调整结构顺序,Tab键顺序类型将同时设置为 FSTabOrderMgrStructure 。

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

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

◆ getFirstAnnot()

- (FSAnnot *) getFirstAnnot

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

返回
第一个注释。如果返回的注释对象的 FSAnnot::isEmpty 函数返回值为YES, 则表示没有注释。

◆ getLastAnnot()

- (FSAnnot *) getLastAnnot

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

返回
最后一个注释。如果返回的注释对象的 FSAnnot::isEmpty 函数返回值为YES, 则表示没有注释。

◆ getNextAnnot:()

- (FSAnnot *) getNextAnnot: (FSAnnot*)  annot

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

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

◆ getPrevAnnot:()

- (FSAnnot *) getPrevAnnot: (FSAnnot*)  annot

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

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

◆ initWithOther:()

- (id) initWithOther: (FSTabOrderMgr*)  other

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

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

◆ initWithPage:()

- (id) initWithPage: (FSPDFPage*)  page

从PDF页面对象构造。

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

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

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

返回
YES表示当前对象为空,NO表示不为空。

◆ reload()

- (void) reload

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

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


返回
无。