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

Class ModuleStructureConfigurable

java.lang.Object

com.intellij.openapi.ui.MasterDetailsComponent

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

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

All Implemented Interfaces:

Disposable, Configurable, MasterDetails, SearchableConfigurable, UnnamedConfigurable, DetailsComponent.Facade, Place.Navigator

public class ModuleStructureConfigurable
extends BaseStructureConfigurable
implements Place.Navigator

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.roots.ui.configuration.projectRoot.BaseStructureConfigurable

BaseStructureConfigurable.AbstractAddGroup, BaseStructureConfigurable.MyRemoveAction

Nested classes/interfaces inherited from class com.intellij.openapi.ui.MasterDetailsComponent

MasterDetailsComponent.ActionGroupWithPreselection, MasterDetailsComponent.ItemsChangeListener, MasterDetailsComponent.MyActionGroupWrapper, MasterDetailsComponent.MyDeleteAction, MasterDetailsComponent.MyNode, MasterDetailsComponent.MyRootNode

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

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Field Summary

Fields inherited from class com.intellij.openapi.roots.ui.configuration.projectRoot.BaseStructureConfigurable

myAutoScrollEnabled, myContext, myProject, myUiDisposed

Fields inherited from class com.intellij.openapi.ui.MasterDetailsComponent

COPY_ICON, LOG, myAutoScrollHandler, myCurrentConfigurable, myHistory, myNorthPanel, myRoot, myState, myToReInitWholePanel, myTree, myWholePanel, TREE_NAME, TREE_OBJECT, TREE_UPDATER

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Constructor and Description
ModuleStructureConfigurable(Project project)

Method Summary

Modifier and Type	Method and Description
void	addLibraryOrderEntry(Module module, Library library)
void	addNode(MasterDetailsComponent.MyNode nodeToAdd, MasterDetailsComponent.MyNode parent)
void	apply() Stores the settings from the Swing form to the configurable component.
protected java.util.ArrayList<AnAction>	createActions(boolean fromPopup)
protected BaseStructureConfigurable.AbstractAddGroup	createAddAction()
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
protected java.util.List<? extends AnAction>	createCopyActions(boolean fromPopup)
void	dispose() Usually not invoked directly, see class javadoc.
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
MasterDetailsComponent.MyNode	findModuleNode(Module module)
protected java.util.ArrayList<AnAction>	getAdditionalActions()
protected java.lang.String	getComponentStateKey()
StructureConfigurableContext	getContext()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
protected java.lang.String	getEmptySelectionString()
ProjectFacetsConfigurator	getFacetConfigurator()
FacetEditorFacadeImpl	getFacetEditorFacade()
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.
static ModuleStructureConfigurable	getInstance(Project project)
Module	getModule(java.lang.String moduleName)
Module[]	getModules()
protected java.util.Comparator<MasterDetailsComponent.MyNode>	getNodeComparator()
Project	getProject()
protected java.util.Collection<? extends ProjectStructureElement>	getProjectStructureElements()
protected java.util.List<RemoveConfigurableHandler<?>>	getRemoveHandlers()
Module	getSelectedModule()
protected java.lang.String	getTextForSpeedSearch(MasterDetailsComponent.MyNode node)
void	init(StructureConfigurableContext context)
protected void	initTree()
protected boolean	isAutoScrollEnabled()
boolean	isModified() Indicates whether the Swing form was modified or not.
protected void	loadTree()
void	removeLibraryOrderEntry(Module module, Library library)
void	reset() Loads the settings from the configurable component to the Swing form.
ActionCallback	selectOrderEntry(Module module, OrderEntry orderEntry)
protected boolean	updateMultiSelection(java.util.List<? extends NamedConfigurable> selectedConfigurables)
boolean	updateProjectTree(Module[] modules)
protected void	updateSelection(NamedConfigurable configurable)

Methods inherited from class com.intellij.openapi.roots.ui.configuration.projectRoot.BaseStructureConfigurable

addCollapseExpandActions, checkCanApply, getSelectedElement, getStateService, navigateTo, onStructureSelected, onStructureUnselected, queryPlace, reloadTreeNodes, removeFacetNodes

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

addItemsChangeListener, addNotify, checkForEmptyAndDuplicatedNames, clearChildren, createToolbarActionGroup, ensureInitialized, findNodeByCondition, findNodeByName, findNodeByObject, forAll, getDetails, getDetailsComponent, getMaster, getPanelPreferredSize, getSelectedConfigurable, getSelectedNode, getSelectedObject, getSplitter, getState, getToolbar, getTree, initializeConfigurable, initUi, isInitialized, loadComponentState, loadState, onItemDeleted, processRemovedItems, reInitWholePanelIfNeeded, removeNodes, removePaths, restoreLastSelection, selectNodeInTree, selectNodeInTree, selectNodeInTree, selectNodeInTree, selectNodeInTree, setHistory, setSelectedNode, sortDescendants, wasObjectStored

Methods inherited from class java.lang.Object

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

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

navigateTo, queryPlace, setHistory

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

ModuleStructureConfigurable

public ModuleStructureConfigurable(Project project)

Method Detail

getComponentStateKey

protected java.lang.String getComponentStateKey()

Overrides:

getComponentStateKey in class MasterDetailsComponent

initTree

protected void initTree()

Overrides:

initTree in class BaseStructureConfigurable

getTextForSpeedSearch

protected java.lang.String getTextForSpeedSearch(MasterDetailsComponent.MyNode node)

Overrides:

getTextForSpeedSearch in class BaseStructureConfigurable

getAdditionalActions

protected java.util.ArrayList<AnAction> getAdditionalActions()

Overrides:

getAdditionalActions in class MasterDetailsComponent

addNode

public void addNode(MasterDetailsComponent.MyNode nodeToAdd,
                    MasterDetailsComponent.MyNode parent)

Overrides:

addNode in class MasterDetailsComponent

createActions

protected java.util.ArrayList<AnAction> createActions(boolean fromPopup)

Overrides:

createActions in class BaseStructureConfigurable

createCopyActions

protected java.util.List<? extends AnAction> createCopyActions(boolean fromPopup)

Overrides:

createCopyActions in class BaseStructureConfigurable

loadTree

protected void loadTree()

Specified by:

loadTree in class BaseStructureConfigurable

getProjectStructureElements

protected java.util.Collection<? extends ProjectStructureElement> getProjectStructureElements()

Overrides:

getProjectStructureElements in class BaseStructureConfigurable

updateSelection

protected void updateSelection(NamedConfigurable configurable)

Overrides:

updateSelection in class MasterDetailsComponent

isAutoScrollEnabled

protected boolean isAutoScrollEnabled()

Overrides:

isAutoScrollEnabled in class MasterDetailsComponent

updateMultiSelection

protected boolean updateMultiSelection(java.util.List<? extends NamedConfigurable> selectedConfigurables)

Overrides:

updateMultiSelection in class MasterDetailsComponent

updateProjectTree

public boolean updateProjectTree(Module[] modules)

getNodeComparator

protected java.util.Comparator<MasterDetailsComponent.MyNode> getNodeComparator()

Overrides:

getNodeComparator in class MasterDetailsComponent

init

public void init(StructureConfigurableContext context)

Overrides:

init in class BaseStructureConfigurable

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

Overrides:

reset in class BaseStructureConfigurable

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

Overrides:

apply in class MasterDetailsComponent

Throws:

ConfigurationException - if values cannot be applied

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

Overrides:

isModified in class MasterDetailsComponent

Returns:

true if the settings were modified, false otherwise

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

Overrides:

disposeUIResources in class BaseStructureConfigurable

dispose

public void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

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

Overrides:

createComponent in class MasterDetailsComponent

Returns:

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

See Also:

UnnamedConfigurable.disposeUIResources()

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

Overrides:

getHelpTopic in class MasterDetailsComponent

Returns:

the help topic, or null if no help is available

selectOrderEntry

public ActionCallback selectOrderEntry(Module module,
                                       OrderEntry orderEntry)

getInstance

public static ModuleStructureConfigurable getInstance(Project project)

getProject

public Project getProject()

getModules

public Module[] getModules()

removeLibraryOrderEntry

public void removeLibraryOrderEntry(Module module,
                                    Library library)

addLibraryOrderEntry

public void addLibraryOrderEntry(Module module,
                                 Library library)

findModuleNode

public MasterDetailsComponent.MyNode findModuleNode(Module module)

getFacetEditorFacade

public FacetEditorFacadeImpl getFacetEditorFacade()

getFacetConfigurator

public ProjectFacetsConfigurator getFacetConfigurator()

getSelectedModule

public Module getSelectedModule()

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

getModule

public Module getModule(java.lang.String moduleName)

getContext

public StructureConfigurableContext getContext()

createAddAction

protected BaseStructureConfigurable.AbstractAddGroup createAddAction()

Specified by:

createAddAction in class BaseStructureConfigurable

getRemoveHandlers

protected java.util.List<RemoveConfigurableHandler<?>> getRemoveHandlers()

Overrides:

getRemoveHandlers in class BaseStructureConfigurable

getEmptySelectionString

protected java.lang.String getEmptySelectionString()

Overrides:

getEmptySelectionString in class MasterDetailsComponent