Package com.intellij.openapi.options

Class ConfigurableBase<UI extends ConfigurableUi<S>,S>

java.lang.Object

com.intellij.openapi.options.ConfigurableBase<UI,S>

All Implemented Interfaces:

Configurable, Configurable.NoScroll, SearchableConfigurable, UnnamedConfigurable

Direct Known Subclasses:

CommitDialogConfigurable, ConsentConfigurable, DateTimeFormatConfigurable, HgProjectConfigurable, HttpProxyConfigurable, QuickListsPanel, SimpleConfigurable, SvnConfigurable

public abstract class ConfigurableBase<UI extends ConfigurableUi<S>,S>
extends java.lang.Object
implements SearchableConfigurable, Configurable.NoScroll

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 inherited from interface com.intellij.openapi.options.Configurable

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurableBase(java.lang.String id, java.lang.String displayName, java.lang.String helpTopic)

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
protected abstract UI	createUi()
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
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.
javax.swing.JComponent	getPreferredFocusedComponent()
protected abstract S	getSettings()
boolean	isModified() Indicates whether the Swing form was modified or not.
void	reset() Loads the settings from the configurable component to the Swing form.

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

enableSearch, getOriginalClass

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

isModified, isModified, isModified, isModified

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

cancel

Constructor Detail

ConfigurableBase

protected ConfigurableBase(java.lang.String id,
                           java.lang.String displayName,
                           java.lang.String helpTopic)

Method Detail

getId

public final 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

getDisplayName

public final 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 final 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

getSettings

protected abstract S getSettings()

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

createComponent

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

createUi

protected abstract UI createUi()

isModified

public final 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 final 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

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Specified by:

getPreferredFocusedComponent in interface Configurable

Returns:

component which should be focused when the dialog appears on the screen.

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