Package com.intellij.ide.structureView.impl

Class TemplateLanguageStructureViewBuilder

java.lang.Object

com.intellij.ide.structureView.TreeBasedStructureViewBuilder

com.intellij.ide.structureView.impl.TemplateLanguageStructureViewBuilder

All Implemented Interfaces:

StructureViewBuilder

public abstract class TemplateLanguageStructureViewBuilder
extends TreeBasedStructureViewBuilder

Field Summary

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

EP_NAME, PROVIDER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TemplateLanguageStructureViewBuilder(PsiElement psiElement)

Method Summary

Modifier and Type	Method and Description
static TemplateLanguageStructureViewBuilder	create(PsiFile psiFile, PairFunction<? super PsiFile,? super Editor,? extends StructureViewModel> modelFactory)
protected abstract TreeBasedStructureViewBuilder	createMainBuilder(PsiFile psi)
StructureView	createStructureView(FileEditor fileEditor, Project project) Returns the structure view implementation for the specified file
StructureViewModel	createStructureViewModel(Editor editor) Returns the structure view model defining the data displayed in the structure view for a specific file.
protected boolean	isAcceptableBaseLanguageFile(PsiFile dataFile)
boolean	isRootNodeShown() Override returning false if root node created by TreeBasedStructureViewBuilder.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

TemplateLanguageStructureViewBuilder

protected TemplateLanguageStructureViewBuilder(PsiElement psiElement)

Method Detail

create

public static TemplateLanguageStructureViewBuilder create(PsiFile psiFile,
                                                          PairFunction<? super PsiFile,? super Editor,? extends StructureViewModel> modelFactory)

isRootNodeShown

public boolean isRootNodeShown()

Description copied from class: TreeBasedStructureViewBuilder

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

Overrides:

isRootNodeShown in class TreeBasedStructureViewBuilder

Returns:

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

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

Overrides:

createStructureView in class TreeBasedStructureViewBuilder

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

createStructureViewModel

public StructureViewModel createStructureViewModel(Editor editor)

Description copied from class: TreeBasedStructureViewBuilder

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

Specified by:

createStructureViewModel in class TreeBasedStructureViewBuilder

Returns:

the structure view model instance.

See Also:

TextEditorBasedStructureViewModel

isAcceptableBaseLanguageFile

protected boolean isAcceptableBaseLanguageFile(PsiFile dataFile)

createMainBuilder

protected abstract TreeBasedStructureViewBuilder createMainBuilder(PsiFile psi)