Package com.intellij.openapi.ui

Class NamedConfigurable<T>

java.lang.Object

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

All Implemented Interfaces:

Configurable, UnnamedConfigurable

Direct Known Subclasses:

CopyrightConfigurable, FacetTypeConfigurable, FrameworkDetectionConfigurable, GroupConfigurable, JsonSchemaConfigurable, ProjectStructureElementConfigurable, ScopeConfigurable, SingleRemoteServerConfigurable, TextConfigurable

public abstract class NamedConfigurable<T>
extends java.lang.Object
implements Configurable

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

Modifier	Constructor and Description
protected	NamedConfigurable()
protected	NamedConfigurable(boolean isNameEditable, java.lang.Runnable updateTree)

Method Summary

Modifier and Type	Method and Description
protected void	checkName(java.lang.String name)
javax.swing.JComponent	createComponent() Creates new Swing form that enables user to configure the settings.
abstract javax.swing.JComponent	createOptionsPanel()
protected javax.swing.JComponent	createTopRightComponent()
abstract java.lang.String	getBannerSlogan()
abstract T	getEditableObject()
javax.swing.Icon	getIcon(boolean expanded)
boolean	isNameEditable()
protected void	resetOptionsPanel()
abstract void	setDisplayName(java.lang.String name)
void	setNameFieldShown(boolean shown)
java.lang.String	toString()
void	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

getDisplayName, getHelpTopic, getPreferredFocusedComponent, isModified, isModified, isModified, isModified

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

apply, cancel, disposeUIResources, isModified, reset

Constructor Detail

NamedConfigurable

protected NamedConfigurable()

NamedConfigurable

protected NamedConfigurable(boolean isNameEditable,
                            java.lang.Runnable updateTree)

Method Detail

isNameEditable

public boolean isNameEditable()

setNameFieldShown

public void setNameFieldShown(boolean shown)

setDisplayName

public abstract void setDisplayName(java.lang.String name)

getEditableObject

public abstract T getEditableObject()

getBannerSlogan

public abstract java.lang.String getBannerSlogan()

createComponent

public final 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()

checkName

protected void checkName(java.lang.String name)
                  throws ConfigurationException

Throws:

ConfigurationException

createTopRightComponent

protected javax.swing.JComponent createTopRightComponent()

resetOptionsPanel

protected void resetOptionsPanel()

updateName

public void updateName()

createOptionsPanel

public abstract javax.swing.JComponent createOptionsPanel()

getIcon

public javax.swing.Icon getIcon(boolean expanded)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object