Foxit PDF SDK
Public Member Functions | Static Public Attributes | List of all members
com.foxit.sdk.addon.accessibility.AutoTagProviderCallback Class Reference

Public Member Functions

String getReportText (int type)
 Get the display text for an auto tag result data type.
More...
 

Static Public Attributes

static final int e_AutoTagResultDataTypeAlttext = 31
 Auto tag result data type: alttext.

 
static final int e_AutoTagResultDataTypeArtifacts = 5
 Auto tag result data type: artifacts.

 
static final int e_AutoTagResultDataTypeBacktotop = 41
 Auto tag result data type: back to top.

 
static final int e_AutoTagResultDataTypeCheckCategory = 18
 Auto tag result data type: check category.

 
static final int e_AutoTagResultDataTypeCheckerTable5 = 33
 Auto tag result data type: checker table 5.

 
static final int e_AutoTagResultDataTypeFigures = 8
 Auto tag result data type: figures.

 
static final int e_AutoTagResultDataTypeFixCategory = 19
 Auto tag result data type: fix category.

 
static final int e_AutoTagResultDataTypeHighConfidence = 13
 Auto tag result data type: high confidence.

 
static final int e_AutoTagResultDataTypeHintAlttext = 32
 Auto tag result data type: hint alttext.

 
static final int e_AutoTagResultDataTypeHintArtifacts = 21
 Auto tag result data type: hint artifacts.

 
static final int e_AutoTagResultDataTypeHintFigure = 24
 Auto tag result data type: hint figure.

 
static final int e_AutoTagResultDataTypeHintList = 23
 Auto tag result data type: hint list.

 
static final int e_AutoTagResultDataTypeHintParagraph = 22
 Auto tag result data type: hint paragraph.

 
static final int e_AutoTagResultDataTypeHintRegion = 20
 Auto tag result data type: hint region.

 
static final int e_AutoTagResultDataTypeHintRepair = 29
 Auto tag result data type: hint repair.

 
static final int e_AutoTagResultDataTypeHintTableHeader = 27
 Auto tag result data type: hint tableheader.

 
static final int e_AutoTagResultDataTypeHintTableRow = 26
 Auto tag result data type: hint tablerow.

 
static final int e_AutoTagResultDataTypeHintTables = 25
 Auto tag result data type: hint tables.

 
static final int e_AutoTagResultDataTypeHintToc = 28
 Auto tag result data type: hint toc.

 
static final int e_AutoTagResultDataTypeIntroduction = 34
 Auto tag result data type: introduction.

 
static final int e_AutoTagResultDataTypeListItem = 7
 Auto tag result data type: listitem.

 
static final int e_AutoTagResultDataTypeLowConfidence = 17
 Auto tag result data type: low confidence.

 
static final int e_AutoTagResultDataTypeMediumConfidence = 15
 Auto tag result data type: medium confidence.

 
static final int e_AutoTagResultDataTypeMediumhighConfidence = 14
 Auto tag result data type: mediumhigh confidence.

 
static final int e_AutoTagResultDataTypeMediumlowConfidence = 16
 Auto tag result data type: mediumlow confidence.

 
static final int e_AutoTagResultDataTypeMissFigure = 39
 Auto tag result data type: miss figure.

 
static final int e_AutoTagResultDataTypePage = 3
 Auto tag result data type: page.

 
static final int e_AutoTagResultDataTypeParagraphs = 6
 Auto tag result data type: paragraphs.

 
static final int e_AutoTagResultDataTypeReduceConfidence = 0
 Auto tag result data type: reduce confidence.

 
static final int e_AutoTagResultDataTypeRegions = 4
 Auto tag result data type: regions.

 
static final int e_AutoTagResultDataTypeRibbonCategory = 36
 Auto tag result data type: ribbon category.

 
static final int e_AutoTagResultDataTypeSumAlttextFigure = 37
 Auto tag result data type: sum alttext figure.

 
static final int e_AutoTagResultDataTypeSumReduceConfidence = 35
 Auto tag result data type: sum reduce confidence.

 
static final int e_AutoTagResultDataTypeTableHeader = 11
 Auto tag result data type: table header.

 
static final int e_AutoTagResultDataTypeTableRow = 10
 Auto tag result data type: table row.

 
static final int e_AutoTagResultDataTypeTables = 9
 Auto tag result data type: tables.

 
static final int e_AutoTagResultDataTypeTagrepIntroduction = 38
 Auto tag result data type: tagrep introduction.

 
static final int e_AutoTagResultDataTypeTagreportFilename = 40
 Auto tag result data type: tagreport filename.

 
static final int e_AutoTagResultDataTypeTagreportNextpage = 2
 Auto tag result data type: tagreport nextpage.

 
static final int e_AutoTagResultDataTypeTagreportPrepage = 1
 Auto tag result data type: tagreport prepage.

 
static final int e_AutoTagResultDataTypeToc = 12
 Auto tag result data type: toc.

 
static final int e_AutoTagResultDataTypeTouchupReadingOrder = 30
 Auto tag result data type: touchup reading order.

 

Detailed Description

This class represents an auto tag results provider for accessibility.

All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class.

Member Function Documentation

◆ getReportText()

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

Get the display text for an auto tag result data type.

This callback is invoked by the SDK while it generates the "Add Tags" report during auto tagging. For each result data type (see ), the SDK requests the corresponding (typically localized) display string from the application, so the application controls all user-visible wording in the report.

Most types map to a plain label (for example "Figures", "Artifacts", "Table Summary"). A few types expect the returned string to contain a printf-style placeholder that the SDK substitutes at runtime; the implementation must keep the placeholder and its order intact:

  • %d page number (1-based): e_AutoTagResultDataTypePage ("Page \%d"), e_AutoTagResultDataTypeMissFigure ("Figure missing AltText on page \%d.");
  • %d count: e_AutoTagResultDataTypeSumReduceConfidence ("\%d reduced confidence pages"), e_AutoTagResultDataTypeSumAlttextFigure ("\%d figures missing AltText");
  • %ls category name: e_AutoTagResultDataTypeCheckCategory ("\%ls to check."), e_AutoTagResultDataTypeFixCategory ("How to Fix \%ls Tagging.");
  • %ls file name: e_AutoTagResultDataTypeTagreportFilename ("Add Tags Report for \%ls").

Return an empty string for an unknown or unhandled type.

Parameters
[in]typeOne value of the enumeration, that the SDK is requesting text for.
Returns
The display text for type (may contain a placeholder as noted above), or an empty string if the type is not handled.