FoxitPDFSDKforWeb  7.1.1
Foxit PDF SDK for Web
UIXAddon Class Reference

UIXAddon, an addon that relies on the UIExtension of Foxit PDF SDK for Web, is packaged separately into a JS file. The applications can load this addon as needed. This class defines the method templates what a UIXAddon needs to implement. More...

Public Member Functions

 afterMounted (root)
 Lifecycle method: this method is called after the UI component element mout into DOM tree. More...
 
 beforeMounted (root)
 Lifecycle method: this hook is called before the UI component element mount into DOM tree. More...
 
 destroy ()
 Lifecycle method: to override this method to implement the destroying logics. This method is called when a PDFUI instance is destroyed or the addon is dettached from PDFUI. More...
 
 fragments ()
 UI fragment configurations of this addon. More...
 
 getI18NResources ()
 Get I18n resources. More details about I18Next, please visit: https://www.i18next.com/. More...
 
static getName ()
 Returns the name of an addon. More...
 
 init (pdfui)
 Called when initializing this addon. More...
 
 pdfViewerCreated (pdfviewer)
 Lifecycle method: this method is called when PDFViewer instance has been created and is before the afterMounted method . More...
 

Detailed Description

UIXAddon, an addon that relies on the UIExtension of Foxit PDF SDK for Web, is packaged separately into a JS file. The applications can load this addon as needed. This class defines the method templates what a UIXAddon needs to implement.

Member Function Documentation

◆ afterMounted()

UIXAddon::afterMounted (   root)
inline

Lifecycle method: this method is called after the UI component element mout into DOM tree.

Parameters
rootComponent

◆ beforeMounted()

UIXAddon::beforeMounted (   root)
inline

Lifecycle method: this hook is called before the UI component element mount into DOM tree.

Parameters
rootComponent

◆ destroy()

UIXAddon::destroy ( )
inline

Lifecycle method: to override this method to implement the destroying logics. This method is called when a PDFUI instance is destroyed or the addon is dettached from PDFUI.

Returns
Promise | void

◆ fragments()

UIXAddon::fragments ( )
inline

UI fragment configurations of this addon.

Returns
UIFragmentOptions[]

◆ getI18NResources()

UIXAddon::getI18NResources ( )
inline

Get I18n resources. More details about I18Next, please visit: https://www.i18next.com/.

Returns
object
format:
{ [language]: { [key]: value } }

◆ getName()

static getName ( )
inline

Returns the name of an addon.

@static

Returns
string

◆ init()

init (   pdfui)
inline

Called when initializing this addon.

Parameters
pdfui- PDFUI

◆ pdfViewerCreated()

UIXAddon::pdfViewerCreated (   pdfviewer)
inline

Lifecycle method: this method is called when PDFViewer instance has been created and is before the afterMounted method .

Parameters
pdfviewerPDFUI

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