Foxit PDF SDK
9.1
|
Classes | |
interface | ConfigurationChangedListener |
interface | IDocModifiedEventListener |
interface | ILinkEventListener |
interface | ISignatureEventListener |
class | LinkInfo |
interface | MenuEventListener |
interface | OnFinishListener |
interface | ToolHandlerChangedListener |
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 () |
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.
com.foxit.uiextensions.UIExtensionsManager.UIExtensionsManager | ( | Context | context, |
PDFViewCtrl | pdfViewCtrl | ||
) |
Instantiates a new UI extensions manager.
context | A Context object which species the context. |
pdfViewCtrl | A PDFViewCtrl object which species the PDF view control. |
com.foxit.uiextensions.UIExtensionsManager.UIExtensionsManager | ( | Context | context, |
PDFViewCtrl | pdfViewCtrl, | ||
Config | config | ||
) |
Instantiates a new UI extensions manager with modules config.
context | A Context object which species the context. |
pdfViewCtrl | A PDFViewCtrl object which species the PDF view control. |
config | A Config object which species a modules loading config, if null, UIExtension manager will load all modules by default, and equal to UIExtensionsManager(Context, PDFViewCtrl). |
boolean com.foxit.uiextensions.UIExtensionsManager.backToNormalState | ( | ) |
Show normal view reading state
void com.foxit.uiextensions.UIExtensionsManager.backToPrevActivity | ( | ) |
boolean com.foxit.uiextensions.UIExtensionsManager.canAddAnnot | ( | ) |
Check whether the document can add annotation
boolean com.foxit.uiextensions.UIExtensionsManager.canAssemble | ( | ) |
Check whether the document can be assemble.
boolean com.foxit.uiextensions.UIExtensionsManager.canModifyContents | ( | ) |
Check whether the document can be modified.
boolean com.foxit.uiextensions.UIExtensionsManager.canUpdateAnnotDefaultProperties | ( | ) |
Whether to update the default properties of creating annot.
void com.foxit.uiextensions.UIExtensionsManager.changeState | ( | int | state | ) |
Change the read state
state | should be one of ReadStateConfig.STATE_XXX |
Implements com.foxit.uiextensions.IPDFReader.
void com.foxit.uiextensions.UIExtensionsManager.enableAutoFullScreen | ( | boolean | enable | ) |
Set whether to automatically full screen, the default is true.
enable | If you set true, it will automatically full screen after a few seconds, hiding topbar and bottommbar,false otherwise. |
void com.foxit.uiextensions.UIExtensionsManager.enableBottomToolbar | ( | boolean | isEnabled | ) |
Whether show the bottom tool bar
isEnabled | True show the bottom tool bar, or otherwise. |
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.
enable | True means highlight color of form field. can be displayed, false for else. |
void com.foxit.uiextensions.UIExtensionsManager.enableLinkHighlight | ( | boolean | enable | ) |
Enable highlight color of link annotation
enable | True means highlight color of link annotation can be displayed, false for else. |
void com.foxit.uiextensions.UIExtensionsManager.enableLinks | ( | boolean | enable | ) |
Enable link annotation action event.
enable | True means link annotation action event can be triggered, false for else. |
void com.foxit.uiextensions.UIExtensionsManager.enableModification | ( | boolean | isEnabled | ) |
Set whether the pdf document can be modified. The default is allow modification.
isEnabled | whether the pdf document can be modified |
void com.foxit.uiextensions.UIExtensionsManager.enableSmallBottomToolbar | ( | boolean | isEnabled | ) |
Enable or disable small bottom toolbar.
isEnabled | Whether small bottom toolbar is enabled or not. |
void com.foxit.uiextensions.UIExtensionsManager.enableSmallTopToolbar | ( | boolean | isEnabled | ) |
Enable or disable small top toolbar.
isEnabled | Whether small top toolbar is enabled or not. |
void com.foxit.uiextensions.UIExtensionsManager.enableTopToolbar | ( | boolean | isEnabled | ) |
Whether show the top tool bar
isEnabled | True show the top tool bar, or otherwise. |
void com.foxit.uiextensions.UIExtensionsManager.exitPanZoomMode | ( | ) |
Exit the pan zoom mode.
IAnnotationsPermission com.foxit.uiextensions.UIExtensionsManager.getAnnotationsPermission | ( | ) |
Get permission control to annotations on the basis of document permission.
String com.foxit.uiextensions.UIExtensionsManager.getAnnotAuthor | ( | ) |
Get annotation author string. The default author is "foxit sdk"
AnnotHandler com.foxit.uiextensions.UIExtensionsManager.getAnnotHandlerByType | ( | int | type | ) |
Get the specified AnnotHandler from current UI extensions manager.
type | The type of AnnotHandler, refer to AnnotHandler#getType(); |
IAppInfoProvider com.foxit.uiextensions.UIExtensionsManager.getAPPInfoProvider | ( | ) |
Get Interface for applying related information
Activity com.foxit.uiextensions.UIExtensionsManager.getAttachedActivity | ( | ) |
Get the attached activity.
BackEventListener com.foxit.uiextensions.UIExtensionsManager.getBackEventListener | ( | ) |
Implements com.foxit.uiextensions.IPDFReader.
IBarsHandler com.foxit.uiextensions.UIExtensionsManager.getBarManager | ( | ) |
Get bar manager
Implements com.foxit.uiextensions.IPDFReader.
RelativeLayout com.foxit.uiextensions.UIExtensionsManager.getContentView | ( | ) |
Implements com.foxit.uiextensions.IPDFReader.
AnnotHandler com.foxit.uiextensions.UIExtensionsManager.getCurrentAnnotHandler | ( | ) |
String com.foxit.uiextensions.UIExtensionsManager.getCurrentSelectedText | ( | ) |
Get current selected text content from text select tool handler.
ToolHandler com.foxit.uiextensions.UIExtensionsManager.getCurrentToolHandler | ( | ) |
Get the current tool handler.
ToolHandler
object which specifies the current tool handler. DocumentManager com.foxit.uiextensions.UIExtensionsManager.getDocumentManager | ( | ) |
Implements com.foxit.uiextensions.IPDFReader.
Annot com.foxit.uiextensions.UIExtensionsManager.getFocusAnnot | ( | ) |
Get the focus annotation.
Implements com.foxit.sdk.PDFViewCtrl.UIExtensionsManager.
long com.foxit.uiextensions.UIExtensionsManager.getFormHighlightColor | ( | ) |
Get the highlight color of form field.
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.
int com.foxit.uiextensions.UIExtensionsManager.getInkDrawToolType | ( | ) |
Get the ink drawing type.
ILinkEventListener com.foxit.uiextensions.UIExtensionsManager.getLinkEventListener | ( | ) |
Get link event listener object.
long com.foxit.uiextensions.UIExtensionsManager.getLinkHighlightColor | ( | ) |
get the highlight color of link annotation.
IMainFrame com.foxit.uiextensions.UIExtensionsManager.getMainFrame | ( | ) |
Get the IMainFrame of the UI extension.
Implements com.foxit.uiextensions.IPDFReader.
int com.foxit.uiextensions.UIExtensionsManager.getMeasurementUnits | ( | ) |
Get measurement units for page size information
IMenuView com.foxit.uiextensions.UIExtensionsManager.getMenuView | ( | ) |
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.
Implements com.foxit.uiextensions.IPDFReader.
Module com.foxit.uiextensions.UIExtensionsManager.getModuleByName | ( | String | name | ) |
Get the specified module from current UI extensions manager.
name | The specified module name, refer to Module#getName(). |
Module
object with specified module name. int com.foxit.uiextensions.UIExtensionsManager.getNightColorMode | ( | ) |
Get the night color mode.
int com.foxit.uiextensions.UIExtensionsManager.getPageColorMode | ( | ) |
Get the page color mode.
IPanelManager com.foxit.uiextensions.UIExtensionsManager.getPanelManager | ( | ) |
Get the interface to handle the creation, display, hiding, layout, and interaction of panels.
PDFViewCtrl com.foxit.uiextensions.UIExtensionsManager.getPDFViewCtrl | ( | ) |
Get the pdf view control
Implements com.foxit.uiextensions.IPDFReader.
ViewGroup com.foxit.uiextensions.UIExtensionsManager.getRootView | ( | ) |
int com.foxit.uiextensions.UIExtensionsManager.getSaveDocFlag | ( | ) |
Get the flag while saving a document has used
String com.foxit.uiextensions.UIExtensionsManager.getSavePath | ( | ) |
FileWriterCallback com.foxit.uiextensions.UIExtensionsManager.getSaveWriter | ( | ) |
int com.foxit.uiextensions.UIExtensionsManager.getSelectionHighlightColor | ( | ) |
Get highlight color (including alpha) when text has selected.
IViewSettingsWindow com.foxit.uiextensions.UIExtensionsManager.getSettingWindow | ( | ) |
Note: If you want to use this,, it must be used after UIExtensionsManager#onCreate(Activity, PDFViewCtrl, Bundle)
Implements com.foxit.uiextensions.IPDFReader.
String com.foxit.uiextensions.UIExtensionsManager.getSignedDocSavePath | ( | ) |
int com.foxit.uiextensions.UIExtensionsManager.getState | ( | ) |
Get the read state.
ReadStateConfig.STATE_XXX
Implements com.foxit.uiextensions.IPDFReader.
ToolHandler com.foxit.uiextensions.UIExtensionsManager.getToolHandlerByType | ( | String | type | ) |
get the specified ToolHandler from current UI extensions manager.
type | The tool handler type, refer to function ToolHandler#getType(). |
ToolHandler
object with specified type. void com.foxit.uiextensions.UIExtensionsManager.handleActivityResult | ( | Activity | act, |
int | requestCode, | ||
int | resultCode, | ||
Intent | data | ||
) |
Receive and handle result from activity
act | The current activity |
requestCode | The integer request code originally supplied to startActivityForResult(), allowing you to identify who this result came from. |
resultCode | The integer result code returned by the child activity through its setResult(). |
data | An 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) |
void com.foxit.uiextensions.UIExtensionsManager.handleRequestPermissionsResult | ( | int | requestCode, |
@NonNull String[] | permissions, | ||
@NonNull int[] | grantResults | ||
) |
Receive and handle request permissions result from activity
requestCode | The request code passed in Activity#requestPermissions(String[], int). |
permissions | The requested permissions. Never null. |
grantResults | The grant results for the corresponding permissions which is either android.content.pm.PackageManager#PERMISSION_GRANTED or android.content.pm.PackageManager#PERMISSION_DENIED. Never null. |
boolean com.foxit.uiextensions.UIExtensionsManager.handleSingleTapConfirmed | ( | MotionEvent | motionEvent | ) |
Receive and handle the single tap event.
motionEvent | MotionEvent object which species the event. |
boolean com.foxit.uiextensions.UIExtensionsManager.isAutoSaveDoc | ( | ) |
Returns true if the document is automatically saved.
boolean com.foxit.uiextensions.UIExtensionsManager.isAutoSaveSignedDoc | ( | ) |
Returns true if the signed document is automatically saved.
boolean com.foxit.uiextensions.UIExtensionsManager.isContinueAddAnnot | ( | ) |
Whether or not the annotation can be created continuously.
True
the annotation can be created continuously or otherwise. boolean com.foxit.uiextensions.UIExtensionsManager.isEnableModification | ( | ) |
whether the pdf document can be modified
boolean com.foxit.uiextensions.UIExtensionsManager.isFormHighlightEnable | ( | ) |
Check whether form highlight can be displayed.
boolean com.foxit.uiextensions.UIExtensionsManager.isLinkHighlightEnabled | ( | ) |
Check whether link highlight can be display.
boolean com.foxit.uiextensions.UIExtensionsManager.isLinksEnabled | ( | ) |
Check whether link annotation action event can be triggered.
boolean com.foxit.uiextensions.UIExtensionsManager.isLoadAnnotModule | ( | Annot | annot | ) |
Check whether the specified annotation module that is loaded.
boolean com.foxit.uiextensions.UIExtensionsManager.isUseLogicalPageNumbers | ( | ) |
Whether to use logical pages.
|
protected |
By default, all modules will be loaded..
void com.foxit.uiextensions.UIExtensionsManager.onConfigurationChanged | ( | Activity | act, |
Configuration | newConfig | ||
) |
Should be called in Activity#onConfigurationChanged(Configuration) or Fragment#onConfigurationChanged(Configuration)
act | The current activity |
newConfig | The new device configuration. |
void com.foxit.uiextensions.UIExtensionsManager.onCreate | ( | Activity | act, |
PDFViewCtrl | pdfViewCtrl, | ||
Bundle | bundle | ||
) |
Should be called in Activity#onCreate(Bundle) or Fragment#onCreate(Bundle)
void com.foxit.uiextensions.UIExtensionsManager.onDestroy | ( | Activity | act | ) |
Should be called in Activity#onDestroy() or Fragment#onDestroy()
boolean com.foxit.uiextensions.UIExtensionsManager.onDoubleTap | ( | MotionEvent | e | ) |
Triggered when PDFViewCtrl#onDoubleTap(MotionEvent) is called.
e | The down motion event of the first tap of the double-tap. |
true
means the event is consumed.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IDoubleTapEventListener.
boolean com.foxit.uiextensions.UIExtensionsManager.onDoubleTapEvent | ( | MotionEvent | e | ) |
Triggered when PDFViewCtrl#onDoubleTapEvent(MotionEvent) is called.
e | The motion event that occurred during the double-tap gesture. |
true
means the event is consumed.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IDoubleTapEventListener.
boolean com.foxit.uiextensions.UIExtensionsManager.onDown | ( | MotionEvent | e | ) |
Triggered when PDFViewCtrl#onDown(MotionEvent) is called.
e | The down motion event. |
true
means the event is consumed.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.
void com.foxit.uiextensions.UIExtensionsManager.onDraw | ( | int | pageIndex, |
Canvas | canvas | ||
) |
Triggered when
pageIndex | The page index.Valid range: from 0 to (count -1). count is the page count. |
canvas | The canvas of pdf view control. PDFViewCtrl#onDraw(Canvas) is called. |
Implements com.foxit.sdk.PDFViewCtrl.IDrawEventListener.
boolean com.foxit.uiextensions.UIExtensionsManager.onFling | ( | MotionEvent | e1, |
MotionEvent | e2, | ||
float | velocityX, | ||
float | velocityY | ||
) |
Triggered when PDFViewCtrl#onFling(MotionEvent, MotionEvent, float, float) is called.
e1 | The first down motion event. |
e2 | The move motion event. |
velocityX | The velocity of this fling measured in pixels per second along the x axis. |
velocityY | The velocity of this fling measured in pixels per second along the y axis. |
true
means the event is consumed.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.
void com.foxit.uiextensions.UIExtensionsManager.onHiddenChanged | ( | boolean | hidden | ) |
Should be called in Fragment#onHiddenChanged(boolean)
hidden | True if the fragment is now hidden, false otherwise. |
boolean com.foxit.uiextensions.UIExtensionsManager.onKeyDown | ( | Activity | act, |
int | keyCode, | ||
KeyEvent | event | ||
) |
Should be call in Activity#onKeyDown(int, KeyEvent)
act | The current activity |
keyCode | The value in event.getKeyCode(). |
event | Description of the key event. |
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) void com.foxit.uiextensions.UIExtensionsManager.onLongPress | ( | MotionEvent | e | ) |
Triggered when PDFViewCtrl#onLongPress(MotionEvent) is called.
e | The initial on down motion event that started the longpress. |
Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.
void com.foxit.uiextensions.UIExtensionsManager.onPause | ( | Activity | act | ) |
Should be called in Activity#onPause() or Fragment#onPause()
void com.foxit.uiextensions.UIExtensionsManager.onResume | ( | Activity | act | ) |
Should be called in Activity#onResume() or Fragment#onResume()
boolean com.foxit.uiextensions.UIExtensionsManager.onScale | ( | ScaleGestureDetector | detector | ) |
Triggered when PDFViewCtrl#onScale(ScaleGestureDetector) is called.
detector | The detector reporting the event. |
true
means the detector should consider this event as handled.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IScaleGestureEventListener.
boolean com.foxit.uiextensions.UIExtensionsManager.onScaleBegin | ( | ScaleGestureDetector | detector | ) |
Triggered when PDFViewCtrl#onScaleBegin(ScaleGestureDetector) is called.
detector | The detector reporting the event. |
true
means the detector should continue recognizing this gesture.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IScaleGestureEventListener.
void com.foxit.uiextensions.UIExtensionsManager.onScaleEnd | ( | ScaleGestureDetector | detector | ) |
Triggered when PDFViewCtrl#onScaleEnd(ScaleGestureDetector) is called.
detector | The detector reporting the event. |
Implements com.foxit.sdk.PDFViewCtrl.IScaleGestureEventListener.
boolean com.foxit.uiextensions.UIExtensionsManager.onScroll | ( | MotionEvent | e1, |
MotionEvent | e2, | ||
float | distanceX, | ||
float | distanceY | ||
) |
Triggered when PDFViewCtrl#onScroll(MotionEvent, MotionEvent, float, float) is called.
e1 | The first down motion event that started the scrolling. |
e2 | The move motion event that triggered the current onScroll. |
distanceX | The distance along the X axis that has been scrolled since the last call to onScroll. |
distanceY | The distance along the Y axis that has been scrolled since the last call to onScroll. |
true
means the event is consumed.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.
void com.foxit.uiextensions.UIExtensionsManager.onShowPress | ( | MotionEvent | e | ) |
Triggered when PDFViewCtrl#onShowPress(MotionEvent) is called.
e | The down motion event. |
Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.
boolean com.foxit.uiextensions.UIExtensionsManager.onSingleTapConfirmed | ( | MotionEvent | e | ) |
Triggered when PDFViewCtrl#onSingleTapConfirmed(MotionEvent) is called.
e | The down motion event of the single-tap. |
true
means the event is consumed.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IDoubleTapEventListener.
boolean com.foxit.uiextensions.UIExtensionsManager.onSingleTapUp | ( | MotionEvent | e | ) |
Triggered when PDFViewCtrl#onSingleTapUp(MotionEvent) is called.
e | The up motion event that completed the first tap |
true
means the event is consumed.false
means not. Implements com.foxit.sdk.PDFViewCtrl.IGestureEventListener.
void com.foxit.uiextensions.UIExtensionsManager.onStart | ( | Activity | act | ) |
Should be called in Activity#onStart() or Fragment#onStart()
void com.foxit.uiextensions.UIExtensionsManager.onStop | ( | Activity | act | ) |
Should be called in Activity#onStop() or Fragment#onStop()
boolean com.foxit.uiextensions.UIExtensionsManager.onTouchEvent | ( | int | pageIndex, |
MotionEvent | event | ||
) |
Triggered when PDFViewCtrl#onTouchEvent(MotionEvent) is called.
pageIndex | The page index.Valid range: from 0 to (count -1). count is the page count. |
event | A MotionEvent object which species the event. |
true
means the event was handled, while false
means not. Implements com.foxit.sdk.PDFViewCtrl.UIExtensionsManager.
void com.foxit.uiextensions.UIExtensionsManager.onXFAPageRemoved | ( | boolean | isSuccess, |
int | pageIndex | ||
) |
Called when the specified xfa page has removed.
void com.foxit.uiextensions.UIExtensionsManager.onXFAPagesInserted | ( | boolean | isSuccess, |
int | pageIndex | ||
) |
Called when a xfa page has added in the specified position.
void com.foxit.uiextensions.UIExtensionsManager.onXFAWidgetAdded | ( | XFAWidget | xfaWidget | ) |
Called when a XFAWidget has added.
void com.foxit.uiextensions.UIExtensionsManager.onXFAWidgetWillRemove | ( | XFAWidget | xfaWidget | ) |
Called when a XFAWidget will be removed.
void com.foxit.uiextensions.UIExtensionsManager.openDocument | ( | FileReaderCallback | fileReader, |
byte[] | password | ||
) |
Open a PDF document with a file read callback object.
fileReader | A FileReaderCallback object which is implemented by user to load a PDF document. It should not be null. |
password | A 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. |
void com.foxit.uiextensions.UIExtensionsManager.openDocument | ( | String | path, |
byte[] | password | ||
) |
Open a PDF document from a specified PDF file path.
path | A PDF file path. |
password | A 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. |
void com.foxit.uiextensions.UIExtensionsManager.registerAnnotHandler | ( | AnnotHandler | handler | ) |
Register the specified AnnotHandler to current UI extensions manager.
handler | A AnnotHandler to use. |
void com.foxit.uiextensions.UIExtensionsManager.registerConfigurationChangedListener | ( | ConfigurationChangedListener | listener | ) |
Register a callback to be invoked when the configuration changed.
listener | the configuration changed ConfigurationChangedListener |
void com.foxit.uiextensions.UIExtensionsManager.registerDocModifiedEventListener | ( | IDocModifiedEventListener | listener | ) |
Register a document modified event listener.
listener | An IDocModifiedEventListener object to be registered. |
void com.foxit.uiextensions.UIExtensionsManager.registerInteractionListener | ( | IInteractionEventListener | listener | ) |
Register a callback to be invoked when the interaction event happened.
listener | the interaction event IInteractionEventListener |
boolean com.foxit.uiextensions.UIExtensionsManager.registerLifecycleListener | ( | ILifecycleEventListener | listener | ) |
Register a callback to be invoked when the activity of fragment lifecycle ILifecycleEventListener#onCreate(Activity, Bundle), ILifecycleEventListener#onStart(Activity), ILifecycleEventListener#onPause(Activity), ILifecycleEventListener#onResume(Activity), ILifecycleEventListener#onStop(Activity), ILifecycleEventListener#onDestroy(Activity), ILifecycleEventListener#onSaveInstanceState(Activity, Bundle), ILifecycleEventListener#onHiddenChanged(boolean), ILifecycleEventListener#onActivityResult(Activity, int, int, Intent) executing.
listener | the specified ILifecycleEventListener |
Implements com.foxit.uiextensions.IPDFReader.
void com.foxit.uiextensions.UIExtensionsManager.registerMenuEventListener | ( | MenuEventListener | listener | ) |
Register a callback to be invoked when the menu event has triggered.
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
module | A Module object to be registered. |
void com.foxit.uiextensions.UIExtensionsManager.registerPolicyEventListener | ( | IPolicyEventListener | listener | ) |
Register a callback to be invoked when the policy has changed.
listener | The policy event listener to be registered. |
void com.foxit.uiextensions.UIExtensionsManager.registerSignatureEventListener | ( | ISignatureEventListener | listener | ) |
Register a signature related event listener.
listener | An ISignatureEventListener object to be registered. |
boolean com.foxit.uiextensions.UIExtensionsManager.registerStateChangeListener | ( | IStateChangeListener | listener | ) |
Register a callback to be invoked when the state changed.
listener | the IStateChangeListener to use. |
Implements com.foxit.uiextensions.IPDFReader.
void com.foxit.uiextensions.UIExtensionsManager.registerThemeEventListener | ( | IThemeEventListener | listener | ) |
Register a callback to be invoked when the theme changed.
listener | the theme event IThemeEventListener |
void com.foxit.uiextensions.UIExtensionsManager.registerToolHandler | ( | ToolHandler | handler | ) |
Register the specified ToolHandler to current UI extensions manager.
handler | A ToolHandler object to be registered. |
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
void com.foxit.uiextensions.UIExtensionsManager.registerUIInteractionEventListener | ( | IUIInteractionEventListener | listener | ) |
Register a UI intercation related event listener.
listener | An IUIInteractionEventListener object to be registered. |
void com.foxit.uiextensions.UIExtensionsManager.registerXFAPageEventListener | ( | IXFAPageEventListener | listener | ) |
Register a xfa page event listener.
listener | An IPageEventListener object to be registered. |
void com.foxit.uiextensions.UIExtensionsManager.registerXFAWidgetEventListener | ( | IXFAWidgetEventListener | listener | ) |
Register a xfa widget event listener.
listener | An IXFAWidgetEventListener object to be registered. |
void com.foxit.uiextensions.UIExtensionsManager.setAnnotationsPermission | ( | IAnnotationsPermission | permission | ) |
Add permission control to annotations on the basis of document permission
permission | customize annotations permission IAnnotationsPermission |
void com.foxit.uiextensions.UIExtensionsManager.setAnnotAuthor | ( | String | author | ) |
Set annotation author
author | the author string to be set |
void com.foxit.uiextensions.UIExtensionsManager.setAPPInfoProvider | ( | IAppInfoProvider | provider | ) |
This interface is used to set application information
provider | example Set the application version name IAppInfoProvider |
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.
activity | The attached activity. |
void com.foxit.uiextensions.UIExtensionsManager.setAutoSaveDoc | ( | boolean | autoSaveDoc | ) |
Sets whether the document should be automatically saved.
autoSaveDoc | True auto save document, false otherwise. |
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.
autoSaveSignedDoc | True auto save signed document, false otherwise. |
void com.foxit.uiextensions.UIExtensionsManager.setBackEventListener | ( | BackEventListener | listener | ) |
Set a BackEventListener to be invoked when the back button clicked.
listener | The BackEventListener to use |
Implements com.foxit.uiextensions.IPDFReader.
void com.foxit.uiextensions.UIExtensionsManager.setContinueAddAnnot | ( | boolean | continueAddAnnot | ) |
Set whether the annotation can be created continuously. The default is false.
continueAddAnnot | whether the annot can be created continuously. |
void com.foxit.uiextensions.UIExtensionsManager.setCurrentToolHandler | ( | ToolHandler | toolHandler | ) |
Set the current tool handler.
toolHandler | A ToolHandler object which specifies the current tool handler. |
void com.foxit.uiextensions.UIExtensionsManager.setFilePath | ( | String | path | ) |
Set the file path
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.
color | the form highlight color to be set |
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.
timeoutMillis | The timeout duration in milliseconds. Default is -1 to disable. |
void com.foxit.uiextensions.UIExtensionsManager.setInkDrawToolType | ( | int | toolType | ) |
Set the ink drawing type.
toolType | 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. |
void com.foxit.uiextensions.UIExtensionsManager.setLinkEventListener | ( | ILinkEventListener | listener | ) |
Set link event listener.
listener | The specified link event listener. |
void com.foxit.uiextensions.UIExtensionsManager.setLinkHighlightColor | ( | long | color | ) |
Set the highlight color of link annotation.
color | the highlight color to be set |
void com.foxit.uiextensions.UIExtensionsManager.setMeasurementUnits | ( | int | unit | ) |
Set measurement units for page size information. The default value is inch.
unit | measurement units |
void com.foxit.uiextensions.UIExtensionsManager.setNightColorMode | ( | int | nightColorMode | ) |
Set the night color mode.
nightColorMode | The night color mode. It should be one of NIGHTCOLORMODE_DEFAULT, NIGHTCOLORMODE_MAPPINGGRAY. |
void com.foxit.uiextensions.UIExtensionsManager.setOnFinishListener | ( | OnFinishListener | listener | ) |
Set the OnFinishListener to be invoked when the document closed and current activity has exited.
listener | the OnFinishListener to use. |
void com.foxit.uiextensions.UIExtensionsManager.setPageColorMode | ( | int | pageColorMode | ) |
Set the page color mode.
pageColorMode | The page color mode. It should be one of NIGHTCOLORMODE_DEFAULT, NIGHTCOLORMODE_MAPPINGGRAY. |
void com.foxit.uiextensions.UIExtensionsManager.setSaveDocFlag | ( | int | flag | ) |
Set the flag to be used when the document has saved
void com.foxit.uiextensions.UIExtensionsManager.setSavePath | ( | String | savePath | ) |
Set the path where the document will be saved
void com.foxit.uiextensions.UIExtensionsManager.setSaveWriter | ( | FileWriterCallback | writer | ) |
set the file writer callback where the document will be saved.
writer | File writer callbackFileWriterCallback for the new saved PDF file. |
void com.foxit.uiextensions.UIExtensionsManager.setSelectionHighlightColor | ( | int | color | ) |
Set highlight color (including alpha) when select text.
color | The highlight color to be set. |
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.
void com.foxit.uiextensions.UIExtensionsManager.setUpdateAnnotDefaultProperties | ( | boolean | update | ) |
Set whether to update the default properties of creating annot.
update | 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. |
void com.foxit.uiextensions.UIExtensionsManager.setUseLogicalPageNumbers | ( | boolean | useLogicalPageNumbers | ) |
Whether to use logical pages, default is false.
useLogicalPageNumbers | True means use logical page numbers, false for else. |
boolean com.foxit.uiextensions.UIExtensionsManager.shouldViewCtrlDraw | ( | Annot | annot | ) |
Whether PDFViewCtrl draw the specified annotation.
annot | The specified annotation. |
Implements com.foxit.sdk.PDFViewCtrl.UIExtensionsManager.
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
context | The context to use. it must be instanceof Activity. |
pdfDoc | The PDFDoc Object, it can not be empty . |
printJobName | print job name, it is can be null or empty. |
fileName | The 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. |
callback | print callback IPrintResultCallback |
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
context | The context to use. it must be instanceof Activity. |
xfaDoc | The XFADoc Object, it can not be empty . |
printJobName | print job name, it is can be null or empty. |
fileName | The 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. |
callback | print callback IPrintResultCallback |
void com.foxit.uiextensions.UIExtensionsManager.triggerDismissMenuEvent | ( | ) |
Called when menu has dismissed.
void com.foxit.uiextensions.UIExtensionsManager.unregisterAnnotHandler | ( | AnnotHandler | handler | ) |
Unregister the specified AnnotHandler from current UI extensions manager.
handler | A AnnotHandler to use. |
void com.foxit.uiextensions.UIExtensionsManager.unregisterConfigurationChangedListener | ( | ConfigurationChangedListener | listener | ) |
unregister the specified ConfigurationChangedListener.
listener | the specified ConfigurationChangedListener |
void com.foxit.uiextensions.UIExtensionsManager.unregisterDocModifiedEventListener | ( | IDocModifiedEventListener | listener | ) |
Unregister a document modified event listener.
listener | An IDocModifiedEventListener object to be unregistered. |
void com.foxit.uiextensions.UIExtensionsManager.unregisterInteractionListener | ( | IInteractionEventListener | listener | ) |
Unregister the interaction event listener.
listener | the interaction event IInteractionEventListener |
boolean com.foxit.uiextensions.UIExtensionsManager.unregisterLifecycleListener | ( | ILifecycleEventListener | listener | ) |
Unregister the specified ILifecycleEventListener
listener | the specified ILifecycleEventListener |
Implements com.foxit.uiextensions.IPDFReader.
void com.foxit.uiextensions.UIExtensionsManager.unregisterMenuEventListener | ( | MenuEventListener | listener | ) |
Unregister the specified MenuEventListener
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
module | A Module object to be unregistered. |
void com.foxit.uiextensions.UIExtensionsManager.unregisterPolicyEventListener | ( | IPolicyEventListener | listener | ) |
Unregister a callback to be invoked when the policy has changed.
listener | The policy event listener to be unregistered. |
void com.foxit.uiextensions.UIExtensionsManager.unregisterSignatureEventListener | ( | ISignatureEventListener | listener | ) |
Unregister a signature related event listener.
listener | An ISignatureEventListener object to be unregistered. |
boolean com.foxit.uiextensions.UIExtensionsManager.unregisterStateChangeListener | ( | IStateChangeListener | listener | ) |
Unregister the specified IStateChangeListener
listener | the specified IStateChangeListener |
Implements com.foxit.uiextensions.IPDFReader.
void com.foxit.uiextensions.UIExtensionsManager.unregisterThemeEventListener | ( | IThemeEventListener | listener | ) |
Unregister the theme event listener.
listener | the theme event IThemeEventListener |
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
handler | A ToolHandler object to be unregistered. |
void com.foxit.uiextensions.UIExtensionsManager.unregisterToolHandlerChangedListener | ( | ToolHandlerChangedListener | listener | ) |
Unregister the ToolHandler changed listener.
Note: This method is only used within RDK
listener | a ToolHandlerChangedListener to use. |
void com.foxit.uiextensions.UIExtensionsManager.unregisterUIInteractionEventListener | ( | IUIInteractionEventListener | listener | ) |
Unregister a UI intercation related event listener.
listener | An IUIInteractionEventListener object to be unregistered. |
void com.foxit.uiextensions.UIExtensionsManager.unregisterXFAPageEventListener | ( | IXFAPageEventListener | listener | ) |
Unregister a xfa page event listener.
listener | An IPageEventListener object to be unregistered. |
void com.foxit.uiextensions.UIExtensionsManager.unregisterXFAWidgetEventListener | ( | IXFAWidgetEventListener | listener | ) |
Unregister a xfa widget event listener.
listener | An IXFAWidgetEventListener object to be unregistered. |
|
static |
link type: annotation
|
static |
link type: text
|
static |
measurement units: centermeters
|
static |
measurement units: inch
|
static |
measurement units: millimeters
|
static |
night color mode: default
|
static |
night color mode: mapping gray