Foxit PDF SDK
com.foxit.sdk.addon.accessibility.AutoTagProviderCallback类 参考

表示用于可访问性自动标记结果的提供者回调对象。
更多...

Public 成员函数

String getReportText (int type)
 获取指定自动标记结果数据类型的显示文本。
更多...
 

静态 Public 属性

static final int e_AutoTagResultDataTypeAlttext = 31
 自动标记结果数据类型:替代文本(alttext)。

 
static final int e_AutoTagResultDataTypeArtifacts = 5
 自动标记结果数据类型:人工元素集合(Artifacts)。

 
static final int e_AutoTagResultDataTypeBacktotop = 41
 自动标记结果数据类型:返回顶部。

 
static final int e_AutoTagResultDataTypeCheckCategory = 18
 自动标记结果数据类型:检查类别。

 
static final int e_AutoTagResultDataTypeCheckerTable5 = 33
 自动标记结果数据类型:检查器表格5。

 
static final int e_AutoTagResultDataTypeFigures = 8
 自动标记结果数据类型:图形集合。

 
static final int e_AutoTagResultDataTypeFixCategory = 19
 自动标记结果数据类型:修复类别。

 
static final int e_AutoTagResultDataTypeHighConfidence = 13
 自动标记结果数据类型:高置信度。

 
static final int e_AutoTagResultDataTypeHintAlttext = 32
 自动标记结果数据类型:替代文本提示。

 
static final int e_AutoTagResultDataTypeHintArtifacts = 21
 自动标记结果数据类型:提示人工元素。

 
static final int e_AutoTagResultDataTypeHintFigure = 24
 自动标记结果数据类型:提示图形。

 
static final int e_AutoTagResultDataTypeHintList = 23
 自动标记结果数据类型:提示列表。

 
static final int e_AutoTagResultDataTypeHintParagraph = 22
 自动标记结果数据类型:提示段落。

 
static final int e_AutoTagResultDataTypeHintRegion = 20
 自动标记结果数据类型:提示区域。

 
static final int e_AutoTagResultDataTypeHintRepair = 29
 自动标记结果数据类型:提示修复。

 
static final int e_AutoTagResultDataTypeHintTableHeader = 27
 自动标记结果数据类型:提示表格表头。

 
static final int e_AutoTagResultDataTypeHintTableRow = 26
 自动标记结果数据类型:提示表格行。

 
static final int e_AutoTagResultDataTypeHintTables = 25
 自动标记结果数据类型:提示表格。

 
static final int e_AutoTagResultDataTypeHintToc = 28
 自动标记结果数据类型:提示目录(TOC)。

 
static final int e_AutoTagResultDataTypeIntroduction = 34
 自动标记结果数据类型:引言/介绍。

 
static final int e_AutoTagResultDataTypeListItem = 7
 自动标记结果数据类型:列表项。

 
static final int e_AutoTagResultDataTypeLowConfidence = 17
 自动标记结果数据类型:低置信度。

 
static final int e_AutoTagResultDataTypeMediumConfidence = 15
 自动标记结果数据类型:中等置信度。

 
static final int e_AutoTagResultDataTypeMediumhighConfidence = 14
 自动标记结果数据类型:中高置信度。

 
static final int e_AutoTagResultDataTypeMediumlowConfidence = 16
 自动标记结果数据类型:中低置信度。

 
static final int e_AutoTagResultDataTypeMissFigure = 39
 自动标记结果数据类型:缺失图像。

 
static final int e_AutoTagResultDataTypePage = 3
 自动标记结果数据类型:页面。

 
static final int e_AutoTagResultDataTypeParagraphs = 6
 自动标记结果数据类型:段落集合。

 
static final int e_AutoTagResultDataTypeReduceConfidence = 0
 自动标记结果数据类型:降低置信度。

 
static final int e_AutoTagResultDataTypeRegions = 4
 自动标记结果数据类型:区域集合。

 
static final int e_AutoTagResultDataTypeRibbonCategory = 36
 自动标记结果数据类型:功能区(Ribbon)类别。

 
static final int e_AutoTagResultDataTypeSumAlttextFigure = 37
 自动标记结果数据类型:图像替代文本汇总。

 
static final int e_AutoTagResultDataTypeSumReduceConfidence = 35
 自动标记结果数据类型:降低置信度汇总。

 
static final int e_AutoTagResultDataTypeTableHeader = 11
 自动标记结果数据类型:表格表头。

 
static final int e_AutoTagResultDataTypeTableRow = 10
 自动标记结果数据类型:表格行。

 
static final int e_AutoTagResultDataTypeTables = 9
 自动标记结果数据类型:表格集合。

 
static final int e_AutoTagResultDataTypeTagrepIntroduction = 38
 自动标记结果数据类型:标记报告简介。

 
static final int e_AutoTagResultDataTypeTagreportFilename = 40
 自动标记结果数据类型:标记报告文件名。

 
static final int e_AutoTagResultDataTypeTagreportNextpage = 2
 自动标记结果数据类型:标记报告下一页。

 
static final int e_AutoTagResultDataTypeTagreportPrepage = 1
 自动标记结果数据类型:标记报告上一页。

 
static final int e_AutoTagResultDataTypeToc = 12
 自动标记结果数据类型:目录(TOC)。

 
static final int e_AutoTagResultDataTypeTouchupReadingOrder = 30
 自动标记结果数据类型:微调阅读顺序。

 

详细描述

表示用于可访问性自动标记结果的提供者回调对象。

本类中的所有纯虚函数都作为回调使用,应在派生类中由用户实现。

成员函数说明

◆ getReportText()

String com.foxit.sdk.addon.accessibility.AutoTagProviderCallback.getReportText ( int  type)

获取指定自动标记结果数据类型的显示文本。

该回调在 SDK 生成”添加标记(Add Tags)”报告(自动标记过程中)时被调用。对于从 AutoTagProviderCallback::AutoTagResultDataType::e_AutoTagResultDataTypeReduceConfidence 开始的每个值,SDK 都会向应用请求对应的 (通常是本地化的)显示字符串,因此报告中所有面向用户的文案均由应用控制。

大多数类型对应一个普通标签(例如 "Figures"、"Artifacts"、"Table Summary")。少数类型要求 返回的字符串中包含 printf 风格的占位符,SDK 会在运行时进行替换;实现时必须保留占位符及其顺序:

  • %d 页码(从 1 开始):e_AutoTagResultDataTypePage("Page \%d")、 e_AutoTagResultDataTypeMissFigure("Figure missing AltText on page \%d.");
  • %d 数量:e_AutoTagResultDataTypeSumReduceConfidence("\%d reduced confidence pages")、 e_AutoTagResultDataTypeSumAlttextFigure("\%d figures missing AltText");
  • %ls 类别名称:e_AutoTagResultDataTypeCheckCategory("\%ls to check.")、 e_AutoTagResultDataTypeFixCategory("How to Fix \%ls Tagging.");
  • %ls 文件名:e_AutoTagResultDataTypeTagreportFilename("Add Tags Report for \%ls")。

对于未知或未处理的类型,请返回空字符串。完整的参考实现可见无障碍单元测试类 CFSUT_AutoTagProviderCallbackImpl。

参数
[in]type从 AutoTagProviderCallback::AutoTagResultDataType::e_AutoTagResultDataTypeReduceConfidence 开始的值之一,SDK 正在请求其显示文本。
返回
type 对应的显示文本(可能包含上述占位符);若该类型未处理,返回空字符串。