Package com.intellij.openapi.externalSystem.util

Interface ExternalSystemSettingsControl<S>

Type Parameters:

S - settings type

All Known Implementing Classes:

AbstractExternalProjectSettingsControl, ExternalSystemTaskSettingsControl, GradleProjectSettingsControl, GradleSystemSettingsControl

public interface ExternalSystemSettingsControl<S>

Defines contract for a component which knows how to manage particular settings.

Method Summary

Modifier and Type	Method and Description
void	apply(S 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.
default java.lang.String	getHelpId()
boolean	isModified()
void	reset() Asks current control to reset its state to the initial one.
default void	reset(Project project) Asks current control to reset its state to the initial one.
default void	reset(WizardContext wizardContext) Asks current control to reset its state to the initial one.
void	showUi(boolean show) Hides/shows components added by the current control.
boolean	validate(S settings) Asks current control to validate given settings with the current user-defined values.

Method Detail

fillUi

void fillUi(PaintAwarePanel canvas,
            int indentLevel)

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.

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

void reset()

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

reset

default void reset(Project project)

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

reset

default void reset(WizardContext wizardContext)

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

isModified

boolean isModified()

Returns:

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

apply

void apply(S settings)

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

Parameters:

settings - settings holder

validate

boolean validate(S settings)
          throws ConfigurationException

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

Parameters:

settings - settings holder

Throws:

ConfigurationException

disposeUIResources

void disposeUIResources()

showUi

void showUi(boolean show)

Hides/shows components added by the current control.

Parameters:

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

getHelpId

default java.lang.String getHelpId()