Guides

BOTA界面配置

功能说明

BOTA界面用于展示 PDF 文档的书签列表、大纲列表和注释列表。

通过配置 BOTA，可以控制显示哪些类型的界面，以及每个界面中的菜单选项。

BOTA 配置路径为 CPDFConfiguration.globalConfig.bota。如果不传该配置，SDK 默认显示 outline、bookmark、annotations 三个标签页。

设置启用的标签页

使用 CPDFBotaConfig.tabs 配置启用的标签页：

CPDFConfiguration config = CPDFConfiguration(
  globalConfig: const CPDFGlobalConfig(
    bota: CPDFBotaConfig(
      tabs: [
        CPDFBotaTabs.outline,
        CPDFBotaTabs.annotations
      ]
    )
  )
);

效果示例：

Android	iOS

设置注释菜单选项

BOTA 支持为注释列表界面设置 全局菜单 和 单条注释菜单项：

CPDFConfiguration(
  globalConfig: const CPDFGlobalConfig(
    bota: CPDFBotaConfig(
      tabs: [
        CPDFBotaTabs.bookmark,
        CPDFBotaTabs.annotations,
      ],
      menus: CPDFBotaMenuConfig(
        annotations: CPDFBotaAnnotationMenuConfig(
          global: [
            CPDFBotaMenuItem(id: CPDFBotaAnnotGlobalMenu.importAnnotation),
            CPDFBotaMenuItem(id: CPDFBotaAnnotGlobalMenu.exportAnnotation),
            CPDFBotaMenuItem(id: CPDFBotaAnnotGlobalMenu.removeAllAnnotation),
          ],
          item: [
            CPDFBotaMenuItem(id: CPDFBotaAnnotItemMenu.reviewStatus, subMenus: [
              CPDFReviewState.accepted,
              CPDFReviewState.cancelled,
              CPDFReviewState.none,
            ]),
            CPDFBotaMenuItem(id: CPDFBotaAnnotItemMenu.more, subMenus: [
              CPDFBotaAnnotMoreMenu.delete
            ]),
          ]
        )
      )
    )
  )
)

效果示例：

Android	iOS

注释全局菜单选项

选项	描述
CPDFBotaAnnotGlobalMenu.importAnnotation	导入注释
CPDFBotaAnnotGlobalMenu.exportAnnotation	导出注释
CPDFBotaAnnotGlobalMenu.removeAllAnnotation	删除所有注释
CPDFBotaAnnotGlobalMenu.removeAllReply	删除所有注释回复

BOTA 配置字段

字段	说明
tabs	BOTA 面板中显示的标签页，支持 outline、bookmark、annotations。
menus.annotations.global	注释列表工具栏中的全局操作。
menus.annotations.item	单条注释项中的操作。可通过 subMenus 限制回复状态或更多菜单的子项。

注意：BOTA 菜单配置只作用于 SDK 内置 BOTA 面板。如果你通过 CPDFReaderWidgetController 自行实现 BOTA 页面，需要在自定义 UI 中处理菜单行为。

注释回复状态子菜单选项

选项	描述
accepted	已接受
rejected	已拒绝
cancelled	已取消
completed	已完成
none	无状态

更多菜单选项

选项	描述
addReply	添加注释回复
viewReply	查看注释回复
delete	删除注释