hxuanyu/intellij-sdk-code-samples
1
0
Fork 0
mirror of https://github.com/JetBrains/intellij-sdk-code-samples.git synced 2025-07-28 01:07:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

settings_guide.md: Add code formatting to titles

Browse Source
This commit is contained in:
Karol Lewandowski 2024-04-08 12:40:14 +02:00
parent 167231c6dd
commit 16c2548285
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
topics/reference_guide/settings_guide.md
View File

@ -130,7 +130,7 @@ Implementations for `com.intellij.projectConfigurable` EP and `com.intellij.appl
Most Settings providers are based on the `Configurable` interface or one of its sub- or supertypes. Most Settings providers are based on the `Configurable` interface or one of its sub- or supertypes.
* The [`ConfigurableProvider`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/ConfigurableProvider.java) class, which can hide a configurable component from the Settings dialog based on runtime conditions. * The [`ConfigurableProvider`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/ConfigurableProvider.java) class, which can hide a configurable component from the Settings dialog based on runtime conditions.
### The Configurable Interface ### The `Configurable` Interface
Many Settings in the `intellij-community` code base implement `Configurable` or one of its subtypes, such as [`SearchableConfigurable`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/SearchableConfigurable.java). Many Settings in the `intellij-community` code base implement `Configurable` or one of its subtypes, such as [`SearchableConfigurable`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/SearchableConfigurable.java).
Readers are encouraged to review the Javadoc comments for `Configurable`. Readers are encouraged to review the Javadoc comments for `Configurable`.
@ -148,7 +148,7 @@ For a `Configurable` implementation correctly declared using an EP, the implemen
> >
{style="warning"} {style="warning"}
#### IntelliJ Platform Interactions with Configurable #### IntelliJ Platform Interactions with `Configurable`
The instantiation of a generic `Configurable` implementation is documented in the interface file. The instantiation of a generic `Configurable` implementation is documented in the interface file.
A few high-level points are reviewed here: A few high-level points are reviewed here:
@ -161,7 +161,7 @@ A few high-level points are reviewed here:
To open Settings dialog or show specific `Configurable`, see [`ShowSettingsUtil`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/options/ShowSettingsUtil.java). To open Settings dialog or show specific `Configurable`, see [`ShowSettingsUtil`](%gh-ic%/platform/platform-api/src/com/intellij/openapi/options/ShowSettingsUtil.java).
#### Configurable Marker Interfaces #### `Configurable` Marker Interfaces
Implementations based on `Configurable` can implement marker interfaces, which provide additional flexibility in the implementation. Implementations based on `Configurable` can implement marker interfaces, which provide additional flexibility in the implementation.
@ -176,7 +176,7 @@ Implementations based on `Configurable` can implement marker interfaces, which p
`Configurable.Beta` `Configurable.Beta`
: _(2022.3)_ Adds <control>Beta</control> label next to settings page title in <control>Settings</control> tree. : _(2022.3)_ Adds <control>Beta</control> label next to settings page title in <control>Settings</control> tree.
#### Additional Interfaces Based on Configurable #### Additional Interfaces Based on `Configurable`
There are classes in the IntelliJ Platform specialized in particular types of Settings. There are classes in the IntelliJ Platform specialized in particular types of Settings.
These subtypes are based on `com.intellij.openapi.options.ConfigurableEP`. These subtypes are based on `com.intellij.openapi.options.ConfigurableEP`.
@ -188,7 +188,7 @@ Existing implementations of `Configurable` in the IntelliJ Platform that can ser
* [`ConsoleConfigurable`](%gh-ic%/platform/lang-impl/src/com/intellij/execution/console/ConsoleConfigurable.java) (application configurable) * [`ConsoleConfigurable`](%gh-ic%/platform/lang-impl/src/com/intellij/execution/console/ConsoleConfigurable.java) (application configurable)
* [`AutoImportOptionsConfigurable`](%gh-ic%/platform/lang-impl/src/com/intellij/application/options/editor/AutoImportOptionsConfigurable.kt) (project configurable) * [`AutoImportOptionsConfigurable`](%gh-ic%/platform/lang-impl/src/com/intellij/application/options/editor/AutoImportOptionsConfigurable.kt) (project configurable)
### The ConfigurableProvider Class ### The `ConfigurableProvider` Class
The [`ConfigurableProvider`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/ConfigurableProvider.java) class only provides a `Configurable` implementation if its runtime conditions are met. The [`ConfigurableProvider`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/ConfigurableProvider.java) class only provides a `Configurable` implementation if its runtime conditions are met.
The IntelliJ Platform first calls the `ConfigurableProvider.canCreateConfigurable()`, which evaluates runtime conditions to determine if Settings changes make sense in the current context. The IntelliJ Platform first calls the `ConfigurableProvider.canCreateConfigurable()`, which evaluates runtime conditions to determine if Settings changes make sense in the current context.