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

An appearance like a packed theme. It provides a layout template and also allows to do things related to UE in beforeMounted or afterMounted method. When the layout template is rewritten, it is best to inherit this class and override the disableAll and enableAll methods to handle associated logic. More...

Inheritance diagram for Appearance:
Disposable AdaptiveAppearance UIAppearance MobileAppearance RibbonAppearance

Public Member Functions

 afterMounted (root)
 A lifecycle method, will allways be called after root component mounted into DOM tree. More...
 
 beforeMounted (root)
 A lifecycle method, will allways be called before root component mounted into DOM tree. More...
 
- Public Member Functions inherited from Disposable
 addDestroyHook (...hooks)
 
 destroy ()
 

Static Public Member Functions

static extend (proto, statics)
 Extends from Appearance class and generates a customize appearance! More...
 

Protected Member Functions

 disableAll ()
 A method to disable those components that are activated only when the current PDF document is displayed.. It's called when the PDFViewCtrl.constants.ViewerEvents.willCloseDocument event is triggerred.
 
 enableAll ()
 A method to enable those components that are disabled by calling disableAll() method. It's called when the PDFViewCtrl.constants.ViewerEvents.openFileSuccess event is triggerred.
 
 getDefaultFragments ()
 UI fragments array, defines serveral UI components and business logics. More...
 
 getLayoutTemplate ()
 A method provides a layout template. More...
 

Detailed Description

An appearance like a packed theme. It provides a layout template and also allows to do things related to UE in beforeMounted or afterMounted method. When the layout template is rewritten, it is best to inherit this class and override the disableAll and enableAll methods to handle associated logic.

Member Function Documentation

◆ afterMounted()

Appearance::afterMounted (   root)
inline

A lifecycle method, will allways be called after root component mounted into DOM tree.

Parameters
rootComponent

◆ beforeMounted()

Appearance::beforeMounted (   root)
inline

A lifecycle method, will allways be called before root component mounted into DOM tree.

Parameters
rootComponent

◆ extend()

static Appearance::extend (   proto,
  statics 
)
inlinestatic

Extends from Appearance class and generates a customize appearance!

Parameters
prototypeobject - Appearance.prototype
[statics]object - static members
Returns
Class<Appearance>

◆ getDefaultFragments()

Appearance::getDefaultFragments ( )
inlineprotected

UI fragments array, defines serveral UI components and business logics.

Returns
UIFragmentOptions[]

◆ getLayoutTemplate()

Appearance::getLayoutTemplate ( )
inlineprotected

A method provides a layout template.

Returns
string

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