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

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

Public 成员函数
	EmbeddedGotoAction (Action action)
	构造函数，使用父类对象。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
Destination	getDestination () throws com.foxit.sdk.PDFException
	获取指定在最终目标文件中跳转位置的目标信息。 更多...
String	getDestinationName () throws com.foxit.sdk.PDFException
	获取在最终目标PDF文件中定义的目标名称。 更多...
int	getNewWindowFlag () throws com.foxit.sdk.PDFException
	获取用于决定是否在新窗口中打开目标文档的标志。 更多...
FileSpec	getRootFile () throws com.foxit.sdk.PDFException
	获取根文件的文件规范，该根文件是目标的根文件。 更多...
EmbeddedGotoTarget	getTarget () throws com.foxit.sdk.PDFException
	获取目标。 更多...
void	setDestination (Destination destination) throws com.foxit.sdk.PDFException
	设置指定在最终目标文件中跳转位置的目标信息。 更多...
void	setDestinationName (String dest_name) throws com.foxit.sdk.PDFException
	设置目标名称。 更多...
void	setNewWindowFlag (int flag) throws com.foxit.sdk.PDFException
	设置用于决定是否在新窗口中打开目标文档的标志。 更多...
void	setRootFile (FileSpec file_specification) throws com.foxit.sdk.PDFException
	设置根文件的文件规范，该根文件是目标的根文件。 更多...
void	setTarget (EmbeddedGotoTarget target) throws com.foxit.sdk.PDFException
	设置目标。 更多...
Public 成员函数 继承自 com.foxit.sdk.pdf.actions.Action
	Action (Action action)
	构造函数，使用另一个动作对象。 更多...
	Action (PDFDoc document, PDFDictionary action_dict)
	构造函数，带参数。 更多...
PDFDictionary	getDict () throws com.foxit.sdk.PDFException
	获取当前对象的PDF字典。 更多...
PDFDoc	getDocument () throws com.foxit.sdk.PDFException
	获取当前动作所属的PDF文档。 更多...
Action	getSubAction (int index) throws com.foxit.sdk.PDFException
	按索引获取子动作。 更多...
int	getSubActionCount () throws com.foxit.sdk.PDFException
	获取子动作的数量。 更多...
int	getType () throws com.foxit.sdk.PDFException
	获取动作类型。 更多...
void	insertSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException
	在指定索引位置插入新的子动作。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...
void	removeAllSubActions () throws com.foxit.sdk.PDFException
	移除所有子动作。 更多...
void	removeSubAction (int index) throws com.foxit.sdk.PDFException
	移除指定索引的子动作。 更多...
void	setSubAction (int index, Action sub_action) throws com.foxit.sdk.PDFException
	按索引设置子动作。 更多...

额外继承的成员函数
静态 Public 成员函数 继承自 com.foxit.sdk.pdf.actions.Action
static Action	create (PDFDoc document, int action_type) throws com.foxit.sdk.PDFException
	为指定的动作类型创建新动作。 更多...
静态 Public 属性 继承自 com.foxit.sdk.pdf.actions.Action
static final int	e_NewWindowFlagFalse = 0
	"NewWindow"标志为false。
static final int	e_NewWindowFlagNone = 2
	无"NewWindow"标志。
static final int	e_NewWindowFlagTrue = 1
	"NewWindow"标志为true。
static final int	e_TypeGoto = 1
	动作类型：转到动作。
static final int	e_TypeGoTo3DView = 18
	动作类型：转到3D视图动作。
static final int	e_TypeGoToE = 3
	动作类型：嵌入转到动作。
static final int	e_TypeGoToR = 2
	动作类型：远程转到动作。
static final int	e_TypeHide = 9
	动作类型：隐藏动作。
static final int	e_TypeImportData = 13
	动作类型：导入数据动作。
static final int	e_TypeJavaScript = 14
	动作类型：JavaScript动作。
static final int	e_TypeLaunch = 4
	动作类型：启动动作。
static final int	e_TypeMovie = 8
	动作类型：电影动作。
static final int	e_TypeNamed = 10
	动作类型：命名动作。
static final int	e_TypeRendition = 16
	动作类型：演示动作。
static final int	e_TypeResetForm = 12
	动作类型：重置表单动作。
static final int	e_TypeSetOCGState = 15
	动作类型：设置OCG状态动作。
static final int	e_TypeSound = 7
	动作类型：声音动作。
static final int	e_TypeSubmitForm = 11
	动作类型：提交表单动作。
static final int	e_TypeThread = 5
	动作类型：线程动作。
static final int	e_TypeTrans = 17
	动作类型：过渡动作。
static final int	e_TypeUnknown = 0
	动作类型：未知动作。
static final int	e_TypeURI = 6
	动作类型：统一资源标识符(URI)动作。

详细描述

嵌入转到动作类似于远程转到动作，但允许从嵌入在另一个PDF文件中的PDF文件中跳转或跳转到该文件。 类com.foxit.sdk.pdf.actions.EmbeddedGotoTarget 派生自Action ， 提供用于获取/设置嵌入转到动作数据的函数。

参见

Action

构造及析构函数说明

EmbeddedGotoAction()

com.foxit.sdk.pdf.actions.EmbeddedGotoAction.EmbeddedGotoAction

(

Action

action

)

构造函数，使用父类对象。

参数

[in]

action

父类对象。

成员函数说明

delete()

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

(

)

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

返回

无。

注解

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

重载 com.foxit.sdk.pdf.actions.Action .

getDestination()

Destination com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getDestination

(

)

throws com.foxit.sdk.PDFException

获取指定在最终目标文件中跳转位置的目标信息。

对于嵌入转到动作，目标信息可以存储为目标对象 或目标名称：

• 如果是目标对象，函数EmbeddedGotoAction.getDestination 将 返回有效的目标对象。
  
• 如果是目标名称，函数EmbeddedGotoAction.getDestinationName 将 返回有效的字符串，目标名称将在最终目标PDF文件中定义。
  

如果返回的目标对象的函数Destination.isEmpty 的返回值 为true，且函数EmbeddedGotoAction.getDestinationName 返回空字符串，则表示嵌入转到动作没有任何目标信息。

返回

目标对象。如果返回的目标对象的函数Destination.isEmpty 的返回值 为true，请尝试函数 EmbeddedGotoAction.getDestinationName 。

getDestinationName()

String com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getDestinationName

(

)

throws com.foxit.sdk.PDFException

获取在最终目标PDF文件中定义的目标名称。

对于远程转到动作，目标信息可以存储为目标对象 或目标名称：

• 如果是目标对象，函数EmbeddedGotoAction.getDestination 将返回有效的目标对象。
  
• 如果是目标名称，函数EmbeddedGotoAction.getDestinationName 将返回有效的字符串，目标名称将在目标PDF文件中定义。
  

如果返回的目标对象的函数Destination.isEmpty 的返回值 为true，且函数EmbeddedGotoAction.getDestinationName 返回空字符串，则表示嵌入转到动作没有任何目标信息。

返回

目标名称。如果此函数返回空字符串，请尝试函数 EmbeddedGotoAction.getDestination 。

getNewWindowFlag()

int com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getNewWindowFlag

(

)

throws com.foxit.sdk.PDFException

获取用于决定是否在新窗口中打开目标文档的标志。

返回

新窗口标志。将是以下值之一：

• com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。
  
• com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。
  
• com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagNone 表示 没有此类标志，查看器应用程序应根据当前用户首选项行为。
  

getRootFile()

FileSpec com.foxit.sdk.pdf.actions.EmbeddedGotoAction.getRootFile

(

)

throws com.foxit.sdk.PDFException

获取根文件的文件规范，该根文件是目标的根文件。

返回

非嵌入的文件规范对象。如果返回的文件规范对象的函数FileSpec.isEmpty 的返回值为true，则表示包含当前嵌入转到动作的PDF文件 就是目标对象的根文件。

getTarget()

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

(

)

throws com.foxit.sdk.PDFException

获取目标。

返回

嵌入转到目标对象。如果返回的嵌入转到目标对象的函数EmbeddedGotoTarget.isEmpty 的返回值为true，则表示没有目标。

setDestination()

void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setDestination

(

Destination

destination

)

throws com.foxit.sdk.PDFException

设置指定在最终目标文件中跳转位置的目标信息。

参数

[in]

destination

要设置的有效目标对象。

返回

无。

setDestinationName()

void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setDestinationName

(

String

dest_name

)

throws com.foxit.sdk.PDFException

设置目标名称。

目标名称应该已经在目标PDF文件的"Dests"名称树中。

参数

[in]

dest_name

要设置的目标名称。不应为空字符串。

返回

无。

setNewWindowFlag()

void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setNewWindowFlag

(

int

flag

)

throws com.foxit.sdk.PDFException

设置用于决定是否在新窗口中打开目标文档的标志。

参数

[in]

flag

新窗口标志。应为以下值之一： com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagTrue 表示 在新窗口中打开目标文档。 com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagFalse 表示 目标文档在同一窗口中替换当前文档。 com.foxit.sdk.pdf.actions.Action.e_NewWindowFlagNone 表示 不需要此类标志，查看器应用程序应根据 当前用户首选项行为。

返回

无。

setRootFile()

void com.foxit.sdk.pdf.actions.EmbeddedGotoAction.setRootFile

(

FileSpec

file_specification

)

throws com.foxit.sdk.PDFException

设置根文件的文件规范，该根文件是目标的根文件。

参数

[in]

file_specification

文件规范对象： 可以通过默认构造函数构造且不设置任何值。 在这种情况下，表示包含当前嵌入转到动作的PDF文件 也是目标的根文件。 否则，这应该是有效的文件规范对象，应该表示 另一个文件，而不是嵌入文件。文件规范对象应该 与当前动作在同一个PDF文件中。

返回

无。

setTarget()

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

(

EmbeddedGotoTarget

target

)

throws com.foxit.sdk.PDFException

设置目标。

参数

[in]

target

嵌入转到目标对象。如果这是通过默认构造函数构造的且 没有设置任何值，则表示没有目标。

返回

无。