org.eclipse.ptp.etfw.toolopts
Interface IToolUITab

All Superinterfaces:

IAppInput

All Known Implementing Classes:

ToolPane

public interface IToolUITab
extends IAppInput

Since:

5.0

Method Summary

String	getConfigID()
String	getConfigVarID()
String	getName()
String	getOptionString()
String	getToolName()
Map<String,String>	getVarMap()
void	initializePane(ILaunchConfiguration configuration) Initializes the pane's widgets with values from the launch configuration
boolean	isEmbedded() Returns true if this tab is embedded (managed internally but not displayed), otherwise false.
boolean	isVirtual()
void	makeToolPane(Composite comp) Create the tab's widgets in the supplied composite
void	makeToolPane(Composite comp, ToolPaneListener paneListener) Create the tab's widgets in the supplied composite using the given listener for the widget's activity.
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 widget values in the tab to the launch configuration
void	setDefaults(ILaunchConfigurationWorkingCopy configuration) Sets the default values in the launch configuration
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

Methods inherited from interface org.eclipse.ptp.etfw.toolopts.IAppInput

getArgument, getEnvVars

Method Detail

getConfigID

String getConfigID()

Returns:

the key to this tab's input string defined in the ui and saved in the launch configuration

getConfigVarID

String getConfigVarID()

Returns:

the key to this tab's environment variables defined in the ui and saved in the launch configuration

getName

String getName()

Returns:

the name of this ui tab

getOptionString

String getOptionString()

Returns:

the string defined by this ui tab, configured in the launch configuration

getToolName

String getToolName()

Returns:

the name of the tool getting input from this tab

getVarMap

Map<String,String> getVarMap()

Returns:

the map of environment variable names and values defined in this tab and saved in the launch configuration

initializePane

void initializePane(ILaunchConfiguration configuration)
                    throws CoreException

Initializes the pane's widgets with values from the launch configuration

Parameters:

configuration -

Throws:

CoreException

isEmbedded

boolean isEmbedded()

Returns true if this tab is embedded (managed internally but not displayed), otherwise false.

Returns:

isVirtual

boolean isVirtual()

Returns:

true if this is a virtual tab, not defined using an XML workflow. Otherwise false.

makeToolPane

void makeToolPane(Composite comp)

Create the tab's widgets in the supplied composite

Parameters:

comp -

makeToolPane

void makeToolPane(Composite comp,
                  ToolPaneListener paneListener)

Create the tab's widgets in the supplied composite using the given listener for the widget's activity.

Parameters:

comp -

paneListener -

OptUpdate

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

performApply

void performApply(ILaunchConfigurationWorkingCopy configuration)

Saves widget values in the tab to the launch configuration

Parameters:

configuration -

setDefaults

void setDefaults(ILaunchConfigurationWorkingCopy configuration)

Sets the default values in the launch configuration

Parameters:

configuration -

updateOptDisplay

void updateOptDisplay()

Places the current string of name/value pairs in the option-display text box

Since:

5.0

updateOptField

boolean updateOptField(Object source)

If the object is a tool in this pane update the associated strings and displays for the object

Parameters:

source - The object being searched for and updated if found

Returns:

True if the object is found, otherwise false