com.foxit.sdk.pdf.actions.EmbeddedGotoTarget类 参考

类 com.foxit.sdk.pdf.actions.EmbeddedGotoTarget 继承关系图:

Public 成员函数
	EmbeddedGotoTarget (EmbeddedGotoTarget action)
	构造函数，使用另一个嵌入转到目标对象。 更多...
	EmbeddedGotoTarget (PDFDoc document)
	构造函数，使用PDF文档。 更多...
	EmbeddedGotoTarget (PDFDoc document, PDFDictionary target_object)
	构造函数，使用PDF字典。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
String	getAttachedFileName () throws com.foxit.sdk.PDFException
	获取嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。 更多...
PDFDictionary	getDict () throws com.foxit.sdk.PDFException
	获取当前对象的PDF字典。 更多...
int	getFileAttachmentAnnotIndex () throws com.foxit.sdk.PDFException
	获取指定页面中文件附件注释的注释索引。 更多...
int	getPageIndex () throws com.foxit.sdk.PDFException
	获取指定包含目标文件附件注释的页面的页面索引。 更多...
String	getRelationship () throws com.foxit.sdk.PDFException
	获取当前目标对象和当前目标对象所属对象之间的关系。 更多...
EmbeddedGotoTarget	getTarget () throws com.foxit.sdk.PDFException
	获取指定到目标文档的附加路径信息的目标。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...
void	setAttachedFileName (String embed_file_name) throws com.foxit.sdk.PDFException
	设置嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。 更多...
void	setFileAttachmentAnnotIndex (int annot_index) throws com.foxit.sdk.PDFException
	设置指定页面中文件附件注释的注释索引。 更多...
void	setPageIndex (int page_index) throws com.foxit.sdk.PDFException
	设置指定包含目标文件附件注释的页面的页面索引。 更多...
void	setRelationship (String relationship) throws com.foxit.sdk.PDFException
	设置当前目标对象和当前目标对象所属对象之间的关系。 更多...
void	setTarget (EmbeddedGotoTarget target) throws com.foxit.sdk.PDFException
	设置指定到目标文档的附加路径信息的目标。 更多...

详细描述

嵌入转到动作的目标是目标所在的文档。

参见

EmbeddedGotoAction

构造及析构函数说明

EmbeddedGotoTarget() [1/3]

com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.EmbeddedGotoTarget

(

PDFDoc

document

)

构造函数，使用PDF文档。

此构造函数用于构造一个新的嵌入转到目标对象（不包含任何数据）。

参数

[in]

document

有效的PDF文档对象。

EmbeddedGotoTarget() [2/3]

com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.EmbeddedGotoTarget	(	PDFDoc	document,
		PDFDictionary	target_object
	)

构造函数，使用PDF字典。

参数

[in]	document	有效的PDF文档对象。
[in]	target_object	表示嵌入转到目标数据的PDF字典。

EmbeddedGotoTarget() [3/3]

com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.EmbeddedGotoTarget

(

EmbeddedGotoTarget

action

)

构造函数，使用另一个嵌入转到目标对象。

参数

[in]

action

另一个嵌入转到目标对象。

成员函数说明

delete()

synchronized void com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.delete

(

)

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

返回

无。

注解

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

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

getAttachedFileName()

String com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.getAttachedFileName

(

)

throws com.foxit.sdk.PDFException

获取嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。

这仅在关系为"C"时有用。如果此属性是有效字符串， 那意味着目标文件是在"EmbeddedFiles"名称树中定义的嵌入文件。

返回

嵌入文件名。

getDict()

PDFDictionary com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.getDict

(

)

throws com.foxit.sdk.PDFException

获取当前对象的PDF字典。

返回

PDF字典。如果有任何错误，此函数将返回null。

getFileAttachmentAnnotIndex()

int com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.getFileAttachmentAnnotIndex

(

)

throws com.foxit.sdk.PDFException

获取指定页面中文件附件注释的注释索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定指定页面中的文件附件注释。 函数EmbeddedGotoTarget.getPageIndex 可用于 获取指定包含目标文件附件注释的页面的页面索引。

返回

指定文件附件注释的注释索引。有效值从0开始。 -1表示没有此类属性。

getPageIndex()

int com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.getPageIndex

(

)

throws com.foxit.sdk.PDFException

获取指定包含目标文件附件注释的页面的页面索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关。此属性仅指定包含文件附件注释的页面。 函数EmbeddedGotoTarget.getFileAttachmentAnnotIndex 可用于获取目标文件附件注释的注释索引。

返回

页面索引。有效值从0开始。-1表示没有此类属性。

getRelationship()

String com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.getRelationship

(

)

throws com.foxit.sdk.PDFException

获取当前目标对象和当前目标对象所属对象之间的关系。

关系是当前目标对象和当前目标对象所属对象之间的关系。目前，关系可以是以下之一：

• "P"：当前目标对象是当前目标对象所属对象的父对象。
  
• "C"：当前目标对象是当前目标对象所属对象的子对象。
  

返回

关系字符串。

getTarget()

EmbeddedGotoTarget com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.getTarget

(

)

throws com.foxit.sdk.PDFException

获取指定到目标文档的附加路径信息的目标。

返回

嵌入转到目标对象。如果返回的嵌入转到目标对象的函数EmbeddedGotoTarget.isEmpty 的返回值为true，那意味着当前目标对象表示最终目标文件。

isEmpty()

boolean com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.isEmpty

(

)

检查当前对象是否为空。

当当前对象为空时，那意味着当前对象是无用的。

返回

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

setAttachedFileName()

void com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.setAttachedFileName

(

String

embed_file_name

)

throws com.foxit.sdk.PDFException

设置嵌入文件名，该文件名在当前目标文件的"EmbeddedFile"名称树中使用。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件是 在"EmbeddedFiles"名称树中定义的嵌入文件。

参数

[in]

embed_file_name

嵌入文件的名称。

返回

无。

setFileAttachmentAnnotIndex()

void com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.setFileAttachmentAnnotIndex

(

int

annot_index

)

throws com.foxit.sdk.PDFException

设置指定页面中文件附件注释的注释索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定指定页面中的文件附件注释。 函数EmbeddedGotoTarget.setPageIndex 可用于 设置指定包含目标文件附件注释的页面的页面索引。

参数

[in]

annot_index

指定文件附件注释的注释索引。 有效范围：从0到(count-1)。count表示 指定页面中的注释数量。

返回

无。

setPageIndex()

void com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.setPageIndex

(

int

page_index

)

throws com.foxit.sdk.PDFException

设置指定包含目标文件附件注释的页面的页面索引。

这仅在关系为"C"时有用。如果此属性存在，那意味着目标文件与 文件附件注释相关，此属性仅指定包含文件附件注释的页面。 函数EmbeddedGotoTarget.setFileAttachmentAnnotIndex 可用于设置目标文件附件注释的注释索引。

参数

[in]

page_index

指定包含目标文件附件注释的页面的页面索引。 有效范围：从0到(count-1)。count表示 当前目标PDF文件的页面数量。

返回

无。

setRelationship()

void com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.setRelationship

(

String

relationship

)

throws com.foxit.sdk.PDFException

设置当前目标对象和当前目标对象所属对象之间的关系。

关系是当前目标对象和当前目标对象所属对象之间的关系。目前，关系可以是以下之一：

• "P"：当前目标对象是当前目标对象所属对象的父对象。
  
• "C"：当前目标对象是当前目标对象所属对象的子对象。
  

参数

[in]

relationship

应该是以下字符串之一："P"、"C"。

返回

无。

setTarget()

void com.foxit.sdk.pdf.actions.EmbeddedGotoTarget.setTarget

(

EmbeddedGotoTarget

target

)

throws com.foxit.sdk.PDFException

设置指定到目标文档的附加路径信息的目标。

参数

[in]

target

嵌入转到目标对象。如果返回的嵌入转到目标对象的函数EmbeddedGotoTarget.isEmpty 的返回值为true，那意味着当前目标对象表示最终目标文件。

返回

无。