com.intellij.openapi.options
Interface Configurable

All Superinterfaces:

UnnamedConfigurable

All Known Subinterfaces:

ModuleConfigurationEditor

All Known Implementing Classes:

BaseConfigurable, BaseConfigurableWithChangeSupport, RunConfigurationConfigurableAdapter, SettingsEditorConfigurable

public interface Configurable
extends UnnamedConfigurable

Named component which provides a configuration user interface. Components which implement ApplicationComponent and this interface are shown as items in the "IDE Settings" group of the main IDEA settings dialog. Components which implement ProjectComponent and this interface are shown in the "Project Settings" group of that dialog.

Method Summary

java.lang.String	getDisplayName() Returns the user-visible name of the settings component.
java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for the configurable is requested.
javax.swing.Icon	getIcon() Returns the icon representing the settings component.

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

apply, createComponent, disposeUIResources, isModified, reset

Method Detail

getDisplayName

java.lang.String getDisplayName()

Returns the user-visible name of the settings component.

Returns:

the visible name of the component.

getIcon

javax.swing.Icon getIcon()

Returns the icon representing the settings component. Components shown in the IDEA settings dialog have 32x32 icons.

Returns:

the icon for the component.

getHelpTopic

@Nullable
java.lang.String getHelpTopic()

Returns the topic in the help file which is shown when help for the configurable is requested.

Returns:

the help topic, or null if no help is available.