Package com.intellij.ide.projectView

Class ProjectViewNode<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>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractModuleNode, AbstractProjectNode, AbstractPsiBasedNode, ClassSmartPointerNode, ExternalLibrariesNode, FieldSmartPointerNode, FormNode, LibraryGroupNode, MethodSmartPointerNode, ModuleGroupNode, ModuleListNode, NamedLibraryElementNode, PackageElementNode, PackageViewLibrariesNode, ProjectViewNodeWithChildrenList, ProjectViewUnloadedModuleNode, ResourceBundleNode, SyntheticLibraryElementNode

public abstract class ProjectViewNode<Value>
extends AbstractTreeNode<Value>
implements RootsProvider, SettingsProvider

A node in the project view tree.

See Also:

TreeStructureProvider.modify(AbstractTreeNode, Collection, ViewSettings)

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

Modifier and Type	Field and Description
protected static Logger	LOG

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	ProjectViewNode(Project project, Value value, ViewSettings viewSettings) Creates an instance of the project view node.

Method Summary

Modifier and Type	Method and Description
boolean	canHaveChildrenMatching(Condition<PsiFile> condition) Efficiently checks if there are nodes under the project view node which match the specified condition.
abstract boolean	contains(VirtualFile file) Checks if this node or one of its children represents the specified virtual file.
static AbstractTreeNode<?>	createTreeNode(java.lang.Class<? extends AbstractTreeNode<?>> nodeClass, Project project, java.lang.Object value, ViewSettings settings)
protected static java.util.Collection<VirtualFile>	getDefaultRootsFor(VirtualFile file)
java.lang.Comparable	getManualOrderKey()
java.lang.String	getQualifiedNameSortKey()
java.util.Collection<VirtualFile>	getRoots()
ViewSettings	getSettings()
java.lang.Comparable	getSortKey() When nodes aren't sorted by type all objects with same weigh will be sorted using some common algorithm (e.g alpha comparator).
java.lang.String	getTitle()
java.lang.Comparable	getTypeSortKey() When nodes are sorted by type all objects with same weigh will be sorted using some common algorithm (e.g alpha comparator).
int	getTypeSortWeight(boolean sortByType)
VirtualFile	getVirtualFile() Returns the virtual file represented by this node or one of its children.
protected boolean	hasProblemFileBeneath()
boolean	isSortByFirstChild()
boolean	isValidating()
protected boolean	shouldApply()
boolean	shouldDrillDownOnEmptyElement()
protected boolean	shouldPostprocess()
boolean	someChildContainsFile(VirtualFile file)
boolean	someChildContainsFile(VirtualFile file, boolean optimizeByCheckingFileRootsFirst)
boolean	validate()
static java.util.List<AbstractTreeNode<?>>	wrap(java.util.Collection objects, Project project, java.lang.Class<? extends AbstractTreeNode<?>> nodeClass, ViewSettings settings)

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

apply, canNavigate, canNavigateToSource, canRepresent, equals, getChildren, getChildToHighlightAt, getElement, getEqualityObject, getFileStatus, getFileStatusColor, getLeafState, getName, getNullValueSetTrace, getParent, getParentDescriptor, getParentValue, getTestPresentation, getToolTip, getValue, hashCode, isAlwaysExpand, isAlwaysLeaf, isAlwaysShowPlus, navigate, 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, 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

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

ProjectViewNode

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

Creates an instance of the project view node.

Parameters:

project - the project containing the node.

value - the object (for example, a PSI element) represented by the project view node

viewSettings - the settings of the project view.

Method Detail

contains

public abstract boolean contains(VirtualFile file)

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

Parameters:

file - the file to check for.

Returns:

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

getVirtualFile

public VirtualFile getVirtualFile()

Returns the virtual file represented by this node or one of its children.

Overrides:

getVirtualFile in class AbstractTreeNode<Value>

Returns:

the virtual file instance, or null if the project view node doesn't represent a virtual file.

getSettings

public final ViewSettings getSettings()

Specified by:

getSettings in interface SettingsProvider

wrap

public static java.util.List<AbstractTreeNode<?>> wrap(java.util.Collection objects,
                                                       Project project,
                                                       java.lang.Class<? extends AbstractTreeNode<?>> nodeClass,
                                                       ViewSettings settings)

createTreeNode

public static AbstractTreeNode<?> createTreeNode(java.lang.Class<? extends AbstractTreeNode<?>> nodeClass,
                                                 Project project,
                                                 java.lang.Object value,
                                                 ViewSettings settings)
                                          throws java.lang.InstantiationException

Throws:

java.lang.InstantiationException

someChildContainsFile

public boolean someChildContainsFile(VirtualFile file)

someChildContainsFile

public boolean someChildContainsFile(VirtualFile file,
                                     boolean optimizeByCheckingFileRootsFirst)

getRoots

public java.util.Collection<VirtualFile> getRoots()

Specified by:

getRoots in interface RootsProvider

Returns:

a collection of corresponding virtual files

getDefaultRootsFor

protected static java.util.Collection<VirtualFile> getDefaultRootsFor(VirtualFile file)

hasProblemFileBeneath

protected boolean hasProblemFileBeneath()

Overrides:

hasProblemFileBeneath in class AbstractTreeNode<Value>

canHaveChildrenMatching

public boolean canHaveChildrenMatching(Condition<PsiFile> condition)

Efficiently checks if there are nodes under the project view node which match the specified condition. Should return true if it's not possible to perform the check efficiently (for example, if recursive traversal of all child nodes is required to check the condition).

Parameters:

condition - the condition to check the nodes.

getTitle

public java.lang.String getTitle()

isSortByFirstChild

public boolean isSortByFirstChild()

getTypeSortWeight

public int getTypeSortWeight(boolean sortByType)

getTypeSortKey

public java.lang.Comparable getTypeSortKey()

When nodes are sorted by type all objects with same weigh will be sorted using some common algorithm (e.g alpha comparator). This method allows to perform custom sorting for such objects. And default comparison will be applied only if nodes are equal from custom comparator's point of view. Also comparison will be applied only if both objects have not null comparable keys.

Returns:

Comparable object.

getSortKey

public java.lang.Comparable getSortKey()

When nodes aren't sorted by type all objects with same weigh will be sorted using some common algorithm (e.g alpha comparator). This method allows to perform custom sorting for such objects. And default comparison will be applied only if nodes are equal from custom comparator's point of view. Also comparison will be applied only if both objects have not null comparable keys.

Returns:

Comparable object.

getManualOrderKey

public java.lang.Comparable getManualOrderKey()

getQualifiedNameSortKey

public java.lang.String getQualifiedNameSortKey()

shouldDrillDownOnEmptyElement

public boolean shouldDrillDownOnEmptyElement()

validate

public boolean validate()

shouldPostprocess

protected boolean shouldPostprocess()

Overrides:

shouldPostprocess in class PresentableNodeDescriptor<AbstractTreeNode<Value>>

shouldApply

protected boolean shouldApply()

Overrides:

shouldApply in class PresentableNodeDescriptor<AbstractTreeNode<Value>>

isValidating

public boolean isValidating()