Package com.intellij.openapi.options

Class ConfigurableEP<T extends UnnamedConfigurable>

java.lang.Object

com.intellij.openapi.extensions.AbstractExtensionPointBean

com.intellij.openapi.options.ConfigurableEP<T>

All Implemented Interfaces:

PluginAware

Direct Known Subclasses:

AutoImportOptionsProviderEP, CodeCompletionConfigurableEP, CodeFoldingOptionsProviderEP, EditorAppearanceConfigurableEP, EditorOptionsProviderEP, EditorSmartKeysConfigurableEP, ErrorOptionsProviderEP, GeneralCodeStyleOptionsProviderEP, GeneralSettingsConfigurableEP, ModuleConfigurableEP

public class ConfigurableEP<T extends UnnamedConfigurable>
extends AbstractExtensionPointBean

Declares a named component that enables to configure settings.

See Also:

Configurable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ConfigurableEP.ObjectProducer

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	bundle This attribute specifies the resource bundle that contains the specified key.
java.util.List<ConfigurableEP<?>>	children
java.lang.String	childrenEPName This attribute specifies a name of the extension point of ConfigurableEP type that will be used to calculate children.
java.lang.String	displayName This attribute specifies the setting name visible to users.
boolean	dynamic This attribute states that a custom configurable component implements the Configurable.Composite interface and its children are dynamically calculated by calling the Configurable.Composite.getConfigurables() method.
java.lang.String	groupId This attribute specifies a top-level group, which the configurable component belongs to.
int	groupWeight This attribute specifies the weight of a configurable component within a group or a parent configurable component.
java.lang.String	id This attribute specifies the unique identifier of the configurable component.
java.lang.String	implementationClass Deprecated. use 'instance' or 'provider' attribute instead
java.lang.String	instanceClass This attribute specifies a qualified name of a custom implementation of this interface.
java.lang.String	key This attribute specifies the resource key in the specified bundle.
boolean	nonDefaultProject This attribute is applicable to the projectConfigurable extension only.
java.lang.String	parentId This attribute is used to create a hierarchy of settings.
java.lang.String	providerClass This attribute can be used instead of the instance attribute.
java.lang.String	treeRendererClass

Fields inherited from class com.intellij.openapi.extensions.AbstractExtensionPointBean

myPluginDescriptor

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConfigurableEP()
protected	ConfigurableEP(ComponentManager componentManager)
protected	ConfigurableEP(PicoContainer picoContainer, Project project) Deprecated. Use ConfigurableEP(ComponentManager)
	ConfigurableEP(Project project) Deprecated. Use ConfigurableEP(ComponentManager)

Method Summary

Modifier and Type	Method and Description
boolean	canCreateConfigurable()
T	createConfigurable()
protected ConfigurableEP.ObjectProducer	createProducer()
ConfigurableTreeRenderer	createTreeRenderer()
java.util.ResourceBundle	findBundle()
java.util.List<ConfigurableEP<?>>	getChildren()
java.lang.Class<?>	getConfigurableType() Returns the type of configurable to create or null, if it cannot be determined.
java.lang.String	getDisplayName()
Project	getProject()
boolean	isAvailable()
java.lang.String	toString()

Methods inherited from class com.intellij.openapi.extensions.AbstractExtensionPointBean

findClass, findClass, findClassNoExceptions, findExtensionClass, getLoaderForClass, getPluginDescriptor, getPluginId, instantiate, instantiate, instantiate, instantiateClass, setPluginDescriptor

Methods inherited from class java.lang.Object

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

Field Detail

displayName

public java.lang.String displayName

This attribute specifies the setting name visible to users. It has precedence over the pair of attributes key-bundle. 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

public java.lang.String key

This attribute specifies the resource key in the specified bundle. This is another way to specify the display name.

bundle

public java.lang.String bundle

This attribute specifies the resource bundle that contains the specified key. This is another way to specify the display name.

children

public java.util.List<ConfigurableEP<?>> children

childrenEPName

public java.lang.String childrenEPName

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

See Also:

dynamic

dynamic

public boolean dynamic

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

parentId

public java.lang.String 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.

See Also:

groupId

id

public java.lang.String id

This attribute specifies the unique identifier of the configurable component. It is also recommended specifying the identifier in XML to improve UI responsiveness.

groupId

public java.lang.String 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.

This attribute should not be used together with the parentId attribute, which has precedence. Currently, it is possible to specify a group identifier in the parentId attribute.

groupWeight

public int 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.

nonDefaultProject

public boolean 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.

implementationClass

@Deprecated
public java.lang.String implementationClass

Deprecated. use 'instance' or 'provider' attribute instead

instanceClass

public java.lang.String instanceClass

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>

See Also:

provider

providerClass

public java.lang.String providerClass

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>

See Also:

instance

treeRendererClass

public java.lang.String treeRendererClass

Constructor Detail

ConfigurableEP

public ConfigurableEP()

ConfigurableEP

protected ConfigurableEP(ComponentManager componentManager)

ConfigurableEP

@Deprecated
protected ConfigurableEP(PicoContainer picoContainer,
                         Project project)

Deprecated. Use ConfigurableEP(ComponentManager)

ConfigurableEP

@Deprecated
public ConfigurableEP(Project project)

Deprecated. Use ConfigurableEP(ComponentManager)

Method Detail

getDisplayName

public java.lang.String getDisplayName()

findBundle

public java.util.ResourceBundle findBundle()

Returns:

a resource bundle using the specified base name or null

getChildren

public java.util.List<ConfigurableEP<?>> getChildren()

isAvailable

public boolean isAvailable()

createProducer

protected ConfigurableEP.ObjectProducer createProducer()

createConfigurable

public T createConfigurable()

createTreeRenderer

public ConfigurableTreeRenderer createTreeRenderer()

getProject

public Project getProject()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

canCreateConfigurable

public boolean canCreateConfigurable()

getConfigurableType

public java.lang.Class<?> getConfigurableType()

Returns the type of configurable to create or null, if it cannot be determined.

Returns:

the the configurable's type or null