Package com.intellij.openapi.externalSystem.service.execution

Class ExternalSystemTaskSettingsControl

java.lang.Object

com.intellij.openapi.externalSystem.service.execution.ExternalSystemTaskSettingsControl

All Implemented Interfaces:

ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

public class ExternalSystemTaskSettingsControl
extends java.lang.Object
implements ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

Constructor Summary

Constructors

Constructor and Description
ExternalSystemTaskSettingsControl(Project project, ProjectSystemId externalSystemId)

Method Summary

Modifier and Type	Method and Description
void	apply(ExternalSystemTaskExecutionSettings settings) Asks current control to fill given settings with the current user-defined values.
void	disposeUIResources()
void	fillUi(PaintAwarePanel canvas, int indentLevel) Adds current control-specific UI controls to the given canvas.
boolean	isModified()
void	reset() Asks current control to reset its state to the initial one.
void	setOriginalSettings(ExternalSystemTaskExecutionSettings originalSettings)
void	showUi(boolean show) Hides/shows components added by the current control.
boolean	validate(ExternalSystemTaskExecutionSettings settings) Asks current control to validate given settings with the current user-defined values.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.intellij.openapi.externalSystem.util.ExternalSystemSettingsControl

getHelpId, reset, reset

Constructor Detail

ExternalSystemTaskSettingsControl

public ExternalSystemTaskSettingsControl(Project project,
                                         ProjectSystemId externalSystemId)

Method Detail

setOriginalSettings

public void setOriginalSettings(ExternalSystemTaskExecutionSettings originalSettings)

fillUi

public void fillUi(PaintAwarePanel canvas,
                   int indentLevel)

Description copied from interface: ExternalSystemSettingsControl

Adds current control-specific UI controls to the given canvas.

Note: given canvas component is expected to be managed by a GridBagLayout. That is the reason on why we use this method instead of a method like 'JComponent getComponent()' - there is a possible case that given canvas has components from more than one control and we might want them to be aligned.

Specified by:

fillUi in interface ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

Parameters:

canvas - container to use as a holder for UI components specific to the current control

indentLevel - a hint on how much UI components added by the current control should be indented

reset

public void reset()

Description copied from interface: ExternalSystemSettingsControl

Asks current control to reset its state to the initial one.

Specified by:

reset in interface ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

isModified

public boolean isModified()

Specified by:

isModified in interface ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

Returns:

true if settings exposed by the current control have been modified; false otherwise

apply

public void apply(ExternalSystemTaskExecutionSettings settings)

Description copied from interface: ExternalSystemSettingsControl

Asks current control to fill given settings with the current user-defined values.

Specified by:

apply in interface ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

Parameters:

settings - settings holder

validate

public boolean validate(ExternalSystemTaskExecutionSettings settings)
                 throws ConfigurationException

Description copied from interface: ExternalSystemSettingsControl

Asks current control to validate given settings with the current user-defined values.

Specified by:

validate in interface ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

Parameters:

settings - settings holder

Throws:

ConfigurationException

disposeUIResources

public void disposeUIResources()

Specified by:

disposeUIResources in interface ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

showUi

public void showUi(boolean show)

Description copied from interface: ExternalSystemSettingsControl

Hides/shows components added by the current control.

Specified by:

showUi in interface ExternalSystemSettingsControl<ExternalSystemTaskExecutionSettings>

Parameters:

show - flag which indicates if current control' components should be visible