Package com.intellij.openapi.options

Class ConfigurableBuilder

java.lang.Object

UiDslConfigurable.Simple

com.intellij.openapi.options.ConfigurableBuilder

All Implemented Interfaces:

ConfigurableWithOptionDescriptors

Direct Known Subclasses:

JavadocOptionsProvider, JavaErrorOptionsProvider, JsonSmartKeysConfigurable, PySmartKeysOptions, YAMLSmartOptionsProvider

public abstract class ConfigurableBuilder
extends UiDslConfigurable.Simple
implements ConfigurableWithOptionDescriptors

See also UiDslConfigurable.Simple for more flexible alternative.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConfigurableBuilder()
protected	ConfigurableBuilder(java.lang.String title)

Method Summary

Modifier and Type	Method and Description
protected void	checkBox(java.lang.String title, <any> prop)
protected void	checkBox(java.lang.String title, Getter<java.lang.Boolean> getter, Setter<? super java.lang.Boolean> setter) Adds check box with given title.
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.
void	createComponentRow(RowBuilder builder)
static java.lang.String	getConfigurableTitle(UnnamedConfigurable configurable)
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()
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

Constructor Detail

ConfigurableBuilder

protected ConfigurableBuilder()

ConfigurableBuilder

protected ConfigurableBuilder(java.lang.String title)

Method Detail

getTitle

public java.lang.String getTitle()

setTitle

protected void setTitle(java.lang.String title)

checkBox

protected void checkBox(java.lang.String title,
                        Getter<java.lang.Boolean> getter,
                        Setter<? super 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

createComponentRow

public void createComponentRow(RowBuilder builder)

getConfigurableTitle

public static java.lang.String getConfigurableTitle(UnnamedConfigurable configurable)