Package com.intellij.openapi.options

Interface Configurable

All Superinterfaces:

UnnamedConfigurable

All Known Subinterfaces:

CodeStyleConfigurable, EditorOptionsProvider, ErrorsConfigurable, IntentionsConfigurable, ModuleConfigurationEditor, SearchableConfigurable, SearchableConfigurable.Parent

All Known Implementing Classes:

AbstractExternalSystemConfigurable, ActionMacroConfigurable, AllFileTemplatesConfigurable, AnnotationProcessorsConfigurable, AnnotationsEditor, AppEditorFontConfigurable, AppEngineCloudConfigurable, AppEngineFacetEditor, ArrangementRuleAliasesListEditor, ArtifactConfigurable, ArtifactConfigurableBase, ArtifactsStructureConfigurable, AutoImportOptionsConfigurable, BaseConfigurable, BaseConfigurableWithChangeSupport, BaseLibrariesConfigurable, BaseStructureConfigurable, BrowserSettings, BuildElementsEditor, BuildoutConfigurable, BuildoutModulesConfigurable, CaptureConfigurable, CertificateConfigurable, ChangelistConflictConfigurable, ChromeSettingsConfigurable, ClasspathEditor, CodeCompletionOptions, CodeFoldingConfigurable, CodeInspectionAction.ExternalProfilesComboboxAwareInspectionToolsConfigurable, CodeStyleAbstractConfigurable, CodeStyleConfigurableWrapper, CodeStyleGenerationConfigurable, CodeStyleGroupProvider.CodeStyleGroupConfigurable, CodeStyleSchemesConfigurable, ColorAndFontOptions, CommitDialogConfigurable, CommonContentEntriesEditor, CompilerConfigurable, CompilerUIConfigurable, CompositeConfigurable, ConfigurableBase, ConfigurableWrapper, ConsentConfigurable, ConsoleConfigurable, ContentEntriesEditor, CopyrightConfigurable, CopyrightFormattingConfigurable, CopyrightProjectConfigurable, CoverageOptionsConfigurable, CustomizationConfigurable, DateTimeFormatConfigurable, DebuggerConfigurable, DebuggerDataViewsConfigurable, DefaultFacetSettingsConfigurable, DefaultSchemasConfigurable, DependencyConfigurable, DetectionExcludesConfigurable, EclipseCompilerConfigurable, EmmetCompositeConfigurable, EqualsHashCodeTemplatesPanel, ErrorPaneConfigurable, ExternalDependenciesConfigurable, ExternalDiffSettingsConfigurable, ExternalResourceConfigurable, FacetConfigurable, FacetEditorTab, FacetStructureConfigurable, FacetTypeConfigurable, FileAssociationsConfigurable, FileColorsConfigurable, FileStatusColorsConfigurable, FileTemplateConfigurable, FileTypeConfigurable, FirefoxSettingsConfigurable, FrameworkDetectionConfigurable, GantConfigurable, GenerateToStringConfigurable, GitUpdateConfigurable, GlobalLibrariesConfigurable, GradleConfigurable, GreclipseConfigurable, GroovyCodeStyleGenerationConfigurable, GroovyCompilerConfigurable, GroupConfigurable, GuiDesignerConfigurable, GutterIconsConfigurable, HgProjectConfigurable, HgUpdateEnvironment.UpdateConfigurable, HttpProxyConfigurable, ImagesConfigurable, InjectionsSettingsUI, InspectionToolsConfigurable, IntentionSettingsConfigurable, InvalidArtifactConfigurable, InvalidFacetEditor, IssueNavigationConfigurationPanel, JavacConfigurable, JavaCompilersTab, JavaContentEntriesEditor, JavadocConfigurable, JavadocEditor, JavaFxSettingsConfigurable, JdkConfigurable, JdkListConfigurable, JsonSchemaCatalogConfigurable, JsonSchemaConfigurable, JsonSchemaMappingsConfigurable, JsonSmartKeysConfigurable, KeymapPanel, LibraryConfigurable, LiveTemplatesConfigurable, MarkdownSettingsConfigurable, MasterDetailsComponent, ModuleAwareProjectConfigurable, ModuleConfigurable, ModuleElementsEditor, ModuleStructureConfigurable, NamedConfigurable, NamedItemsListEditor, NotificationsConfigurable, OtherFileTypesCodeStyleConfigurable, OutputEditor, PathMacroConfigurable, PerFileConfigurableBase, PlatformContentEntriesConfigurable, PluginHostsConfigurable, PluginManagerConfigurable, PluginManagerConfigurableProxy, PostfixTemplatesConfigurable, ProjectConfigurable, ProjectInspectionToolsConfigurable, ProjectJdksConfigurable, ProjectLibrariesConfigurable, ProjectStructureConfigurable, ProjectStructureElementConfigurable, PyActiveSdkModuleConfigurable, PyConsoleOptionsConfigurable, PyContentEntriesEditor, PyContentEntriesModuleConfigurable, PyDebuggerConfigurable, PyDependenciesConfigurable, PyIntegratedToolsConfigurable, PyIntegratedToolsModulesConfigurable, PySmartKeysOptions, PythonContentEntriesConfigurable, PythonDocumentationConfigurable, QuickListsPanel, RemoteRepositoriesConfigurable, RemoteServerListConfigurable, RestConfigurable, RmicConfigurable, RunConfigurationConfigurableAdapter, ScopeChooserConfigurable, ScopeConfigurable, SdkEditor, SdkHomeConfigurable, SearchableConfigurable.Delegate, SearchableConfigurable.Parent.Abstract, SettingsEditorConfigurable, SettingsPage, ShelfProjectConfigurable, SimpleConfigurable, SingleConfigurationConfigurable, SingleRemoteServerConfigurable, SortedConfigurableGroup, SpellCheckerSettingsManager, SvnConfigurable, SvnConfigurable.General, SvnConfigurable.Network, SvnConfigurable.Presentation, SvnConfigurable.Ssh, SvnConfigureProxiesComponent, SvnMergeSourceDetails, SvnUpdateConfigurable, TabbedConfigurable, TaskConfigurable, TaskRepositoriesConfigurable, TemplateCommentPanel, TemplateDataLanguageConfigurable, TemplatesPanel, TerminalOptionsConfigurable, TextConfigurable, ThreadsViewConfigurable, TodoConfigurable, ToolConfigurable, UndefinedMacrosConfigurable, UpdateConfigurable, UpdateSettingsConfigurable, ValidationConfigurable, VcsBackgroundOperationsConfigurable, VcsCheckBoxWithSpinnerConfigurable, VcsContentAnnotationConfigurable, VcsDirectoryConfigurationPanel, VcsGeneralConfigurationConfigurable, VcsLimitHistoryConfigurable, VcsManagerConfigurable, XMLCatalogConfigurable, XmlEmmetConfigurable, XPathConfigurable

public interface Configurable
extends UnnamedConfigurable

This interface represents a named configurable component that provides a Swing form to configure some settings via the Settings dialog.

To register a custom implementation of this interface use the following extension points: com.intellij.applicationConfigurable for settings, which are global for IDE, and com.intellij.projectConfigurable for project settings, which are applied to the current project only. They differ only in the constructor implementation. Classes for IDE settings must have a default constructor with no arguments, while classes for project settings must declare a constructor with a single argument of the Project type.

The following attributes are available for both extension points mentioned above:

instance

This attribute specifies a qualified name of a custom implementation of this interface. The constructor will be determined automatically from the tag name:
<extensions defaultExtensionNs="com.intellij">
&nbsp;&nbsp;&nbsp;&nbsp;<projectConfigurable instance="fully.qualified.class.name"/>
</extensions>

provider

This attribute can be used instead of the instance attribute. It specifies a qualified name of a custom implementation of the ConfigurableProvider interface, which provides another way to create a configurable component:
<extensions defaultExtensionNs="com.intellij">
&nbsp;&nbsp;&nbsp;&nbsp;<projectConfigurable provider="fully.qualified.class.name"/>
</extensions>

implementation

This attribute is deprecated and replaced with two attributes above. In fact, it works as the instance attribute.

nonDefaultProject

This attribute is applicable to the projectConfigurable extension only. If it is set to true, the corresponding project settings will be shown for a real project only, not for the template project, which provides default settings for all the new projects.

displayName

This attribute specifies the setting name visible to users. If the display name is not set, a configurable component will be instantiated to retrieve its name dynamically. This causes a loading of plugin classes and increases the delay before showing the settings dialog. It is highly recommended specifying the display name in XML to improve UI responsiveness.

key and bundle

These attributes specify the display name too, if the specified key is declared in the specified resource bundle.

id

This attribute specifies the unique identifier for the configurable component. It is also recommended specifying the identifier in XML.

parentId

This attribute is used to create a hierarchy of settings. If it is set, the configurable component will be a child of the specified parent component.

groupId

This attribute specifies a top-level group, which the configurable component belongs to. If this attribute is not set, the configurable component will be added to the Other Settings group. The following groups are supported:

ROOT groupId="root"

This is the invisible root group that contains all other groups. Usually, you should not place your settings here.

Appearance & Behavior groupId="appearance"

This group contains settings to personalize IDE appearance and behavior: change themes and font size, tune the keymap, and configure plugins and system settings, such as password policies, HTTP proxy, updates and more.

Editor groupId="editor"

This group contains settings to personalize source code appearance by changing fonts, highlighting styles, indents, etc. Here you can customize the editor from line numbers, caret placement and tabs to source code inspections, setting up templates and file encodings.

Default Project / Project Settings groupId="project"

This group is intended to store some project-related settings, but now it is rarely used.

Build, Execution, Deployment groupId="build"

This group contains settings to configure you project integration with the different build tools, modify the default compiler settings, manage server access configurations, customize the debugger behavior, etc.

Build Tools groupId="build.tools"

This is subgroup of the group above. Here you can configure your project integration with the different build tools, such as Maven, Gradle, or Gant.

Languages & Frameworks groupId="language"

This group is intended to configure the settings related to specific frameworks and technologies used in your project.

Tools groupId="tools"

This group contains settings to configure integration with third-party applications, specify the SSH Terminal connection settings, manage server certificates and tasks, configure diagrams layout, etc.

Other Settings groupId="other"

This group contains settings that are related to non-bundled custom plugins and are not assigned to any other category.

The parentId and the groupId attributes should not be used together and the parentId has precedence. Currently, it is possible to specify a group identifier in the parentId attribute.

groupWeight

This attribute specifies the weight of a configurable component within a group or a parent configurable component. The default weight is 0. If one child in a group or a parent configurable component has non-zero weight, all children will be sorted descending by their weight. And if the weights are equal, the components will be sorted ascending by their display name.

dynamic

This attribute states that a custom configurable component implements the Configurable.Composite interface and its children are dynamically calculated by calling the getConfigurables method. It is needed to improve performance, because we do not want to load any additional classes during the building a setting tree.

childrenEPName

This attribute specifies a name of the extension point that will be used to calculate children.

configurable

This is not an attribute, this is an inner tag. It specifies children directly in the main tag body. For example,
<projectConfigurable id="tasks" nonDefaultProject="true" instance="com.intellij.tasks.config.TaskConfigurable">
&nbsp;&nbsp;&nbsp;&nbsp;<configurable id="tasks.servers" instance="com.intellij.tasks.config.TaskRepositoriesConfigurable"/>
</projectConfigurable>
is similar to the following declarations
<projectConfigurable id="tasks" nonDefaultProject="true" instance="com.intellij.tasks.config.TaskConfigurable"/>
<projectConfigurable parentId="tasks" id="tasks.servers" nonDefaultProject="true" instance="com.intellij.tasks.config.TaskRepositoriesConfigurable"/>

See Also:

ConfigurableEP, SearchableConfigurable, ShowSettingsUtil

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Configurable.Composite This interface represents a configurable component that has child components.
static interface	Configurable.NoMargin This marker interface notifies the Settings dialog to not add an empty border to the Swing form.
static interface	Configurable.NoScroll This marker interface notifies the Settings dialog to not add scroll bars to the Swing form.
static interface	Configurable.TopComponentController
static interface	Configurable.TopComponentProvider
static interface	Configurable.VariableProjectAppLevel Allows to dynamically define if current configurable settings apply to current project or to the IDE and update "For current project" indicator accordingly.
static interface	Configurable.WithEpDependencies The interface is used for configurable that depends on some dynamic extension points.

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<ConfigurableEP<Configurable>>	APPLICATION_CONFIGURABLE
static ExtensionPointName<ConfigurableEP<Configurable>>	PROJECT_CONFIGURABLE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayName() Returns the visible name of the configurable component.
default java.lang.String	getHelpTopic() Returns the topic in the help file which is shown when help for the configurable is requested.
default javax.swing.JComponent	getPreferredFocusedComponent()
default <T> boolean	isModified(ComboBox<T> comboBox, T value)
default boolean	isModified(javax.swing.JTextField textField, int value, UINumericRange range)
default boolean	isModified(javax.swing.JTextField textField, java.lang.String value)
default boolean	isModified(javax.swing.JToggleButton toggleButton, boolean value)

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

apply, cancel, createComponent, disposeUIResources, isModified, reset

Field Detail

APPLICATION_CONFIGURABLE

static final ExtensionPointName<ConfigurableEP<Configurable>> APPLICATION_CONFIGURABLE

PROJECT_CONFIGURABLE

static final ExtensionPointName<ConfigurableEP<Configurable>> PROJECT_CONFIGURABLE

Method Detail

getDisplayName

java.lang.String getDisplayName()

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

getHelpTopic

default 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

isModified

default boolean isModified(javax.swing.JTextField textField,
                           java.lang.String value)

isModified

default boolean isModified(javax.swing.JTextField textField,
                           int value,
                           UINumericRange range)

isModified

default boolean isModified(javax.swing.JToggleButton toggleButton,
                           boolean value)

isModified

default <T> boolean isModified(ComboBox<T> comboBox,
                               T value)

getPreferredFocusedComponent

default javax.swing.JComponent getPreferredFocusedComponent()

Returns:

component which should be focused when the dialog appears on the screen.