FoxitPDFSDKforWeb  8.3.0
Foxit PDF SDK for Web
StateHandlerManager Class Reference

Public Member Functions

 get (name)
 Get state handler by name. More...
 
 getCurrentStates ()
 Get current state handler. More...
 
 register (StateHandler)
 Register state handler. More...
 
 switchTo (name, params)
 Switch to state handler. More...
 

Detailed Description

IStateHandler's State Manager

Member Function Documentation

◆ get()

StateHandlerManager::get (   name)
inline

Get state handler by name.

Parameters
name{string}
Returns
{function(new: IStateHandler)} Returns HandStateHandler by default

◆ getCurrentStates()

StateHandlerManager::getCurrentStates ( )
inline

Get current state handler.

Returns
{function(new:IStateHandler)}

◆ register()

StateHandlerManager::register (   StateHandler)
inline

Register state handler.

Parameters
StateHandler{function(new:IStateHandler)}

◆ switchTo()

StateHandlerManager::switchTo (   name,
  params 
)
inline

Switch to state handler.

Note
If encounter error, it will switch to HandStateHandler.
Parameters
name{string} - Specifies the state handler's name. Refer to STATE_HANDLER_NAMES
params{ StampStateHandlerParams|{[key]: string}|undefined} - Set state handler's parameters. could be StampStateHandlerParams
async function example (pdfViewer) {
var handlerManager = await pdfViewer.getStateHandlerManager();
await handlerManager.switchTo(PDFViewCtrl.STATE_HANDLER_NAMES.STATE_HANDLER_CREATE_STAMP);
}
See also
STATE_HANDLER_NAMES

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