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

structure_view.md: cleanup

Browse Source
This commit is contained in:
Yann Cébron 2019-12-02 15:42:08 +01:00
parent a45d7f987f
commit bd3e27b063
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
reference_guide/custom_language_support/structure_view.md
View File

@ -14,11 +14,11 @@ The starting point for the structure view is the
[`PsiStructureViewFactory`](upsource:///platform/editor-ui-api/src/com/intellij/lang/PsiStructureViewFactory.java) [`PsiStructureViewFactory`](upsource:///platform/editor-ui-api/src/com/intellij/lang/PsiStructureViewFactory.java)
interface, which is registered in the `com.intellij.lang.psiStructureViewFactory` extension point. interface, which is registered in the `com.intellij.lang.psiStructureViewFactory` extension point.
**Example:** **Examples:**
[`PsiStructureViewFactory`](upsource:///plugins/properties/src/com/intellij/lang/properties/structureView/PropertiesStructureViewBuilderFactory.java) - [`PsiStructureViewFactory`](upsource:///plugins/properties/src/com/intellij/lang/properties/structureView/PropertiesStructureViewBuilderFactory.java)
for for
[Properties language plugin](upsource:///plugins/properties) [Properties language plugin](upsource:///plugins/properties)
- [Custom Language Support Tutorial: Structure View](/tutorials/custom_language_support/structure_view_factory.md)
To reuse the *IntelliJ Platform* implementation of the To reuse the *IntelliJ Platform* implementation of the
[`StructureView`](upsource:///platform/editor-ui-api/src/com/intellij/ide/structureView/StructureView.java), [`StructureView`](upsource:///platform/editor-ui-api/src/com/intellij/ide/structureView/StructureView.java),
@ -40,16 +40,16 @@ for
The main method to override is `getRoot()`, which returns the instance of a class implementing the The main method to override is `getRoot()`, which returns the instance of a class implementing the
[`StructureViewTreeElement`](upsource:///platform/editor-ui-api/src/com/intellij/ide/structureView/StructureViewTreeElement.java) [`StructureViewTreeElement`](upsource:///platform/editor-ui-api/src/com/intellij/ide/structureView/StructureViewTreeElement.java)
interface. interface.
There exists no standard implementation of this interface, so a plugin will need to implement it completely. There exists no standard implementation of this interface, so a plugin will need to implement it completely.
The structure view tree is usually built as a partial mirror of the PSI tree. The structure view tree is usually built as a partial mirror of the PSI tree.
In the implementation of In the implementation of
`StructureViewTreeElement.getChildren()`, `StructureViewTreeElement.getChildren()`,
the plugin can specify which of the child elements of a specific PSI tree node need to be represented as elements in the structure view. the plugin can specify which of the child elements of a specific PSI tree node need to be represented as elements in the structure view.
Another important method is `getPresentation()`, which can be used to customize the text, attributes and icon used to represent an element in the structure view. Another important method is `getPresentation()`, which can be used to customize the text, attributes, and icon used to represent an element in the structure view.
The implementation of `StructureViewTreeElement.getChildren()` needs to be matched by `TextEditorBasedStructureViewModel.getSuitableClasses()`. The implementation of `StructureViewTreeElement.getChildren()` needs to be matched by `TextEditorBasedStructureViewModel.getSuitableClasses()`.
The latter method returns an array of `PsiElement`\-derived classes which can be shown as structure view elements, and is used to select the Structure View item matching the cursor position when the structure view is first opened or when the `Autoscroll from source` option is used. The latter method returns an array of `PsiElement`\-derived classes which can be shown as structure view elements. It is used to select the Structure View item matching the cursor position when the structure view is first opened or when the _Autoscroll from source_ option is enabled.
**Example:** **Example:**
[`StructureViewTreeElement`](upsource:///plugins/properties/properties-psi-impl/src/com/intellij/lang/properties/editor/PropertyStructureViewElement.java) [`StructureViewTreeElement`](upsource:///plugins/properties/properties-psi-impl/src/com/intellij/lang/properties/editor/PropertyStructureViewElement.java)