Package com.intellij.openapi.options

Class BeanConfigurable<T>

java.lang.Object

com.intellij.openapi.options.BeanConfigurable<T>

All Implemented Interfaces:

ConfigurableWithOptionDescriptors, UnnamedConfigurable

Direct Known Subclasses:

BaseCodeFoldingOptionsProvider, JavaCodeFoldingOptionsProvider, PythonFoldingOptionsProvider, XmlCodeFoldingOptionsProvider

public abstract class BeanConfigurable<T>
extends java.lang.Object
implements UnnamedConfigurable, ConfigurableWithOptionDescriptors

See ConfigurableBuilder for UiDslConfigurable alternative.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BeanConfigurable(T beanInstance)
protected	BeanConfigurable(T beanInstance, java.lang.String title)

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
protected void	checkBox(java.lang.String title, <any> prop)
protected void	checkBox(java.lang.String title, Getter<java.lang.Boolean> getter, Setter<java.lang.Boolean> setter) Adds check box with given title.
protected void	checkBox(java.lang.String fieldName, java.lang.String title) Deprecated. use checkBox(String, Getter, Setter) instead
protected <V> void	component(javax.swing.JComponent component, Getter<? extends V> beanGetter, Setter<? super V> beanSetter, Getter<? extends V> componentGetter, Setter<? super V> componentSetter) Adds custom component (e.g.
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
protected T	getInstance()
java.util.List<OptionDescription>	getOptionDescriptors(java.lang.String configurableId, java.util.function.Function<? super java.lang.String,java.lang.String> nameConverter)
java.lang.String	getTitle()
boolean	isModified() Indicates whether the Swing form was modified or not.
void	reset() Loads the settings from the configurable component to the Swing form.
protected void	setTitle(java.lang.String title)

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

cancel, disposeUIResources

Constructor Detail

BeanConfigurable

protected BeanConfigurable(T beanInstance)

BeanConfigurable

protected BeanConfigurable(T beanInstance,
                           java.lang.String title)

Method Detail

getTitle

public java.lang.String getTitle()

setTitle

protected void setTitle(java.lang.String title)

getInstance

protected T getInstance()

checkBox

@Deprecated
protected void checkBox(java.lang.String fieldName,
                        java.lang.String title)

Deprecated. use checkBox(String, Getter, Setter) instead

checkBox

protected void checkBox(java.lang.String title,
                        Getter<java.lang.Boolean> getter,
                        Setter<java.lang.Boolean> setter)

Adds check box with given title. Initial checkbox value is obtained from getter. After the apply, the value from the check box is written back to model via setter.

checkBox

protected void checkBox(java.lang.String title,
                        <any> prop)

component

protected <V> void component(javax.swing.JComponent component,
                             Getter<? extends V> beanGetter,
                             Setter<? super V> beanSetter,
                             Getter<? extends V> componentGetter,
                             Setter<? super V> componentSetter)

Adds custom component (e.g. edit box). Initial value is obtained from beanGetter and applied to the component via componentSetter. E.g. text is read from the model and set to the edit box. After the apply, the value from the component is queried via componentGetter and written back to model via beanSetter. E.g. text from the edit box is queried and saved back to model bean.

getOptionDescriptors

public java.util.List<OptionDescription> getOptionDescriptors(java.lang.String configurableId,
                                                              java.util.function.Function<? super java.lang.String,java.lang.String> nameConverter)

Specified by:

getOptionDescriptors in interface ConfigurableWithOptionDescriptors

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