Package com.intellij.application.options

Class ModuleAwareProjectConfigurable<T extends UnnamedConfigurable>

java.lang.Object

com.intellij.application.options.ModuleAwareProjectConfigurable<T>

All Implemented Interfaces:

Configurable, Configurable.NoScroll, SearchableConfigurable, UnnamedConfigurable

Direct Known Subclasses:

BuildoutModulesConfigurable, PyActiveSdkModuleConfigurable, PyDependenciesConfigurable, PyIntegratedToolsModulesConfigurable, PythonContentEntriesConfigurable

public abstract class ModuleAwareProjectConfigurable<T extends UnnamedConfigurable>
extends java.lang.Object
implements SearchableConfigurable, Configurable.NoScroll

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

Constructor and Description
ModuleAwareProjectConfigurable(Project project, java.lang.String displayName, java.lang.String helpTopic)

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 T	createDefaultProjectConfigurable()
protected abstract T	createModuleConfigurable(Module module)
protected T	createProjectConfigurable() This configurable is for project-wide settings
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.
java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for the configurable is requested.
java.lang.String	getId() Unique configurable id.
protected Project	getProject()
protected javax.swing.Icon	getProjectConfigurableItemIcon()
protected java.lang.String	getProjectConfigurableItemName()
boolean	isModified() Indicates whether the Swing form was modified or not.
protected boolean	isSuitableForModule(Module module)
void	reset() Loads the settings from the configurable component to the Swing form.

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

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

getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel

Constructor Detail

ModuleAwareProjectConfigurable

public ModuleAwareProjectConfigurable(Project project,
                                      java.lang.String displayName,
                                      java.lang.String helpTopic)

Method Detail

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

getHelpTopic

public java.lang.String getHelpTopic()

Description copied from interface: Configurable

Returns the topic in the help file which is shown when help for the configurable is requested.

Specified by:

getHelpTopic in interface Configurable

Returns:

the help topic, or null if no help is available

isSuitableForModule

protected boolean isSuitableForModule(Module module)

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()

createDefaultProjectConfigurable

protected T createDefaultProjectConfigurable()

createProjectConfigurable

protected T createProjectConfigurable()

This configurable is for project-wide settings

Returns:

configurable or null if none

getProjectConfigurableItemName

protected java.lang.String getProjectConfigurableItemName()

Returns:

Name for project-wide settings in modules list

getProjectConfigurableItemIcon

protected javax.swing.Icon getProjectConfigurableItemIcon()

Returns:

Icon for project-wide sttings in modules list

createModuleConfigurable

protected abstract T createModuleConfigurable(Module module)

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

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

getId

public java.lang.String getId()

Description copied from interface: SearchableConfigurable

Unique configurable id. Note this id should be THE SAME as the one specified in XML.

Specified by:

getId in interface SearchableConfigurable

See Also:

ConfigurableEP.id

getProject

protected final Project getProject()