Package com.intellij.ide.structureView

Class TreeBasedStructureViewBuilder

java.lang.Object

com.intellij.ide.structureView.TreeBasedStructureViewBuilder

All Implemented Interfaces:

StructureViewBuilder

Direct Known Subclasses:

DomStructureViewBuilder, TemplateLanguageStructureViewBuilder

public abstract class TreeBasedStructureViewBuilder
extends java.lang.Object
implements StructureViewBuilder

Default implementation of the StructureViewBuilder interface which uses the standard implementation of the StructureView component and allows to customize the data displayed in the structure view.

See Also:

StructureViewModel, TextEditorBasedStructureViewModel, LanguageStructureViewBuilder.getStructureViewBuilder(com.intellij.psi.PsiFile)

Field Summary

Fields inherited from interface com.intellij.ide.structureView.StructureViewBuilder

EP_NAME, PROVIDER

Constructor Summary

Constructors

Constructor and Description
TreeBasedStructureViewBuilder()

Method Summary

Modifier and Type	Method and Description
StructureView	createStructureView(FileEditor fileEditor, Project project) Returns the structure view implementation for the specified file
abstract StructureViewModel	createStructureViewModel(Editor editor) Returns the structure view model defining the data displayed in the structure view for a specific file.
boolean	isRootNodeShown() Override returning false if root node created by createStructureViewModel(Editor editor) shall not be visible

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeBasedStructureViewBuilder

public TreeBasedStructureViewBuilder()

Method Detail

createStructureViewModel

public abstract StructureViewModel createStructureViewModel(Editor editor)

Returns the structure view model defining the data displayed in the structure view for a specific file.

Returns:

the structure view model instance.

See Also:

TextEditorBasedStructureViewModel

createStructureView

public StructureView createStructureView(FileEditor fileEditor,
                                         Project project)

Description copied from interface: StructureViewBuilder

Returns the structure view implementation for the specified file

Specified by:

createStructureView in interface StructureViewBuilder

Parameters:

fileEditor - the editor for which the structure view is requested. Can be null if file is not open (e.g. structure is requested from the project view)

project - the project containing the file for which the structure view is requested.

Returns:

the structure view implementation.

See Also:

TreeBasedStructureViewBuilder

isRootNodeShown

public boolean isRootNodeShown()

Override returning false if root node created by createStructureViewModel(Editor editor) shall not be visible

Returns:

false if root node shall not be visible in structure tree.