UIExtension

A module based on the PDFViewCtrl module that contains customizable UI components and APIs.
In this module, without clear declaring, APIs default to be supported in both JR and SR. More...

Modules
	addons
	bookmark
	A module containing the bookmark API for manipulating bookmark data at the UIExtension layer.
	components
	A module Including all UI layers service classes, all of these service instances can be obtained by pdfui.getserviceInstance method.
	controllers
	The controllers module contains serveral classes that inherit from Controller.
	UIConsts
	UIConsts module is an Object, All current available constants of UIExtension module are mount to this object. You can access the constant like this examples in the following:
	appearances
	A module contains supported UI themes across devices.

Classes
class	Modular
	Modular is an singleton class, you can access that instance via UIExtension.modular. More...
class	PDFUI
class	SeniorComponentFactory
	The Factory class is used to create high-order components. More...
interface	SignatureFlowOptions
	An interface that describes all configuration options of customize the signature flow. More...
interface	SignatureInfomation
	An interface declaration containing information related to the signature. More...
interface	Snapshot
	Snapshot information, including the PDFPageRender it belongs to, the selected area, and the image data stream. More...
class	SnapshotInteraction
	This is a built-in snapshot interaction class, and the application layer can inherit it to implement custom interaction logic. More...
class	UIXAddon
	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...
class	UIXModule
	A module constructed by Modular.module is collection of components and controllers. You can register a component class or a controller class into a module then you can use your component in template. An example for registering component class and usage: More...
class	XViewerUI
	This class provides an ability for user to customize the several UI like contextmenu which may be triggered from PDFViewCtrl module. You should customize that stuffs like the following example: new PDFUI({ viewerOptions: { viewerUI: new class extends UIExtension.XViewerUI { createContextMenu(owner, anchor, config) { // ... } } } }) . More...

Enumerations
enum	UIEvents { ,   fullscreenchange = 'fullscreenchange' , appendCommentListComment = 'append-commentlist-comment', appendCommentListReply = 'append-commentlist-reply', destroyCommentListComment = 'destroy-commentlist-comment',   destroyCommentListReply = 'destroy-commentlist-reply', InkImageSelected = "ink-image-selected" , addContentSuccess = "add-content-success" , initializationCompleted = 'pdfui-intialization-completed' ,   bookmarkSelected = 'bookmark-selected' }
	The event enumerations of PDFUI. All event in this enumeration must be registered via PDFUI.addUIEventListener API. More...

Variables
const Modular	modular

Detailed Description

A module based on the PDFViewCtrl module that contains customizable UI components and APIs.
In this module, without clear declaring, APIs default to be supported in both JR and SR.

Enumeration Type Documentation

UIEvents

enum UIEvents

The event enumerations of PDFUI. All event in this enumeration must be registered via PDFUI.addUIEventListener API.

Enumerator
fullscreenchange	Triggered after fulscreen state changed @param isFullscreen {boolean} represents current viewport is or not in fullscreen mode pdfui.addUIEventListener(UIExtension.UIEvents.fullscreenchange, function(isFullscreen) { // do something here })
appendCommentListComment	Triggered after a comment card appended: @param commentCardComponent CommentCardComponent @param annot Markup pdfui.addUIEventListener(UIExtension.UIEvents.appendCommentListComment, function(commentCardComponent, annot) { // do something such as add a button into commentCardComponent })
appendCommentListReply	Triggered after a reply card appended into a comment card in left sidebar: @param replyCardComponent ReplyCardComponent @param annot Annot pdfui.addUIEventListener(UIExtension.UIEvents.appendCommentListReply, function(replyCardComponent, annot) { // do something such as add a button into replyComponent })
destroyCommentListComment	Triggered after a comment card in left sidebar has been destroyed: @param commentCardComponent CommentCardComponent @param annot Markup pdfui.addUIEventListener(UIExtension.UIEvents.destroyCommentListComment, function(commentCardComponent, annot) { // do something })
destroyCommentListReply	Triggered after a reply card in left sidebar has been destroyed: @param replyCardComponent ReplyCardComponent @param replyAnnot Annot pdfui.addUIEventListener(UIExtension.UIEvents.destroyCommentListReply, function(replyCardComponent, replyAnnot){ // do something })
InkImageSelected	An event to receive the user selected ink signature image. Parameters imageURL The URL of the ink signature image. pdfui.addViewerEventListener(PDFViewCtrl.constants.ViewerEvents.InkImageSelected,(imageURL)=>{ console.log(imageURL) })
addContentSuccess	Triggered after commit the changes of the annotation's content in comment-list pane. pdfui.addUIEventListener(UIExtension.UIEvents.addContentSuccess, function (annot, oldContent, newContent) { // do somthing }) .
initializationCompleted	Trggered after all resources are prepared completly. pdfui.addUIEventListener(UIExtension.UIEvents.initializationCompleted, function () { // do somthing })
bookmarkSelected	If bookmark has been selected, an event with this type will be triggered. pdfui.addUIEventListener(UIExtension.UIEvents.bookmarkSelected, (bookmark) => { //do something. }) Parameters {Promise.<PDFBookmark>} - Selected bookmark. Deprecated:

Variable Documentation

modular

const Modular modular

This object is used to create and manage all UIXModule instances, You can use this instance like the following:

const _module = UIExtension.modular.module('my-module', []); // Create new UIXModule
const myModule = UIExtension.modular.module('my-module');

See also

Modular

UIXModule