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: cleanup "Configurable Marker Interfaces"

Browse Source
This commit is contained in:
Yann Cébron 2023-08-08 14:34:38 +02:00
parent bf29d09a91
commit a2d343376d
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
topics/reference_guide/settings_guide.md
View File

@ -163,14 +163,16 @@ To open Settings dialog or show specific `Configurable`, see [`ShowSettingsUtil`
Implementations based on `Configurable` can implement marker interfaces, which provide additional flexibility in the implementation.
The following nested interfaces are markers, which convey information about the form to the IntelliJ Platform:
* `Configurable.NoScroll` - Notifies the Settings dialog not to add scroll bars to the form.
By default, a plugin's Settings component is put into a scrollable pane.
`Configurable.NoScroll`
: Do not to add scroll bars to the form. By default, a plugin's Settings component is put into a scrollable pane.
However, a Settings panel can have a `JTree`, which requires its own `JScrollPane`.
So `NoScroll` interface should be used to remove the outer `JScrollPane`.
* `Configurable.NoMargin` - Notifies the Settings dialog not to add an empty border to the form.
By default, an empty border is added for a plugin's Settings component.
* `Configurable.Beta` _(2022.3)_ - Adds <control>Beta</control> label next to settings page title in <control>Settings</control> tree.
`Configurable.NoMargin`
: Do not add an empty border to the form. By default, an empty border is added for a plugin's Settings component.
`Configurable.Beta`
: _(2022.3)_ Adds <control>Beta</control> label next to settings page title in <control>Settings</control> tree.
#### Additional Interfaces Based on Configurable