Package com.intellij.ide.structureView.customRegions

Class CustomRegionTreeElement

java.lang.Object

com.intellij.ide.structureView.customRegions.CustomRegionTreeElement

All Implemented Interfaces:

StructureViewTreeElement, TreeElement, Navigatable

public class CustomRegionTreeElement
extends java.lang.Object
implements StructureViewTreeElement

Field Summary

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

EMPTY_ARRAY

Constructor Summary

Constructors

Constructor and Description
CustomRegionTreeElement(PsiElement startElement, CustomFoldingProvider provider)
CustomRegionTreeElement(PsiElement startElement, CustomFoldingProvider provider, CustomRegionTreeElement parent)

Method Summary

Modifier and Type	Method and Description
void	addChild(StructureViewTreeElement childElement)
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	containsElement(StructureViewTreeElement element)
CustomRegionTreeElement	createNestedRegion(PsiElement element)
CustomRegionTreeElement	endRegion(PsiElement element)
TreeElement []	getChildren() Returns the list of children of the tree element.
ItemPresentation	getPresentation() Returns the presentation of the tree element.
java.lang.Object	getValue() Returns the data object (usually a PSI element) corresponding to the structure view element.
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CustomRegionTreeElement

public CustomRegionTreeElement(PsiElement startElement,
                               CustomFoldingProvider provider,
                               CustomRegionTreeElement parent)

CustomRegionTreeElement

public CustomRegionTreeElement(PsiElement startElement,
                               CustomFoldingProvider provider)

Method Detail

getValue

public java.lang.Object 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.

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.

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.

addChild

public void addChild(StructureViewTreeElement childElement)

getChildren

public TreeElement [] 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.

containsElement

public boolean containsElement(StructureViewTreeElement element)

createNestedRegion

public CustomRegionTreeElement createNestedRegion(PsiElement element)

endRegion

public CustomRegionTreeElement endRegion(PsiElement element)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object