uiextensions.DocumentManager Class Reference

Public Member Functions
	canAddAnnot ()
	canAddSignature ()
	canAssemble ()
	canCopy ()
	canCopyAnnot ()
	canCopyForAssess ()
	canEdit ()
	canExtract ()
	canFillForm ()
	canModifyContents (isJudgeAddSignature=false)
	canModifyFile ()
	canModifyForm ()
	canModifyXFAForm ()
	canPrint ()
	canPrintHighQuality ()
	canSaveAsFile ()
	canSigning ()
	getActionCallback ()
	getCurrentAnnot ()
	hasForm ()
	isDocModified ()
	isSigned ()
	isXFA ()
	registerAnnotEventListener (listener)
	registerFlattenEventListener (listener) unregisterFlattenEventListener(listener)
	registerGroupEventListener (listener)
	registerImportedAnnotsEventListener (listener)
	registerRedactionEventListener (listener)
	resetActionCallback ()
	setActionCallback (handler)
	setCurrentAnnot (annot, reRender=true)
	setDocModified (isModified)
	simpleCheckPDFA (pdfDoc)
	unregisterAnnotEventListener (listener)
	unregisterGroupEventListener (listener)
	unregisterImportedAnnotsEventListener (listener)
	unregisterRedactionEventListener (listener)

Detailed Description

PDF 文档管理器，用于管理文档的注释、页面、权限等相关功能。 此实现对所有模块共享。

Member Function Documentation

canAddAnnot()

uiextensions.DocumentManager.canAddAnnot

(

)

检测批注添加权限

Returns

true表示允许添加注释，false表示禁止添加注释

canAddSignature()

uiextensions.DocumentManager.canAddSignature

(

)

检测签名字段添加权限

Returns

true表示允许在文档中创建新的签名域，false表示禁止添加签名字段

canAssemble()

uiextensions.DocumentManager.canAssemble

(

)

检测文档重组权限

Returns

true表示允许页面插入/删除或文档合并操作，false表示禁止重组文档结构

canCopy()

uiextensions.DocumentManager.canCopy

(

)

检测文本复制权限

Returns

true表示允许通过选择工具复制文本内容，false表示禁止复制操作

canCopyAnnot()

uiextensions.DocumentManager.canCopyAnnot

(

)

检测是否可以复制注释

Returns

true表示允许复制注释，false表示禁止复制注释

canCopyForAssess()

uiextensions.DocumentManager.canCopyForAssess

(

)

检测评估用途的特殊复制权限

Returns

true表示允许为可访问性需求复制内容，false表示无此特殊权限

canEdit()

uiextensions.DocumentManager.canEdit

(

)

检测文档编辑权限

Returns

true表示允许执行内容编辑操作，false表示文档处于只读模式

canExtract()

uiextensions.DocumentManager.canExtract

(

)

检测内容提取权限

Returns

true表示允许提取文本/图片等文档内容，false表示禁止提取操作

canFillForm()

uiextensions.DocumentManager.canFillForm

(

)

检测表单填写权限

Returns

true表示允许在表单字段中输入内容，false表示表单处于锁定状态

canModifyContents()

uiextensions.DocumentManager.canModifyContents

(

isJudgeAddSignature

= false

)

检测内容修改权限

Parameters

isJudgeAddSignature

当设置为true时，添加数字签名的操作不会影响该权限判断

Returns

true表示允许修改文档文字/图片等主体内容，false表示禁止内容修改

canModifyFile()

uiextensions.DocumentManager.canModifyFile

(

)

检测文件结构修改权限

Returns

true表示允许修改文档目录结构，false表示禁止结构变更

canModifyForm()

uiextensions.DocumentManager.canModifyForm

(

)

检测表单修改权限

Returns

true表示允许修改表单字段属性，false表示表单结构已锁定

canModifyXFAForm()

uiextensions.DocumentManager.canModifyXFAForm

(

)

检测XFA表单编辑权限

Returns

true表示允许修改XFA动态表单内容，false表示禁止XFA表单操作

canPrint()

uiextensions.DocumentManager.canPrint

(

)

检测文档打印权限状态

Returns

true表示允许执行普通打印操作，false表示禁止打印

canPrintHighQuality()

uiextensions.DocumentManager.canPrintHighQuality

(

)

检测高质量打印权限状态

Returns

true表示允许执行高精度打印，false表示仅允许低质量打印

canSaveAsFile()

uiextensions.DocumentManager.canSaveAsFile

(

)

检测另存为操作权限

Returns

true表示允许另存为新文档，false表示禁止保存副本

canSigning()

uiextensions.DocumentManager.canSigning

(

)

检测数字签名权限

Returns

true表示允许进行文档签名操作，false表示禁止添加或修改签名

getActionCallback()

uiextensions.DocumentManager.getActionCallback

(

)

获取当前PDF动作回调处理器

Returns

返回当前设置的动作回调对象实例或null

getCurrentAnnot()

uiextensions.DocumentManager.getCurrentAnnot

(

)

获取当前选中批注

Returns

返回当前选中的批注实例或null

hasForm()

uiextensions.DocumentManager.hasForm

(

)

检测是否存在表单

Returns

true表示文档存在表单，false表示无表单元素

isDocModified()

uiextensions.DocumentManager.isDocModified

(

)

获取文档修改状态

Returns

返回布尔值，true表示文档已修改，false表示未修改

isSigned()

uiextensions.DocumentManager.isSigned

(

)

检测签名完成状态

Returns

true表示当前签名域已完成数字签名，false表示待签名状态

isXFA()

uiextensions.DocumentManager.isXFA

(

)

检测XFA文档类型

Returns

true表示文档使用XFA动态表单技术，false表示标准静态表单

registerAnnotEventListener()

uiextensions.DocumentManager.registerAnnotEventListener

(

listener

)

注册批注事件监听器

Parameters

listener

实现IAnnotEventListener的对象实例，用于接收批注添加/删除等事件通知

registerFlattenEventListener()

uiextensions.DocumentManager.registerFlattenEventListener

(

listener

)

扁平化事件监听器接口，用于处理文档结构扁平化操作相关事件 注册扁平化事件监听器

Parameters

listener

需要订阅的事件监听器实例 IFlattenEventListener

registerGroupEventListener()

uiextensions.DocumentManager.registerGroupEventListener

(

listener

)

组合事件监听器接口，用于处理文档元素编组操作相关事件

registerImportedAnnotsEventListener()

uiextensions.DocumentManager.registerImportedAnnotsEventListener

(

listener

)

注册注释导入事件监听器

Parameters

listener

需要订阅的事件监听器实例 IImportAnnotsEventListener

registerRedactionEventListener()

uiextensions.DocumentManager.registerRedactionEventListener

(

listener

)

注册密文事件监听器

Parameters

listener

需要订阅的事件监听器实例 IRedactionEventListener

resetActionCallback()

uiextensions.DocumentManager.resetActionCallback

(

)

重置PDF动作回调处理器

将当前动作回调对象恢复为SDK默认设置

setActionCallback()

uiextensions.DocumentManager.setActionCallback

(

handler

)

设置PDF动作回调处理器

Parameters

handler

自定义动作回调对象 FoxitRDKNative.IActionCallback，传入null表示不使用回调对象。 开发者需要确保应用层已实现所有回调函数，设置后SDK将接管该对象的生命周期管理

setCurrentAnnot()

uiextensions.DocumentManager.setCurrentAnnot	(	annot	,
		reRender	= true
	)

设置当前选中批注

Parameters

annot	要设置的批注实例 FoxitRDKNative.pdf.annots.Annot，传入null将取消当前选中
reRender	是否触发重渲染操作，默认值为true

setDocModified()

uiextensions.DocumentManager.setDocModified

(

isModified

)

设置文档修改状态标识

Parameters

isModified

文档修改状态标识，true表示文档已修改，false表示未修改

simpleCheckPDFA()

uiextensions.DocumentManager.simpleCheckPDFA

(

pdfDoc

)

PDFA格式检测

Parameters

pdfDoc

待检测的PDF文档对象 FoxitRDKNative.pdf.PDFDoc

Returns

true表示是PDFA格式文件， false 表示不是

unregisterAnnotEventListener()

uiextensions.DocumentManager.unregisterAnnotEventListener

(

listener

)

移除批注事件监听器

Parameters

listener

需要取消订阅的IAnnotEventListener实例

unregisterGroupEventListener()

uiextensions.DocumentManager.unregisterGroupEventListener

(

listener

)

注销组合事件监听器

Parameters

listener

需要移除的事件监听器实例 IGroupEventListener

unregisterImportedAnnotsEventListener()

uiextensions.DocumentManager.unregisterImportedAnnotsEventListener

(

listener

)

注销注释导入事件监听器

Parameters

listener

需要移除的事件监听器实例 IImportAnnotsEventListener

unregisterRedactionEventListener()

uiextensions.DocumentManager.unregisterRedactionEventListener

(

listener

)

注销密文事件监听器

Parameters

listener

需要移除的事件监听器实例 IRedactionEventListener