com.foxit.sdk.addon.xfa.XFAPage类 参考

类 com.foxit.sdk.addon.xfa.XFAPage 继承关系图:

Public 成员函数
	XFAPage (XFAPage other)
	构造函数，使用另一个 XFA 页面对象。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
Matrix2D	getDisplayMatrix (int left, int top, int width, int height, int rotate) throws com.foxit.sdk.PDFException
	获取显示矩阵，从 PDF 坐标系统到目标设备坐标系统。 更多...
XFAWidget	getFirstWidget () throws com.foxit.sdk.PDFException
	获取当前制表顺序中的第一个 XFA 控件。 更多...
float	getHeight () throws com.foxit.sdk.PDFException
	获取 XFA 页面的高度。 更多...
int	getIndex () throws com.foxit.sdk.PDFException
	获取 XFA 页面的索引。 更多...
XFAWidget	getLastWidget () throws com.foxit.sdk.PDFException
	获取当前制表顺序中的最后一个 XFA 控件。 更多...
XFAWidget	getNextWidget (XFAWidget widget) throws com.foxit.sdk.PDFException
	获取当前制表顺序中指定 XFA 控件的下一个 XFA 控件。 更多...
XFAWidget	getPrevWidget (XFAWidget widget) throws com.foxit.sdk.PDFException
	获取当前制表顺序中指定 XFA 控件的上一个 XFA 控件。 更多...
XFAWidget	getWidget (int widget_index) throws com.foxit.sdk.PDFException
	按索引获取 XFA 控件。 更多...
XFAWidget	getWidgetAtDevicePoint (Matrix2D matrix, PointF device_point, float tolerance) throws com.foxit.sdk.PDFException
	在设备坐标系统中的指定点获取 XFA 控件。 更多...
XFAWidget	getWidgetByFullName (String full_name) throws com.foxit.sdk.PDFException
	获取在当前 XFA 页面中与指定全名匹配的 XFA 控件。 更多...
int	getWidgetCount () throws com.foxit.sdk.PDFException
	获取 XFA 控件的数量。 更多...
float	getWidth () throws com.foxit.sdk.PDFException
	获取宽度。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...

详细描述

类 XFAPage 表示从 XFA 文档对象检索的 XFA 页面。
要渲染 XFA 页面，请使用函数 common.Renderer.startRenderXFAPage 。

参见

com.foxit.sdk.common.Renderer

构造及析构函数说明

XFAPage()

com.foxit.sdk.addon.xfa.XFAPage.XFAPage

(

XFAPage

other

)

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

参数

[in]

other

另一个 XFA 页面对象。

成员函数说明

delete()

synchronized void com.foxit.sdk.addon.xfa.XFAPage.delete

(

)

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

返回

无。

注解

一旦这个接口被调用，这个对象将不能再被使用。

重载 com.foxit.sdk.common.Base .

getDisplayMatrix()

Matrix2D com.foxit.sdk.addon.xfa.XFAPage.getDisplayMatrix	(	int	left,
		int	top,
		int	width,
		int	height,
		int	rotate
	)		throws com.foxit.sdk.PDFException

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

参数

[in]	left	设备坐标系统中变换区域的左侧位置，通常以像素为单位。
[in]	top	设备坐标系统中变换区域的顶部位置，通常以像素为单位。
[in]	width	设备坐标系统中变换区域的宽度，通常以像素为单位。
[in]	height	设备坐标系统中变换区域的高度，通常以像素为单位。
[in]	rotate	旋转值。请参考从 com.foxit.sdk.common.Constants.e_Rotation0 开始的值， 这应该是这些值之一。

返回

接收用于当前 XFA 页面的显示矩阵的 Matrix 对象。 如果有任何错误，将返回所有值都为 0 的 Matrix。

getFirstWidget()

XFAWidget com.foxit.sdk.addon.xfa.XFAPage.getFirstWidget

(

)

throws com.foxit.sdk.PDFException

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

返回

第一个 XFA 控件。如果返回的 XFA 控件对象的函数 XFAWidget.isEmpty 的返回值为 true，表示没有 XFA 控件。

getHeight()

float com.foxit.sdk.addon.xfa.XFAPage.getHeight

(

)

throws com.foxit.sdk.PDFException

获取 XFA 页面的高度。

返回

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

getIndex()

int com.foxit.sdk.addon.xfa.XFAPage.getIndex

(

)

throws com.foxit.sdk.PDFException

获取 XFA 页面的索引。

返回

XFA 页面的索引。

getLastWidget()

XFAWidget com.foxit.sdk.addon.xfa.XFAPage.getLastWidget

(

)

throws com.foxit.sdk.PDFException

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

返回

最后一个 XFA 控件。如果返回的 XFA 控件对象的函数 XFAWidget.isEmpty 的返回值为 true，表示没有 XFA 控件。

getNextWidget()

XFAWidget com.foxit.sdk.addon.xfa.XFAPage.getNextWidget

(

XFAWidget

widget

)

throws com.foxit.sdk.PDFException

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

参数

[in]

widget

有效的指定 XFA 控件。

返回

下一个 XFA 控件。如果返回的 XFA 控件对象的函数 XFAWidget.isEmpty 的返回值为 true，表示指定的 XFA 控件是当前制表顺序中的最后一个 XFA 控件。

getPrevWidget()

XFAWidget com.foxit.sdk.addon.xfa.XFAPage.getPrevWidget

(

XFAWidget

widget

)

throws com.foxit.sdk.PDFException

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

参数

[in]

widget

有效的指定 XFA 控件。

返回

上一个 XFA 控件。如果返回的 XFA 控件对象的函数 XFAWidget.isEmpty 的返回值为 true，表示指定的 XFA 控件是当前制表顺序中的第一个 XFA 控件。

getWidget()

XFAWidget com.foxit.sdk.addon.xfa.XFAPage.getWidget

(

int

widget_index

)

throws com.foxit.sdk.PDFException

按索引获取 XFA 控件。

参数

[in]

widget_index

XFA 控件索引。有效范围：从 0 到 (count-1)。 count 由函数 XFAPage.getWidgetCount 返回。

返回

XFA 控件。

getWidgetAtDevicePoint()

XFAWidget com.foxit.sdk.addon.xfa.XFAPage.getWidgetAtDevicePoint	(	Matrix2D	matrix,
		PointF	device_point,
		float	tolerance
	)		throws com.foxit.sdk.PDFException

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

参数

[in]	matrix	变换矩阵。通常这由函数 XFAPage.getDisplayMatrix 返回。
[in]	device_point	设备坐标系统中的点。
[in]	tolerance	容差值。有效范围：0.0f 到 30.0f。

返回

XFA 控件对象。

getWidgetByFullName()

XFAWidget com.foxit.sdk.addon.xfa.XFAPage.getWidgetByFullName

(

String

full_name

)

throws com.foxit.sdk.PDFException

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

参数

[in]

full_name

XFA 控件的全名。它不应该是空字符串。 XFA 控件的全名可以通过函数 XFAWidget.getName 使用类型 com.foxit.sdk.addon.xfa.XFAWidget.e_WidgetNameTypeFullName 在之前的过程中检索。

返回

XFA 控件对象。

getWidgetCount()

int com.foxit.sdk.addon.xfa.XFAPage.getWidgetCount

(

)

throws com.foxit.sdk.PDFException

获取 XFA 控件的数量。

返回

XFA 控件的数量。

getWidth()

float com.foxit.sdk.addon.xfa.XFAPage.getWidth

(

)

throws com.foxit.sdk.PDFException

获取宽度。

返回

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

isEmpty()

boolean com.foxit.sdk.addon.xfa.XFAPage.isEmpty

(

)

检查当前对象是否为空。

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

返回

true 表示当前对象为空，false 表示不为空。