Foxit PDF SDK
FSXFAPage类 参考
类 FSXFAPage 继承关系图:
FSBase

构造函数

(FSMatrix2D *) - getDisplayMatrix:top:width:height:rotate:
 获取显示矩阵,从 PDF 坐标系统到目标设备坐标系统。
更多...
 
(FSXFAWidget *) - getFirstWidget
 获取当前制表顺序中的第一个 XFA 控件。
更多...
 
(float) - getHeight
 获取 XFA 页面的高度。
更多...
 
(int) - getIndex
 获取 XFA 页面的索引。
更多...
 
(FSXFAWidget *) - getLastWidget
 获取当前制表顺序中的最后一个 XFA 控件。
更多...
 
(FSXFAWidget *) - getNextWidget:
 获取当前制表顺序中指定 XFA 控件的下一个 XFA 控件。
更多...
 
(FSXFAWidget *) - getPrevWidget:
 获取当前制表顺序中指定 XFA 控件的上一个 XFA 控件。
更多...
 
(FSXFAWidget *) - getWidget:
 按索引获取 XFA 控件。
更多...
 
(FSXFAWidget *) - getWidgetAtDevicePoint:device_point:tolerance:
 在设备坐标系统中的指定点获取 XFA 控件。
更多...
 
(FSXFAWidget *) - getWidgetByFullName:
 获取在当前 XFA 页面中与指定全名匹配的 XFA 控件。
更多...
 
(int) - getWidgetCount
 获取 XFA 控件的数量。
更多...
 
(float) - getWidth
 获取宽度。
更多...
 
(id) - initWithOther:
 构造函数,使用另一个 XFA 页面对象。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 

详细描述

FSXFAPage 表示从 XFA 文档对象检索的 XFA 页面。
要渲染 XFA 页面,请使用函数 FSRenderer::startRenderXFAPage:matrix:is_highlight:pause:

参见
FSRenderer

函数文档

◆ getDisplayMatrix:top:width:height:rotate:()

- (FSMatrix2D *) getDisplayMatrix: (int)  left
top: (int)  top
width: (int)  width
height: (int)  height
rotate: (FSRotation rotate 

获取显示矩阵,从 PDF 坐标系统到目标设备坐标系统。

参数
[in]left设备坐标系统中变换区域的左侧位置,通常以像素为单位。
[in]top设备坐标系统中变换区域的顶部位置,通常以像素为单位。
[in]width设备坐标系统中变换区域的宽度,通常以像素为单位。
[in]height设备坐标系统中变换区域的高度,通常以像素为单位。
[in]rotate旋转值。请参考从 FSRotation0 开始的值, 这应该是这些值之一。
返回
接收用于当前 XFA 页面的显示矩阵的 Matrix 对象。 如果有任何错误,将返回所有值都为 0 的 Matrix。

◆ getFirstWidget()

- (FSXFAWidget *) getFirstWidget

获取当前制表顺序中的第一个 XFA 控件。

返回
第一个 XFA 控件。如果返回的 XFA 控件对象的函数 FSXFAWidget::isEmpty 的返回值为 YES,表示没有 XFA 控件。

◆ getHeight()

- (float) getHeight

获取 XFA 页面的高度。

返回
接收当前 XFA 页面高度的浮点值。

◆ getIndex()

- (int) getIndex

获取 XFA 页面的索引。

返回
XFA 页面的索引。

◆ getLastWidget()

- (FSXFAWidget *) getLastWidget

获取当前制表顺序中的最后一个 XFA 控件。

返回
最后一个 XFA 控件。如果返回的 XFA 控件对象的函数 FSXFAWidget::isEmpty 的返回值为 YES,表示没有 XFA 控件。

◆ getNextWidget:()

- (FSXFAWidget *) getNextWidget: (FSXFAWidget*)  widget

获取当前制表顺序中指定 XFA 控件的下一个 XFA 控件。

参数
[in]widget有效的指定 XFA 控件。
返回
下一个 XFA 控件。如果返回的 XFA 控件对象的函数 FSXFAWidget::isEmpty 的返回值为 YES,表示指定的 XFA 控件是当前制表顺序中的最后一个 XFA 控件。

◆ getPrevWidget:()

- (FSXFAWidget *) getPrevWidget: (FSXFAWidget*)  widget

获取当前制表顺序中指定 XFA 控件的上一个 XFA 控件。

参数
[in]widget有效的指定 XFA 控件。
返回
上一个 XFA 控件。如果返回的 XFA 控件对象的函数 FSXFAWidget::isEmpty 的返回值为 YES,表示指定的 XFA 控件是当前制表顺序中的第一个 XFA 控件。

◆ getWidget:()

- (FSXFAWidget *) getWidget: (int)  widget_index

按索引获取 XFA 控件。

参数
[in]widget_indexXFA 控件索引。有效范围:从 0 到 (count-1)。 count 由函数 FSXFAPage::getWidgetCount 返回。
返回
XFA 控件。

◆ getWidgetAtDevicePoint:device_point:tolerance:()

- (FSXFAWidget *) getWidgetAtDevicePoint: (FSMatrix2D*)  matrix
device_point: (FSPointF*)  device_point
tolerance: (float)  tolerance 

在设备坐标系统中的指定点获取 XFA 控件。

参数
[in]matrix变换矩阵。通常这由函数 FSXFAPage::getDisplayMatrix:top:width:height:rotate: 返回。
[in]device_point设备坐标系统中的点。
[in]tolerance容差值。有效范围:0.0f 到 30.0f。
返回
XFA 控件对象。

◆ getWidgetByFullName:()

- (FSXFAWidget *) getWidgetByFullName: (NSString *)  full_name

获取在当前 XFA 页面中与指定全名匹配的 XFA 控件。

参数
[in]full_nameXFA 控件的全名。它不应该是空字符串。 XFA 控件的全名可以通过函数 FSXFAWidget::getName: 使用类型 FSXFAWidgetWidgetNameTypeFullName 在之前的过程中检索。
返回
XFA 控件对象。

◆ getWidgetCount()

- (int) getWidgetCount

获取 XFA 控件的数量。

返回
XFA 控件的数量。

◆ getWidth()

- (float) getWidth

获取宽度。

返回
接收当前 XFA 页面宽度的浮点值。

◆ initWithOther:()

- (id) initWithOther: (FSXFAPage*)  other

构造函数,使用另一个 XFA 页面对象。

参数
[in]other另一个 XFA 页面对象。

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

当前对象为空时,表示当前对象无用。

返回
YES 表示当前对象为空,NO 表示不为空。