Package com.intellij.openapi.ui

Class MasterDetailsComponent

java.lang.Object

com.intellij.openapi.ui.MasterDetailsComponent

All Implemented Interfaces:

Configurable, MasterDetails, UnnamedConfigurable, DetailsComponent.Facade

Direct Known Subclasses:

BaseStructureConfigurable, JsonSchemaMappingsConfigurable, NamedItemsListEditor, ProjectJdksConfigurable, RemoteServerListConfigurable, ScopeChooserConfigurable, SvnConfigureProxiesComponent, SvnMergeSourceDetails

public abstract class MasterDetailsComponent
extends java.lang.Object
implements Configurable, DetailsComponent.Facade, MasterDetails

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MasterDetailsComponent.ActionGroupWithPreselection
protected static interface	MasterDetailsComponent.ItemsChangeListener
protected class	MasterDetailsComponent.MyActionGroupWrapper
protected class	MasterDetailsComponent.MyDeleteAction
static class	MasterDetailsComponent.MyNode
protected static class	MasterDetailsComponent.MyRootNode

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

Modifier and Type	Field and Description
protected static javax.swing.Icon	COPY_ICON
protected static Logger	LOG
protected AutoScrollToSourceHandler	myAutoScrollHandler
protected NamedConfigurable	myCurrentConfigurable
protected History	myHistory
javax.swing.JPanel	myNorthPanel
protected MasterDetailsComponent.MyNode	myRoot
protected MasterDetailsState	myState
protected boolean	myToReInitWholePanel
protected Tree	myTree
protected javax.swing.JPanel	myWholePanel
static java.lang.String	TREE_NAME
static java.lang.String	TREE_OBJECT
protected java.lang.Runnable	TREE_UPDATER

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MasterDetailsComponent()
protected	MasterDetailsComponent(MasterDetailsState state)

Method Summary

Modifier and Type	Method and Description
void	addItemsChangeListener(MasterDetailsComponent.ItemsChangeListener l)
protected void	addNode(MasterDetailsComponent.MyNode nodeToAdd, MasterDetailsComponent.MyNode parent)
protected void	addNotify()
void	apply() Stores the settings from the Swing form to the configurable component.
protected void	checkForEmptyAndDuplicatedNames(java.lang.String prefix, java.lang.String title, java.lang.Class<? extends NamedConfigurable> configurableClass)
protected void	clearChildren()
protected java.util.List<AnAction>	createActions(boolean fromPopup)
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
protected DefaultActionGroup	createToolbarActionGroup()
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
void	ensureInitialized(NamedConfigurable configurable)
protected static MasterDetailsComponent.MyNode	findNodeByCondition(javax.swing.tree.TreeNode root, Condition<? super NamedConfigurable> condition)
protected static MasterDetailsComponent.MyNode	findNodeByName(javax.swing.tree.TreeNode root, java.lang.String profileName)
static MasterDetailsComponent.MyNode	findNodeByObject(javax.swing.tree.TreeNode root, java.lang.Object editableObject)
protected static Condition<java.lang.Object[]>	forAll(Condition<java.lang.Object> condition)
protected java.util.ArrayList<AnAction>	getAdditionalActions()
protected java.lang.String	getComponentStateKey()
DetailsComponent	getDetails()
DetailsComponent	getDetailsComponent()
protected java.lang.String	getEmptySelectionString()
java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for the configurable is requested.
javax.swing.JComponent	getMaster()
protected java.util.Comparator<MasterDetailsComponent.MyNode>	getNodeComparator()
protected java.awt.Dimension	getPanelPreferredSize()
NamedConfigurable	getSelectedConfigurable()
MasterDetailsComponent.MyNode	getSelectedNode()
java.lang.Object	getSelectedObject()
Splitter	getSplitter()
protected MasterDetailsState	getState()
protected MasterDetailsStateService	getStateService()
javax.swing.JComponent	getToolbar()
Tree	getTree()
protected void	initializeConfigurable(NamedConfigurable configurable)
protected void	initTree()
void	initUi()
protected boolean	isAutoScrollEnabled()
protected boolean	isInitialized(NamedConfigurable configurable)
boolean	isModified() Indicates whether the Swing form was modified or not.
protected void	loadComponentState()
protected void	loadState(MasterDetailsState object)
protected void	onItemDeleted(java.lang.Object item)
protected void	processRemovedItems()
protected void	reInitWholePanelIfNeeded()
protected void	removeNodes(java.util.List<? extends MasterDetailsComponent.MyNode> nodes)
protected void	removePaths(javax.swing.tree.TreePath... paths)
void	reset() Loads the settings from the configurable component to the Swing form.
protected void	restoreLastSelection()
ActionCallback	selectNodeInTree(javax.swing.tree.DefaultMutableTreeNode nodeToSelect)
ActionCallback	selectNodeInTree(javax.swing.tree.DefaultMutableTreeNode nodeToSelect, boolean requestFocus)
ActionCallback	selectNodeInTree(javax.swing.tree.DefaultMutableTreeNode nodeToSelect, boolean center, boolean requestFocus)
void	selectNodeInTree(java.lang.Object object)
void	selectNodeInTree(java.lang.String displayName)
void	setHistory(History history)
protected void	setSelectedNode(MasterDetailsComponent.MyNode node)
protected void	sortDescendants(MasterDetailsComponent.MyNode root)
protected boolean	updateMultiSelection(java.util.List<? extends NamedConfigurable> selectedConfigurables)
protected void	updateSelection(NamedConfigurable configurable)
protected boolean	wasObjectStored(java.lang.Object editableObject)

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.Configurable

getDisplayName, getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel

Field Detail

LOG

protected static final Logger LOG

COPY_ICON

protected static final javax.swing.Icon COPY_ICON

myCurrentConfigurable

protected NamedConfigurable myCurrentConfigurable

TREE_OBJECT

public static final java.lang.String TREE_OBJECT

See Also:

Constant Field Values

TREE_NAME

public static final java.lang.String TREE_NAME

See Also:

Constant Field Values

myHistory

protected History myHistory

myState

protected final MasterDetailsState myState

TREE_UPDATER

protected final java.lang.Runnable TREE_UPDATER

myRoot

protected MasterDetailsComponent.MyNode myRoot

myTree

protected Tree myTree

myWholePanel

protected javax.swing.JPanel myWholePanel

myNorthPanel

public javax.swing.JPanel myNorthPanel

myAutoScrollHandler

protected AutoScrollToSourceHandler myAutoScrollHandler

myToReInitWholePanel

protected boolean myToReInitWholePanel

Constructor Detail

MasterDetailsComponent

protected MasterDetailsComponent()

MasterDetailsComponent

protected MasterDetailsComponent(MasterDetailsState state)

Method Detail

setHistory

public void setHistory(History history)

reInitWholePanelIfNeeded

protected void reInitWholePanelIfNeeded()

addNotify

protected void addNotify()

updateMultiSelection

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

getDetailsComponent

public DetailsComponent getDetailsComponent()

Specified by:

getDetailsComponent in interface DetailsComponent.Facade

getSplitter

public Splitter getSplitter()

isAutoScrollEnabled

protected boolean isAutoScrollEnabled()

createToolbarActionGroup

protected DefaultActionGroup createToolbarActionGroup()

addItemsChangeListener

public void addItemsChangeListener(MasterDetailsComponent.ItemsChangeListener l)

getPanelPreferredSize

protected java.awt.Dimension getPanelPreferredSize()

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

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

isInitialized

protected boolean isInitialized(NamedConfigurable configurable)

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

processRemovedItems

protected void processRemovedItems()

wasObjectStored

protected boolean wasObjectStored(java.lang.Object editableObject)

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

restoreLastSelection

protected final void restoreLastSelection()

loadComponentState

protected void loadComponentState()

getComponentStateKey

protected java.lang.String getComponentStateKey()

getStateService

protected MasterDetailsStateService getStateService()

getState

protected MasterDetailsState getState()

loadState

protected void loadState(MasterDetailsState object)

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

clearChildren

protected void clearChildren()

createActions

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

initTree

protected void initTree()

getAdditionalActions

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

addNode

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

sortDescendants

protected void sortDescendants(MasterDetailsComponent.MyNode root)

getNodeComparator

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

selectNodeInTree

public ActionCallback selectNodeInTree(javax.swing.tree.DefaultMutableTreeNode nodeToSelect)

selectNodeInTree

public ActionCallback selectNodeInTree(javax.swing.tree.DefaultMutableTreeNode nodeToSelect,
                                       boolean requestFocus)

selectNodeInTree

public ActionCallback selectNodeInTree(javax.swing.tree.DefaultMutableTreeNode nodeToSelect,
                                       boolean center,
                                       boolean requestFocus)

getSelectedObject

public java.lang.Object getSelectedObject()

getSelectedNode

public final MasterDetailsComponent.MyNode getSelectedNode()

getSelectedConfigurable

public NamedConfigurable getSelectedConfigurable()

selectNodeInTree

public void selectNodeInTree(java.lang.String displayName)

selectNodeInTree

public void selectNodeInTree(java.lang.Object object)

findNodeByName

protected static MasterDetailsComponent.MyNode findNodeByName(javax.swing.tree.TreeNode root,
                                                              java.lang.String profileName)

findNodeByObject

public static MasterDetailsComponent.MyNode findNodeByObject(javax.swing.tree.TreeNode root,
                                                             java.lang.Object editableObject)

findNodeByCondition

protected static MasterDetailsComponent.MyNode findNodeByCondition(javax.swing.tree.TreeNode root,
                                                                   Condition<? super NamedConfigurable> condition)

setSelectedNode

protected void setSelectedNode(MasterDetailsComponent.MyNode node)

updateSelection

protected void updateSelection(NamedConfigurable configurable)

ensureInitialized

public void ensureInitialized(NamedConfigurable configurable)

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

getEmptySelectionString

protected java.lang.String getEmptySelectionString()

initializeConfigurable

protected void initializeConfigurable(NamedConfigurable configurable)

checkForEmptyAndDuplicatedNames

protected final void checkForEmptyAndDuplicatedNames(java.lang.String prefix,
                                                     java.lang.String title,
                                                     java.lang.Class<? extends NamedConfigurable> configurableClass)
                                              throws ConfigurationException

Throws:

ConfigurationException

getTree

public Tree getTree()

removePaths

protected void removePaths(javax.swing.tree.TreePath... paths)

removeNodes

protected void removeNodes(java.util.List<? extends MasterDetailsComponent.MyNode> nodes)

onItemDeleted

protected void onItemDeleted(java.lang.Object item)

forAll

protected static Condition<java.lang.Object[]> forAll(Condition<java.lang.Object> condition)

getToolbar

public javax.swing.JComponent getToolbar()

Specified by:

getToolbar in interface MasterDetails

getMaster

public javax.swing.JComponent getMaster()

Specified by:

getMaster in interface MasterDetails

getDetails

public DetailsComponent getDetails()

Specified by:

getDetails in interface MasterDetails

initUi

public void initUi()

Specified by:

initUi in interface MasterDetails