Class ExecuteTargetFile
- java.lang.Object
-
- com.zerog.ia.auto.project.ProjectObject
-
- com.zerog.ia.auto.project.InstallableObject
-
- com.zerog.ia.auto.project.actions.Action
-
- com.zerog.ia.auto.project.actions.ExecuteTargetFile
-
- All Implemented Interfaces:
OSHostable
,Referenceable
public final class ExecuteTargetFile extends Action implements OSHostable
Launches an executable or opens a document that is included in the installer. If the target is a document that has the appropriate application associations set up, then the document is opened in the correct application.
-
-
Constructor Summary
Constructors Constructor Description ExecuteTargetFile()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCommandLineArgs()
The command line to execute.java.lang.String
getDialogLabel()
The message to be displayed in the indeterminate dialog.java.lang.String
getExitCodeVar()
The name of the variable to store exit codes.java.lang.String
getName()
The name of the action.boolean
getShowIndeterminateDialog()
Whether to show an indeterminate dialog during the execution of the command and to show the message you define calling setDialogLabel.boolean
getShowPleaseWaitPanel()
Whether to show a "Please wait..." panel while executing the action.java.lang.String
getStderrVar()
The name of the variable to store command's stderr.java.lang.String
getStdoutVar()
The name of the variable to store command's stdout.boolean
getSuppressConsoleWindow()
Whether to suppress the console dialog on Windows machines.FileAction
getTargetAction()
The file to execute.boolean
getWaitForProcess()
Whether suspend the installation until process completes, causing the installer to halt until the process launched by the command has returned.boolean
isSubstituteUnknownVariable()
Whether to substitute unknown variables or not.void
setCommandLineArgs(java.lang.String args)
The command line to execute.void
setDialogLabel(java.lang.String label)
The message to be displayed in the indeterminate dialog.void
setExitCodeVar(java.lang.String exitCodeVar)
The name of the variable to store exit codes.void
setName(java.lang.String s)
The name of the action.void
setShowIndeterminateDialog(boolean show)
Whether to show an indeterminate dialog during the execution of the command and to show the message you define calling setDialogLabel (default: Executing...).void
setShowPleaseWaitPanel(boolean show)
Whether to show a "Please wait..." panel while executing the action.void
setStderrVar(java.lang.String stderrVar)
The name of the variable to store command's stderr.void
setStdoutVar(java.lang.String stdoutVar)
The name of the variable to store command's stdout.void
setSubstituteUnknownVariable(boolean substituteUnknownVariable)
Whether to substitute unknown variables or not.void
setSuppressConsoleWindow(boolean suppress)
Whether to suppress the console dialog on Windows machines.void
setTargetAction(FileAction target)
The file to execute.void
setWaitForProcess(boolean wait)
Whether suspend the installation until process completes, causing the installer to halt until the process launched by the command has returned.-
Methods inherited from class com.zerog.ia.auto.project.InstallableObject
getBelongsToUninstallPhase, getRollbackEnabledCancel, getRollbackEnabledError, getRuleExpression, getRules, getRulesLogicalOperation, getTagsInInstallPiece, setBelongsToUninstallPhase, setRollbackEnabledCancel, setRollbackEnabledError, setRuleExpression, setRulesLogicalOperation, setTagsInInstallPiece
-
Methods inherited from class com.zerog.ia.auto.project.ProjectObject
equals, getReferenceID, hashCode, setReferenceID
-
-
-
-
Method Detail
-
getStdoutVar
public java.lang.String getStdoutVar()
The name of the variable to store command's stdout.
-
setStdoutVar
public void setStdoutVar(java.lang.String stdoutVar)
The name of the variable to store command's stdout. Default: $EXECUTE_STDOUT$.
-
getStderrVar
public java.lang.String getStderrVar()
The name of the variable to store command's stderr.
-
setStderrVar
public void setStderrVar(java.lang.String stderrVar)
The name of the variable to store command's stderr. Default: $EXECUTE_STDERR$.
-
getExitCodeVar
public java.lang.String getExitCodeVar()
The name of the variable to store exit codes.
-
setExitCodeVar
public void setExitCodeVar(java.lang.String exitCodeVar)
The name of the variable to store exit codes. Default: $EXECUTE_EXITCODE$.
-
setName
public void setName(java.lang.String s)
The name of the action.
-
getName
public java.lang.String getName()
The name of the action.
-
setWaitForProcess
public void setWaitForProcess(boolean wait)
Whether suspend the installation until process completes, causing the installer to halt until the process launched by the command has returned.- Parameters:
wait
- Suspend installation.
-
getWaitForProcess
public boolean getWaitForProcess()
Whether suspend the installation until process completes, causing the installer to halt until the process launched by the command has returned.- Returns:
- Suspend installation.
-
setShowIndeterminateDialog
public void setShowIndeterminateDialog(boolean show)
Whether to show an indeterminate dialog during the execution of the command and to show the message you define calling setDialogLabel (default: Executing...).
-
getShowIndeterminateDialog
public boolean getShowIndeterminateDialog()
Whether to show an indeterminate dialog during the execution of the command and to show the message you define calling setDialogLabel.
-
setDialogLabel
public void setDialogLabel(java.lang.String label)
The message to be displayed in the indeterminate dialog. (default: Executing...)- See Also:
setShowIndeterminateDialog(boolean)
-
getDialogLabel
public java.lang.String getDialogLabel()
The message to be displayed in the indeterminate dialog.- See Also:
setShowIndeterminateDialog(boolean)
-
setShowPleaseWaitPanel
public void setShowPleaseWaitPanel(boolean show)
Whether to show a "Please wait..." panel while executing the action.
-
getShowPleaseWaitPanel
public boolean getShowPleaseWaitPanel()
Whether to show a "Please wait..." panel while executing the action.
-
setSuppressConsoleWindow
public void setSuppressConsoleWindow(boolean suppress)
Whether to suppress the console dialog on Windows machines.- Parameters:
suppress
- Suppress the console dialog
-
getSuppressConsoleWindow
public boolean getSuppressConsoleWindow()
Whether to suppress the console dialog on Windows machines.- Returns:
- Suppress the console dialog
-
setCommandLineArgs
public void setCommandLineArgs(java.lang.String args)
The command line to execute. The $EXECUTE_FILE_TARGET$ variable will be replaced during the install with the fully qualified name of the target file.
-
getCommandLineArgs
public java.lang.String getCommandLineArgs()
The command line to execute. The $EXECUTE_FILE_TARGET$ variable will be replaced during the install with the fully qualified name of the target file.
-
setTargetAction
public void setTargetAction(FileAction target)
The file to execute.
-
getTargetAction
public FileAction getTargetAction()
The file to execute.
-
isSubstituteUnknownVariable
public boolean isSubstituteUnknownVariable()
Whether to substitute unknown variables or not.
-
setSubstituteUnknownVariable
public void setSubstituteUnknownVariable(boolean substituteUnknownVariable)
Whether to substitute unknown variables or not.
-
-