FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
StatefulController Class Reference

This Controller class encapsulates the implementation logic for IStateHandler registration and toggle event listening. More...

Inheritance diagram for StatefulController:
Controller

Public Member Functions

 constructor (component, ExpectedStateHandlerClass)
 Classes inherit from StatefulController must override this contructor and passing a class inherit from IStateHandler into super() function. If that StateHandler class has been registed, you can also passing the state handler name instead of class into super() function. More...
 
- Public Member Functions inherited from Controller
 constructor (component)
 
 getComponentByName (name)
 
 handle (...args)
 

Protected Member Functions

 stateIn ()
 Triggered when the viewer state switched into this 'ExpectedStateHandlerClass'. More...
 
 stateOut ()
 Triggered when the viewer state switched into another StateHandlerClass. More...
 
- Protected Member Functions inherited from Controller
 getPDFUI ()
 
 mounted ()
 This method is called after the component is inserted into DOM tree, where you can add some event listeners to the component or handle any other tasks. More...
 
 postlink ()
 This method is called during component postlink lifecycle. More...
 
 prelink ()
 This method is called during component prelink lifecycle. More...
 

Additional Inherited Members

- Protected Attributes inherited from Controller
Component component
 The component of this controller. More...
 

Detailed Description

This Controller class encapsulates the implementation logic for IStateHandler registration and toggle event listening.

See also
PDFViewer::getStateHandlerManager()
StateHandlerManager
IStateHandler
Since
7.0.0

Member Function Documentation

◆ constructor()

constructor (   component,
  ExpectedStateHandlerClass 
)
inline

Classes inherit from StatefulController must override this contructor and passing a class inherit from IStateHandler into super() function. If that StateHandler class has been registed, you can also passing the state handler name instead of class into super() function.

Example 1, passing a MyStateHandlerClass into super():

class MyStateHandlerClass extends PDFViewCtrl.IStateHandler {
// ...
}
class MyStateController extends UIExtension.controllers.StatefulController {
super(component, MyStateHandlerClass);
}
}

Example 2, passing state handler name into super():

class MystateController extends UIExtension.controllers.StatefulController {
super(component, 'your-custom-state-name');
}
}
Parameters
componentComponent
ExpectedStateHandlerClassfunction(new:IStateHandler) | string
See also
IStateHandler

◆ stateIn()

StatefulController::stateIn ( )
inlineprotected

Triggered when the viewer state switched into this 'ExpectedStateHandlerClass'.

Returns
void

◆ stateOut()

StatefulController::stateOut ( )
inlineprotected

Triggered when the viewer state switched into another StateHandlerClass.

Returns
void

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