com.foxit.sdk.pdf.objects.PDFArray类 参考

类 com.foxit.sdk.pdf.objects.PDFArray 继承关系图:

Public 成员函数
void	addBoolean (boolean boolean_value) throws com.foxit.sdk.PDFException
	将布尔值添加到当前PDF数组对象的末尾。 更多...
void	addDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
	将日期时间添加到当前PDF数组对象的末尾。 更多...
void	addElement (PDFObject element) throws com.foxit.sdk.PDFException
	将PDF对象添加到当前PDF数组对象的末尾。 更多...
void	addFloat (float float_value) throws com.foxit.sdk.PDFException
	将浮点数值添加到当前PDF数组对象的末尾。 更多...
void	addInteger (int integer_value) throws com.foxit.sdk.PDFException
	将整数值添加到当前PDF数组对象的末尾。 更多...
void	addMatrix (Matrix2D matrix) throws com.foxit.sdk.PDFException
	将矩阵添加到当前PDF数组对象的末尾。 更多...
void	addName (String name) throws com.foxit.sdk.PDFException
	将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。 更多...
void	addRect (RectF rect) throws com.foxit.sdk.PDFException
	将矩形添加到当前PDF数组对象的末尾。 更多...
void	addReference (PDFObject pdf_object, PDFDoc document) throws com.foxit.sdk.PDFException
	将间接PDF对象（其对象编号总是大于0）的引用对象设置为值元素。 更多...
void	addString (String new_string) throws com.foxit.sdk.PDFException
	将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
PDFObject	getElement (int index) throws com.foxit.sdk.PDFException
	通过索引获取指定的元素。 更多...
int	getElementCount () throws com.foxit.sdk.PDFException
	获取元素的数量。 更多...
void	insertAt (int index, PDFObject element) throws com.foxit.sdk.PDFException
	将PDF对象插入到当前PDF数组对象的指定位置。 更多...
void	removeAt (int index) throws com.foxit.sdk.PDFException
	从当前PDF数组对象中移除指定位置（按索引）的元素。 更多...
void	setAt (int index, PDFObject element) throws com.foxit.sdk.PDFException
	在当前PDF数组对象的指定位置设置新的PDF对象。 更多...
Public 成员函数 继承自 com.foxit.sdk.pdf.objects.PDFObject
PDFObject	cloneObject ()
	克隆当前PDF对象并获取克隆的PDF对象。 更多...
PDFObject	deepCloneObject ()
	克隆当前PDF对象并获取克隆的PDF对象。 更多...
PDFArray	getArray ()
	获取当前PDF对象的PDF数组对象。 更多...
boolean	getBoolean () throws com.foxit.sdk.PDFException
	获取当前PDF对象的布尔值。 更多...
DateTime	getDateTime () throws com.foxit.sdk.PDFException
	获取当前PDF对象的日期时间值。 更多...
PDFDictionary	getDict ()
	获取当前PDF对象的PDF字典对象。 更多...
PDFObject	getDirectObject ()
	获取当前PDF对象的直接对象。 更多...
float	getFloat () throws com.foxit.sdk.PDFException
	获取当前PDF对象的浮点数值。 更多...
int	getInteger () throws com.foxit.sdk.PDFException
	获取当前PDF对象的整数值。 更多...
Matrix2D	getMatrix () throws com.foxit.sdk.PDFException
	获取当前PDF对象的矩阵值。 更多...
String	getName () throws com.foxit.sdk.PDFException
	获取当前PDF对象的名称值。 更多...
int	getObjNum ()
	获取当前PDF对象的间接对象编号。 更多...
RectF	getRect () throws com.foxit.sdk.PDFException
	获取当前PDF对象的矩形值。 更多...
PDFStream	getStream ()
	获取当前PDF对象的PDF流对象。 更多...
byte[]	getString ()
	获取当前PDF对象的字符串值。 更多...
int	getType ()
	获取当前PDF对象的类型。 更多...
String	getWideString ()
	获取当前PDF对象的宽字符串值。 更多...
boolean	isIdentical (PDFObject pdf_obj)
	检查输入的PDF对象是否与当前PDF对象相同。 更多...
void	release ()
	释放新创建的PDF对象或克隆PDF对象， 该对象与PDF文档或其他PDF对象无关且不会再使用。 更多...

静态 Public 成员函数
static PDFArray	create () throws com.foxit.sdk.PDFException
	创建新的数组对象。 更多...
static PDFArray	createFromMatrix (Matrix2D matrix) throws com.foxit.sdk.PDFException
	为矩阵创建新的数组对象。 更多...
static PDFArray	createFromRect (RectF rect) throws com.foxit.sdk.PDFException
	为矩形创建新的数组对象。 更多...
静态 Public 成员函数 继承自 com.foxit.sdk.pdf.objects.PDFObject
static PDFObject	createFromBoolean (boolean boolean_value)
	从布尔值创建PDF对象。 更多...
static PDFObject	createFromDateTime (DateTime date_time)
	从日期时间创建PDF对象。 更多...
static PDFObject	createFromFloat (float float_value)
	从浮点数创建PDF对象。 更多...
static PDFObject	createFromInteger (int integer_value)
	Create a PDF object from a integer number. 更多...
static PDFObject	createFromName (String name)
	从表示名称的字符串创建PDF对象。 更多...
static PDFObject	createFromNameW (String name)
	从表示名称的字符串创建PDF对象。 更多...
static PDFObject	createFromString (String string_value)
	从字符串创建PDF对象。 更多...
static PDFObject	createFromString (String string_value, int length)
	从字符串创建PDF对象。 更多...
static PDFObject	createReference (PDFDoc document, int object_number)
	为间接对象创建引用。 更多...

额外继承的成员函数
静态 Public 属性 继承自 com.foxit.sdk.pdf.objects.PDFObject
static final int	e_Array = 5
	PDF数组对象。
static final int	e_Boolean = 1
	PDF布尔对象。
static final int	e_Dictionary = 6
	PDF字典对象。
static final int	e_InvalidType = 0
	无效的PDF对象类型。
static final int	e_Name = 4
	PDF名称对象。
static final int	e_Null = 8
	PDF空对象。
static final int	e_Number = 2
	PDF数字对象。
static final int	e_Reference = 9
	PDF引用对象。
static final int	e_Stream = 7
	PDF流对象。
static final int	e_String = 3
	PDF字符串对象。

详细描述

PDF数组对象是按顺序排列的对象的一维集合。 与许多其他计算机语言中的数组不同，PDF数组中的元素可以是数字、 字符串、字典或任何其他对象（包括其他数组）的任意组合。 有关更多详细信息，请参阅<PDF Reference 1.7>中的第3.2.5节“数组对象”。
类com.foxit.sdk.pdf.objects.PDFArray 派生自PDFObject ，并提供函数来创建新的PDF数组对象以及 获取/设置PDF数组对象的元素。

参见

PDFObject

成员函数说明

addBoolean()

void com.foxit.sdk.pdf.objects.PDFArray.addBoolean

(

boolean

boolean_value

)

throws com.foxit.sdk.PDFException

将布尔值添加到当前PDF数组对象的末尾。

参数

[in]

boolean_value

要添加到当前PDF数组对象的布尔值。

返回

无。

addDateTime()

void com.foxit.sdk.pdf.objects.PDFArray.addDateTime

(

DateTime

date_time

)

throws com.foxit.sdk.PDFException

将日期时间添加到当前PDF数组对象的末尾。

参数

[in]

date_time

要添加到当前PDF数组对象的日期时间。

返回

无。

addElement()

void com.foxit.sdk.pdf.objects.PDFArray.addElement

(

PDFObject

element

)

throws com.foxit.sdk.PDFException

将PDF对象添加到当前PDF数组对象的末尾。

参数

[in]

element

要添加到当前PDF数组对象的PDF对象。它不应为null。

返回

无。

addFloat()

void com.foxit.sdk.pdf.objects.PDFArray.addFloat

(

float

float_value

)

throws com.foxit.sdk.PDFException

将浮点数值添加到当前PDF数组对象的末尾。

参数

[in]

float_value

要添加到当前PDF数组对象的浮点数值。

返回

无。

addInteger()

void com.foxit.sdk.pdf.objects.PDFArray.addInteger

(

int

integer_value

)

throws com.foxit.sdk.PDFException

将整数值添加到当前PDF数组对象的末尾。

参数

[in]

integer_value

要添加到当前PDF数组对象的整数值。

返回

无。

addMatrix()

void com.foxit.sdk.pdf.objects.PDFArray.addMatrix

(

Matrix2D

matrix

)

throws com.foxit.sdk.PDFException

将矩阵添加到当前PDF数组对象的末尾。

参数

[in]

matrix

要添加到当前PDF数组对象的矩阵。

返回

无。

addName()

void com.foxit.sdk.pdf.objects.PDFArray.addName

(

String

name

)

throws com.foxit.sdk.PDFException

将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。

参数

[in]

name

要作为PDF名称对象添加到当前PDF数组对象的字符串。 它不应为空字符串。

返回

无。

addRect()

void com.foxit.sdk.pdf.objects.PDFArray.addRect

(

RectF

rect

)

throws com.foxit.sdk.PDFException

将矩形添加到当前PDF数组对象的末尾。

参数

[in]

rect

要添加到当前PDF数组对象的矩形。

返回

无。

addReference()

void com.foxit.sdk.pdf.objects.PDFArray.addReference	(	PDFObject	pdf_object,
		PDFDoc	document
	)		throws com.foxit.sdk.PDFException

将间接PDF对象（其对象编号总是大于0）的引用对象设置为值元素。

如果用户想要将直接PDF对象（其对象编号总是等于0）设置到条目， 请参考函数PDFDictionary.setAt 。

参数

[in]	pdf_object	一个PDFObject 对象，它是一个间接PDF对象（其对象编号总是大于0）， 将通过引用此间接对象的引用对象设置到条目。它不应为null。
[in]	document	一个有效的PDF文档对象，当前PDF字典对象属于该文档， 且参数pdf_object是或将是其中的间接对象。

返回

无。

addString()

void com.foxit.sdk.pdf.objects.PDFArray.addString

(

String

new_string

)

throws com.foxit.sdk.PDFException

将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。

参数

[in]

new_string

要作为PDF字符串对象添加到当前PDF数组对象的字符串。 它不应为空字符串。

返回

无。

create()

static PDFArray com.foxit.sdk.pdf.objects.PDFArray.create ( ) throws com.foxit.sdk.PDFException

static

创建新的数组对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用， 请调用函数PDFObject.release 来释放该对象。

返回

一个新的PDFArray 对象。 如果有任何错误，此函数将返回null。

createFromMatrix()

static PDFArray com.foxit.sdk.pdf.objects.PDFArray.createFromMatrix ( Matrix2D  matrix ) throws com.foxit.sdk.PDFException

static

为矩阵创建新的数组对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用， 请调用函数PDFObject.release 来释放该对象。

参数

[in]

matrix

一个矩阵。

返回

一个新的PDFArray 对象。 如果有任何错误，此函数将返回null。

createFromRect()

static PDFArray com.foxit.sdk.pdf.objects.PDFArray.createFromRect ( RectF  rect ) throws com.foxit.sdk.PDFException

static

为矩形创建新的数组对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用， 请调用函数PDFObject.release 来释放该对象。

参数

[in]

rect

一个矩形。

返回

一个新的PDFArray 对象。 如果有任何错误，此函数将返回null。

delete()

synchronized void com.foxit.sdk.pdf.objects.PDFArray.delete

(

)

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

返回

无。

注解

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

重载 com.foxit.sdk.pdf.objects.PDFObject .

getElement()

PDFObject com.foxit.sdk.pdf.objects.PDFArray.getElement

(

int

index

)

throws com.foxit.sdk.PDFException

通过索引获取指定的元素。

参数

[in]

index

要检索的元素的索引。有效范围：从0到(count-1)。 count由函数PDFArray.getElementCount 返回。

返回

一个PDFObject 对象，接收指定的元素。 如果有任何错误，此函数将返回null。

getElementCount()

int com.foxit.sdk.pdf.objects.PDFArray.getElementCount

(

)

throws com.foxit.sdk.PDFException

获取元素的数量。

返回

元素数量。

insertAt()

void com.foxit.sdk.pdf.objects.PDFArray.insertAt	(	int	index,
		PDFObject	element
	)		throws com.foxit.sdk.PDFException

将PDF对象插入到当前PDF数组对象的指定位置。

参数

[in]	index	参数element将被插入到的位置的索引。 有效范围：从0到(count-1)。 count由函数PDFArray.getElementCount 返回。 如果小于0或当前PDF数组中的元素数量为0， 参数element将被插入到第一个位置。 如果大于当前PDF数组中的元素数量， 参数element将被添加到末尾。
[in]	element	要插入到当前PDF数组对象的PDF对象。它不应为null。

返回

无。

removeAt()

void com.foxit.sdk.pdf.objects.PDFArray.removeAt

(

int

index

)

throws com.foxit.sdk.PDFException

从当前PDF数组对象中移除指定位置（按索引）的元素。

参数

[in]

index

将被移除的元素的位置的索引。 有效范围：从0到(count-1)。 count由函数PDFArray.getElementCount 返回。

返回

无。

setAt()

void com.foxit.sdk.pdf.objects.PDFArray.setAt	(	int	index,
		PDFObject	element
	)		throws com.foxit.sdk.PDFException

在当前PDF数组对象的指定位置设置新的PDF对象。

参数

[in]	index	参数element将被设置到的位置的索引。 有效范围：从0到(count-1)。 count由函数PDFArray.getElementCount 返回。
[in]	element	要设置到当前PDF数组对象的PDF对象。它不应为null。

返回

无。