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

图像替代文本信息的数据结构。
更多...

Public 成员函数

 AlternateTextFigureData ()
 默认构造函数:创建一个空的、非装饰性图像条目。

 
 AlternateTextFigureData (AlternateTextFigureData other)
 拷贝构造函数。

 
 AlternateTextFigureData (boolean is_decorative_figure, String alternate_text, String alternate_text_changed, int page_index, RectF rect)
 使用显式值构造。
更多...
 
synchronized void delete ()
 直接清除C++相关资源。 更多...
 
String getAlternate_text ()
 Get 更改前的替代文本(原始)。
更多...
 
String getAlternate_text_changed ()
 Get 更改后的替代文本(修复模式下修改)。
更多...
 
boolean getIs_decorative_figure ()
 Get 是否为装饰性图像(无替代文本)。
更多...
 
int getPage_index ()
 Get 图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
更多...
 
RectF getRect ()
 Get 图像在页面上的边界矩形。
更多...
 
void set (boolean is_decorative_figure, String alternate_text, String alternate_text_changed, int page_index, RectF rect)
 一次性设置对象的所有值。
更多...
 
void setAlternate_text (String value)
 Set 更改前的替代文本(原始)。
更多...
 
void setAlternate_text_changed (String value)
 Set 更改后的替代文本(修复模式下修改)。
更多...
 
void setIs_decorative_figure (boolean value)
 Set 是否为装饰性图像(无替代文本)。
更多...
 
void setPage_index (int value)
 Set 图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
更多...
 
void setRect (RectF value)
 Set 图像在页面上的边界矩形。
更多...
 

详细描述

图像替代文本信息的数据结构。

存储在无障碍标记与修复工作流中使用的单个图像信息。

  • is_decorative_figure:指示图像是否为装饰性图像(若为装饰性则不应设置替代文本)。
  • alternate_text:原始替代文本(编辑前)。
  • alternate_text_changed:用户修改后的替代文本(修复模式下使用)。
  • page_index:图像所在的零基页面索引。
  • rect:图像在页面上的边界矩形。


典型用法:

  1. 使用 TaggedPDF::GetNextFigureData() / GetPrevFigureData() 迭代。
  2. 使用 SetCurrentFigureDataInfo() 修改并通过 TaggedPDF::SaveFigureData() 保存。


构造及析构函数说明

◆ AlternateTextFigureData()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.AlternateTextFigureData ( boolean  is_decorative_figure,
String  alternate_text,
String  alternate_text_changed,
int  page_index,
RectF  rect 
)

使用显式值构造。

参数
[in]is_decorative_figure若为 true 则表示图像为装饰性(无需替代文本)。
[in]alternate_text原始替代文本(可为 null/空)。
[in]alternate_text_changed修改后的替代文本(可为 null/空)。
[in]page_index图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
[in]rect图像在页面上的边界矩形。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.addon.accessibility.AlternateTextFigureData.delete ( )

直接清除C++相关资源。

返回
无。
注解
一旦这个接口被调用,这个对象将不能再被使用。

◆ getAlternate_text()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.getAlternate_text ( )

Get 更改前的替代文本(原始)。

返回
更改前的替代文本(原始)。

◆ getAlternate_text_changed()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.getAlternate_text_changed ( )

Get 更改后的替代文本(修复模式下修改)。

返回
更改后的替代文本(修复模式下修改)。

◆ getIs_decorative_figure()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.getIs_decorative_figure ( )

Get 是否为装饰性图像(无替代文本)。

返回
是否为装饰性图像(无替代文本)。

◆ getPage_index()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.getPage_index ( )

Get 图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。

返回
图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。

◆ getRect()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.getRect ( )

Get 图像在页面上的边界矩形。

返回
图像在页面上的边界矩形。

◆ set()

void com.foxit.sdk.addon.accessibility.AlternateTextFigureData.set ( boolean  is_decorative_figure,
String  alternate_text,
String  alternate_text_changed,
int  page_index,
RectF  rect 
)

一次性设置对象的所有值。

参数
[in]is_decorative_figure是否为装饰性图像。
[in]alternate_text原始替代文本。
[in]alternate_text_changed修改后的替代文本。
[in]page_index图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
[in]rect图像的边界矩形。

◆ setAlternate_text()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.setAlternate_text ( String  value)

Set 更改前的替代文本(原始)。

参数
[in]value更改前的替代文本(原始)。
返回
None.

◆ setAlternate_text_changed()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.setAlternate_text_changed ( String  value)

Set 更改后的替代文本(修复模式下修改)。

参数
[in]value更改后的替代文本(修复模式下修改)。
返回
None.

◆ setIs_decorative_figure()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.setIs_decorative_figure ( boolean  value)

Set 是否为装饰性图像(无替代文本)。

参数
[in]value是否为装饰性图像(无替代文本)。
返回
None.

◆ setPage_index()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.setPage_index ( int  value)

Set 图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。

参数
[in]value图像所在的零基页面索引。有效取值范围为 0 到 (count - 1),其中 count 为函数 pdf.PDFDoc.getPageCount 返回的页面总数。
返回
None.

◆ setRect()

com.foxit.sdk.addon.accessibility.AlternateTextFigureData.setRect ( RectF  value)

Set 图像在页面上的边界矩形。

参数
[in]value图像在页面上的边界矩形。
返回
None.