com.itextpdf.forms.xfdf

Class ActionObject

java.lang.Object

com.itextpdf.forms.xfdf.ActionObject

public class ActionObject
extends Object

Represent Action tag in xfdf document structure. Content model: ( URI | Launch | GoTo | GoToR | Named ). Attributes: none. For more details see paragraph 6.5.1 in Xfdf specification.

Constructor Summary

Constructors

Constructor and Description
ActionObject(PdfName type)

Method Summary

Modifier and Type	Method and Description
DestObject	getDestination() Gets Dest, inner element of link, GoTo, and GoToR elements.
String	getFileOriginalName() Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
PdfName	getNameAction() Gets the value of Name, required attribute of Named element.
PdfName	getType() Returns the type of inner action element.
PdfString	getUri() Gets the string value of URI elements.
boolean	isMap() Gets IsMap, optional attribute of URI element.
boolean	isNewWindow() Sets the boolean value of NewWindow, optional attribute of Launch element.
ActionObject	setDestination(DestObject destination) Sets Dest, inner element of link, GoTo, and GoToR elements.
ActionObject	setFileOriginalName(String fileOriginalName) Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
ActionObject	setMap(boolean map) Sets IsMap, optional attribute of URI element.
ActionObject	setNameAction(PdfName nameAction) Sets the value of Name, required attribute of Named element.
ActionObject	setNewWindow(boolean newWindow) Gets the boolean value of NewWindow, optional attribute of Launch element.
ActionObject	setType(PdfName type) Sets the type of inner action element.
ActionObject	setUri(PdfString uri) Sets the string value of URI elements.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionObject

public ActionObject(PdfName type)

Method Detail

getType

public PdfName getType()

Returns the type of inner action element. Possible values: PdfName.URI, PdfName.Launch, PdfName.GoTo, PdfName.GoToR, PdfName.Named.

setType

public ActionObject setType(PdfName type)

Sets the type of inner action element. Possible values: PdfName.URI, PdfName.Launch, PdfName.GoTo, PdfName.GoToR, PdfName.Named.

getUri

public PdfString getUri()

Gets the string value of URI elements. Corresponds to Name, required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.

setUri

public ActionObject setUri(PdfString uri)

Sets the string value of URI elements. Corresponds to Name, required attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.

isMap

public boolean isMap()

Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.

setMap

public ActionObject setMap(boolean map)

Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.

getNameAction

public PdfName getNameAction()

Gets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.

setNameAction

public ActionObject setNameAction(PdfName nameAction)

Sets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.

getFileOriginalName

public String getFileOriginalName()

Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element. Corresponds to F key in go-to action or launch dictionaries. For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.

setFileOriginalName

public ActionObject setFileOriginalName(String fileOriginalName)

Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element. Corresponds to F key in go-to action or launch dictionaries. For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.

isNewWindow

public boolean isNewWindow()

Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.

setNewWindow

public ActionObject setNewWindow(boolean newWindow)

Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.

getDestination

public DestObject getDestination()

Gets Dest, inner element of link, GoTo, and GoToR elements. Corresponds to Dest key in link annotation dictionary. For more details see paragraph 6.5.10 in Xfdf specification.

setDestination

public ActionObject setDestination(DestObject destination)

Sets Dest, inner element of link, GoTo, and GoToR elements. Corresponds to Dest key in link annotation dictionary. For more details see paragraph 6.5.10 in Xfdf specification.