Guides

注释

ComPDF Flutter SDK 支持多种注释事件监听，以下是常用的注释事件：

事件名称	描述
onAnnotationCreationPreparedCallback	当用户准备创建签名、图章、超链接、图片注释时触发，返回注释类型。
annotationsCreated	当用户创建注释时触发，返回创建的注释数据。
annotationsSelected	当用户选中注释时触发，返回选中的注释数据。
annotationsDeselected	当用户取消选中注释时触发，返回取消选中的注释数据。

onAnnotationCreationPreparedCallback 用于在注释模式下点击底部的签名、图章、超链接、图片工具，或通过 controller.setAnnotationMode() 进入创建注释模式时触发。

通过此回调，可在 Flutter 应用中弹出自定义的选择框，而非使用 ComPDF 集成的选择弹窗。此功能需要配合 CPDFConfiguration 中的配置，禁止在创建这四种注释时弹出默认选择对话框：

CPDFConfiguration(
  annotationsConfig: const CPDFAnnotationsConfig(
    // 禁止创建签名、图章、超链接、图片注释时弹出选择对话框
    autoShowSignPicker: false,
    autoShowLinkDialog: false,
    autoShowPicPicker: false,
    autoShowStampPicker: false,
  ),
);

要监听 onAnnotationCreationPreparedCallback事件，可以在创建 CPDFReaderWidget 时传入相应的回调函数。例如：

CPDFReaderWidget(
  document: documentPath,
  configuration: configuration,
  onCreated: (controller) {},
  onAnnotationCreationPreparedCallback: (CPDFAnnotationType annotationType, CPDFAnnotation? annotation) {
    // 签名、图章、图片注释在进入创建模式时(点击底部工具栏按钮或调用controller.setAnnotationMode())会触发此回调
    // 超链接注释在用户在页面中滑取矩形抬起手指后回调。
    debugPrint('Preparing to create annotation of type: $annotationType');
    // 在这里可以弹出自定义的选择框，供用户选择签名、图章、图片等
  },
);

插入签名

在选择完签名图片后，调用以下API插入签名注释：

await controller?.prepareNextSignature(signImagePath);

插入图章

在选择完标准图章、图片图章、文字图章后，调用以下API插入图章注释：

// 插入标准图章，查看CPDFStandardStamp枚举获取可用的标准图章类型
await controller?.prepareNextStamp(standardStamp: stamp);

// 插入图片图章
await controller?.prepareNextStamp(imagePath: imagePath);

// 插入文字图章
await controller?.prepareNextStamp(
  textStamp: CPDFTextStamp(
    content: 'ComPDF-Flutter',
    date:
    CPDFDate.getTextStampDate(timeSwitch: false, dateSwitch: true),
    shape: CPDFTextStampShape.none,
    color: CPDFTextStampColor.white));

通过以上方式，您可以在 Flutter 应用中自定义签名和图章的选择过程，同时利用 ComPDF 强大的注释创建功能。

要监听其他注释事件，可以在创建 CPDFReaderWidget 后通过 CPDFReaderWidgetController调用函数。例如：

controller.addEventListener(CPDFEvent.annotationsCreated, (event) {
  // event 为 CPDFAnnotation 对象以及其子类对象
  print(jsonEncode(event));
});

controller.addEventListener(CPDFEvent.annotationsSelected, (event) {
  // event 为 CPDFAnnotation 对象以及其子类对象
  print(jsonEncode(event));
});

controller.addEventListener(CPDFEvent.annotationsDeselected, (event) {
  // event 为 CPDFAnnotation 对象以及其子类对象,可能为空
  print(jsonEncode(event));
});