FoxitPDFSDKforWeb  v10.0.0
Foxit PDF SDK for Web
IStateHandler Class Reference

Interface of StateHandler. More...

Inherited by CreateComplexShapeStateHandler, CreateCropPagesStateHandler, CreatPredefinedTextStateHandler, HandStateHandler, LoupeStateHandler, LoupeStateHandler, SelectTextStateHandler, and SelectTextStateHandler.

Public Member Functions

 constructor (pdfViewer)
 The constructor for constructing an instance of IStateHandler. More...
 
 destroyDocHandler ()
 Executed when the document is destroyed.
 
 destroyPageHandler ()
 
 docHandler (pdfDocRender)
 Binding at the document level. More...
 
 out ()
 This method is executed when it leaves the current stateHandler.
 
 pageHandler (pdfPageRender)
 Binding at the page level. More...
 

Static Public Member Functions

static getStateName ()
 The name of the state handler, also a unique identifier. More...
 
static setParams (params, pdfViewer)
 This function is called by StateHandlerManager.switchTo, and processes parameters that were passed in.. More...
 

Detailed Description

Interface of StateHandler.

Member Function Documentation

◆ constructor()

IStateHandler::constructor (   pdfViewer)
inline

The constructor for constructing an instance of IStateHandler.

Parameters
pdfViewerPDFViewer - The PDFViewer instance owns this state handler instance.
Since
9.0.0

◆ destroyPageHandler()

IStateHandler::destroyPageHandler ( )
inline

Executed when the page is destroyed

◆ docHandler()

IStateHandler::docHandler (   pdfDocRender)
inline

Binding at the document level.

Parameters
pdfDocRenderPDFDocRender - PDFDocRender

◆ getStateName()

static IStateHandler::getStateName ( )
inlinestatic

The name of the state handler, also a unique identifier.

Returns
string -

◆ pageHandler()

IStateHandler::pageHandler (   pdfPageRender)
inline

Binding at the page level.

Parameters
pdfPageRenderPDFPageRender - PDFPageRender

◆ setParams()

static IStateHandler::setParams (   params,
  pdfViewer 
)
inlinestatic

This function is called by StateHandlerManager.switchTo, and processes parameters that were passed in..

Parameters
paramsobject - Parameters come from second parameter of StateHandlerManager.switchTo.
pdfViewerPDFViewer -

Foxit Software Corporation Logo
@2024 Foxit Software Incorporated. All rights reserved.