Package com.intellij.ide.util.scopeChooser

Class ScopeConfigurable

java.lang.Object

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

com.intellij.ide.util.scopeChooser.ScopeConfigurable

All Implemented Interfaces:

Configurable, UnnamedConfigurable

public class ScopeConfigurable
extends NamedConfigurable<NamedScope>

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
ScopeConfigurable(NamedScope scope, boolean shareScope, Project project, java.lang.Runnable updateTree)

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
void	cancelCurrentProgress()
javax.swing.JComponent	createOptionsPanel()
protected javax.swing.JComponent	createTopRightComponent()
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
java.lang.String	getBannerSlogan()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
NamedScope	getEditableObject()
java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for the configurable is requested.
NamedScopesHolder	getHolder()
javax.swing.Icon	getIcon(boolean expanded)
NamedScope	getScope()
boolean	isModified() Indicates whether the Swing form was modified or not.
void	reset() Loads the settings from the configurable component to the Swing form.
void	restoreCanceledProgress()
void	setDisplayName(java.lang.String name)

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

checkName, createComponent, 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.openapi.options.Configurable

getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel

Constructor Detail

ScopeConfigurable

public ScopeConfigurable(NamedScope scope,
                         boolean shareScope,
                         Project project,
                         java.lang.Runnable updateTree)

Method Detail

setDisplayName

public void setDisplayName(java.lang.String name)

Specified by:

setDisplayName in class NamedConfigurable<NamedScope>

getEditableObject

public NamedScope getEditableObject()

Specified by:

getEditableObject in class NamedConfigurable<NamedScope>

getBannerSlogan

public java.lang.String getBannerSlogan()

Specified by:

getBannerSlogan in class NamedConfigurable<NamedScope>

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.

Returns:

the visible name of the configurable component

getHolder

public NamedScopesHolder getHolder()

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.

Returns:

the help topic, or null if no help is available

createTopRightComponent

protected javax.swing.JComponent createTopRightComponent()

Overrides:

createTopRightComponent in class NamedConfigurable<NamedScope>

createOptionsPanel

public javax.swing.JComponent createOptionsPanel()

Specified by:

createOptionsPanel in class NamedConfigurable<NamedScope>

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.

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.

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.

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.

cancelCurrentProgress

public void cancelCurrentProgress()

getScope

public NamedScope getScope()

restoreCanceledProgress

public void restoreCanceledProgress()

getIcon

public javax.swing.Icon getIcon(boolean expanded)

Overrides:

getIcon in class NamedConfigurable<NamedScope>