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

Public 成员函数
synchronized void	delete ()
	直接清除C++相关资源。更多...

PDFObject	getElement (String key) throws com.foxit.sdk.PDFException
	获取具有指定键的条目的值元素。更多...

String	getKey (long position) throws com.foxit.sdk.PDFException
	获取由位置指定的条目的键。更多...

PDFObject	getValue (long position) throws com.foxit.sdk.PDFException
	获取由位置指定的条目的值元素。更多...

boolean	hasKey (String key) throws com.foxit.sdk.PDFException
	检查当前字典中是否存在具有指定键的条目。更多...

long	moveNext (long position) throws com.foxit.sdk.PDFException
	移动到第一个或下一个条目的位置。更多...

void	removeAt (String key) throws com.foxit.sdk.PDFException
	移除由键指定的条目。更多...

void	setAt (String key, PDFObject pdf_object) throws com.foxit.sdk.PDFException
	将直接PDF对象（其对象编号总是等于0）作为值元素设置到由键指定的条目。更多...

void	setAtBoolean (String key, boolean value) throws com.foxit.sdk.PDFException
	将布尔元素设置到由键指定的条目。更多...

void	setAtDateTime (String key, DateTime value) throws com.foxit.sdk.PDFException
	将Datetime对象作为值元素设置到由键指定的条目。更多...

void	setAtFloat (String key, float value) throws com.foxit.sdk.PDFException
	将浮点数元素设置到由键指定的条目。更多...

void	setAtInteger (String key, int value) throws com.foxit.sdk.PDFException
	将整数元素设置到由键指定的条目。更多...

void	setAtMatrix (String key, Matrix2D value) throws com.foxit.sdk.PDFException
	将矩阵对象作为值元素设置到由键指定的条目。更多...

void	setAtName (String key, String value) throws com.foxit.sdk.PDFException
	将字符串（作为PDF名称对象）作为值元素设置到由键指定的条目。更多...

void	setAtRect (String key, RectF value) throws com.foxit.sdk.PDFException
	将矩形对象作为值元素设置到由键指定的条目。更多...

void	setAtReference (String key, PDFObject pdf_object, PDFDoc document) throws com.foxit.sdk.PDFException
	将间接PDF对象（其对象编号总是大于0）的引用对象作为值元素设置到由键指定的条目。更多...

void	setAtString (String key, String value) throws com.foxit.sdk.PDFException
	将字符串作为值元素设置到由键指定的条目。更多...

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 PDFDictionary	create () 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对象，包括另一个字典。在同一个字典中，不应有两个条目具有相同的键。有关更多详细信息，请参阅<PDF Reference 1.7>中的第3.2.6节“字典对象”。
类com.foxit.sdk.pdf.objects.PDFDictionary 派生自PDFObject ，并提供函数来创建新的PDF字典对象以及获取/设置PDF字典对象中的条目。

参见: PDFObject

成员函数说明

◆ create()

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

static

创建新的字典对象。

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

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

◆ delete()

synchronized void com.foxit.sdk.pdf.objects.PDFDictionary.delete ( )

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

返回: 无。

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

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

◆ getElement()

PDFObject com.foxit.sdk.pdf.objects.PDFDictionary.getElement ( String key ) throws com.foxit.sdk.PDFException

获取具有指定键的条目的值元素。

参数

[in] key 条目的键。它不应为空字符串。

返回: 一个PDFObject 对象，接收具有指定键的值。如果未找到，此函数将返回null。

◆ getKey()

String com.foxit.sdk.pdf.objects.PDFDictionary.getKey ( long position ) throws com.foxit.sdk.PDFException

获取由位置指定的条目的键。

参数

[in] position 指定条目位置的POSITION。它不应为null或0。

返回: 指定条目的键。

◆ getValue()

PDFObject com.foxit.sdk.pdf.objects.PDFDictionary.getValue ( long position ) throws com.foxit.sdk.PDFException

获取由位置指定的条目的值元素。

参数

[in] position 指定条目位置的POSITION。它不应为null或0。

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

◆ hasKey()

boolean com.foxit.sdk.pdf.objects.PDFDictionary.hasKey ( String key ) throws com.foxit.sdk.PDFException

检查当前字典中是否存在具有指定键的条目。

参数

[in] key 要检查的键。它不应为空字符串。

返回: true表示指定的键存在于当前字典中，而false表示不存在。

◆ moveNext()

long com.foxit.sdk.pdf.objects.PDFDictionary.moveNext ( long position ) throws com.foxit.sdk.PDFException

移动到第一个或下一个条目的位置。

参数

[in] position 一个POSITION，指示字典中当前条目的位置。如果为null或0，将返回字典中第一个条目的位置。

返回: 一个POSITION，表示字典中下一个条目的位置。 null或0表示当前条目是字典中的最后一个。

◆ removeAt()

void com.foxit.sdk.pdf.objects.PDFDictionary.removeAt ( String key ) throws com.foxit.sdk.PDFException

移除由键指定的条目。

参数

[in] key 要移除的条目的键。它不应为空字符串。

返回: 无。

◆ setAt()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAt	(	String	key,
		PDFObject	pdf_object
	)		throws com.foxit.sdk.PDFException

将直接PDF对象（其对象编号总是等于0）作为值元素设置到由键指定的条目。

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

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	pdf_object	一个PDFObject 对象，它是一个直接PDF对象（其对象编号总是等于0），将被设置到条目。它不应为null。

返回: 无。

◆ setAtBoolean()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtBoolean	(	String	key,
		boolean	value
	)		throws com.foxit.sdk.PDFException

将布尔元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的布尔元素。

返回: 无。

◆ setAtDateTime()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtDateTime	(	String	key,
		DateTime	value
	)		throws com.foxit.sdk.PDFException

将Datetime对象作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的日期时间信息。

返回: 无。

◆ setAtFloat()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtFloat	(	String	key,
		float	value
	)		throws com.foxit.sdk.PDFException

将浮点数元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的浮点数值。

返回: 无。

◆ setAtInteger()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtInteger	(	String	key,
		int	value
	)		throws com.foxit.sdk.PDFException

将整数元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的整数值。

返回: 无。

◆ setAtMatrix()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtMatrix	(	String	key,
		Matrix2D	value
	)		throws com.foxit.sdk.PDFException

将矩阵对象作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的矩阵。

返回: 无。

◆ setAtName()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtName	(	String	key,
		String	value
	)		throws com.foxit.sdk.PDFException

将字符串（作为PDF名称对象）作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将作为PDF名称对象设置到条目的字符串。它不应为空字符串。

返回: 无。

◆ setAtRect()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtRect	(	String	key,
		RectF	value
	)		throws com.foxit.sdk.PDFException

将矩形对象作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将被设置到条目的矩形。

返回: 无。

◆ setAtReference()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtReference	(	String	key,
		PDFObject	pdf_object,
		PDFDoc	document
	)		throws com.foxit.sdk.PDFException

将间接PDF对象（其对象编号总是大于0）的引用对象作为值元素设置到由键指定的条目。

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

参数

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

返回: 无。

◆ setAtString()

void com.foxit.sdk.pdf.objects.PDFDictionary.setAtString	(	String	key,
		String	value
	)		throws com.foxit.sdk.PDFException

将字符串作为值元素设置到由键指定的条目。

参数

[in]	key	条目的键，其值元素将被设置。它不应为空字符串。
[in]	value	将作为PDF字符串对象设置到条目的宽字符串。

返回: 无。

注解: 如果要获取字符串值，请调用函数PDFObject.getWideString 。

Public 成员函数

静态 Public 成员函数

额外继承的成员函数

详细描述

成员函数说明

◆ create()

◆ delete()

◆ getElement()

◆ getKey()

◆ getValue()

◆ hasKey()

◆ moveNext()

◆ removeAt()

◆ setAt()

◆ setAtBoolean()

◆ setAtDateTime()

◆ setAtFloat()

◆ setAtInteger()

◆ setAtMatrix()

◆ setAtName()

◆ setAtRect()

◆ setAtReference()

◆ setAtString()