Package com.intellij.openapi.externalSystem.service.settings

Class AbstractExternalProjectSettingsControl<S extends ExternalProjectSettings>

java.lang.Object

com.intellij.openapi.externalSystem.service.settings.AbstractSettingsControl

com.intellij.openapi.externalSystem.service.settings.AbstractExternalProjectSettingsControl<S>

All Implemented Interfaces:

ExternalSystemSettingsControl<S>

Direct Known Subclasses:

GradleProjectSettingsControl

public abstract class AbstractExternalProjectSettingsControl<S extends ExternalProjectSettings>
extends AbstractSettingsControl
implements ExternalSystemSettingsControl<S>

Templates class for managing single external project settings (single ide project might contain multiple bindings to external projects, e.g. one module is backed by a single external project and couple of others are backed by a single external multi-project).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExternalProjectSettingsControl(Project project, S initialSettings)
protected	AbstractExternalProjectSettingsControl(Project project, S initialSettings, ExternalSystemSettingsControlCustomizer controlCustomizer) Deprecated. see ExternalSystemSettingsControlCustomizer for details
protected	AbstractExternalProjectSettingsControl(S initialSettings)

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.
protected abstract void	applyExtraSettings(S settings)
void	disposeUIResources()
protected abstract void	fillExtraControls(PaintAwarePanel content, int indentLevel)
void	fillUi(PaintAwarePanel canvas, int indentLevel) Adds current control-specific UI controls to the given canvas.
S	getInitialSettings()
Project	getProject()
protected abstract boolean	isExtraSettingModified()
boolean	isModified()
void	reset() Asks current control to reset its state to the initial one.
void	reset(boolean isDefaultModuleCreation, Project project)
void	reset(boolean isDefaultModuleCreation, WizardContext wizardContext, Project project)
void	reset(Project project) Asks current control to reset its state to the initial one.
void	reset(WizardContext wizardContext) Asks current control to reset its state to the initial one.
protected abstract void	resetExtraSettings(boolean isDefaultModuleCreation)
protected void	resetExtraSettings(boolean isDefaultModuleCreation, WizardContext wizardContext)
void	setCurrentProject(Project project) see AbstractImportFromExternalSystemControl.setCurrentProject(Project)
void	showUi(boolean show) Hides/shows components added by the current control.
protected void	updateInitialExtraSettings()
void	updateInitialSettings()

Methods inherited from class com.intellij.openapi.externalSystem.service.settings.AbstractSettingsControl

reset, setProject

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, validate

Constructor Detail

AbstractExternalProjectSettingsControl

protected AbstractExternalProjectSettingsControl(S initialSettings)

AbstractExternalProjectSettingsControl

protected AbstractExternalProjectSettingsControl(Project project,
                                                 S initialSettings)

AbstractExternalProjectSettingsControl

@Deprecated
protected AbstractExternalProjectSettingsControl(Project project,
                                                 S initialSettings,
                                                 ExternalSystemSettingsControlCustomizer controlCustomizer)

Deprecated. see ExternalSystemSettingsControlCustomizer for details

Method Detail

getInitialSettings

public S getInitialSettings()

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<S extends ExternalProjectSettings>

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

fillExtraControls

protected abstract void fillExtraControls(PaintAwarePanel content,
                                          int indentLevel)

isModified

public boolean isModified()

Specified by:

isModified in interface ExternalSystemSettingsControl<S extends ExternalProjectSettings>

Returns:

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

isExtraSettingModified

protected abstract boolean isExtraSettingModified()

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<S extends ExternalProjectSettings>

reset

public void reset(Project project)

Description copied from interface: ExternalSystemSettingsControl

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

Specified by:

reset in interface ExternalSystemSettingsControl<S extends ExternalProjectSettings>

reset

public void reset(WizardContext wizardContext)

Description copied from interface: ExternalSystemSettingsControl

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

Specified by:

reset in interface ExternalSystemSettingsControl<S extends ExternalProjectSettings>

reset

public void reset(boolean isDefaultModuleCreation,
                  Project project)

reset

public void reset(boolean isDefaultModuleCreation,
                  WizardContext wizardContext,
                  Project project)

resetExtraSettings

protected abstract void resetExtraSettings(boolean isDefaultModuleCreation)

resetExtraSettings

protected void resetExtraSettings(boolean isDefaultModuleCreation,
                                  WizardContext wizardContext)

apply

public void apply(S 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<S extends ExternalProjectSettings>

Parameters:

settings - settings holder

applyExtraSettings

protected abstract void applyExtraSettings(S settings)

disposeUIResources

public void disposeUIResources()

Specified by:

disposeUIResources in interface ExternalSystemSettingsControl<S extends ExternalProjectSettings>

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<S extends ExternalProjectSettings>

Parameters:

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

updateInitialSettings

public void updateInitialSettings()

updateInitialExtraSettings

protected void updateInitialExtraSettings()

setCurrentProject

public void setCurrentProject(Project project)

see AbstractImportFromExternalSystemControl.setCurrentProject(Project)

getProject

public Project getProject()

Overrides:

getProject in class AbstractSettingsControl