FSPDFArray类 参考

类 FSPDFArray 继承关系图:

构造函数
(void)	- addBoolean:
	将布尔值添加到当前PDF数组对象的末尾。 更多...
(void)	- addDateTime:
	将日期时间添加到当前PDF数组对象的末尾。 更多...
(void)	- addElement:
	将PDF对象添加到当前PDF数组对象的末尾。 更多...
(void)	- addFloat:
	将浮点数值添加到当前PDF数组对象的末尾。 更多...
(void)	- addInteger:
	将整数值添加到当前PDF数组对象的末尾。 更多...
(void)	- addMatrix:
	将矩阵添加到当前PDF数组对象的末尾。 更多...
(void)	- addName:
	将字符串作为PDF名称对象添加到当前PDF数组对象的末尾。 更多...
(void)	- addRect:
	将矩形添加到当前PDF数组对象的末尾。 更多...
(void)	- addReference:document:
	将间接PDF对象（其对象编号总是大于0）的引用对象设置为值元素。 更多...
(void)	- addString:
	将字符串作为PDF字符串对象添加到当前PDF数组对象的末尾。 更多...
(FSPDFObject *)	- getElement:
	通过索引获取指定的元素。 更多...
(int)	- getElementCount
	获取元素的数量。 更多...
(void)	- insertAt:element:
	将PDF对象插入到当前PDF数组对象的指定位置。 更多...
(void)	- removeAt:
	从当前PDF数组对象中移除指定位置（按索引）的元素。 更多...
(void)	- setAt:element:
	在当前PDF数组对象的指定位置设置新的PDF对象。 更多...
构造函数 继承自 FSPDFObject
(FSPDFObject *)	- cloneObject
	克隆当前PDF对象并获取克隆的PDF对象。 更多...
(FSPDFObject *)	- deepCloneObject
	克隆当前PDF对象并获取克隆的PDF对象。 更多...
(void)	- destroy
	释放新创建的PDF对象或克隆PDF对象， 该对象与PDF文档或其他PDF对象无关且不会再使用。 更多...
(FSPDFArray *)	- getArray
	获取当前PDF对象的PDF数组对象。 更多...
(BOOL)	- getBoolean
	获取当前PDF对象的布尔值。 更多...
(FSDateTime *)	- getDateTime
	获取当前PDF对象的日期时间值。 更多...
(FSPDFDictionary *)	- getDict
	获取当前PDF对象的PDF字典对象。 更多...
(FSPDFObject *)	- getDirectObject
	获取当前PDF对象的直接对象。 更多...
(float)	- getFloat
	获取当前PDF对象的浮点数值。 更多...
(int)	- getInteger
	获取当前PDF对象的整数值。 更多...
(FSMatrix2D *)	- getMatrix
	获取当前PDF对象的矩阵值。 更多...
(NSString *)	- getName
	获取当前PDF对象的名称值。 更多...
(unsigned int)	- getObjNum
	获取当前PDF对象的间接对象编号。 更多...
(FSRectF *)	- getRect
	获取当前PDF对象的矩形值。 更多...
(FSPDFStream *)	- getStream
	获取当前PDF对象的PDF流对象。 更多...
(NSData *)	- getString
	获取当前PDF对象的字符串值。 更多...
(FSPDFObjectType)	- getType
	获取当前PDF对象的类型。 更多...
(NSString *)	- getWideString
	获取当前PDF对象的宽字符串值。 更多...
(BOOL)	- isIdentical:
	检查输入的PDF对象是否与当前PDF对象相同。 更多...

类方法
(FSPDFArray *)	+ create
	创建新的数组对象。 更多...
(FSPDFArray *)	+ createFromMatrix:
	为矩阵创建新的数组对象。 更多...
(FSPDFArray *)	+ createFromRect:
	为矩形创建新的数组对象。 更多...
类方法 继承自 FSPDFObject
(FSPDFObject *)	+ createFromBoolean:
	从布尔值创建PDF对象。 更多...
(FSPDFObject *)	+ createFromDateTime:
	从日期时间创建PDF对象。 更多...
(FSPDFObject *)	+ createFromFloat:
	从浮点数创建PDF对象。 更多...
(FSPDFObject *)	+ createFromInteger:
	Create a PDF object from a integer number. 更多...
(FSPDFObject *)	+ createFromName:
	从表示名称的字符串创建PDF对象。 更多...
(FSPDFObject *)	+ createFromNameW:
	从表示名称的字符串创建PDF对象。 更多...
(FSPDFObject *)	+ createFromString:
	从字符串创建PDF对象。 更多...
(FSPDFObject *)	+ createFromStringWithLength:length:
	从字符串创建PDF对象。 更多...
(FSPDFObject *)	+ createReference:object_number:
	为间接对象创建引用。 更多...

详细描述

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

参见

FSPDFObject

函数文档

addBoolean:()

- (void) addBoolean:

(BOOL)

boolean_value

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

参数

[in]

boolean_value

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

返回

无。

addDateTime:()

- (void) addDateTime:

(FSDateTime*)

date_time

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

参数

[in]

date_time

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

返回

无。

addElement:()

- (void) addElement:

(FSPDFObject*)

element

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

参数

[in]

element

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

返回

无。

addFloat:()

- (void) addFloat:

(float)

float_value

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

参数

[in]

float_value

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

返回

无。

addInteger:()

- (void) addInteger:

(int)

integer_value

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

参数

[in]

integer_value

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

返回

无。

addMatrix:()

- (void) addMatrix:

(FSMatrix2D*)

matrix

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

参数

[in]

matrix

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

返回

无。

addName:()

- (void) addName:

(NSString *)

name

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

参数

[in]

name

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

返回

无。

addRect:()

- (void) addRect:

(FSRectF*)

rect

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

参数

[in]

rect

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

返回

无。

addReference:document:()

- (void) addReference:		(FSPDFObject*)	pdf_object
document:		(FSPDFDoc*)	document

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

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

参数

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

返回

无。

addString:()

- (void) addString:

(NSString *)

new_string

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

参数

[in]

new_string

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

返回

无。

create()

+ (FSPDFArray *) create

创建新的数组对象。

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

返回

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

createFromMatrix:()

+ (FSPDFArray *) createFromMatrix:

(FSMatrix2D*)

matrix

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

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

参数

[in]

matrix

一个矩阵。

返回

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

createFromRect:()

+ (FSPDFArray *) createFromRect:

(FSRectF*)

rect

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

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

参数

[in]

rect

一个矩形。

返回

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

getElement:()

- (FSPDFObject *) getElement:

(int)

index

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

参数

[in]

index

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

返回

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

getElementCount()

- (int) getElementCount

获取元素的数量。

返回

元素数量。

insertAt:element:()

- (void) insertAt:		(int)	index
element:		(FSPDFObject*)	element

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

参数

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

返回

无。

removeAt:()

- (void) removeAt:

(int)

index

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

参数

[in]

index

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

返回

无。

setAt:element:()

- (void) setAt:		(int)	index
element:		(FSPDFObject*)	element

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

参数

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

返回

无。