Child pages
  • Customizing the IDEA Settings Dialog

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Redirect
locationhttps://plugins.jetbrains.com/docs/intellij/settings.html

This topic explains how you can create a plugin that customize the system dialog box Settings displayed when you click on the IDEA toolbar. This dialog box (see the screenshot below) allows you to specify both the project-specific and IDE-specific settings.
To customize this dialog, your plugin must contribute to the applicationConfigurable (IDE settings) or projectConfigurable (project settings) extenstion points available in the IDEA core.

The applicationConfigurable extension point is designed to configure IDEA settings pertaining to your workspace (IDE settings). The IntelliJ IDEA UI provides the Settings dialog you can display by clicking Image Removed on the IDEA toolbar. The settings pertaining to your workspace are displayed under IDE Settings (see the screenshot below).
For more information about extensions and extension points, see IntelliJ IDEA Plugin Structure .

This topic considers a sample plugin that customizes the IDE-specific settings. However, you can create your own plugin for customization of the project-scpecific settings using the similar technique.

Creation of Extension to applicationConfigurable

To create a plugin that contributes to the applicationConfigurable extension point and customizes the IDE Settings area of the Setting dialog box, perform the following principal steps:

  1. In your plugin project, create a Java class that implements the Configurable interface.
  2. In this class, override the following methods:
    • createComponent: creates the UI visual form and returns its root element.
    • apply: this method is called when the user clicks the OK or Apply button.
    • reset: this method is called when the user clicks the Cancel button.
    • isModified: this method is regularly called to check the form for changes. If the method returns false, the Apply button is disabled.
    • disposeUIResources: this method is called when the user closes the form. In this method, you can, for example, release the resources used by the form.
  3. In the plugin configuration file plugin.xml, create the <extensions defaultExtensionNs="com.intellij"> </extensions> section.
  4. To this section, add the <applicationConfigurable implementationinstance=%MyJavaClassName%></applicationConfigurable> section, where the %MyJavaClassName% refers to the name of your Java class implementing the Configurable interface (see Step 1).

Sample Plugin

...

To clarify the above procedure, consider the applicationConfigurable sample plugin that adds the new menu command "Menu Font" to the IDE Settings area. Clicking this commands causes IntelliJ IDEA to display a visual form designed to specify a font used for the IntelliJ IDEA menus. This UI is similar to the following screen:

...