Package com.intellij.ide.projectView.impl.nodes

Class AbstractPsiBasedNode<Value>

java.lang.Object

com.intellij.ide.util.treeView.NodeDescriptor<E>

com.intellij.ide.util.treeView.PresentableNodeDescriptor<AbstractTreeNode<T>>

com.intellij.ide.util.treeView.AbstractTreeNode<Value>

com.intellij.ide.projectView.ProjectViewNode<Value>

com.intellij.ide.projectView.impl.nodes.AbstractPsiBasedNode<Value>

Type Parameters:

Value - Value of node descriptor

All Implemented Interfaces:

RootsProvider, SettingsProvider, ValidateableNode, NavigationItem, Queryable.Contributor, Navigatable, StatePreservingNavigatable, LeafState.Supplier

Direct Known Subclasses:

BasePsiNode

public abstract class AbstractPsiBasedNode<Value>
extends ProjectViewNode<Value>
implements ValidateableNode, StatePreservingNavigatable

Class for node descriptors based on PsiElements. Subclasses should define method that extract PsiElement from Value.

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.ide.util.treeView.PresentableNodeDescriptor

PresentableNodeDescriptor.ColoredFragment

Nested classes/interfaces inherited from class com.intellij.ide.util.treeView.NodeDescriptor

NodeDescriptor.NodeComparator<T extends NodeDescriptor<?>>

Field Summary

Fields inherited from class com.intellij.ide.util.treeView.NodeDescriptor

DEFAULT_WEIGHT, EMPTY_ARRAY, myClosedIcon, myColor, myName, myOpenIcon, myProject

Fields inherited from interface com.intellij.ide.projectView.RootsProvider

EMPTY_ROOTS

Fields inherited from interface com.intellij.navigation.NavigationItem

EMPTY_NAVIGATION_ITEM_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPsiBasedNode(Project project, Value value, ViewSettings viewSettings)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	calcTooltip()
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).
protected static FileStatus	computeFileStatus(VirtualFile virtualFile, Project project)
boolean	contains(VirtualFile file) Checks if this node or one of its children represents the specified virtual file.
protected abstract PsiElement	extractPsiFromValue()
java.util.Collection<? extends AbstractTreeNode<?>>	getChildren()
protected abstract java.util.Collection<AbstractTreeNode<?>>	getChildrenImpl()
FileStatus	getFileStatus()
protected int	getIconableFlags()
NavigationItem	getNavigationItem()
protected boolean	isDeprecated()
protected boolean	isMarkReadOnly()
boolean	isValid()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
void	navigate(boolean requestFocus, boolean preserveState)
static javax.swing.Icon	patchIcon(Project project, javax.swing.Icon original, VirtualFile file)
void	update(PresentationData data)
protected abstract void	updateImpl(PresentationData data)
boolean	validate()

Methods inherited from class com.intellij.ide.projectView.ProjectViewNode

canHaveChildrenMatching, createTreeNode, getDefaultRootsFor, getManualOrderKey, getQualifiedNameSortKey, getRoots, getSettings, getSortKey, getTitle, getTypeSortKey, getTypeSortWeight, getVirtualFile, hasProblemFileBeneath, isSortByFirstChild, isValidating, shouldApply, shouldDrillDownOnEmptyElement, shouldPostprocess, someChildContainsFile, someChildContainsFile, wrap

Methods inherited from class com.intellij.ide.util.treeView.AbstractTreeNode

apply, canRepresent, equals, getChildToHighlightAt, getElement, getEqualityObject, getFileStatusColor, getLeafState, getName, getNullValueSetTrace, getParent, getParentDescriptor, getParentValue, getTestPresentation, getToolTip, getValue, hashCode, isAlwaysExpand, isAlwaysLeaf, isAlwaysShowPlus, postprocess, setParent, setValue, shouldUpdateData, toTestString, valueIsCut

Methods inherited from class com.intellij.ide.util.treeView.PresentableNodeDescriptor

apply, apply, applyFrom, createPresentation, getHighlightColor, getPresentation, getTemplatePresentation, isAncestorOrSelf, isContentHighlighted, isHighlightableContentNode, isParentOf, update

Methods inherited from class com.intellij.ide.util.treeView.NodeDescriptor

expandOnDoubleClick, getChildrenSortingStamp, getClosedIcon, getColor, getIcon, getIndex, getOpenIcon, getProject, getUpdateCount, getWeight, isWasDeclaredAlwaysLeaf, setChildrenSortingStamp, setIcon, setIndex, setUpdateCount, setWasDeclaredAlwaysLeaf, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Constructor Detail

AbstractPsiBasedNode

protected AbstractPsiBasedNode(Project project,
                               Value value,
                               ViewSettings viewSettings)

Method Detail

extractPsiFromValue

protected abstract PsiElement extractPsiFromValue()

getChildrenImpl

protected abstract java.util.Collection<AbstractTreeNode<?>> getChildrenImpl()

updateImpl

protected abstract void updateImpl(PresentationData data)

getChildren

public final java.util.Collection<? extends AbstractTreeNode<?>> getChildren()

Specified by:

getChildren in class AbstractTreeNode<Value>

isValid

public boolean isValid()

Specified by:

isValid in interface ValidateableNode

isMarkReadOnly

protected boolean isMarkReadOnly()

getFileStatus

public FileStatus getFileStatus()

Overrides:

getFileStatus in class AbstractTreeNode<Value>

computeFileStatus

protected static FileStatus computeFileStatus(VirtualFile virtualFile,
                                              Project project)

update

public void update(PresentationData data)

Specified by:

update in class PresentableNodeDescriptor<AbstractTreeNode<Value>>

getIconableFlags

protected int getIconableFlags()

patchIcon

public static javax.swing.Icon patchIcon(Project project,
                                         javax.swing.Icon original,
                                         VirtualFile file)

isDeprecated

protected boolean isDeprecated()

contains

public boolean contains(VirtualFile file)

Description copied from class: ProjectViewNode

Checks if this node or one of its children represents the specified virtual file.

Specified by:

contains in class ProjectViewNode<Value>

Parameters:

file - the file to check for.

Returns:

true if the file is found in the subtree, false otherwise.

getNavigationItem

public NavigationItem getNavigationItem()

navigate

public void navigate(boolean requestFocus,
                     boolean preserveState)

Specified by:

navigate in interface StatePreservingNavigatable

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

Overrides:

navigate in class AbstractTreeNode<Value>

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

Overrides:

canNavigate in class AbstractTreeNode<Value>

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

Overrides:

canNavigateToSource in class AbstractTreeNode<Value>

Returns:

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

calcTooltip

protected java.lang.String calcTooltip()

validate

public boolean validate()

Overrides:

validate in class ProjectViewNode<Value>