Package com.intellij.openapi.options

Class SettingsEditor<Settings>

java.lang.Object

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

All Implemented Interfaces:

Disposable

Direct Known Subclasses:

ApplicationConfigurable, CloudDeploymentNameEditor, CompositeSettingsEditor, CompoundRunConfigurationSettingsEditor, ConfigurationSettingsEditorWrapper, CoverageConfigurable, CustomFileTypeEditor, DeployToServerSettingsEditor, ExtendableSettingsEditor, ExternalSystemRunConfigurationEditor, GenericDebuggerParametersRunnerConfigurable, GroovyRunConfigurationEditor, JarApplicationConfigurable, JavaScratchConfigurable, JUnitConfigurable, LogConfigurationPanel, MvcRunConfigurationEditor, PyTestConfigurationEditor, PythonDocTestRunConfigurationEditor, PythonExtendedConfigurationEditor, PythonNoseTestRunConfigurationEditor, PythonRunConfigurationEditor, PythonUnitTestRunConfigurationEditor, RemoteConfigurable, RestConfigurationEditor, SettingsEditorGroup, SettingsEditorWrapper, ShRunConfigurationEditor

public abstract class SettingsEditor<Settings>
extends java.lang.Object
implements Disposable

This class presents an abstraction of user interface transactional editor provider of some abstract data type. getComponent() should be called before resetFrom(Object)

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
SettingsEditor()
SettingsEditor(Factory<Settings> settingsFactory)

Method Summary

Modifier and Type	Method and Description
void	addSettingsEditorListener(SettingsEditorListener<Settings> listener)
protected abstract void	applyEditorTo(Settings s)
void	applyTo(Settings s)
void	bulkUpdate(java.lang.Runnable runnable)
protected abstract javax.swing.JComponent	createEditor()
protected UserActivityWatcher	createWatcher()
void	dispose() Usually not invoked directly, see class javadoc.
protected void	disposeEditor()
protected void	fireEditorStateChanged()
javax.swing.JComponent	getComponent()
Factory<Settings>	getFactory()
CompositeSettingsEditor<Settings>	getOwner()
Settings	getSnapshot()
protected void	installWatcher(javax.swing.JComponent c)
void	removeSettingsEditorListener(SettingsEditorListener<Settings> listener)
protected abstract void	resetEditorFrom(Settings s)
void	resetFrom(Settings s)
protected void	uninstallWatcher()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettingsEditor

public SettingsEditor()

SettingsEditor

public SettingsEditor(Factory<Settings> settingsFactory)

Method Detail

resetEditorFrom

protected abstract void resetEditorFrom(Settings s)

applyEditorTo

protected abstract void applyEditorTo(Settings s)
                               throws ConfigurationException

Throws:

ConfigurationException

createEditor

protected abstract javax.swing.JComponent createEditor()

disposeEditor

protected void disposeEditor()

getSnapshot

public Settings getSnapshot()
                     throws ConfigurationException

Throws:

ConfigurationException

getOwner

public final CompositeSettingsEditor<Settings> getOwner()

getFactory

public Factory<Settings> getFactory()

resetFrom

public final void resetFrom(Settings s)

bulkUpdate

public final void bulkUpdate(java.lang.Runnable runnable)

applyTo

public final void applyTo(Settings s)
                   throws ConfigurationException

Throws:

ConfigurationException

getComponent

public final javax.swing.JComponent getComponent()

dispose

public final void dispose()

Description copied from interface: Disposable

Usually not invoked directly, see class javadoc.

Specified by:

dispose in interface Disposable

uninstallWatcher

protected void uninstallWatcher()

installWatcher

protected void installWatcher(javax.swing.JComponent c)

createWatcher

protected UserActivityWatcher createWatcher()

addSettingsEditorListener

public final void addSettingsEditorListener(SettingsEditorListener<Settings> listener)

removeSettingsEditorListener

public final void removeSettingsEditorListener(SettingsEditorListener<Settings> listener)

fireEditorStateChanged

protected final void fireEditorStateChanged()