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

add link summary

Browse Source
This commit is contained in:
Yann Cébron 2022-12-20 18:30:44 +01:00
parent 2d54650326
commit 47e1dfa5a8
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
topics/reference_guide/settings_groups.md
View File

@ -1,8 +1,10 @@
[//]: # (title: 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-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. -->
As described in [Extension Points for Settings](settings_guide.md#extension-points-for-settings), custom _Settings_ can be declared as children of existing parent groups such as `tools`. <link-summary>Defining groups of related settings.</link-summary>
As described in [](settings_guide.md#extension-points-for-settings), custom Settings can be declared as children of existing parent groups such as <ui-path>Tools</ui-path>.
These parent groups are the existing categories of Settings in the IntelliJ Platform-based IDE. These parent groups are the existing categories of Settings in the IntelliJ Platform-based IDE.
However, suppose the custom Settings are rich enough to require multiple levels? However, suppose the custom Settings are rich enough to require multiple levels?
@ -60,7 +62,7 @@ This approach nests the child's Settings declaration within the `com.intellij.pr
When using `configurable` there isn't a `parentId` for the child because the nesting implies it. When using `configurable` there isn't a `parentId` for the child because the nesting implies it.
As with using separate EP declarations, formatting restrictions are placed on the child's `id` attribute - the suffix (`servers`) gets added. As with using separate EP declarations, formatting restrictions are placed on the child's `id` attribute - the suffix (`servers`) gets added.
See the [Attributes for Parent-Child Settings EPs](#attributes-for-parent-child-settings-eps) section. See the [](#attributes-for-parent-child-settings-eps) section.
The example below demonstrates a nested `configurable` declaration: The example below demonstrates a nested `configurable` declaration:
@ -86,7 +88,7 @@ Within the parent `<projectConfigurable>` EP declaration above, more `<configura
### Attributes for Parent-Child Settings EPs ### Attributes for Parent-Child Settings EPs
There is only one unique attribute when declaring a child Settings EP. There is only one unique attribute when declaring a child Settings EP.
The other attributes are the same as discussed in [Settings EP Attributes](settings_guide.md#settings-declaration-attributes). The other attributes are the same as discussed in [](settings_guide.md#settings-declaration-attributes).
For the child of a parent, the `id` attribute becomes compound: For the child of a parent, the `id` attribute becomes compound:
@ -96,12 +98,11 @@ For the child of a parent, the `id` attribute becomes compound:
> All children share the parent's `id` as the basis of their own `id`. > All children share the parent's `id` as the basis of their own `id`.
> All children have an `id` suffix that is unique among their siblings. > All children have an `id` suffix that is unique among their siblings.
>
## Implementations for Parent-Child Settings ## Implementations for Parent-Child Settings
Implementations can be based on [`Configurable`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/Configurable.java), [`ConfigurableProvider`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/ConfigurableProvider.java) or one of their subtypes. Implementations can be based on [`Configurable`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/Configurable.java), [`ConfigurableProvider`](%gh-ic%/platform/ide-core/src/com/intellij/openapi/options/ConfigurableProvider.java) or one of their subtypes.
For more information about creating Settings implementations, see [Implementations for Settings Extension Points](settings_guide.md#implementations-for-settings-extension-points). For more information about creating Settings implementations, see [](settings_guide.md#implementations-for-settings-extension-points).
### Configurable Marker Interfaces ### Configurable Marker Interfaces

2
topics/tutorials/settings_tutorial.md
View File

@ -2,7 +2,7 @@
<!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. --> <!-- Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. -->
## Introduction <link-summary>Implementing custom settings tutorial.</link-summary>
As discussed in the [](settings_guide.md), plugins can add Settings to IntelliJ Platform-based IDEs. As discussed in the [](settings_guide.md), plugins can add Settings to IntelliJ Platform-based IDEs.
The IDE displays the Settings in response to a user choosing <ui-path>Settings/Preferences</ui-path>. The IDE displays the Settings in response to a user choosing <ui-path>Settings/Preferences</ui-path>.