Foxit PDF SDK  9.1
com.foxit.uiextensions.DocumentManager Class Reference

Inherits AbstractUndo.

Public Member Functions

void setActionCallback (ActionCallback handler)
 
ActionCallback getActionCallback ()
 
void resetActionCallback ()
 
void setCurrentAnnot (Annot annot)
 
void setCurrentAnnot (Annot annot, boolean reRender)
 
Annot getCurrentAnnot ()
 
boolean canPrint ()
 
boolean canPrintHighQuality ()
 
boolean canCopy ()
 
boolean canCopyForAssess ()
 
boolean canAssemble ()
 
boolean canModifyContents ()
 
boolean canFillForm ()
 
boolean canAddAnnot ()
 
boolean canEdit ()
 
boolean canSigning ()
 
boolean canAddSignature ()
 
boolean canModifyForm ()
 
boolean canModifyXFAForm ()
 
boolean hasForm ()
 
boolean canModifyFile ()
 
boolean canSaveAsFile ()
 
boolean isSign ()
 
boolean isXFA ()
 
void registerAnnotEventListener (AnnotEventListener listener)
 
void unregisterAnnotEventListener (AnnotEventListener listener)
 
void registerFlattenEventListener (IFlattenEventListener listener)
 
void unregisterFlattenEventListener (IFlattenEventListener listener)
 
void registerGroupEventListener (IGroupEventListener listener)
 
void unregisterGroupEventListener (IGroupEventListener listener)
 
void registerRedactionEventListener (IRedactionEventListener listener)
 
void unregisterRedactionEventListener (IRedactionEventListener listener)
 
void registerImportedAnnotsEventListener (IImportAnnotsEventListener listener)
 
void unregisterImportedAnnotsEventListener (IImportAnnotsEventListener listener)
 
boolean isDocModified ()
 
void setDocModified (boolean isModified)
 
boolean simpleCheckPDFA (@NonNull PDFDoc pdfDoc)
 
void setAnnotationsPermission (IAnnotationsPermission permission)
 
IAnnotationsPermission getAnnotationsPermission ()
 

Detailed Description

Management for PDF document annotations, pages, permissions, and so on. This implementation is shared with all the modules.

Member Function Documentation

◆ canAddAnnot()

boolean com.foxit.uiextensions.DocumentManager.canAddAnnot ( )
Returns
true if the document can add annotation, otherwise false

◆ canAddSignature()

boolean com.foxit.uiextensions.DocumentManager.canAddSignature ( )
Returns
true if the document can be add signature, otherwise false

◆ canAssemble()

boolean com.foxit.uiextensions.DocumentManager.canAssemble ( )
Returns
true if the document can be assemble, otherwise false.

◆ canCopy()

boolean com.foxit.uiextensions.DocumentManager.canCopy ( )
Returns
true if the document can be copied, otherwise false.

◆ canCopyForAssess()

boolean com.foxit.uiextensions.DocumentManager.canCopyForAssess ( )
Returns
true if the document can be copied for access, otherwise false.

◆ canEdit()

boolean com.foxit.uiextensions.DocumentManager.canEdit ( )
Returns
true if the document can be edited, otherwise false

◆ canFillForm()

boolean com.foxit.uiextensions.DocumentManager.canFillForm ( )
Returns
true if the document can fill form, otherwise false

◆ canModifyContents()

boolean com.foxit.uiextensions.DocumentManager.canModifyContents ( )
Returns
true if the document can be modified, otherwise false

◆ canModifyFile()

boolean com.foxit.uiextensions.DocumentManager.canModifyFile ( )
Returns
true if the document can be modified, otherwise false

◆ canModifyForm()

boolean com.foxit.uiextensions.DocumentManager.canModifyForm ( )
Returns
true if the document can be modified form, otherwise false

◆ canModifyXFAForm()

boolean com.foxit.uiextensions.DocumentManager.canModifyXFAForm ( )
Returns
true if the document can be modify XFA form, otherwise false

◆ canPrint()

boolean com.foxit.uiextensions.DocumentManager.canPrint ( )
Returns
true if the document can be printed, otherwise false.

◆ canPrintHighQuality()

boolean com.foxit.uiextensions.DocumentManager.canPrintHighQuality ( )
Returns
true if the document can be printed with high quality, otherwise false.

◆ canSaveAsFile()

boolean com.foxit.uiextensions.DocumentManager.canSaveAsFile ( )
Returns
true if the document can be saved as file, otherwise false

◆ canSigning()

boolean com.foxit.uiextensions.DocumentManager.canSigning ( )
Returns
true if the document can be signed, otherwise false

◆ getActionCallback()

ActionCallback com.foxit.uiextensions.DocumentManager.getActionCallback ( )
Returns
Get the current action callback object.
See also
ActionCallback

◆ getAnnotationsPermission()

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

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

Returns
customize annotations permission IAnnotationsPermission

◆ getCurrentAnnot()

Annot com.foxit.uiextensions.DocumentManager.getCurrentAnnot ( )

Get the current annotation.

Returns
The current annotation.

◆ hasForm()

boolean com.foxit.uiextensions.DocumentManager.hasForm ( )

Check whether current PDF document has interactive form (also known as AcroForm).

Returns
true means current document has interactive form. false means current document does not have interactive form.

◆ isDocModified()

boolean com.foxit.uiextensions.DocumentManager.isDocModified ( )
Returns
true if the document is modified, false otherwise.

◆ isSign()

boolean com.foxit.uiextensions.DocumentManager.isSign ( )

Check whether current signature is signed or not.

Returns
true means current signature is signed, and false means not.

◆ isXFA()

boolean com.foxit.uiextensions.DocumentManager.isXFA ( )

Check whether current PDF document is an XFA document.

Returns
true means current document is an XFA document, while false means current document is not an XFA document.

◆ registerAnnotEventListener()

void com.foxit.uiextensions.DocumentManager.registerAnnotEventListener ( AnnotEventListener  listener)

Register a annot event listener.

Parameters
listenerThe annot event listenerAnnotEventListener.

◆ registerFlattenEventListener()

void com.foxit.uiextensions.DocumentManager.registerFlattenEventListener ( IFlattenEventListener  listener)

Register a fltten event listener.

Parameters
listenerThe flatten event listenerIFlattenEventListener.

◆ registerGroupEventListener()

void com.foxit.uiextensions.DocumentManager.registerGroupEventListener ( IGroupEventListener  listener)

Register a group event listener.

Parameters
listenerThe group event listenerIGroupEventListener.

◆ registerImportedAnnotsEventListener()

void com.foxit.uiextensions.DocumentManager.registerImportedAnnotsEventListener ( IImportAnnotsEventListener  listener)

Register a import annots event listener.

Parameters
listenerThe import annots event listenerIImportAnnotsEventListener.

◆ registerRedactionEventListener()

void com.foxit.uiextensions.DocumentManager.registerRedactionEventListener ( IRedactionEventListener  listener)

Register a redact event listener.

Parameters
listenerThe redact event listenerIRedactionEventListener.

◆ resetActionCallback()

void com.foxit.uiextensions.DocumentManager.resetActionCallback ( )

Reset current action callback object to Foxit PDF SDK.

◆ setActionCallback()

void com.foxit.uiextensions.DocumentManager.setActionCallback ( ActionCallback  handler)

User should implement an action callback object and call this function to set the action callback object to Foxit PDF SDK if PDF actions need to be performed, such as filling a PDF form.

Parameters
handlerA customized ActionCallback object. null means not use any action callback object. User should ensure all the callback functions have been implemented in application level. If this is a valid action callback object, Foxit PDF SDK will take over the management of this callback object and user should not release it directly.
See also
ActionCallback

◆ setAnnotationsPermission()

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

Add permission control to annotations on the basis of document permission

Parameters
permissioncustomize annotations permission IAnnotationsPermission

◆ setCurrentAnnot() [1/2]

void com.foxit.uiextensions.DocumentManager.setCurrentAnnot ( Annot  annot)

Set the current annotation.

Parameters
annotThe selected annotation. If it is set to null, the current annotation will be deselected.

◆ setCurrentAnnot() [2/2]

void com.foxit.uiextensions.DocumentManager.setCurrentAnnot ( Annot  annot,
boolean  reRender 
)

Set the current annotation.

Parameters
annotThe selected annotation. If it is set to null, the current annotation will be deselected.
reRenderwhether re-render the selected annotation.

◆ setDocModified()

void com.foxit.uiextensions.DocumentManager.setDocModified ( boolean  isModified)

Set the document is modified or not.

Parameters
isModifiedtrue if the document is modified, false otherwise.

◆ simpleCheckPDFA()

boolean com.foxit.uiextensions.DocumentManager.simpleCheckPDFA ( @NonNull PDFDoc  pdfDoc)

Just simply judge a file whether is PDFA or not.

Parameters
pdfDocthe specified pdf file.
Returns
true: is pdfa file.

◆ unregisterAnnotEventListener()

void com.foxit.uiextensions.DocumentManager.unregisterAnnotEventListener ( AnnotEventListener  listener)

Unregister a annot event listener.

Parameters
listenerThe annot event listenerAnnotEventListener.

◆ unregisterFlattenEventListener()

void com.foxit.uiextensions.DocumentManager.unregisterFlattenEventListener ( IFlattenEventListener  listener)

Unregister a flatten event listener.

Parameters
listenerThe flatten event listenerIFlattenEventListener.

◆ unregisterGroupEventListener()

void com.foxit.uiextensions.DocumentManager.unregisterGroupEventListener ( IGroupEventListener  listener)

Unregister a group event listener.

Parameters
listenerThe group event listenerIGroupEventListener.

◆ unregisterImportedAnnotsEventListener()

void com.foxit.uiextensions.DocumentManager.unregisterImportedAnnotsEventListener ( IImportAnnotsEventListener  listener)

Unregister a import annots event listener.

Parameters
listenerThe import annots event listenerIImportAnnotsEventListener.

◆ unregisterRedactionEventListener()

void com.foxit.uiextensions.DocumentManager.unregisterRedactionEventListener ( IRedactionEventListener  listener)

Unregister a redact event listener.

Parameters
listenerThe redact event listenerIRedactionEventListener.