LaunchAction Class Documentation
class LaunchAction : ActionNamespace:com::datalogics::PDFL
- Inherits from:
Action
Detailed Description
A launch action launches an application or opens or prints a document.
Uses types
Constructor & Destructor Documentation
LaunchAction
LaunchAction(FileSpecification fileSpec)Parameters
fileSpec: FileSpecificationA FileSpecification representing the application to be launched or the document to be opened or printed by this action.
General constructor.
The action's target will be the path referenced in the FileSpecification parameter. If the path is absolute, the target path will also be absolute. If the path is relative, the target path will also be relative.
Generally, the FileSpecification should be associated with the same Document that contains the LaunchAction. (Both FileSpecification and LaunchAction objects are associated with a Document at creation time, and the association cannot be changed.) The LaunchAction will be associated with the same Document that the FileSpecification parameter is associated with.
If the action's FileSpecification is changed during program execution such that the FileSpecification is associated with a different Document than the LaunchAction, saving the Document that contains the action will create a copy of the FileSpecification in the Document that contains the action.
Member Function Documentation
delete
synchronized void delete(Boolean disposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized void delete()Returns:
synchronized voidequals
boolean equals(Object rhs)Parameters
rhs: Object
Returns:
booleanfinalize
void finalize()Returns:
voidgetFileSpecification
FileSpecification getFileSpecification()Returns:
FileSpecificationThe FileSpecification associated with the LaunchAction.
The FileSpecification for this action. Generally, the FileSpecification should be associated with the same Document that contains the LaunchAction. (Both FileSpecification and LaunchAction are associated with a Document at creation time.)
getNewWindow
boolean getNewWindow()Returns:
booleantrue if the destination document is set to open in a new window, false otherwise.
Whether the destination document should be opened in a new window. By default, this flag is not present.
If the action's FileSpecification is not a PDF, this flag is ignored.
getPDFDict
PDFDict getPDFDict()Returns:
PDFDictThe underlying PDF dictionary for this Action.
Retrieve the PDFObject representation of this object.
getSubtype
String getSubtype()Returns:
StringThe subtype string for this action, such as "GoTo", "URI", "Launch", or "GoToR".
The action's subtype.
setFileSpecification
void setFileSpecification(FileSpecification fileSpec)Parameters
fileSpec: FileSpecificationThe FileSpecification to associate with the LaunchAction.
Returns:
voidSet the FileSpecification for this action. Generally, the FileSpecification should be associated with the same Document that contains the LaunchAction. (Both FileSpecification and LaunchAction are associated with a Document at creation time.)
If the FileSpecification is associated with a different Document than the LaunchAction, saving the Document that contains the action will create a copy of the FileSpecification in that Document.
setNewWindow
void setNewWindow(boolean newValue)Parameters
newValue: booleantrue to open the destination document in a new window, false otherwise.
Returns:
voidSet whether the destination document should be opened in a new window. By default, this flag is not present.
If the action's FileSpecification is not a PDF, this flag is ignored.
toString
String toString()Returns:
StringA string describing this Action.
Returns a string representation of this Action. The string includes the action's subtype.