Package com.intellij.openapi.roots.ui.configuration.projectRoot

Class ModuleConfigurable

java.lang.Object

com.intellij.openapi.ui.NamedConfigurable<T>

com.intellij.openapi.roots.ui.configuration.projectRoot.ProjectStructureElementConfigurable<Module>

com.intellij.openapi.roots.ui.configuration.projectRoot.ModuleConfigurable

All Implemented Interfaces:

Configurable, UnnamedConfigurable, Place.Navigator

public class ModuleConfigurable
extends ProjectStructureElementConfigurable<Module>
implements Place.Navigator

Nested Class Summary

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
ModuleConfigurable(ModulesConfigurator modulesConfigurator, Module module, java.lang.Runnable updateTree, ModuleGrouper moduleGrouper)

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
protected void	checkName(java.lang.String name)
javax.swing.JComponent	createOptionsPanel()
java.lang.String	getBannerSlogan()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
Module	getEditableObject()
java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for the configurable is requested.
javax.swing.Icon	getIcon(boolean open)
Module	getModule()
ModuleEditor	getModuleEditor()
ModuleGrouper	getModuleGrouper()
ProjectStructureElement	getProjectStructureElement()
boolean	isModified() Indicates whether the Swing form was modified or not.
ActionCallback	navigateTo(Place place, boolean requestFocus)
void	queryPlace(Place place)
void	setDisplayName(java.lang.String name)

Methods inherited from class com.intellij.openapi.ui.NamedConfigurable

createComponent, createTopRightComponent, isNameEditable, resetOptionsPanel, setNameFieldShown, toString, updateName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.ui.navigation.Place.Navigator

setHistory

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

getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel, disposeUIResources, reset

Constructor Detail

ModuleConfigurable

public ModuleConfigurable(ModulesConfigurator modulesConfigurator,
                          Module module,
                          java.lang.Runnable updateTree,
                          ModuleGrouper moduleGrouper)

Method Detail

setDisplayName

public void setDisplayName(java.lang.String name)

Specified by:

setDisplayName in class NamedConfigurable<Module>

checkName

protected void checkName(java.lang.String name)
                  throws ConfigurationException

Overrides:

checkName in class NamedConfigurable<Module>

Throws:

ConfigurationException

getModuleGrouper

public ModuleGrouper getModuleGrouper()

getProjectStructureElement

public ProjectStructureElement getProjectStructureElement()

Specified by:

getProjectStructureElement in class ProjectStructureElementConfigurable<Module>

getEditableObject

public Module getEditableObject()

Specified by:

getEditableObject in class NamedConfigurable<Module>

getBannerSlogan

public java.lang.String getBannerSlogan()

Specified by:

getBannerSlogan in class NamedConfigurable<Module>

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

getIcon

public javax.swing.Icon getIcon(boolean open)

Overrides:

getIcon in class NamedConfigurable<Module>

getModule

public Module getModule()

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

createOptionsPanel

public javax.swing.JComponent createOptionsPanel()

Specified by:

createOptionsPanel in class NamedConfigurable<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

getModuleEditor

public ModuleEditor getModuleEditor()

navigateTo

public ActionCallback navigateTo(Place place,
                                 boolean requestFocus)

Specified by:

navigateTo in interface Place.Navigator

queryPlace

public void queryPlace(Place place)

Specified by:

queryPlace in interface Place.Navigator