com.intellij.ide.structureView
Class TreeBasedStructureViewBuilder

java.lang.Object
  com.intellij.ide.structureView.TreeBasedStructureViewBuilder

All Implemented Interfaces:

StructureViewBuilder

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

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

See Also:

StructureViewModel, TextEditorBasedStructureViewModel, Language.getStructureViewBuilder(com.intellij.psi.PsiFile), FileType.getStructureViewBuilder(com.intellij.openapi.vfs.VirtualFile, com.intellij.openapi.project.Project)

Constructor Summary

TreeBasedStructureViewBuilder()

Method Summary

StructureView	createStructureView(FileEditor fileEditor, Project project) Returns the structure view implementation for the file displayed in the specified editor.
abstract StructureViewModel	createStructureViewModel() Returns the structure view model defining the data displayed in the structure view for a specific file.

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()

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 file displayed in the specified editor.

Specified by:

createStructureView in interface StructureViewBuilder

Parameters:

fileEditor - the editor for which the structure view is requested.

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

Returns:

the structure view implementation.

See Also:

TreeBasedStructureViewBuilder