Package com.intellij.openapi.options

Class SettingsEditorConfigurable<Settings>

java.lang.Object

com.intellij.openapi.options.BaseConfigurable

com.intellij.openapi.options.SettingsEditorConfigurable<Settings>

All Implemented Interfaces:

Configurable, UnnamedConfigurable

Direct Known Subclasses:

RunConfigurationConfigurableAdapter, SingleConfigurationConfigurable

public abstract class SettingsEditorConfigurable<Settings>
extends BaseConfigurable

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 class com.intellij.openapi.options.BaseConfigurable

myModified

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

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Constructor and Description
SettingsEditorConfigurable(SettingsEditor<Settings> editor, Settings settings)

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.
void	disposeUIResources() Notifies the configurable component that the Swing form will be closed.
SettingsEditor<Settings>	getEditor()
Settings	getSettings()
void	reset() Loads the settings from the configurable component to the Swing form.

Methods inherited from class com.intellij.openapi.options.BaseConfigurable

getPreferredFocusedComponent, isModified, setModified

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, getHelpTopic, isModified, isModified, isModified, isModified

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

cancel

Constructor Detail

SettingsEditorConfigurable

public SettingsEditorConfigurable(SettingsEditor<Settings> editor,
                                  Settings settings)

Method Detail

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

Returns:

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

See Also:

UnnamedConfigurable.disposeUIResources()

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.

getEditor

public SettingsEditor<Settings> getEditor()

getSettings

public Settings getSettings()