XViewerUI Class Reference

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...

Inherits TinyViewerUI.

Public Member Functions
	alert (message, title)
	A method shows alert dialog like window.alert() More...
	confirm (message, title)
	A method shows confirm dialog like window.alert() More...
	createContextMenu (owner, anchor, config)
	A method which is used to create the contextmenu component and registers the right-click event. You can override this method to customize the right-click menu. More...
	prompt (defaultValue, message, title)
	A method shows prompt dialog like window.alert() More...

Protected Member Functions
	getAnnotsContextMenuName (owner)
	Obtains the contextmenu component name according to the owner annotation's type. If the component's name is not found in the template, you need to use the default contextmenu component according to the type of Annotation. 'fv–markup-contextmenu'， 'fv–textmarkup-contextmenu' and 'fv–default-annot-contextmenu' are used as default contextmenu component name by the implementation of the XViewerUI.createContextMenu method. More...
	getContextMenuNameByOwner (owner)
	Obtains the contextmenu component name according to the owner type(including state-handler name or AnnotComponent instance). More...

Detailed Description

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) {
             // ...
         }
     }
 }
})

.

Since

7.2.0

Member Function Documentation

alert()

XViewerUI::alert (   message,   title  )

inline

A method shows alert dialog like window.alert()

Parameters

{string}	messageThe alert message.
{string}	[title]The title of alert dialog.

Returns

{Promise} - A fulfilled Promise.

confirm()

XViewerUI::confirm (   message,   title  )

inline

A method shows confirm dialog like window.alert()

Parameters

{string}	messageThe confirm message.
{string}	[title]The title of the confirm dialog.

Returns

{Promise} - A fulfilled Promise if user confirmed, otherwise rejected Promise.

createContextMenu()

XViewerUI::createContextMenu (   owner,   anchor,   config  )

inline

A method which is used to create the contextmenu component and registers the right-click event. You can override this method to customize the right-click menu.

Parameters

owner	string|AnnotComponentIndicates the owner of the contextmneu instance returned by this method , which can be the name of a state-handler or an instance ofAnnotComponent.
anchor	HTMLElementAn html element used to respond to right-click events.
config	{object} -
config.selector	stringA css selector of an element, this element may be the anchor or it's children, this selector is used to detect the right-click event target.

Returns

{IContextMenu}

getAnnotsContextMenuName()

XViewerUI::getAnnotsContextMenuName (   owner )

inlineprotected

Obtains the contextmenu component name according to the owner annotation's type. If the component's name is not found in the template, you need to use the default contextmenu component according to the type of Annotation. 'fv–markup-contextmenu'， 'fv–textmarkup-contextmenu' and 'fv–default-annot-contextmenu' are used as default contextmenu component name by the implementation of the XViewerUI.createContextMenu method.

Parameters

{AnnotComponent}

owner

Returns

{string}

getContextMenuNameByOwner()

XViewerUI::getContextMenuNameByOwner (   owner )

inlineprotected

Obtains the contextmenu component name according to the owner type(including state-handler name or AnnotComponent instance).

Parameters

{string|AnnotComponent}

ownerIndicates the owner of the contextmneu instance returned by this method , which can be the name of a state-handler or an instance ofAnnotComponent.

Returns

{string|undefined} - undefined if owner is unsupported otherwise an string.

prompt()

XViewerUI::prompt (   defaultValue,   message,   title  )

inline

A method shows prompt dialog like window.alert()

Parameters

{string}	defaultValueThe default value of the input box.
{string}	messageThe message above the input.
{string}	[title]The title of the prompt dialog.

Returns

{Promise} - A fulfilled Promise with the value of the input box if user confirmed, otherwise rejected Promise.