Package com.intellij.openapi.options.ex

Class ConfigurableWrapper

java.lang.Object

com.intellij.openapi.options.ex.ConfigurableWrapper

All Implemented Interfaces:

Configurable, SearchableConfigurable, UnnamedConfigurable

public class ConfigurableWrapper
extends java.lang.Object
implements SearchableConfigurable

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

Modifier and Type	Field and Description
static java.util.Comparator<Configurable>	COMPARATOR

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Method Summary

Modifier and Type	Method and Description
ConfigurableWrapper	addChild(Configurable configurable)
void	apply() Stores the settings from the Swing form to the configurable component.
void	cancel() Called when 'Cancel' is pressed in the Settings dialog.
static <T> T	cast(java.lang.Class<T> type, UnnamedConfigurable configurable)
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
static <T extends UnnamedConfigurable> java.util.List<T>	createConfigurables(ExtensionPointName<? extends ConfigurableEP<T>> name)
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
java.lang.Runnable	enableSearch(java.lang.String option)
UnnamedConfigurable	getConfigurable()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
ConfigurableEP<?>	getExtensionPoint()
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.
java.lang.Class<?>	getOriginalClass() When building an index of searchable options, it's important to know a class which caused the creation of a configurable.
java.lang.String	getParentId()
Project	getProject()
java.lang.String	getProviderClass()
UnnamedConfigurable	getRawConfigurable()
int	getWeight()
static boolean	hasOwnContent(UnnamedConfigurable configurable)
boolean	isModified() Indicates whether the Swing form was modified or not.
static boolean	isNonDefaultProject(Configurable configurable)
void	reset() Loads the settings from the configurable component to the Swing form.
java.lang.String	toString()
static <T extends UnnamedConfigurable> T	wrapConfigurable(ConfigurableEP<T> ep)
static <T extends UnnamedConfigurable> T	wrapConfigurable(ConfigurableEP<T> ep, boolean settings)

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

Field Detail

COMPARATOR

public static final java.util.Comparator<Configurable> COMPARATOR

Method Detail

wrapConfigurable

public static <T extends UnnamedConfigurable> T wrapConfigurable(ConfigurableEP<T> ep)

wrapConfigurable

public static <T extends UnnamedConfigurable> T wrapConfigurable(ConfigurableEP<T> ep,
                                                                 boolean settings)

createConfigurables

public static <T extends UnnamedConfigurable> java.util.List<T> createConfigurables(ExtensionPointName<? extends ConfigurableEP<T>> name)

hasOwnContent

public static boolean hasOwnContent(UnnamedConfigurable configurable)

isNonDefaultProject

public static boolean isNonDefaultProject(Configurable configurable)

cast

public static <T> T cast(java.lang.Class<T> type,
                         UnnamedConfigurable configurable)

getRawConfigurable

public UnnamedConfigurable getRawConfigurable()

getConfigurable

public UnnamedConfigurable getConfigurable()

getWeight

public int getWeight()

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

getProviderClass

public java.lang.String getProviderClass()

getProject

public Project getProject()

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

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

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

cancel

public void cancel()

Description copied from interface: UnnamedConfigurable

Called when 'Cancel' is pressed in the Settings dialog.

Specified by:

cancel 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

getExtensionPoint

public ConfigurableEP<?> getExtensionPoint()

getParentId

public java.lang.String getParentId()

addChild

public ConfigurableWrapper addChild(Configurable configurable)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

enableSearch

public java.lang.Runnable enableSearch(java.lang.String option)

Specified by:

enableSearch in interface SearchableConfigurable

Parameters:

option - setting search query

Returns:

an action to perform when this configurable is opened when a search filter query is entered by the user in setting dialog. This action, for example, can select something in a tree or a list embedded in this setting page that matches the query.

getOriginalClass

public java.lang.Class<?> getOriginalClass()

Description copied from interface: SearchableConfigurable

When building an index of searchable options, it's important to know a class which caused the creation of a configurable. It often happens that the configurable is created based on a provider from an arbitrary extension point. In such a case, the provider's class should be returned from this method.
When the configurable is based on several providers consider extending CompositeConfigurable.
Keep in mind that this method can be expensive as it can load previously unloaded class.

Specified by:

getOriginalClass in interface SearchableConfigurable

Returns:

a class which is a cause of the creation of this configurable