Foxit PDF SDK  9.1
<IPageEventListener> Protocol Reference

The page event listener. More...

Inheritance diagram for <IPageEventListener>:
UIExtensionsManager

Instance Methods

(void) - onPageChanged:currentIndex:
 Triggered when current page is changed. More...
 
(void) - onPageInvisible:
 Triggered when the page becomes invisible. More...
 
(void) - onPageJumped
 Triggered by the page navigation or link jump. More...
 
(void) - onPagesFlattened:
 Triggered when page were flattened. More...
 
(void) - onPagesInsertedAtRange:
 Triggered when pages were inserted. More...
 
(void) - onPagesMoved:dstIndex:
 Triggered when pages were moved to a new index. More...
 
(void) - onPagesRemoved:
 Triggered when pages were removed. More...
 
(void) - onPagesRotated:rotation:
 Triggered when pages were rotated. More...
 
(void) - onPagesWillFlatten:
 Triggered when page will be flattened. More...
 
(void) - onPagesWillMove:dstIndex:
 Triggered when pages will be moved to a new index. More...
 
(void) - onPagesWillRemove:
 Triggered when pages will be removed. More...
 
(void) - onPagesWillRotate:rotation:
 Triggered when pages will be rotated. More...
 
(void) - onPageVisible:
 Triggered when the page becomes visible. More...
 

Detailed Description

The page event listener.

Method Documentation

◆ onPageChanged:currentIndex:

- (void) onPageChanged: (int)  oldIndex
currentIndex: (int)  currentIndex 
optional

Triggered when current page is changed.

Parameters
[in]oldIndexOld page index. Valid range: from 0 to (count-1). count is the page count.
[in]currentIndexCurrent page index. Valid range: from 0 to (count-1). count is the page count.

◆ onPageInvisible:

- (void) onPageInvisible: (int)  index
optional

Triggered when the page becomes invisible.

Parameters
[in]indexPage index. Valid range: from 0 to (count-1). count is the page count.

◆ onPageJumped

- (void) onPageJumped
optional

Triggered by the page navigation or link jump.

◆ onPagesFlattened:

- (void) onPagesFlattened: (int)  index
optional

Triggered when page were flattened.

Parameters
[in]indexPage index array. Valid range of page index: from 0 to (count-1). count is the page count.

◆ onPagesInsertedAtRange:

- (void) onPagesInsertedAtRange: (NSRange)  range
optional

Triggered when pages were inserted.

Parameters
[in]rangePage index range.

◆ onPagesMoved:dstIndex:

- (void) onPagesMoved: (NSArray< NSNumber * > *)  indexes
dstIndex: (int)  dstIndex 
optional

Triggered when pages were moved to a new index.

Parameters
[in]indexesPage index array. Valid range of page index: from 0 to (count-1). count is the page count.
[in]dstIndexThe destination page index, which the pages will be inserted before.

◆ onPagesRemoved:

- (void) onPagesRemoved: (NSArray< NSNumber * > *)  indexes
optional

Triggered when pages were removed.

Parameters
[in]indexesPage index array. Valid range of page index: from 0 to (count-1). count is the page count.

◆ onPagesRotated:rotation:

- (void) onPagesRotated: (NSArray< NSNumber * > *)  indexes
rotation: (int)  rotation 
optional

Triggered when pages were rotated.

Parameters
[in]indexesPage index array. Valid range of page index: from 0 to (count-1). count is the page count.
[in]rotationThe page rotation, valid value will be 0(0 degree), 1(90 degree), 2(180 degree), 3(270 degree).

◆ onPagesWillFlatten:

- (void) onPagesWillFlatten: (int)  index
optional

Triggered when page will be flattened.

Parameters
[in]indexPage index array. Valid range of page index: from 0 to (count-1). count is the page count.

◆ onPagesWillMove:dstIndex:

- (void) onPagesWillMove: (NSArray< NSNumber * > *)  indexes
dstIndex: (int)  dstIndex 
optional

Triggered when pages will be moved to a new index.

Parameters
[in]indexesPage index array. Valid range of page index: from 0 to (count-1). count is the page count.
[in]dstIndexThe destination page index, which the pages will be inserted before.

◆ onPagesWillRemove:

- (void) onPagesWillRemove: (NSArray< NSNumber * > *)  indexes
optional

Triggered when pages will be removed.

Parameters
[in]indexesPage index array. Valid range of page index: from 0 to (count-1). count is the page count.

◆ onPagesWillRotate:rotation:

- (void) onPagesWillRotate: (NSArray< NSNumber * > *)  indexes
rotation: (int)  rotation 
optional

Triggered when pages will be rotated.

Parameters
[in]indexesPage index array. Valid range of page index: from 0 to (count-1). count is the page count.
[in]rotationThe page rotation, valid value will be 0(0 degree), 1(90 degree), 2(180 degree), 3(270 degree).

◆ onPageVisible:

- (void) onPageVisible: (int)  index
optional

Triggered when the page becomes visible.

Parameters
[in]indexPage index. Valid range: from 0 to (count-1). count is the page count.