Foxit PDF SDK  9.1
com.foxit.uiextensions.UIExtensionsManager Class Reference
Inheritance diagram for com.foxit.uiextensions.UIExtensionsManager:
com.foxit.sdk.PDFViewCtrl.UIExtensionsManager com.foxit.uiextensions.IPDFReader com.foxit.sdk.PDFViewCtrl.IGestureEventListener com.foxit.sdk.PDFViewCtrl.IDoubleTapEventListener com.foxit.sdk.PDFViewCtrl.IScaleGestureEventListener com.foxit.sdk.PDFViewCtrl.IDrawEventListener

Classes

interface  ConfigurationChangedListener
 
interface  IDocModifiedEventListener
 
interface  ILinkEventListener
 
interface  ISignatureEventListener
 
class  LinkInfo
 
interface  MenuEventListener
 
interface  OnFinishListener
 
interface  ToolHandlerChangedListener
 

Public Member Functions

void setLinkEventListener (ILinkEventListener listener)
 
void setOnFinishListener (OnFinishListener listener)
 
ILinkEventListener getLinkEventListener ()
 
 UIExtensionsManager (Context context, PDFViewCtrl pdfViewCtrl)
 
 UIExtensionsManager (Context context, PDFViewCtrl pdfViewCtrl, Config config)
 
ViewGroup getRootView ()
 
void registerToolHandlerChangedListener (ToolHandlerChangedListener listener)
 
void unregisterToolHandlerChangedListener (ToolHandlerChangedListener listener)
 
void registerInteractionListener (IInteractionEventListener listener)
 
void unregisterInteractionListener (IInteractionEventListener listener)
 
void registerThemeEventListener (IThemeEventListener listener)
 
void unregisterThemeEventListener (IThemeEventListener listener)
 
void registerConfigurationChangedListener (ConfigurationChangedListener listener)
 
void unregisterConfigurationChangedListener (ConfigurationChangedListener listener)
 
void registerXFAPageEventListener (IXFAPageEventListener listener)
 
void unregisterXFAPageEventListener (IXFAPageEventListener listener)
 
void onXFAPageRemoved (boolean isSuccess, int pageIndex)
 
void onXFAPagesInserted (boolean isSuccess, int pageIndex)
 
void registerXFAWidgetEventListener (IXFAWidgetEventListener listener)
 
void unregisterXFAWidgetEventListener (IXFAWidgetEventListener listener)
 
void onXFAWidgetAdded (XFAWidget xfaWidget)
 
void onXFAWidgetWillRemove (XFAWidget xfaWidget)
 
void setCurrentToolHandler (ToolHandler toolHandler)
 
ToolHandler getCurrentToolHandler ()
 
void registerToolHandler (ToolHandler handler)
 
void unregisterToolHandler (ToolHandler handler)
 
ToolHandler getToolHandlerByType (String type)
 
void registerAnnotHandler (AnnotHandler handler)
 
void unregisterAnnotHandler (AnnotHandler handler)
 
AnnotHandler getCurrentAnnotHandler ()
 
AnnotHandler getAnnotHandlerByType (int type)
 
void registerModule (Module module)
 
void unregisterModule (Module module)
 
Module getModuleByName (String name)
 
boolean isContinueAddAnnot ()
 
void setContinueAddAnnot (boolean continueAddAnnot)
 
void enableLinks (boolean enable)
 
boolean isLinksEnabled ()
 
boolean isLinkHighlightEnabled ()
 
void enableLinkHighlight (boolean enable)
 
long getLinkHighlightColor ()
 
void setLinkHighlightColor (long color)
 
long getFormHighlightColor ()
 
void setFormHighlightColor (long color)
 
boolean isFormHighlightEnable ()
 
void enableFormHighlight (boolean enable)
 
void setSelectionHighlightColor (int color)
 
int getSelectionHighlightColor ()
 
void setUseLogicalPageNumbers (boolean useLogicalPageNumbers)
 
boolean isUseLogicalPageNumbers ()
 
String getCurrentSelectedText ()
 
void registerMenuEventListener (MenuEventListener listener)
 
void unregisterMenuEventListener (MenuEventListener listener)
 
void triggerDismissMenuEvent ()
 
void enableAutoFullScreen (boolean enable)
 
boolean onTouchEvent (int pageIndex, MotionEvent motionEvent)
 
boolean shouldViewCtrlDraw (Annot annot)
 
Annot getFocusAnnot ()
 
void onDraw (int pageIndex, Canvas canvas)
 
boolean onSingleTapConfirmed (MotionEvent motionEvent)
 
boolean onDoubleTap (MotionEvent motionEvent)
 
boolean onDoubleTapEvent (MotionEvent motionEvent)
 
boolean onDown (MotionEvent motionEvent)
 
void onShowPress (MotionEvent motionEvent)
 
boolean onSingleTapUp (MotionEvent motionEvent)
 
boolean onScroll (MotionEvent motionEvent, MotionEvent motionEvent1, float v, float v1)
 
void onLongPress (MotionEvent motionEvent)
 
boolean onFling (MotionEvent motionEvent, MotionEvent motionEvent1, float v, float v1)
 
boolean onScale (ScaleGestureDetector scaleGestureDetector)
 
boolean onScaleBegin (ScaleGestureDetector scaleGestureDetector)
 
void onScaleEnd (ScaleGestureDetector scaleGestureDetector)
 
void setAttachedActivity (Activity activity)
 
Activity getAttachedActivity ()
 
void startPrintJob (Context context, PDFDoc pdfDoc, String printJobName, String fileName, IPrintResultCallback callback)
 
void startPrintJob (Context context, XFADoc xfaDoc, String printJobName, String fileName, IPrintResultCallback callback)
 
IPanelManager getPanelManager ()
 
Config getConfig ()
 
boolean canModifyContents ()
 
boolean canAddAnnot ()
 
boolean canAssemble ()
 
void exitPanZoomMode ()
 
void setNightColorMode (int nightColorMode)
 
int getNightColorMode ()
 
void setPageColorMode (int pageColorMode)
 
int getPageColorMode ()
 
void onCreate (Activity act, PDFViewCtrl pdfViewCtrl, Bundle bundle)
 
void onConfigurationChanged (Activity act, Configuration newConfig)
 
void onStart (Activity act)
 
void onPause (Activity act)
 
void onHiddenChanged (boolean hidden)
 
void onResume (Activity act)
 
void onStop (Activity act)
 
void onDestroy (Activity act)
 
void handleActivityResult (Activity act, int requestCode, int resultCode, Intent data)
 
void registerPolicyEventListener (IPolicyEventListener listener)
 
void unregisterPolicyEventListener (IPolicyEventListener listener)
 
void handleRequestPermissionsResult (int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults)
 
void openDocument (String path, byte[] password)
 
void openDocument (FileReaderCallback fileReader, byte[] password)
 
boolean registerLifecycleListener (ILifecycleEventListener listener)
 
boolean unregisterLifecycleListener (ILifecycleEventListener listener)
 
boolean registerStateChangeListener (IStateChangeListener listener)
 
boolean unregisterStateChangeListener (IStateChangeListener listener)
 
int getState ()
 
void changeState (int state)
 
IMainFrame getMainFrame ()
 
PDFViewCtrl getPDFViewCtrl ()
 
IBarsHandler getBarManager ()
 
IViewSettingsWindow getSettingWindow ()
 
DocumentManager getDocumentManager ()
 
RelativeLayout getContentView ()
 
void backToPrevActivity ()
 
void setBackEventListener (BackEventListener listener)
 
BackEventListener getBackEventListener ()
 
boolean onKeyDown (Activity act, int keyCode, KeyEvent event)
 
boolean backToNormalState ()
 
void setFilePath (String path)
 
void enableTopToolbar (boolean isEnabled)
 
void enableBottomToolbar (boolean isEnabled)
 
boolean isAutoSaveDoc ()
 
void setAutoSaveDoc (boolean autoSaveDoc)
 
void setAnnotAuthor (String author)
 
boolean canUpdateAnnotDefaultProperties ()
 
void setUpdateAnnotDefaultProperties (boolean update)
 
void setInkDrawToolType (int toolType)
 
int getInkDrawToolType ()
 
String getAnnotAuthor ()
 
void setSaveDocFlag (int flag)
 
int getSaveDocFlag ()
 
void setSaveWriter (FileWriterCallback writer)
 
FileWriterCallback getSaveWriter ()
 
void setSavePath (String savePath)
 
String getSavePath ()
 
IMenuView getMenuView ()
 
MenuViewManager getMenuViewManager ()
 
boolean isLoadAnnotModule (Annot annot)
 
void registerDocModifiedEventListener (IDocModifiedEventListener listener)
 
void unregisterDocModifiedEventListener (IDocModifiedEventListener listener)
 
boolean isAutoSaveSignedDoc ()
 
void setAutoSaveSignedDoc (boolean autoSaveSignedDoc)
 
void setSignedDocSavePath (String savePath)
 
String getSignedDocSavePath ()
 
void setAPPInfoProvider (IAppInfoProvider provider)
 
IAppInfoProvider getAPPInfoProvider ()
 
void setAnnotationsPermission (IAnnotationsPermission permission)
 
IAnnotationsPermission getAnnotationsPermission ()
 
boolean handleSingleTapConfirmed (MotionEvent motionEvent)
 
void registerSignatureEventListener (ISignatureEventListener listener)
 
void unregisterSignatureEventListener (ISignatureEventListener listener)
 
void registerUIInteractionEventListener (IUIInteractionEventListener listener)
 
void unregisterUIInteractionEventListener (IUIInteractionEventListener listener)
 
void enableSmallTopToolbar (boolean isEnabled)
 
void enableSmallBottomToolbar (boolean isEnabled)
 
boolean isEnableModification ()
 
void enableModification (boolean isEnabled)
 
int getMeasurementUnits ()
 
void setMeasurementUnits (int unit)
 
void setInkDrawingTimeout (long timeoutMillis)
 
long getInkDrawingTimeout ()
 

Static Public Attributes

static final int LINKTYPE_ANNOT = 0
 
static final int LINKTYPE_TEXT = 1
 
static final int NIGHTCOLORMODE_DEFAULT = 0
 
static final int NIGHTCOLORMODE_MAPPINGGRAY = 1
 
static final int MEASUREMENT_UNIT_INCH = 0
 
static final int MEASUREMENT_UNIT_CM = 1
 
static final int MEASUREMENT_UNIT_MM = 2
 

Protected Member Functions

void loadAllModules ()
 

Detailed Description

Class UIExtensionsManager represents a UI extensions manager.

The UIExtensionsManager class is mainly used for managing the UI extensions which implement IPDFReader interface, it implements the PDFViewCtrl.UIExtensionsManager interface that is a listener to listen common interaction events and view event, and will dispatch some events to UI extensions, it also defines functions to manage the UI extensions.

Constructor & Destructor Documentation

◆ UIExtensionsManager() [1/2]

com.foxit.uiextensions.UIExtensionsManager.UIExtensionsManager ( Context  context,
PDFViewCtrl  pdfViewCtrl 
)

Instantiates a new UI extensions manager.

Parameters
contextA Context object which species the context.
pdfViewCtrlA PDFViewCtrl object which species the PDF view control.

◆ UIExtensionsManager() [2/2]

com.foxit.uiextensions.UIExtensionsManager.UIExtensionsManager ( Context  context,
PDFViewCtrl  pdfViewCtrl,
Config  config 
)

Instantiates a new UI extensions manager with modules config.

Parameters
contextA Context object which species the context.
pdfViewCtrlA PDFViewCtrl object which species the PDF view control.
configA Config object which species a modules loading config, if null, UIExtension manager will load all modules by default, and equal to UIExtensionsManager(Context, PDFViewCtrl).

Member Function Documentation

◆ backToNormalState()

boolean com.foxit.uiextensions.UIExtensionsManager.backToNormalState ( )

Show normal view reading state

Returns
True means back the normal state

◆ backToPrevActivity()

void com.foxit.uiextensions.UIExtensionsManager.backToPrevActivity ( )

Go back to the previous activity.

hideSave &&

Implements com.foxit.uiextensions.IPDFReader.

◆ canAddAnnot()

boolean com.foxit.uiextensions.UIExtensionsManager.canAddAnnot ( )

Check whether the document can add annotation

Returns
true means The document can add annotation

◆ canAssemble()

boolean com.foxit.uiextensions.UIExtensionsManager.canAssemble ( )

Check whether the document can be assemble.

Returns
true means The document can be assemble

◆ canModifyContents()

boolean com.foxit.uiextensions.UIExtensionsManager.canModifyContents ( )

Check whether the document can be modified.

Returns
true means The document can be modified

◆ canUpdateAnnotDefaultProperties()

boolean com.foxit.uiextensions.UIExtensionsManager.canUpdateAnnotDefaultProperties ( )

Whether to update the default properties of creating annot.

Returns
True if you modify some properties of an annot, those properties will be used the next time when you create the same type of annot, false otherwise.

◆ changeState()

void com.foxit.uiextensions.UIExtensionsManager.changeState ( int  state)

Change the read state

Parameters
stateshould be one of ReadStateConfig.STATE_XXX

Implements com.foxit.uiextensions.IPDFReader.

◆ enableAutoFullScreen()

void com.foxit.uiextensions.UIExtensionsManager.enableAutoFullScreen ( boolean  enable)

Set whether to automatically full screen, the default is true.

Parameters
enableIf you set true, it will automatically full screen after a few seconds, hiding topbar and bottommbar,false otherwise.

◆ enableBottomToolbar()

void com.foxit.uiextensions.UIExtensionsManager.enableBottomToolbar ( boolean  isEnabled)

Whether show the bottom tool bar

Parameters
isEnabledTrue show the bottom tool bar, or otherwise.

◆ enableFormHighlight()

void com.foxit.uiextensions.UIExtensionsManager.enableFormHighlight ( boolean  enable)

Enable the highlight color of form field. If the document is opened, please call function PDFViewCtrl#updatePagesLayout() after setting the new value.

Parameters
enableTrue means highlight color of form field. can be displayed, false for else.

◆ enableLinkHighlight()

void com.foxit.uiextensions.UIExtensionsManager.enableLinkHighlight ( boolean  enable)

Enable highlight color of link annotation

Parameters
enableTrue means highlight color of link annotation can be displayed, false for else.

◆ enableLinks()

void com.foxit.uiextensions.UIExtensionsManager.enableLinks ( boolean  enable)

Enable link annotation action event.

Parameters
enableTrue means link annotation action event can be triggered, false for else.

◆ enableModification()

void com.foxit.uiextensions.UIExtensionsManager.enableModification ( boolean  isEnabled)

Set whether the pdf document can be modified. The default is allow modification.

Parameters
isEnabledwhether the pdf document can be modified

◆ enableSmallBottomToolbar()

void com.foxit.uiextensions.UIExtensionsManager.enableSmallBottomToolbar ( boolean  isEnabled)

Enable or disable small bottom toolbar.

Parameters
isEnabledWhether small bottom toolbar is enabled or not.

◆ enableSmallTopToolbar()

void com.foxit.uiextensions.UIExtensionsManager.enableSmallTopToolbar ( boolean  isEnabled)

Enable or disable small top toolbar.

Parameters
isEnabledWhether small top toolbar is enabled or not.

◆ enableTopToolbar()

void com.foxit.uiextensions.UIExtensionsManager.enableTopToolbar ( boolean  isEnabled)

Whether show the top tool bar

Parameters
isEnabledTrue show the top tool bar, or otherwise.

◆ exitPanZoomMode()

void com.foxit.uiextensions.UIExtensionsManager.exitPanZoomMode ( )

Exit the pan zoom mode.

◆ getAnnotationsPermission()

IAnnotationsPermission com.foxit.uiextensions.UIExtensionsManager.getAnnotationsPermission ( )

Get permission control to annotations on the basis of document permission.

Returns
customize annotations permission IAnnotationsPermission

◆ getAnnotAuthor()

String com.foxit.uiextensions.UIExtensionsManager.getAnnotAuthor ( )

Get annotation author string. The default author is "foxit sdk"

Returns
Annotation author string

◆ getAnnotHandlerByType()

AnnotHandler com.foxit.uiextensions.UIExtensionsManager.getAnnotHandlerByType ( int  type)

Get the specified AnnotHandler from current UI extensions manager.

Parameters
typeThe type of AnnotHandler, refer to AnnotHandler#getType();
Returns
A AnnotHandler object with specified type.

◆ getAPPInfoProvider()

IAppInfoProvider com.foxit.uiextensions.UIExtensionsManager.getAPPInfoProvider ( )

Get Interface for applying related information

Returns
Application version name information IAppInfoProvider

◆ getAttachedActivity()

Activity com.foxit.uiextensions.UIExtensionsManager.getAttachedActivity ( )

Get the attached activity.

Returns
The attached activity.

◆ getBackEventListener()

BackEventListener com.foxit.uiextensions.UIExtensionsManager.getBackEventListener ( )

◆ getBarManager()

IBarsHandler com.foxit.uiextensions.UIExtensionsManager.getBarManager ( )

Get bar manager

Returns
Return the IBarsHandler to use.

Implements com.foxit.uiextensions.IPDFReader.

◆ getConfig()

Config com.foxit.uiextensions.UIExtensionsManager.getConfig ( )

Get a property config

Returns
Config

◆ getContentView()

RelativeLayout com.foxit.uiextensions.UIExtensionsManager.getContentView ( )
Returns
the content view of the UI extension

Implements com.foxit.uiextensions.IPDFReader.

◆ getCurrentAnnotHandler()

AnnotHandler com.foxit.uiextensions.UIExtensionsManager.getCurrentAnnotHandler ( )
Returns
Get the current AnnotHandler

◆ getCurrentSelectedText()

String com.foxit.uiextensions.UIExtensionsManager.getCurrentSelectedText ( )

Get current selected text content from text select tool handler.

Returns
The current selected text content.

◆ getCurrentToolHandler()

ToolHandler com.foxit.uiextensions.UIExtensionsManager.getCurrentToolHandler ( )

Get the current tool handler.

Returns
A ToolHandler object which specifies the current tool handler.

◆ getDocumentManager()

DocumentManager com.foxit.uiextensions.UIExtensionsManager.getDocumentManager ( )
Returns
the DocumentManager which used to get document property and other operations.

Implements com.foxit.uiextensions.IPDFReader.

◆ getFocusAnnot()

Annot com.foxit.uiextensions.UIExtensionsManager.getFocusAnnot ( )

Get the focus annotation.

Returns
The focus annotation.

Implements com.foxit.sdk.PDFViewCtrl.UIExtensionsManager.

◆ getFormHighlightColor()

long com.foxit.uiextensions.UIExtensionsManager.getFormHighlightColor ( )

Get the highlight color of form field.

Returns
the highlight color of form field.

◆ getInkDrawingTimeout()

long com.foxit.uiextensions.UIExtensionsManager.getInkDrawingTimeout ( )

Gets the current timeout value for Ink drawing.

The default value is -1, which disables the timeout. If the timeout value is less than or equal to 0, the timeout feature is disabled.

Returns
The timeout duration in milliseconds. Default is -1 to disable.

◆ getInkDrawToolType()

int com.foxit.uiextensions.UIExtensionsManager.getInkDrawToolType ( )

Get the ink drawing type.

Returns
The ink drawing tool type. Must be one of: InkDrawToolType#STYLUS – draws ink only when using a stylus, or InkDrawToolType#STYLUS_OR_FINGER – automatically selects the drawing tool based on whether a finger or stylus is used.

◆ getLinkEventListener()

ILinkEventListener com.foxit.uiextensions.UIExtensionsManager.getLinkEventListener ( )

Get link event listener object.

Returns
The link event listener object.

◆ getLinkHighlightColor()

long com.foxit.uiextensions.UIExtensionsManager.getLinkHighlightColor ( )

get the highlight color of link annotation.

Returns
the highlight color

◆ getMainFrame()

IMainFrame com.foxit.uiextensions.UIExtensionsManager.getMainFrame ( )

Get the IMainFrame of the UI extension.

Returns
The IMainFrame to use.

Implements com.foxit.uiextensions.IPDFReader.

◆ getMeasurementUnits()

int com.foxit.uiextensions.UIExtensionsManager.getMeasurementUnits ( )

Get measurement units for page size information

Returns
measurement units

◆ getMenuView()

IMenuView com.foxit.uiextensions.UIExtensionsManager.getMenuView ( )
Returns
the IMenuView for interacting with menus

◆ getMenuViewManager()

MenuViewManager com.foxit.uiextensions.UIExtensionsManager.getMenuViewManager ( )

Get menu view manager. Use this menu view manager can obtain a menu view of a specific location, and then customize some operations using this view.

Returns
Return the MenuViewManager to use.

Implements com.foxit.uiextensions.IPDFReader.

◆ getModuleByName()

Module com.foxit.uiextensions.UIExtensionsManager.getModuleByName ( String  name)

Get the specified module from current UI extensions manager.

Parameters
nameThe specified module name, refer to Module#getName().
Returns
A Module object with specified module name.

◆ getNightColorMode()

int com.foxit.uiextensions.UIExtensionsManager.getNightColorMode ( )

◆ getPageColorMode()

int com.foxit.uiextensions.UIExtensionsManager.getPageColorMode ( )

◆ getPanelManager()

IPanelManager com.foxit.uiextensions.UIExtensionsManager.getPanelManager ( )

Get the interface to handle the creation, display, hiding, layout, and interaction of panels.

Returns
IPanelManager

◆ getPDFViewCtrl()

PDFViewCtrl com.foxit.uiextensions.UIExtensionsManager.getPDFViewCtrl ( )

Get the pdf view control

Returns
The PDFViewCtrl to use.

Implements com.foxit.uiextensions.IPDFReader.

◆ getRootView()

ViewGroup com.foxit.uiextensions.UIExtensionsManager.getRootView ( )
Returns
the root view

◆ getSaveDocFlag()

int com.foxit.uiextensions.UIExtensionsManager.getSaveDocFlag ( )

Get the flag while saving a document has used

◆ getSavePath()

String com.foxit.uiextensions.UIExtensionsManager.getSavePath ( )
Returns
the path where the document is saved

◆ getSaveWriter()

FileWriterCallback com.foxit.uiextensions.UIExtensionsManager.getSaveWriter ( )
Returns
Get the file writer callback where the document will be saved.

◆ getSelectionHighlightColor()

int com.foxit.uiextensions.UIExtensionsManager.getSelectionHighlightColor ( )

Get highlight color (including alpha) when text has selected.

Returns
The highlight color.

◆ getSettingWindow()

IViewSettingsWindow com.foxit.uiextensions.UIExtensionsManager.getSettingWindow ( )
Returns
the IViewSettingsWindow which used to control the page mode, zoom mode and other settings.

Note: If you want to use this,, it must be used after UIExtensionsManager#onCreate(Activity, PDFViewCtrl, Bundle)

Implements com.foxit.uiextensions.IPDFReader.

◆ getSignedDocSavePath()

String com.foxit.uiextensions.UIExtensionsManager.getSignedDocSavePath ( )
Returns
the path where the signed document is saved.

◆ getState()

int com.foxit.uiextensions.UIExtensionsManager.getState ( )

Get the read state.

Returns
Return the read state, should be one of ReadStateConfig.STATE_XXX

Implements com.foxit.uiextensions.IPDFReader.

◆ getToolHandlerByType()

ToolHandler com.foxit.uiextensions.UIExtensionsManager.getToolHandlerByType ( String  type)

get the specified ToolHandler from current UI extensions manager.

Parameters
typeThe tool handler type, refer to function ToolHandler#getType().
Returns
A ToolHandler object with specified type.

◆ handleActivityResult()

void com.foxit.uiextensions.UIExtensionsManager.handleActivityResult ( Activity  act,
int  requestCode,
int  resultCode,
Intent  data 
)

Receive and handle result from activity

Parameters
actThe current activity
requestCodeThe integer request code originally supplied to startActivityForResult(), allowing you to identify who this result came from.
resultCodeThe integer result code returned by the child activity through its setResult().
dataAn Intent, which can return result data to the caller (various data can be attached to Intent "extras"). Activity#onActivityResult(int, int, Intent) Fragment#onActivityResult(int, int, Intent)

◆ handleRequestPermissionsResult()

void com.foxit.uiextensions.UIExtensionsManager.handleRequestPermissionsResult ( int  requestCode,
@NonNull String[]  permissions,
@NonNull int[]  grantResults 
)

Receive and handle request permissions result from activity

Parameters
requestCodeThe request code passed in Activity#requestPermissions(String[], int).
permissionsThe requested permissions. Never null.
grantResultsThe grant results for the corresponding permissions which is either android.content.pm.PackageManager#PERMISSION_GRANTED or android.content.pm.PackageManager#PERMISSION_DENIED. Never null.

◆ handleSingleTapConfirmed()

boolean com.foxit.uiextensions.UIExtensionsManager.handleSingleTapConfirmed ( MotionEvent  motionEvent)

Receive and handle the single tap event.

Parameters
motionEventMotionEvent object which species the event.
Returns
true if the event is consumed, false otherwise.

◆ isAutoSaveDoc()

boolean com.foxit.uiextensions.UIExtensionsManager.isAutoSaveDoc ( )

Returns true if the document is automatically saved.

Returns
True if the document is automatically saved, false otherwise.

◆ isAutoSaveSignedDoc()

boolean com.foxit.uiextensions.UIExtensionsManager.isAutoSaveSignedDoc ( )

Returns true if the signed document is automatically saved.

Returns
True if the signed document is automatically saved, false otherwise.

◆ isContinueAddAnnot()

boolean com.foxit.uiextensions.UIExtensionsManager.isContinueAddAnnot ( )

Whether or not the annotation can be created continuously.

Returns
True the annotation can be created continuously or otherwise.

◆ isEnableModification()

boolean com.foxit.uiextensions.UIExtensionsManager.isEnableModification ( )

whether the pdf document can be modified

Returns
whether the pdf document can be modified

◆ isFormHighlightEnable()

boolean com.foxit.uiextensions.UIExtensionsManager.isFormHighlightEnable ( )

Check whether form highlight can be displayed.

Returns
True means form highlight can be displayed, false for else.

◆ isLinkHighlightEnabled()

boolean com.foxit.uiextensions.UIExtensionsManager.isLinkHighlightEnabled ( )

Check whether link highlight can be display.

Returns
True means link highlight can be displayed, false for else.

◆ isLinksEnabled()

boolean com.foxit.uiextensions.UIExtensionsManager.isLinksEnabled ( )

Check whether link annotation action event can be triggered.

Returns
True means link annotation action event can be triggered, false for else.

◆ isLoadAnnotModule()

boolean com.foxit.uiextensions.UIExtensionsManager.isLoadAnnotModule ( Annot  annot)

Check whether the specified annotation module that is loaded.

◆ isUseLogicalPageNumbers()

boolean com.foxit.uiextensions.UIExtensionsManager.isUseLogicalPageNumbers ( )

Whether to use logical pages.

Returns
True means use logical page numbers, false for else.

◆ loadAllModules()

void com.foxit.uiextensions.UIExtensionsManager.loadAllModules ( )
protected

By default, all modules will be loaded..

◆ onConfigurationChanged()

void com.foxit.uiextensions.UIExtensionsManager.onConfigurationChanged ( Activity  act,
Configuration  newConfig 
)

Should be called in Activity#onConfigurationChanged(Configuration) or Fragment#onConfigurationChanged(Configuration)

Parameters
actThe current activity
newConfigThe new device configuration.

◆ onCreate()

void com.foxit.uiextensions.UIExtensionsManager.onCreate ( Activity  act,
PDFViewCtrl  pdfViewCtrl,
Bundle  bundle 
)

◆ onDestroy()

void com.foxit.uiextensions.UIExtensionsManager.onDestroy ( Activity  act)

◆ onDoubleTap()

boolean com.foxit.uiextensions.UIExtensionsManager.onDoubleTap ( MotionEvent  e)

Triggered when PDFViewCtrl#onDoubleTap(MotionEvent) is called.

Parameters
eThe down motion event of the first tap of the double-tap.
Returns
true means the event is consumed.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IDoubleTapEventListener.

◆ onDoubleTapEvent()

boolean com.foxit.uiextensions.UIExtensionsManager.onDoubleTapEvent ( MotionEvent  e)

Triggered when PDFViewCtrl#onDoubleTapEvent(MotionEvent) is called.

Parameters
eThe motion event that occurred during the double-tap gesture.
Returns
true means the event is consumed.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IDoubleTapEventListener.

◆ onDown()

boolean com.foxit.uiextensions.UIExtensionsManager.onDown ( MotionEvent  e)

Triggered when PDFViewCtrl#onDown(MotionEvent) is called.

Parameters
eThe down motion event.
Returns
true means the event is consumed.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.

◆ onDraw()

void com.foxit.uiextensions.UIExtensionsManager.onDraw ( int  pageIndex,
Canvas  canvas 
)

Triggered when

Parameters
pageIndexThe page index.Valid range: from 0 to (count-1). count is the page count.
canvasThe canvas of pdf view control. PDFViewCtrl#onDraw(Canvas) is called.

Implements com.foxit.sdk.PDFViewCtrl.IDrawEventListener.

◆ onFling()

boolean com.foxit.uiextensions.UIExtensionsManager.onFling ( MotionEvent  e1,
MotionEvent  e2,
float  velocityX,
float  velocityY 
)

Triggered when PDFViewCtrl#onFling(MotionEvent, MotionEvent, float, float) is called.

Parameters
e1The first down motion event.
e2The move motion event.
velocityXThe velocity of this fling measured in pixels per second along the x axis.
velocityYThe velocity of this fling measured in pixels per second along the y axis.
Returns
true means the event is consumed.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.

◆ onHiddenChanged()

void com.foxit.uiextensions.UIExtensionsManager.onHiddenChanged ( boolean  hidden)

Should be called in Fragment#onHiddenChanged(boolean)

Parameters
hiddenTrue if the fragment is now hidden, false otherwise.

◆ onKeyDown()

boolean com.foxit.uiextensions.UIExtensionsManager.onKeyDown ( Activity  act,
int  keyCode,
KeyEvent  event 
)

Should be call in Activity#onKeyDown(int, KeyEvent)

Parameters
actThe current activity
keyCodeThe value in event.getKeyCode().
eventDescription of the key event.
Returns
Return true to prevent this event from being propagated further, or false to indicate that you have not handled this event and it should continue to be propagated. Activity#onKeyDown(int, KeyEvent)

◆ onLongPress()

void com.foxit.uiextensions.UIExtensionsManager.onLongPress ( MotionEvent  e)

Triggered when PDFViewCtrl#onLongPress(MotionEvent) is called.

Parameters
eThe initial on down motion event that started the longpress.

Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.

◆ onPause()

void com.foxit.uiextensions.UIExtensionsManager.onPause ( Activity  act)

Should be called in Activity#onPause() or Fragment#onPause()

◆ onResume()

void com.foxit.uiextensions.UIExtensionsManager.onResume ( Activity  act)

Should be called in Activity#onResume() or Fragment#onResume()

◆ onScale()

boolean com.foxit.uiextensions.UIExtensionsManager.onScale ( ScaleGestureDetector  detector)

Triggered when PDFViewCtrl#onScale(ScaleGestureDetector) is called.

Parameters
detectorThe detector reporting the event.
Returns
true means the detector should consider this event as handled.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IScaleGestureEventListener.

◆ onScaleBegin()

boolean com.foxit.uiextensions.UIExtensionsManager.onScaleBegin ( ScaleGestureDetector  detector)

Triggered when PDFViewCtrl#onScaleBegin(ScaleGestureDetector) is called.

Parameters
detectorThe detector reporting the event.
Returns
true means the detector should continue recognizing this gesture.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IScaleGestureEventListener.

◆ onScaleEnd()

void com.foxit.uiextensions.UIExtensionsManager.onScaleEnd ( ScaleGestureDetector  detector)

Triggered when PDFViewCtrl#onScaleEnd(ScaleGestureDetector) is called.

Parameters
detectorThe detector reporting the event.

Implements com.foxit.sdk.PDFViewCtrl.IScaleGestureEventListener.

◆ onScroll()

boolean com.foxit.uiextensions.UIExtensionsManager.onScroll ( MotionEvent  e1,
MotionEvent  e2,
float  distanceX,
float  distanceY 
)

Triggered when PDFViewCtrl#onScroll(MotionEvent, MotionEvent, float, float) is called.

Parameters
e1The first down motion event that started the scrolling.
e2The move motion event that triggered the current onScroll.
distanceXThe distance along the X axis that has been scrolled since the last call to onScroll.
distanceYThe distance along the Y axis that has been scrolled since the last call to onScroll.
Returns
true means the event is consumed.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.

◆ onShowPress()

void com.foxit.uiextensions.UIExtensionsManager.onShowPress ( MotionEvent  e)

Triggered when PDFViewCtrl#onShowPress(MotionEvent) is called.

Parameters
eThe down motion event.

Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.

◆ onSingleTapConfirmed()

boolean com.foxit.uiextensions.UIExtensionsManager.onSingleTapConfirmed ( MotionEvent  e)

Triggered when PDFViewCtrl#onSingleTapConfirmed(MotionEvent) is called.

Parameters
eThe down motion event of the single-tap.
Returns
true means the event is consumed.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IDoubleTapEventListener.

◆ onSingleTapUp()

boolean com.foxit.uiextensions.UIExtensionsManager.onSingleTapUp ( MotionEvent  e)

Triggered when PDFViewCtrl#onSingleTapUp(MotionEvent) is called.

Parameters
eThe up motion event that completed the first tap
Returns
true means the event is consumed.
false means not.

Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.

◆ onStart()

void com.foxit.uiextensions.UIExtensionsManager.onStart ( Activity  act)

Should be called in Activity#onStart() or Fragment#onStart()

◆ onStop()

void com.foxit.uiextensions.UIExtensionsManager.onStop ( Activity  act)

Should be called in Activity#onStop() or Fragment#onStop()

◆ onTouchEvent()

boolean com.foxit.uiextensions.UIExtensionsManager.onTouchEvent ( int  pageIndex,
MotionEvent  event 
)

Triggered when PDFViewCtrl#onTouchEvent(MotionEvent) is called.

Parameters
pageIndexThe page index.Valid range: from 0 to (count-1). count is the page count.
eventA MotionEvent object which species the event.
Returns
true means the event was handled, while false means not.

Implements com.foxit.sdk.PDFViewCtrl.UIExtensionsManager.

◆ onXFAPageRemoved()

void com.foxit.uiextensions.UIExtensionsManager.onXFAPageRemoved ( boolean  isSuccess,
int  pageIndex 
)

Called when the specified xfa page has removed.

◆ onXFAPagesInserted()

void com.foxit.uiextensions.UIExtensionsManager.onXFAPagesInserted ( boolean  isSuccess,
int  pageIndex 
)

Called when a xfa page has added in the specified position.

◆ onXFAWidgetAdded()

void com.foxit.uiextensions.UIExtensionsManager.onXFAWidgetAdded ( XFAWidget  xfaWidget)

Called when a XFAWidget has added.

◆ onXFAWidgetWillRemove()

void com.foxit.uiextensions.UIExtensionsManager.onXFAWidgetWillRemove ( XFAWidget  xfaWidget)

Called when a XFAWidget will be removed.

◆ openDocument() [1/2]

void com.foxit.uiextensions.UIExtensionsManager.openDocument ( FileReaderCallback  fileReader,
byte[]  password 
)

Open a PDF document with a file read callback object.

Parameters
fileReaderA FileReaderCallback object which is implemented by user to load a PDF document. It should not be null.
passwordA byte array which specifies the password used to load the PDF document content. It can be either user password or owner password. If the PDF document is not encrypted by password, just pass an empty string.

◆ openDocument() [2/2]

void com.foxit.uiextensions.UIExtensionsManager.openDocument ( String  path,
byte[]  password 
)

Open a PDF document from a specified PDF file path.

Parameters
pathA PDF file path.
passwordA byte array which specifies the password used to load the PDF document content. It can be either user password or owner password. If the PDF document is not encrypted by password, just pass an empty string.

◆ registerAnnotHandler()

void com.foxit.uiextensions.UIExtensionsManager.registerAnnotHandler ( AnnotHandler  handler)

Register the specified AnnotHandler to current UI extensions manager.

Parameters
handlerA AnnotHandler to use.

◆ registerConfigurationChangedListener()

void com.foxit.uiextensions.UIExtensionsManager.registerConfigurationChangedListener ( ConfigurationChangedListener  listener)

Register a callback to be invoked when the configuration changed.

Parameters
listenerthe configuration changed ConfigurationChangedListener

◆ registerDocModifiedEventListener()

void com.foxit.uiextensions.UIExtensionsManager.registerDocModifiedEventListener ( IDocModifiedEventListener  listener)

Register a document modified event listener.

Parameters
listenerAn IDocModifiedEventListener object to be registered.

◆ registerInteractionListener()

void com.foxit.uiextensions.UIExtensionsManager.registerInteractionListener ( IInteractionEventListener  listener)

Register a callback to be invoked when the interaction event happened.

Parameters
listenerthe interaction event IInteractionEventListener

◆ registerLifecycleListener()

◆ registerMenuEventListener()

void com.foxit.uiextensions.UIExtensionsManager.registerMenuEventListener ( MenuEventListener  listener)

Register a callback to be invoked when the menu event has triggered.

◆ registerModule()

void com.foxit.uiextensions.UIExtensionsManager.registerModule ( Module  module)

Register the specified module to current UI extensions manager.

Note: This method is only used within RDK

Parameters
moduleA Module object to be registered.

◆ registerPolicyEventListener()

void com.foxit.uiextensions.UIExtensionsManager.registerPolicyEventListener ( IPolicyEventListener  listener)

Register a callback to be invoked when the policy has changed.

Parameters
listenerThe policy event listener to be registered.

◆ registerSignatureEventListener()

void com.foxit.uiextensions.UIExtensionsManager.registerSignatureEventListener ( ISignatureEventListener  listener)

Register a signature related event listener.

Parameters
listenerAn ISignatureEventListener object to be registered.

◆ registerStateChangeListener()

boolean com.foxit.uiextensions.UIExtensionsManager.registerStateChangeListener ( IStateChangeListener  listener)

Register a callback to be invoked when the state changed.

Parameters
listenerthe IStateChangeListener to use.
Returns
true
register success or otherwise.

Implements com.foxit.uiextensions.IPDFReader.

◆ registerThemeEventListener()

void com.foxit.uiextensions.UIExtensionsManager.registerThemeEventListener ( IThemeEventListener  listener)

Register a callback to be invoked when the theme changed.

Parameters
listenerthe theme event IThemeEventListener

◆ registerToolHandler()

void com.foxit.uiextensions.UIExtensionsManager.registerToolHandler ( ToolHandler  handler)

Register the specified ToolHandler to current UI extensions manager.

Parameters
handlerA ToolHandler object to be registered.

◆ registerToolHandlerChangedListener()

void com.foxit.uiextensions.UIExtensionsManager.registerToolHandlerChangedListener ( ToolHandlerChangedListener  listener)

Register a callback to be invoked when the tool handler changed.

Note: This method is only used within RDK

◆ registerUIInteractionEventListener()

void com.foxit.uiextensions.UIExtensionsManager.registerUIInteractionEventListener ( IUIInteractionEventListener  listener)

Register a UI intercation related event listener.

Parameters
listenerAn IUIInteractionEventListener object to be registered.

◆ registerXFAPageEventListener()

void com.foxit.uiextensions.UIExtensionsManager.registerXFAPageEventListener ( IXFAPageEventListener  listener)

Register a xfa page event listener.

Parameters
listenerAn IPageEventListener object to be registered.

◆ registerXFAWidgetEventListener()

void com.foxit.uiextensions.UIExtensionsManager.registerXFAWidgetEventListener ( IXFAWidgetEventListener  listener)

Register a xfa widget event listener.

Parameters
listenerAn IXFAWidgetEventListener object to be registered.

◆ setAnnotationsPermission()

void com.foxit.uiextensions.UIExtensionsManager.setAnnotationsPermission ( IAnnotationsPermission  permission)

Add permission control to annotations on the basis of document permission

Parameters
permissioncustomize annotations permission IAnnotationsPermission

◆ setAnnotAuthor()

void com.foxit.uiextensions.UIExtensionsManager.setAnnotAuthor ( String  author)

Set annotation author

Parameters
authorthe author string to be set

◆ setAPPInfoProvider()

void com.foxit.uiextensions.UIExtensionsManager.setAPPInfoProvider ( IAppInfoProvider  provider)

This interface is used to set application information

Parameters
providerexample Set the application version name IAppInfoProvider

◆ setAttachedActivity()

void com.foxit.uiextensions.UIExtensionsManager.setAttachedActivity ( Activity  activity)

Set the attached activity.

If you want add a Note, FreeText, FileAttachment annotation; you must set the attached activity.

If you want to use the function of adding reply or comment to the annotation or about thumbnail, you must set the attached activity and it must be a FragmentActivity.

Parameters
activityThe attached activity.

◆ setAutoSaveDoc()

void com.foxit.uiextensions.UIExtensionsManager.setAutoSaveDoc ( boolean  autoSaveDoc)

Sets whether the document should be automatically saved.

Parameters
autoSaveDocTrue auto save document, false otherwise.

◆ setAutoSaveSignedDoc()

void com.foxit.uiextensions.UIExtensionsManager.setAutoSaveSignedDoc ( boolean  autoSaveSignedDoc)

Set to automatically save the signed document.

Note: if user don`t call setSignedDocSavePath(String) to set the path where the signed document will be saved, the signed document will be saved to the same path as the original file and "-signed" suffix should be added to the filename.

Parameters
autoSaveSignedDocTrue auto save signed document, false otherwise.

◆ setBackEventListener()

void com.foxit.uiextensions.UIExtensionsManager.setBackEventListener ( BackEventListener  listener)

Set a BackEventListener to be invoked when the back button clicked.

Parameters
listenerThe BackEventListener to use

Implements com.foxit.uiextensions.IPDFReader.

◆ setContinueAddAnnot()

void com.foxit.uiextensions.UIExtensionsManager.setContinueAddAnnot ( boolean  continueAddAnnot)

Set whether the annotation can be created continuously. The default is false.

Parameters
continueAddAnnotwhether the annot can be created continuously.

◆ setCurrentToolHandler()

void com.foxit.uiextensions.UIExtensionsManager.setCurrentToolHandler ( ToolHandler  toolHandler)

Set the current tool handler.

Parameters
toolHandlerA ToolHandler object which specifies the current tool handler.

◆ setFilePath()

void com.foxit.uiextensions.UIExtensionsManager.setFilePath ( String  path)

Set the file path

◆ setFormHighlightColor()

void com.foxit.uiextensions.UIExtensionsManager.setFormHighlightColor ( long  color)

Set form highlight color. If the document is opened, please call function PDFViewCtrl#updatePagesLayout() after setting the new value.

Parameters
colorthe form highlight color to be set

◆ setInkDrawingTimeout()

void com.foxit.uiextensions.UIExtensionsManager.setInkDrawingTimeout ( long  timeoutMillis)

Sets a timeout for Ink drawing. If the drawing action stops and exceeds the timeout, an Ink annotation will be automatically created.

The default value is -1, which disables the timeout. If the timeout value is less than or equal to 0, the timeout feature is disabled.

Parameters
timeoutMillisThe timeout duration in milliseconds. Default is -1 to disable.

◆ setInkDrawToolType()

void com.foxit.uiextensions.UIExtensionsManager.setInkDrawToolType ( int  toolType)

Set the ink drawing type.

Parameters
toolTypeThe ink drawing tool type. Must be one of: InkDrawToolType#STYLUS – draws ink only when using a stylus, or InkDrawToolType#STYLUS_OR_FINGER – automatically selects the drawing tool based on whether a finger or stylus is used.

◆ setLinkEventListener()

void com.foxit.uiextensions.UIExtensionsManager.setLinkEventListener ( ILinkEventListener  listener)

Set link event listener.

Parameters
listenerThe specified link event listener.

◆ setLinkHighlightColor()

void com.foxit.uiextensions.UIExtensionsManager.setLinkHighlightColor ( long  color)

Set the highlight color of link annotation.

Parameters
colorthe highlight color to be set

◆ setMeasurementUnits()

void com.foxit.uiextensions.UIExtensionsManager.setMeasurementUnits ( int  unit)

Set measurement units for page size information. The default value is inch.

Parameters
unitmeasurement units

◆ setNightColorMode()

void com.foxit.uiextensions.UIExtensionsManager.setNightColorMode ( int  nightColorMode)

Set the night color mode.

Parameters
nightColorModeThe night color mode. It should be one of NIGHTCOLORMODE_DEFAULT, NIGHTCOLORMODE_MAPPINGGRAY.

◆ setOnFinishListener()

void com.foxit.uiextensions.UIExtensionsManager.setOnFinishListener ( OnFinishListener  listener)

Set the OnFinishListener to be invoked when the document closed and current activity has exited.

Parameters
listenerthe OnFinishListener to use.

◆ setPageColorMode()

void com.foxit.uiextensions.UIExtensionsManager.setPageColorMode ( int  pageColorMode)

Set the page color mode.

Parameters
pageColorModeThe page color mode. It should be one of NIGHTCOLORMODE_DEFAULT, NIGHTCOLORMODE_MAPPINGGRAY.

◆ setSaveDocFlag()

void com.foxit.uiextensions.UIExtensionsManager.setSaveDocFlag ( int  flag)

Set the flag to be used when the document has saved

◆ setSavePath()

void com.foxit.uiextensions.UIExtensionsManager.setSavePath ( String  savePath)

Set the path where the document will be saved

◆ setSaveWriter()

void com.foxit.uiextensions.UIExtensionsManager.setSaveWriter ( FileWriterCallback  writer)

set the file writer callback where the document will be saved.

Parameters
writerFile writer callbackFileWriterCallback for the new saved PDF file.

◆ setSelectionHighlightColor()

void com.foxit.uiextensions.UIExtensionsManager.setSelectionHighlightColor ( int  color)

Set highlight color (including alpha) when select text.

Parameters
colorThe highlight color to be set.

◆ setSignedDocSavePath()

void com.foxit.uiextensions.UIExtensionsManager.setSignedDocSavePath ( String  savePath)

Set the full PDF file path where the signed document will be saved and it works when set to automatically save the signed document.

◆ setUpdateAnnotDefaultProperties()

void com.foxit.uiextensions.UIExtensionsManager.setUpdateAnnotDefaultProperties ( boolean  update)

Set whether to update the default properties of creating annot.

Parameters
updateTrue if you modify some properties of an annot, those properties will be used the next time when you create the same type of annot, false otherwise.

◆ setUseLogicalPageNumbers()

void com.foxit.uiextensions.UIExtensionsManager.setUseLogicalPageNumbers ( boolean  useLogicalPageNumbers)

Whether to use logical pages, default is false.

Parameters
useLogicalPageNumbersTrue means use logical page numbers, false for else.

◆ shouldViewCtrlDraw()

boolean com.foxit.uiextensions.UIExtensionsManager.shouldViewCtrlDraw ( Annot  annot)

Whether PDFViewCtrl draw the specified annotation.

Parameters
annotThe specified annotation.
Returns
true
means the annotation was drawn by PDFViewCtrl. while
false
means not.

Implements com.foxit.sdk.PDFViewCtrl.UIExtensionsManager.

◆ startPrintJob() [1/2]

void com.foxit.uiextensions.UIExtensionsManager.startPrintJob ( Context  context,
PDFDoc  pdfDoc,
String  printJobName,
String  fileName,
IPrintResultCallback  callback 
)

Print PDF documents and Static XFA documents(that is xfaDoc.getType() == XFADoc.e_Static)

Note: Only when OS version is Kitkat and above (Android API >= 19) the print function can be used

Parameters
contextThe context to use. it must be instanceof Activity.
pdfDocThe PDFDoc Object, it can not be empty .
printJobNameprint job name, it is can be null or empty.
fileNameThe document name which may be shown to the user and is the file name if the content it describes is saved as a PDF. Cannot be empty.
callbackprint callback IPrintResultCallback

◆ startPrintJob() [2/2]

void com.foxit.uiextensions.UIExtensionsManager.startPrintJob ( Context  context,
XFADoc  xfaDoc,
String  printJobName,
String  fileName,
IPrintResultCallback  callback 
)

Print Dynamic XFA documents (that is xfaDoc.getType() == XFADoc.e_Dynamic)

Note: Only when OS version is Kitkat and above (Android API >= 19) the print function can be used

Parameters
contextThe context to use. it must be instanceof Activity.
xfaDocThe XFADoc Object, it can not be empty .
printJobNameprint job name, it is can be null or empty.
fileNameThe document name which may be shown to the user and is the file name if the content it describes is saved as a PDF. Cannot be empty.
callbackprint callback IPrintResultCallback

◆ triggerDismissMenuEvent()

void com.foxit.uiextensions.UIExtensionsManager.triggerDismissMenuEvent ( )

Called when menu has dismissed.

◆ unregisterAnnotHandler()

void com.foxit.uiextensions.UIExtensionsManager.unregisterAnnotHandler ( AnnotHandler  handler)

Unregister the specified AnnotHandler from current UI extensions manager.

Parameters
handlerA AnnotHandler to use.

◆ unregisterConfigurationChangedListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterConfigurationChangedListener ( ConfigurationChangedListener  listener)

unregister the specified ConfigurationChangedListener.

Parameters
listenerthe specified ConfigurationChangedListener

◆ unregisterDocModifiedEventListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterDocModifiedEventListener ( IDocModifiedEventListener  listener)

Unregister a document modified event listener.

Parameters
listenerAn IDocModifiedEventListener object to be unregistered.

◆ unregisterInteractionListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterInteractionListener ( IInteractionEventListener  listener)

Unregister the interaction event listener.

Parameters
listenerthe interaction event IInteractionEventListener

◆ unregisterLifecycleListener()

boolean com.foxit.uiextensions.UIExtensionsManager.unregisterLifecycleListener ( ILifecycleEventListener  listener)

Unregister the specified ILifecycleEventListener

Parameters
listenerthe specified ILifecycleEventListener
Returns
true
unregister success or otherwise.

Implements com.foxit.uiextensions.IPDFReader.

◆ unregisterMenuEventListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterMenuEventListener ( MenuEventListener  listener)

Unregister the specified MenuEventListener

◆ unregisterModule()

void com.foxit.uiextensions.UIExtensionsManager.unregisterModule ( Module  module)

Unregister the specified module from current UI extensions manager. Note: This method is only used within RDK

Parameters
moduleA Module object to be unregistered.

◆ unregisterPolicyEventListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterPolicyEventListener ( IPolicyEventListener  listener)

Unregister a callback to be invoked when the policy has changed.

Parameters
listenerThe policy event listener to be unregistered.

◆ unregisterSignatureEventListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterSignatureEventListener ( ISignatureEventListener  listener)

Unregister a signature related event listener.

Parameters
listenerAn ISignatureEventListener object to be unregistered.

◆ unregisterStateChangeListener()

boolean com.foxit.uiextensions.UIExtensionsManager.unregisterStateChangeListener ( IStateChangeListener  listener)

Unregister the specified IStateChangeListener

Parameters
listenerthe specified IStateChangeListener
Returns
true
unregister success or otherwise.

Implements com.foxit.uiextensions.IPDFReader.

◆ unregisterThemeEventListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterThemeEventListener ( IThemeEventListener  listener)

Unregister the theme event listener.

Parameters
listenerthe theme event IThemeEventListener

◆ unregisterToolHandler()

void com.foxit.uiextensions.UIExtensionsManager.unregisterToolHandler ( ToolHandler  handler)

Unregister the specified ToolHandler from current UI extensions manager.

Note: This method is only used within RDK

Parameters
handlerA ToolHandler object to be unregistered.

◆ unregisterToolHandlerChangedListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterToolHandlerChangedListener ( ToolHandlerChangedListener  listener)

Unregister the ToolHandler changed listener.

Note: This method is only used within RDK

Parameters
listenera ToolHandlerChangedListener to use.

◆ unregisterUIInteractionEventListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterUIInteractionEventListener ( IUIInteractionEventListener  listener)

Unregister a UI intercation related event listener.

Parameters
listenerAn IUIInteractionEventListener object to be unregistered.

◆ unregisterXFAPageEventListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterXFAPageEventListener ( IXFAPageEventListener  listener)

Unregister a xfa page event listener.

Parameters
listenerAn IPageEventListener object to be unregistered.

◆ unregisterXFAWidgetEventListener()

void com.foxit.uiextensions.UIExtensionsManager.unregisterXFAWidgetEventListener ( IXFAWidgetEventListener  listener)

Unregister a xfa widget event listener.

Parameters
listenerAn IXFAWidgetEventListener object to be unregistered.

Member Data Documentation

◆ LINKTYPE_ANNOT

final int com.foxit.uiextensions.UIExtensionsManager.LINKTYPE_ANNOT = 0
static

link type: annotation

◆ LINKTYPE_TEXT

final int com.foxit.uiextensions.UIExtensionsManager.LINKTYPE_TEXT = 1
static

link type: text

◆ MEASUREMENT_UNIT_CM

final int com.foxit.uiextensions.UIExtensionsManager.MEASUREMENT_UNIT_CM = 1
static

measurement units: centermeters

◆ MEASUREMENT_UNIT_INCH

final int com.foxit.uiextensions.UIExtensionsManager.MEASUREMENT_UNIT_INCH = 0
static

measurement units: inch

◆ MEASUREMENT_UNIT_MM

final int com.foxit.uiextensions.UIExtensionsManager.MEASUREMENT_UNIT_MM = 2
static

measurement units: millimeters

◆ NIGHTCOLORMODE_DEFAULT

final int com.foxit.uiextensions.UIExtensionsManager.NIGHTCOLORMODE_DEFAULT = 0
static

night color mode: default

◆ NIGHTCOLORMODE_MAPPINGGRAY

final int com.foxit.uiextensions.UIExtensionsManager.NIGHTCOLORMODE_MAPPINGGRAY = 1
static

night color mode: mapping gray