Package com.intellij.ide.structureView.impl.common

Class PsiTreeElementBase<T extends PsiElement>

java.lang.Object

com.intellij.ide.structureView.impl.common.PsiTreeElementBase<T>

All Implemented Interfaces:

StructureViewTreeElement, NodeDescriptorProvidingKey, TreeElement, ItemPresentation, Navigatable

Direct Known Subclasses:

AbstractXmlTagTreeElement, ClassInitializerTreeElement, DtdFileTreeElement, HtmlTagTreeElement, JavaClassTreeElementBase, JavaFileTreeElement, MarkdownStructureElement, PropertiesFileStructureViewElement, RestStructureViewElement

public abstract class PsiTreeElementBase<T extends PsiElement>
extends java.lang.Object
implements StructureViewTreeElement, ItemPresentation, NodeDescriptorProvidingKey

Field Summary

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

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PsiTreeElementBase(T psiElement)

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).
boolean	equals(java.lang.Object o)
StructureViewTreeElement []	getChildren() Returns the list of children of the tree element.
abstract java.util.Collection<StructureViewTreeElement>	getChildrenBase()
StructureViewTreeElement []	getChildrenWithoutCustomRegions()
T	getElement()
javax.swing.Icon	getIcon(boolean open) Returns the icon representing the object.
java.lang.Object	getKey()
java.lang.String	getLocationString() Returns the location of the object (for example, the package of a class).
ItemPresentation	getPresentation() Returns the presentation of the tree element.
T	getValue() Returns the data object (usually a PSI element) corresponding to the structure view element.
int	hashCode()
boolean	isSearchInLocationString()
boolean	isValid()
static StructureViewTreeElement []	mergeWithExtensions(PsiElement element, java.util.Collection<StructureViewTreeElement> baseChildren, boolean withCustomRegions)
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.intellij.navigation.ItemPresentation

getPresentableText

Constructor Detail

PsiTreeElementBase

protected PsiTreeElementBase(T psiElement)

Method Detail

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.

getKey

public java.lang.Object getKey()

Specified by:

getKey in interface NodeDescriptorProvidingKey

getElement

public final T getElement()

getIcon

public javax.swing.Icon getIcon(boolean open)

Description copied from interface: ItemPresentation

Returns the icon representing the object.

Specified by:

getIcon in interface ItemPresentation

Parameters:

open - Used to mean if open/close icons for tree renderer. No longer in use. The parameter is only there for API compatibility reason.

getValue

public T 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.

getLocationString

public java.lang.String getLocationString()

Description copied from interface: ItemPresentation

Returns the location of the object (for example, the package of a class). The location string is used by some renderers and usually displayed as grayed text next to the item name.

Specified by:

getLocationString in interface ItemPresentation

Returns:

the location description, or null if none is applicable.

isSearchInLocationString

public boolean isSearchInLocationString()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getChildren

public final 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.

getChildrenWithoutCustomRegions

public final StructureViewTreeElement [] getChildrenWithoutCustomRegions()

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.

getChildrenBase

public abstract java.util.Collection<StructureViewTreeElement> getChildrenBase()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isValid

public boolean isValid()

mergeWithExtensions

public static StructureViewTreeElement [] mergeWithExtensions(PsiElement element,
                                                              java.util.Collection<StructureViewTreeElement> baseChildren,
                                                              boolean withCustomRegions)

Returns:

element base children merged with children provided by extensions