LaunchAction Class Documentation

classLaunchAction : Action

Namespace:com::datalogics::PDFL

Inherits from:
Action

Detailed Description

A launch action launches an application or opens or prints a document.

Constructor & Destructor Documentation

LaunchAction

LaunchAction(FileSpecificationfileSpec)

Parameters

fileSpec: FileSpecification

A 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

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

equals

booleanequals(Objectrhs)

Parameters

rhs: Object

Returns:

boolean

finalize

voidfinalize()

Returns:

void

getFileSpecification

FileSpecificationgetFileSpecification()

Returns:

The 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

booleangetNewWindow()

Returns:

True if the destination document is set to open in a new window, false otherwise.

A flag specifying whether to open the destination document 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

PDFDictgetPDFDict()

Returns:

PDFDict

Retrieve the PDFObject representation of this object

getSubtype

StringgetSubtype()

Returns:

String

The action's subtype

sameTypeEquals

booleansameTypeEquals(Actionarg0)

Parameters

arg0: Action

Returns:

boolean

setFileSpecification

voidsetFileSpecification(FileSpecificationfileSpec)

Parameters

fileSpec: FileSpecification

The FileSpecification to associate with the LaunchAction.

Returns:

void

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.)

setNewWindow

voidsetNewWindow(booleannewValue)

Parameters

newValue: boolean

The new value for the flag.

Returns:

void

A flag specifying whether to open the destination document 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

StringtoString()

Returns:

String