Package com.intellij.ide.structureView

Class StructureViewModelBase

java.lang.Object

com.intellij.ide.structureView.TextEditorBasedStructureViewModel

com.intellij.ide.structureView.StructureViewModelBase

All Implemented Interfaces:

StructureViewModel, ProvidingTreeModel, TreeModel, Disposable

Direct Known Subclasses:

JsonStructureViewModel, PyStructureViewModel, RestStructureViewModel, StructureViewCompositeModel

public class StructureViewModelBase
extends TextEditorBasedStructureViewModel

Nested Class Summary

Nested classes/interfaces inherited from interface com.intellij.ide.structureView.StructureViewModel

StructureViewModel.ElementInfoProvider, StructureViewModel.ExpandInfoProvider

Nested classes/interfaces inherited from interface com.intellij.openapi.Disposable

Disposable.Parent

Constructor Summary

Constructors

Constructor and Description
StructureViewModelBase(PsiFile psiFile, Editor editor, StructureViewTreeElement root)
StructureViewModelBase(PsiFile psiFile, StructureViewTreeElement root)

Method Summary

Modifier and Type	Method and Description
StructureViewTreeElement	getRoot() Returns the root element of the structure view tree.
Sorter []	getSorters() Returns the array of actions for sorting items in the tree.
protected java.lang.Class []	getSuitableClasses() Returns the list of PSI element classes which are shown as structure view elements.
StructureViewModelBase	withSorters(Sorter... sorters)
StructureViewModelBase	withSuitableClasses(java.lang.Class... suitableClasses)

Methods inherited from class com.intellij.ide.structureView.TextEditorBasedStructureViewModel

addEditorPositionListener, addModelListener, dispose, findAcceptableElement, fireModelUpdate, getCurrentEditorElement, getEditor, getFilters, getGroupers, getNodeProviders, getPsiFile, isEnabled, isSuitable, removeEditorPositionListener, removeModelListener, shouldEnterElement

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureViewModelBase

public StructureViewModelBase(PsiFile psiFile,
                              Editor editor,
                              StructureViewTreeElement root)

StructureViewModelBase

public StructureViewModelBase(PsiFile psiFile,
                              StructureViewTreeElement root)

Method Detail

getRoot

public StructureViewTreeElement getRoot()

Description copied from interface: StructureViewModel

Returns the root element of the structure view tree.

Returns:

the structure view root.

withSorters

public StructureViewModelBase withSorters(Sorter... sorters)

withSuitableClasses

public StructureViewModelBase withSuitableClasses(java.lang.Class... suitableClasses)

getSorters

public Sorter [] getSorters()

Description copied from interface: TreeModel

Returns the array of actions for sorting items in the tree.

Specified by:

getSorters in interface TreeModel

Overrides:

getSorters in class TextEditorBasedStructureViewModel

Returns:

the array of sorting actions.

See Also:

Sorter.EMPTY_ARRAY

getSuitableClasses

protected java.lang.Class [] getSuitableClasses()

Description copied from class: TextEditorBasedStructureViewModel

Returns the list of PSI element classes which are shown as structure view elements. When determining the current editor element, the PSI tree is walked up until an element matching one of these classes is found.

Overrides:

getSuitableClasses in class TextEditorBasedStructureViewModel

Returns:

the list of classes