public class ToolPane extends Object implements IAppInput, IToolUITab
Modifier and Type | Class and Description |
---|---|
protected class |
ToolPane.MakeBrowseListener
A listener class to launch file or directory browsers from browse buttons
for a ToolPane's tools
|
Modifier and Type | Field and Description |
---|---|
static int |
ALL_COMPILERS |
static int |
ANALYSIS |
SelectionListener |
browseListener
The listener for browse buttons in this pane
|
static int |
CC_COMPILER |
protected ToolPaneListener |
checkListener
The listener for check boxes and value entry fields in this pane
|
String |
configID
This unique, generated ID is used to store the output of this pane in a
launch configuration
|
String |
configVarID |
static int |
CXX_COMPILER |
boolean |
displayOptions
If true, the showOpts options display is used.
|
boolean |
embedded
Control the pane normally but don't the user must set it to be displayed
manually in a plugin
|
String |
encloseOpts
String/character put before the first and after the last option in the
option string Default: empty
|
String |
encloseValues
String/character placed around values Default: "
|
static int |
ENV_VAR |
static int |
EXEC_UTIL |
static int |
F90_COMPILER |
ToolOption[] |
options
The individual tool options defined in this pane
|
String |
paneName
The name associated with this tool pane
|
int |
paneType
The type of tool the parameter defined by this pane goes to
|
String |
prependOpts
Added to the beginning of the opt string Default: empty
|
String |
separateNameValue
String/character placed between option names and values Default: =
|
String |
separateOpts
String/Character placed between individual options Default: newline
|
Text |
showOpts
The text box that shows the selected/defined options in this pane
|
String |
toolName
The name of the top-level tool workflow associated with this pane
|
boolean |
virtual
If true then this pane is merely a placeholder for a pane defined
elsewhere
|
Constructor and Description |
---|
ToolPane(boolean virtual)
Creates a new tool pane
|
Modifier and Type | Method and Description |
---|---|
String |
getArgument(ILaunchConfiguration configuration)
Returns the argument(s) contained by this object, building them from information in the configuration if necessary
|
String |
getConfigID() |
String |
getConfigVarID() |
Map<String,String> |
getEnvVars(ILaunchConfiguration configuration) |
String |
getName() |
ToolOption |
getOption(String optID) |
String |
getOptionString()
Returns the complete argument output of this pane, or the empty string if
no input has been specified
|
String |
getToolName() |
Map<String,String> |
getVarMap() |
void |
initializePane(ILaunchConfiguration configuration)
Initializes all tool values and enabled/disabled states with the contents
of configuration, or their defaults
|
boolean |
isEmbedded()
Returns true if this tab is embedded (managed internally but not displayed), otherwise false.
|
boolean |
isVirtual() |
void |
makeToolPane(Composite comp)
Creates the widgets and initializes the values for this ToolPane
|
void |
makeToolPane(Composite comp,
ToolPaneListener paneListener)
Creates the widgets and initializes the values for this ToolPane
|
protected void |
OptArgUpdate(ToolOption opt)
If the given ToolOption has an assoicated value field, the name/value
string is updated accordingly.
|
void |
OptUpdate()
For every option in this pane, if it is active/selected add its
name/value string to the collection of active values for the whole pane
|
void |
performApply(ILaunchConfigurationWorkingCopy configuration)
Saves the current pane-state in the supplied configuration
|
void |
setDefaults(ILaunchConfigurationWorkingCopy configuration)
Sets the default values as suppled for the tools in this pane in the
given configuration
|
void |
setName(String name) |
void |
setOptions(List<ToolOption> toptions) |
void |
updateOptDisplay()
Places the current string of name/value pairs in the option-display text
box
|
boolean |
updateOptField(Object source)
If the object is a tool in this pane update the associated strings and
displays for the object
|
public static final int ALL_COMPILERS
public static final int CC_COMPILER
public static final int CXX_COMPILER
public static final int F90_COMPILER
public static final int EXEC_UTIL
public static final int ANALYSIS
public static final int ENV_VAR
public final boolean virtual
public SelectionListener browseListener
protected ToolPaneListener checkListener
public boolean displayOptions
public Text showOpts
public ToolOption[] options
public String paneName
public String toolName
public String prependOpts
public String encloseOpts
public String separateOpts
public String encloseValues
public String separateNameValue
public String configID
public String configVarID
public int paneType
public boolean embedded
public String getArgument(ILaunchConfiguration configuration)
IAppInput
getArgument
in interface IAppInput
public String getConfigID()
getConfigID
in interface IToolUITab
public String getConfigVarID()
getConfigVarID
in interface IToolUITab
public Map<String,String> getEnvVars(ILaunchConfiguration configuration)
getEnvVars
in interface IAppInput
public String getName()
getName
in interface IToolUITab
public ToolOption getOption(String optID)
public String getOptionString()
getOptionString
in interface IToolUITab
public String getToolName()
getToolName
in interface IToolUITab
public Map<String,String> getVarMap()
getVarMap
in interface IToolUITab
public void initializePane(ILaunchConfiguration configuration) throws CoreException
initializePane
in interface IToolUITab
configuration
- The configuration from which the current tool values are to be
extractedCoreException
public boolean isEmbedded()
IToolUITab
isEmbedded
in interface IToolUITab
public boolean isVirtual()
isVirtual
in interface IToolUITab
public void makeToolPane(Composite comp)
makeToolPane
in interface IToolUITab
comp
- The composite that will contain the elements of this tool panepublic void makeToolPane(Composite comp, ToolPaneListener paneListener)
makeToolPane
in interface IToolUITab
comp
- The composite that will contain the elements of this tool panepaneListener
- The listener class that defines behavior when check boxes and
value fields are manipulatedprotected void OptArgUpdate(ToolOption opt)
opt
- The ToolOption being updatedpublic void OptUpdate()
OptUpdate
in interface IToolUITab
public void performApply(ILaunchConfigurationWorkingCopy configuration)
performApply
in interface IToolUITab
configuration
- The configuration where the pane-state is to be savedpublic void setDefaults(ILaunchConfigurationWorkingCopy configuration)
setDefaults
in interface IToolUITab
configuration
- The configuration where the default values are setpublic void setName(String name)
public void setOptions(List<ToolOption> toptions)
public void updateOptDisplay()
updateOptDisplay
in interface IToolUITab
public boolean updateOptField(Object source)
updateOptField
in interface IToolUITab
source
- The object being searched for and updated if foundCopyright (c) 2011 IBM Corporation and others. All Rights Reserved.