Guides

模式配置

ModeConfig 控制文档界面的初始模式、可用模式列表和 UI 可见性行为。

配置字段

字段	类型	默认值	说明
initialViewMode	String	"viewer"	打开文档时的初始模式
availableViewModes	String[]	全部 5 种	用户可切换的模式列表
uiVisibilityMode	String	"automatic"	UI 可见性策略

初始模式

initialViewMode 决定打开文档后默认进入的模式：

值	说明
viewer	阅读模式（默认）
annotations	注释模式
contentEditor	内容编辑模式
forms	表单模式
signatures	签名模式

{
  "modeConfig": {
    "initialViewMode": "viewer"
  }
}

可用模式列表

availableViewModes 控制底部模式切换栏中显示的模式。未在列表中的模式用户将无法切换到：

{
  "modeConfig": {
    "availableViewModes": [
      "viewer",
      "annotations",
      "contentEditor",
      "forms",
      "signatures"
    ]
  }
}

如果只需阅读和注释功能：

{
  "modeConfig": {
    "initialViewMode": "viewer",
    "availableViewModes": [
      "viewer",
      "annotations"
    ]
  }
}

UI 可见性模式

uiVisibilityMode 控制顶部/底部工具栏的显示策略：

值	说明
automatic	自动模式 — 点击 PDF 页面切换全屏状态（默认）
always	始终显示顶部和底部工具栏
never	始终隐藏顶部和底部工具栏

{
  "modeConfig": {
    "uiVisibilityMode": "automatic"
  }
}

完整示例

{
  "modeConfig": {
    "initialViewMode": "viewer",
    "uiVisibilityMode": "automatic",
    "availableViewModes": [
      "viewer",
      "annotations",
      "contentEditor",
      "forms",
      "signatures"
    ]
  }
}

代码示例

java

CPDFConfiguration configuration = CPDFConfigurationUtils.normalConfig(
    context, "tools_default_configuration.json");

// 设置初始模式为注释
configuration.modeConfig.initialViewMode = CPreviewMode.Annotation;

// 仅保留阅读和注释模式
configuration.modeConfig.availableViewModes = Arrays.asList(
    CPreviewMode.Viewer,
    CPreviewMode.Annotation
);

// 设置工具栏始终显示
configuration.modeConfig.uiVisibilityMode = CPDFUIVisibilityMode.ALWAYS;

kotlin

val configuration = CPDFConfigurationUtils.normalConfig(
    context, "tools_default_configuration.json")

configuration.modeConfig.initialViewMode = CPreviewMode.Annotation
configuration.modeConfig.availableViewModes = listOf(
    CPreviewMode.Viewer,
    CPreviewMode.Annotation
)
configuration.modeConfig.uiVisibilityMode = CPDFUIVisibilityMode.ALWAYS