Package com.intellij.ide.structureView

Class TextEditorBasedStructureViewModel

java.lang.Object

com.intellij.ide.structureView.TextEditorBasedStructureViewModel

All Implemented Interfaces:

StructureViewModel, ProvidingTreeModel, TreeModel, Disposable

Direct Known Subclasses:

JavaFileTreeModel, PropertiesFileStructureViewModel, StructureViewModelBase, XmlStructureViewTreeModel

public abstract class TextEditorBasedStructureViewModel
extends java.lang.Object
implements StructureViewModel, ProvidingTreeModel

The standard StructureViewModel implementation which is linked to a text editor.

See Also:

TreeBasedStructureViewBuilder.createStructureViewModel(Editor editor)

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

Modifier	Constructor and Description
protected	TextEditorBasedStructureViewModel(Editor editor) Creates a structure view model instance linked to the specified text editor.
protected	TextEditorBasedStructureViewModel(Editor editor, PsiFile file)
protected	TextEditorBasedStructureViewModel(PsiFile psiFile) Creates a structure view model instance linked to a text editor displaying the specified file.

Method Summary

Modifier and Type	Method and Description
void	addEditorPositionListener(FileEditorPositionListener listener) Adds a listener which gets notified when the selection in the editor linked to the structure view moves to a different element visible in the structure view.
void	addModelListener(ModelListener modelListener) Adds a listener which gets notified when the data represented by the structure view is changed and the structure view needs to be rebuilt.
void	dispose() Disposes of the model.
protected java.lang.Object	findAcceptableElement(PsiElement element)
void	fireModelUpdate()
java.lang.Object	getCurrentEditorElement() Returns the element currently selected in the editor linked to the structure view.
protected Editor	getEditor()
Filter []	getFilters() Returns the array of actions for filtering items in the tree.
Grouper []	getGroupers() Returns the list of actions for grouping items in the tree.
java.util.Collection<NodeProvider>	getNodeProviders()
protected PsiFile	getPsiFile()
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.
boolean	isEnabled(NodeProvider provider)
protected boolean	isSuitable(PsiElement element)
void	removeEditorPositionListener(FileEditorPositionListener listener) Removes a listener which gets notified when the selection in the editor linked to the structure view moves to a different element visible in the structure view.
void	removeModelListener(ModelListener modelListener) Removes a listener which gets notified when the data represented by the structure view is changed and the structure view needs to be rebuilt.
boolean	shouldEnterElement(java.lang.Object element)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.ide.structureView.StructureViewModel

getRoot

Constructor Detail

TextEditorBasedStructureViewModel

protected TextEditorBasedStructureViewModel(PsiFile psiFile)

Creates a structure view model instance linked to a text editor displaying the specified file.

Parameters:

psiFile - the file for which the structure view model is requested.

TextEditorBasedStructureViewModel

protected TextEditorBasedStructureViewModel(Editor editor)

Creates a structure view model instance linked to the specified text editor.

Parameters:

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

TextEditorBasedStructureViewModel

protected TextEditorBasedStructureViewModel(Editor editor,
                                            PsiFile file)

Method Detail

addEditorPositionListener

public final void addEditorPositionListener(FileEditorPositionListener listener)

Description copied from interface: StructureViewModel

Adds a listener which gets notified when the selection in the editor linked to the structure view moves to a different element visible in the structure view.

Specified by:

addEditorPositionListener in interface StructureViewModel

Parameters:

listener - the listener to add.

removeEditorPositionListener

public final void removeEditorPositionListener(FileEditorPositionListener listener)

Description copied from interface: StructureViewModel

Removes a listener which gets notified when the selection in the editor linked to the structure view moves to a different element visible in the structure view.

Specified by:

removeEditorPositionListener in interface StructureViewModel

Parameters:

listener - the listener to remove.

dispose

public void dispose()

Description copied from interface: StructureViewModel

Disposes of the model.

Specified by:

dispose in interface StructureViewModel

Specified by:

dispose in interface Disposable

fireModelUpdate

public void fireModelUpdate()

shouldEnterElement

public boolean shouldEnterElement(java.lang.Object element)

Specified by:

shouldEnterElement in interface StructureViewModel

getCurrentEditorElement

public java.lang.Object getCurrentEditorElement()

Description copied from interface: StructureViewModel

Returns the element currently selected in the editor linked to the structure view.

Specified by:

getCurrentEditorElement in interface StructureViewModel

Returns:

the selected element, or null if the current editor position does not correspond to any element that can be shown in the structure view.

findAcceptableElement

protected java.lang.Object findAcceptableElement(PsiElement element)

getPsiFile

protected PsiFile getPsiFile()

isSuitable

protected boolean isSuitable(PsiElement element)

addModelListener

public void addModelListener(ModelListener modelListener)

Description copied from interface: StructureViewModel

Adds a listener which gets notified when the data represented by the structure view is changed and the structure view needs to be rebuilt.

Specified by:

addModelListener in interface StructureViewModel

Parameters:

modelListener - the listener to add.

removeModelListener

public void removeModelListener(ModelListener modelListener)

Description copied from interface: StructureViewModel

Removes a listener which gets notified when the data represented by the structure view is changed and the structure view needs to be rebuilt.

Specified by:

removeModelListener in interface StructureViewModel

Parameters:

modelListener - the listener to remove.

getSuitableClasses

protected java.lang.Class [] getSuitableClasses()

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.

Returns:

the list of classes

getEditor

protected Editor getEditor()

getGroupers

public Grouper [] getGroupers()

Description copied from interface: TreeModel

Returns the list of actions for grouping items in the tree.

Specified by:

getGroupers in interface TreeModel

Returns:

the array of grouping actions.

See Also:

Grouper.EMPTY_ARRAY

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

Returns:

the array of sorting actions.

See Also:

Sorter.EMPTY_ARRAY

getFilters

public Filter [] getFilters()

Description copied from interface: TreeModel

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

Specified by:

getFilters in interface TreeModel

Returns:

the array of filtering actions.

See Also:

Filter.EMPTY_ARRAY

getNodeProviders

public java.util.Collection<NodeProvider> getNodeProviders()

Specified by:

getNodeProviders in interface ProvidingTreeModel

isEnabled

public boolean isEnabled(NodeProvider provider)

Specified by:

isEnabled in interface ProvidingTreeModel