Package com.intellij.ide.structureView.impl

Class StructureViewElementWrapper<V extends PsiElement>

java.lang.Object

com.intellij.ide.structureView.impl.StructureViewElementWrapper<V>

All Implemented Interfaces:

StructureViewTreeElement, TreeElement, Navigatable

public class StructureViewElementWrapper<V extends PsiElement>
extends java.lang.Object
implements StructureViewTreeElement

Field Summary

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

EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	canNavigateToSource() Indicates whether this instance supports navigation to source (that means some kind of editor).
StructureViewTreeElement []	getChildren() Returns the list of children of the tree element.
ItemPresentation	getPresentation() Returns the presentation of the tree element.
V	getValue() Returns the data object (usually a PSI element) corresponding to the structure view element.
StructureViewTreeElement	getWrappedElement()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.

Methods inherited from class java.lang.Object

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

Method Detail

getWrappedElement

public StructureViewTreeElement getWrappedElement()

getValue

public V getValue()

Description copied from interface: StructureViewTreeElement

Returns the data object (usually a PSI element) corresponding to the structure view element.

Specified by:

getValue in interface StructureViewTreeElement

Returns:

the data object instance.

getChildren

public StructureViewTreeElement [] getChildren()

Description copied from interface: TreeElement

Returns the list of children of the tree element.

Specified by:

getChildren in interface TreeElement

Returns:

the list of children.

getPresentation

public ItemPresentation getPresentation()

Description copied from interface: TreeElement

Returns the presentation of the tree element.

Specified by:

getPresentation in interface TreeElement

Returns:

the element presentation.

navigate

public void navigate(boolean requestFocus)

Description copied from interface: Navigatable

Open editor and select/navigate to the object there if possible. Just do nothing if navigation is not possible like in case of a package

Specified by:

navigate in interface Navigatable

Parameters:

requestFocus - true if focus requesting is necessary

canNavigate

public boolean canNavigate()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation of any kind. Usually this method is called to ensure that navigation is possible. Note that it is not called if navigation to source is supported, i.e. Navigatable.canNavigateToSource() returns true. We assume that this method should return true in such case, so implement this method respectively.

Specified by:

canNavigate in interface Navigatable

Returns:

false if navigation is not possible for any reason.

canNavigateToSource

public boolean canNavigateToSource()

Description copied from interface: Navigatable

Indicates whether this instance supports navigation to source (that means some kind of editor). Note that navigation can be supported even if this method returns false. In such cases it is not recommended to do batch navigation for all navigatables available via CommonDataKeys.NAVIGATABLE_ARRAY, because it may lead to opening several modal dialogs. Use OpenSourceUtil.navigate(com.intellij.pom.Navigatable...) to process such arrays correctly.

Specified by:

canNavigateToSource in interface Navigatable

Returns:

false if navigation to source is not possible for any reason.