settings: inspecting

This commit is contained in:
Yann Cébron 2023-04-05 16:44:04 +02:00
parent f9f350e562
commit aa01c781b6
3 changed files with 14 additions and 2 deletions

View File

@ -68,6 +68,8 @@ Custom Swing components can also provide additional properties via [`UiInspector
## Inspecting Settings ## Inspecting Settings
Enable <ui-path>View | Appearance | Details in Tree View</ui-path> in [Internal Mode](enabling_internal.md) to show Settings page `id` in the tree.
Some additional properties are available when inspecting <control>Settings</control> dialog (2023.1+). Some additional properties are available when inspecting <control>Settings</control> dialog (2023.1+).
> _UI Inspector_ must be invoked only after opening the <control>Settings</control> dialog. > _UI Inspector_ must be invoked only after opening the <control>Settings</control> dialog.

View File

@ -1,6 +1,6 @@
# Custom Settings Groups # Custom Settings Groups
<!-- Copyright 2000-2022 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. --> <!-- Copyright 2000-2023 JetBrains s.r.o. and other contributors. Use of this source code is governed by the Apache 2.0 license that can be found in the LICENSE file. -->
<link-summary>Defining groups of related settings.</link-summary> <link-summary>Defining groups of related settings.</link-summary>
@ -11,6 +11,8 @@ However, suppose the custom Settings are rich enough to require multiple levels?
For example, a custom Setting implementation has multiple sub-Settings implementations. For example, a custom Setting implementation has multiple sub-Settings implementations.
Extension Point declarations can create this kind of multilayer Settings hierarchy. Extension Point declarations can create this kind of multilayer Settings hierarchy.
<include from="settings_guide.md" element-id="settings_ui_inspector"/>
## Extension Points for Parent-Child Settings Relationships ## Extension Points for Parent-Child Settings Relationships
There are multiple ways of creating parent-child relationships in groups of Settings: in implementations, or Extension Point declarations. There are multiple ways of creating parent-child relationships in groups of Settings: in implementations, or Extension Point declarations.

View File

@ -13,7 +13,13 @@ The User Interface (UI) for these custom Settings can be added to the [IDE Setti
Settings can [affect different levels](https://www.jetbrains.com/help/idea/configuring-project-and-ide-settings.html) of scope. Settings can [affect different levels](https://www.jetbrains.com/help/idea/configuring-project-and-ide-settings.html) of scope.
This document describes adding custom Settings at the Project and Application (or Global, IDE) levels. This document describes adding custom Settings at the Project and Application (or Global, IDE) levels.
> To inspect existing Settings in the IDE, use [UI Inspector](internal_ui_inspector.md). <snippet id="settings_ui_inspector">
> See [](internal_ui_inspector.md#inspecting-settings) on how to gather information in the IDE instance for <control>Settings</control> dialog.
>
{style="tip"}
</snippet>
## Extension Points for Settings ## Extension Points for Settings
@ -97,6 +103,8 @@ The attributes supported by `com.intellij.applicationConfigurable` EP and `com.i
The table below shows the allowed values for the `parentId` attribute. The table below shows the allowed values for the `parentId` attribute.
See the [previous section](#table-of-attributes) for all supported attributes. See the [previous section](#table-of-attributes) for all supported attributes.
<include from="settings_guide.md" element-id="settings_ui_inspector"/>
| `parentId` Value | Group | Details | | `parentId` Value | Group | Details |
|:-----------------|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |:-----------------|:-----------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| _default_ | `other` | If neither `parentId` nor `groupId` attribute is set, the component is added to the `other` Settings group. This is undesirable; see `other` group description. | | _default_ | `other` | If neither `parentId` nor `groupId` attribute is set, the component is added to the `other` Settings group. This is undesirable; see `other` group description. |