Package com.intellij.ide.structureView

Interface StructureViewBuilder

All Known Implementing Classes:

DomStructureViewBuilder, TemplateLanguageStructureViewBuilder, TreeBasedStructureViewBuilder

public interface StructureViewBuilder

Defines the implementation of Structure View and the file structure popup for a file type. This class allows to replace the entire Structure View component implementation. If it is acceptable to have the standard component implementation and to customize only how the Structure View is populated with the file data, the standard implementation of this interface - TreeBasedStructureViewBuilder - should be used.

See Also:

LanguageStructureViewBuilder.getStructureViewBuilder(com.intellij.psi.PsiFile), PsiStructureViewFactory.getStructureViewBuilder(com.intellij.psi.PsiFile)}

Field Summary

Fields

Modifier and Type	Field and Description
static ExtensionPointName<KeyedFactoryEPBean>	EP_NAME
static StructureViewBuilderProvider	PROVIDER

Method Summary

Modifier and Type	Method and Description
StructureView	createStructureView(FileEditor fileEditor, Project project) Returns the structure view implementation for the specified file

Field Detail

EP_NAME

static final ExtensionPointName<KeyedFactoryEPBean> EP_NAME

PROVIDER

static final StructureViewBuilderProvider PROVIDER

Method Detail

createStructureView

StructureView createStructureView(FileEditor fileEditor,
                                  Project project)

Returns the structure view implementation for the specified file

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