Skip to content
Demo示例FAQ

PDF 生成模板编辑器

开源可视化 PDF 生成引擎,支持自定义模板,并提供面向开发者的 API,灵活构建文档生成流程。

查看 GitHub
Android Guides Document modification state

文档修改状态监听 ​

从 3.2.0 开始,可通过 OnDocumentChangesListener 监听文档修改标记的变化,用于更新保存按钮或判断退出时是否需要提示保存。

注册监听 ​

以下代码中的 document 是已打开的 CPDFDocument。保留监听器实例,以便在退出页面或切换文档时注销。

java
import com.compdfkit.core.document.OnDocumentChangesListener;

OnDocumentChangesListener changesListener = (changedDocument, hasChanges) -> {
    // 主线程回调。使用 hasChanges 更新保存按钮或退出提示状态。
    saveButton.setEnabled(hasChanges);
};

document.addOnDocumentChangesListener(changesListener);
// 注册时不会回传当前状态,需主动初始化界面。
saveButton.setEnabled(document.hasChanges());
kotlin
import com.compdfkit.core.document.OnDocumentChangesListener

val changesListener = OnDocumentChangesListener { _, hasChanges ->
    // 主线程回调。
    saveButton.isEnabled = hasChanges
}

document.addOnDocumentChangesListener(changesListener)
saveButton.isEnabled = document.hasChanges()

回调语义 ​

行为说明
触发条件修改标记在 false 与 true 之间变化时触发,不逐次通知每个编辑操作
派发方式异步派发到主线程,按状态变化顺序通知
回调参数hasChanges 是发生本次变化时的状态;回调执行时查询文档,可能已经得到后续状态
重复注册同一监听器实例重复注册不会增加订阅
生命周期监听器属于文档 Java 对象,关闭或重新加载文档不会自动移除

hasChanges 为 false 表示修改标记已清除,也可能由关闭文档或调用 clearChanges() 引起。保存是否成功,应检查保存方法的返回值或异常,不能仅根据回调判断。

回调执行前文档可能已经关闭。如果需要访问页面等文档资源,先检查 changedDocument.isValid()。

注销监听 ​

退出页面、销毁视图或切换到其他文档时,在原文档对象上移除监听器:

java
document.removeOnDocumentChangesListener(changesListener);
kotlin
document.removeOnDocumentChangesListener(changesListener)

注销会取消该订阅尚未派发的通知,已经开始派发的通知可能完成。监听器会被文档强引用,使用结束后应及时移除。

保存方法参见 保存文档。