Package com.intellij.openapi.roots.ui.configuration.projectRoot

Class TextConfigurable<T>

java.lang.Object

com.intellij.openapi.ui.NamedConfigurable<T>

com.intellij.openapi.roots.ui.configuration.projectRoot.TextConfigurable<T>

All Implemented Interfaces:

Configurable, UnnamedConfigurable

public class TextConfigurable<T>
extends NamedConfigurable<T>

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 interface com.intellij.openapi.options.Configurable

APPLICATION_CONFIGURABLE, PROJECT_CONFIGURABLE

Constructor Summary

Constructors

Constructor and Description
TextConfigurable(T object, java.lang.String displayName, java.lang.String bannerSlogan, java.lang.String descriptionText, javax.swing.Icon icon)

Method Summary

Modifier and Type	Method and Description
void	apply() Stores the settings from the Swing form to the configurable component.
javax.swing.JComponent	createOptionsPanel()
java.lang.String	getBannerSlogan()
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
T	getEditableObject()
javax.swing.Icon	getIcon(boolean open)
boolean	isModified() Indicates whether the Swing form was modified or not.
void	setDisplayName(java.lang.String name)

Methods inherited from class com.intellij.openapi.ui.NamedConfigurable

checkName, createComponent, createTopRightComponent, isNameEditable, resetOptionsPanel, setNameFieldShown, toString, updateName

Methods inherited from class java.lang.Object

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

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

getHelpTopic, getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

cancel, disposeUIResources, reset

Constructor Detail

TextConfigurable

public TextConfigurable(T object,
                        java.lang.String displayName,
                        java.lang.String bannerSlogan,
                        java.lang.String descriptionText,
                        javax.swing.Icon icon)

Method Detail

setDisplayName

public void setDisplayName(java.lang.String name)

Specified by:

setDisplayName in class NamedConfigurable<T>

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.

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.

Throws:

ConfigurationException - if values cannot be applied

getEditableObject

public T getEditableObject()

Specified by:

getEditableObject in class NamedConfigurable<T>

getBannerSlogan

public java.lang.String getBannerSlogan()

Specified by:

getBannerSlogan in class NamedConfigurable<T>

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: Configurable

Returns the visible name of the configurable component. Note, that this method must return the display name that is equal to the display name declared in XML to avoid unexpected errors.

Returns:

the visible name of the configurable component

getIcon

public javax.swing.Icon getIcon(boolean open)

Overrides:

getIcon in class NamedConfigurable<T>

createOptionsPanel

public javax.swing.JComponent createOptionsPanel()

Specified by:

createOptionsPanel in class NamedConfigurable<T>