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

Class AbstractExternalSystemConfigurable<ProjectSettings extends ExternalProjectSettings,L extends ExternalSystemSettingsListener<ProjectSettings>,SystemSettings extends AbstractExternalSystemSettings<SystemSettings,ProjectSettings,L>>

java.lang.Object

com.intellij.openapi.externalSystem.service.settings.AbstractExternalSystemConfigurable<ProjectSettings,L,SystemSettings>

All Implemented Interfaces:

Configurable, Configurable.NoScroll, SearchableConfigurable, UnnamedConfigurable

Direct Known Subclasses:

GradleConfigurable

public abstract class AbstractExternalSystemConfigurable<ProjectSettings extends ExternalProjectSettings,L extends ExternalSystemSettingsListener<ProjectSettings>,SystemSettings extends AbstractExternalSystemSettings<SystemSettings,ProjectSettings,L>>
extends java.lang.Object
implements SearchableConfigurable, Configurable.NoScroll

Base class that simplifies external system settings management.

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.options.SearchableConfigurable

SearchableConfigurable.Delegate, SearchableConfigurable.Merged, SearchableConfigurable.Parent

Nested classes/interfaces inherited from interface com.intellij.openapi.options.Configurable

Configurable.Composite, Configurable.NoMargin, Configurable.NoScroll, Configurable.TopComponentController, Configurable.TopComponentProvider, Configurable.VariableProjectAppLevel, Configurable.WithEpDependencies

Field Summary

Fields inherited from interface com.intellij.openapi.options.Configurable

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractExternalSystemConfigurable(Project project, ProjectSystemId externalSystemId)

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
protected abstract ExternalSystemSettingsControl<ProjectSettings>	createProjectSettingsControl(ProjectSettings settings) Creates a control for managing given project settings.
protected abstract ExternalSystemSettingsControl<SystemSettings>	createSystemSettingsControl(SystemSettings settings) Creates a control for managing given system-level settings (if any).
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
Project	getProject()
protected java.lang.String	getProjectName(java.lang.String path)
boolean	isModified() Indicates whether the Swing form was modified or not.
protected abstract ProjectSettings	newProjectSettings()
void	reset() Loads the settings from the configurable component to the Swing form.
void	selectProject(java.lang.String linkedProjectPath)

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.options.SearchableConfigurable

enableSearch, getId, getOriginalClass

Methods inherited from interface com.intellij.openapi.options.Configurable

getHelpTopic, getPreferredFocusedComponent, isModified, isModified, isModified, isModified

Methods inherited from interface com.intellij.openapi.options.UnnamedConfigurable

cancel

Constructor Detail

AbstractExternalSystemConfigurable

protected AbstractExternalSystemConfigurable(Project project,
                                             ProjectSystemId externalSystemId)

Method Detail

getProject

public Project getProject()

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: Configurable

Returns the visible name of the configurable component. Note, that this method must return the display name that is equal to the display name declared in XML to avoid unexpected errors.

Specified by:

getDisplayName in interface Configurable

Returns:

the visible name of the configurable component

createComponent

public javax.swing.JComponent createComponent()

Description copied from interface: UnnamedConfigurable

Creates new Swing form that enables user to configure the settings. Usually this method is called on the EDT, so it should not take a long time.

Also this place is designed to allocate resources (subscriptions/listeners etc.)

Specified by:

createComponent in interface UnnamedConfigurable

Returns:

new Swing form to show, or null if it cannot be created

See Also:

UnnamedConfigurable.disposeUIResources()

selectProject

public void selectProject(java.lang.String linkedProjectPath)

createProjectSettingsControl

protected abstract ExternalSystemSettingsControl<ProjectSettings> createProjectSettingsControl(ProjectSettings settings)

Creates a control for managing given project settings.

Parameters:

settings - target external project settings

Returns:

control for managing given project settings

getProjectName

protected java.lang.String getProjectName(java.lang.String path)

createSystemSettingsControl

protected abstract ExternalSystemSettingsControl<SystemSettings> createSystemSettingsControl(SystemSettings settings)

Creates a control for managing given system-level settings (if any).

Parameters:

settings - target system settings

Returns:

a control for managing given system-level settings; null if current external system doesn't have system-level settings (only project-level settings)

isModified

public boolean isModified()

Description copied from interface: UnnamedConfigurable

Indicates whether the Swing form was modified or not. This method is called very often, so it should not take a long time.

Specified by:

isModified in interface UnnamedConfigurable

Returns:

true if the settings were modified, false otherwise

apply

public void apply()
           throws ConfigurationException

Description copied from interface: UnnamedConfigurable

Stores the settings from the Swing form to the configurable component. This method is called on EDT upon user's request.

Specified by:

apply in interface UnnamedConfigurable

Throws:

ConfigurationException - if values cannot be applied

newProjectSettings

protected abstract ProjectSettings newProjectSettings()

Returns:

new empty project-level settings object

reset

public void reset()

Description copied from interface: UnnamedConfigurable

Loads the settings from the configurable component to the Swing form. This method is called on EDT immediately after the form creation or later upon user's request.

Specified by:

reset in interface UnnamedConfigurable

disposeUIResources

public void disposeUIResources()

Description copied from interface: UnnamedConfigurable

Notifies the configurable component that the Swing form will be closed. This method should dispose all resources associated with the component.

Specified by:

disposeUIResources in interface UnnamedConfigurable