Foxit PDF SDK
|
Instance Methods | |
(BOOL) | - adjustStructureOrder: |
Adjust the structure order with specified annotations, and tab order type will be set to FSTabOrderMgrStructure at the same time. More... | |
(FSAnnot *) | - getFirstAnnot |
Get the first annotation in current tab order. More... | |
(FSAnnot *) | - getLastAnnot |
Get the last annotation in current tab order. More... | |
(FSAnnot *) | - getNextAnnot: |
Get the next annotation of specified annotation in current tab order. More... | |
(FSAnnot *) | - getPrevAnnot: |
Get the previous annotation of specified annotation in current tab order. More... | |
(id) | - initWithOther: |
Constructor, with another tab order manager object. More... | |
(id) | - initWithPage: |
Constructor, from a PDF page object. More... | |
(BOOL) | - isEmpty |
Check whether current object is empty or not. More... | |
(void) | - reload |
Reload the tab order of annotations. More... | |
Properties | |
FSTabOrderMgrOrderType | orderType |
Get or Set the tab order type. | |
Tab order is the order to navigate through annotations on a PDF page by using Tab key in keyboard. This class offers functions to manager the order of moving the keyboard focus among annotations on a PDF page. Tab order manager will ignore following types of annotations:
note annotations which are as reply annotations, note annotations which are as state annotations, pop-up annotations, annotations whose flags contain FSAnnotFlagHidden.
This class offers functions to get the order type and get annotations one by one in the order type. This class also offers functions to change the order type:
After FSTabOrderMgr::orderType being used or calling function FSTabOrderMgr::adjustStructureOrder:, function FSTabOrderMgr::reload should be called; otherwise the annotations' order may not be changed as expected.
- (BOOL) adjustStructureOrder: | (FSAnnotArray*) | annot_array |
Adjust the structure order with specified annotations, and tab order type will be set to FSTabOrderMgrStructure at the same time.
This function is used to adjust the annotation order for structure tab order. First, re-order annotations in the input array according to the order in this array, and then re-order the reset annotations (which are not included in the input array) by the reading direction of PDF document.
After this function succeeds, indexes of all annotations in the related PDF page will be changed.
[in] | annot_array | An array of annotations which will be re-ordered first for structure tab order. All the annotations in this array should belong to the same page as the one related to current tab order manager. These annotations should all be valid and should be different from each other. |
- (FSAnnot *) getFirstAnnot |
Get the first annotation in current tab order.
- (FSAnnot *) getLastAnnot |
Get the last annotation in current tab order.
Get the next annotation of specified annotation in current tab order.
[in] | annot | The valid specified annotation. |
Get the previous annotation of specified annotation in current tab order.
[in] | annot | The valid specified annotation. |
- (id) initWithOther: | (FSTabOrderMgr*) | other |
Constructor, with another tab order manager object.
[in] | other | Another tab order manager object. |
- (id) initWithPage: | (FSPDFPage*) | page |
Constructor, from a PDF page object.
[in] | page | A valid PDF page. |
- (BOOL) isEmpty |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- (void) reload |
Reload the tab order of annotations.
This function should be called when: