Package com.intellij.openapi.options

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

java.lang.Object

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

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

All Implemented Interfaces:

Configurable, Configurable.NoScroll, SearchableConfigurable, UnnamedConfigurable

public final class SimpleConfigurable<UI extends ConfigurableUi<S>,S>
extends ConfigurableBase<UI,S>

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

Method Summary

Modifier and Type	Method and Description
static <UI extends ConfigurableUi<S>,S> SimpleConfigurable<UI,S>	create(java.lang.String id, java.lang.String displayName, java.lang.Class<? extends UI> uiClass, Getter<? extends S> settingsGetter)
static <UI extends ConfigurableUi<S>,S> SimpleConfigurable<UI,S>	create(java.lang.String id, java.lang.String displayName, java.lang.String helpTopic, java.lang.Class<? extends UI> uiClass, Getter<? extends S> settingsGetter)
protected UI	createUi()
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.
protected S	getSettings()

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

apply, createComponent, disposeUIResources, getDisplayName, getHelpTopic, getId, getPreferredFocusedComponent, isModified, reset

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

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

isModified, isModified, isModified, isModified

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

cancel

Method Detail

create

public static <UI extends ConfigurableUi<S>,S> SimpleConfigurable<UI,S> create(java.lang.String id,
                                                                               java.lang.String displayName,
                                                                               java.lang.String helpTopic,
                                                                               java.lang.Class<? extends UI> uiClass,
                                                                               Getter<? extends S> settingsGetter)

create

public static <UI extends ConfigurableUi<S>,S> SimpleConfigurable<UI,S> create(java.lang.String id,
                                                                               java.lang.String displayName,
                                                                               java.lang.Class<? extends UI> uiClass,
                                                                               Getter<? extends S> settingsGetter)

getSettings

protected S getSettings()

Specified by:

getSettings in class ConfigurableBase<UI extends ConfigurableUi<S>,S>

createUi

protected UI createUi()

Specified by:

createUi in class ConfigurableBase<UI extends ConfigurableUi<S>,S>

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.

Returns:

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