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

Class PsiDirectoryNode

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

com.intellij.ide.projectView.impl.nodes.BasePsiNode<PsiDirectory>

com.intellij.ide.projectView.impl.nodes.PsiDirectoryNode

All Implemented Interfaces:

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

Direct Known Subclasses:

PyRemoteLibrariesNode, PyRemoteLibrariesNode.PyRemoteRootNode, PySkeletonsNode, PyUserSkeletonsNode, TodoDirNode

public class PsiDirectoryNode
extends BasePsiNode<PsiDirectory>
implements NavigatableWithText

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

Constructor and Description
PsiDirectoryNode(Project project, PsiDirectory value, ViewSettings viewSettings)
PsiDirectoryNode(Project project, PsiDirectory value, ViewSettings viewSettings, PsiFileSystemItemFilter filter)

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	canRepresent(java.lang.Object element)
boolean	contains(VirtualFile file) Checks if this node or one of its children represents the specified virtual file.
java.util.Collection<AbstractTreeNode<?>>	getChildrenImpl()
PsiFileSystemItemFilter	getFilter()
java.lang.String	getNavigateActionText(boolean focusEditor)
java.lang.String	getQualifiedNameSortKey()
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	getTestPresentation()
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)
int	getWeight()
boolean	isAlwaysShowPlus()
boolean	isFQNameShown()
boolean	isValid()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
protected void	setupIcon(PresentationData data, PsiDirectory psiDirectory)
boolean	shouldDrillDownOnEmptyElement()
protected boolean	shouldShowModuleName()
protected boolean	shouldShowSourcesRoot()
protected void	updateImpl(PresentationData data)

Methods inherited from class com.intellij.ide.projectView.impl.nodes.BasePsiNode

extractPsiFromValue, getFileStatus, getVirtualFile

Methods inherited from class com.intellij.ide.projectView.impl.nodes.AbstractPsiBasedNode

calcTooltip, computeFileStatus, getChildren, getIconableFlags, getNavigationItem, isDeprecated, isMarkReadOnly, navigate, patchIcon, update, validate

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

canHaveChildrenMatching, createTreeNode, getDefaultRootsFor, getManualOrderKey, getRoots, getSettings, hasProblemFileBeneath, isSortByFirstChild, isValidating, shouldApply, shouldPostprocess, someChildContainsFile, someChildContainsFile, wrap

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

apply, equals, getChildToHighlightAt, getElement, getEqualityObject, getFileStatusColor, getLeafState, getName, getNullValueSetTrace, getParent, getParentDescriptor, getParentValue, getToolTip, getValue, hashCode, isAlwaysExpand, isAlwaysLeaf, 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, 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

PsiDirectoryNode

public PsiDirectoryNode(Project project,
                        PsiDirectory value,
                        ViewSettings viewSettings)

PsiDirectoryNode

public PsiDirectoryNode(Project project,
                        PsiDirectory value,
                        ViewSettings viewSettings,
                        PsiFileSystemItemFilter filter)

Method Detail

getFilter

public PsiFileSystemItemFilter getFilter()

shouldShowModuleName

protected boolean shouldShowModuleName()

shouldShowSourcesRoot

protected boolean shouldShowSourcesRoot()

updateImpl

protected void updateImpl(PresentationData data)

Specified by:

updateImpl in class AbstractPsiBasedNode<PsiDirectory>

setupIcon

protected void setupIcon(PresentationData data,
                         PsiDirectory psiDirectory)

getChildrenImpl

public java.util.Collection<AbstractTreeNode<?>> getChildrenImpl()

Specified by:

getChildrenImpl in class AbstractPsiBasedNode<PsiDirectory>

getTestPresentation

public java.lang.String getTestPresentation()

Overrides:

getTestPresentation in class AbstractTreeNode<PsiDirectory>

isFQNameShown

public boolean isFQNameShown()

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.

Overrides:

contains in class AbstractPsiBasedNode<PsiDirectory>

Parameters:

file - the file to check for.

Returns:

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

canRepresent

public boolean canRepresent(java.lang.Object element)

Overrides:

canRepresent in class AbstractTreeNode<PsiDirectory>

isValid

public boolean isValid()

Specified by:

isValid in interface ValidateableNode

Overrides:

isValid in class AbstractPsiBasedNode<PsiDirectory>

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 AbstractPsiBasedNode<PsiDirectory>

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 AbstractPsiBasedNode<PsiDirectory>

Returns:

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

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 AbstractPsiBasedNode<PsiDirectory>

Parameters:

requestFocus - true if focus requesting is necessary

getNavigateActionText

public java.lang.String getNavigateActionText(boolean focusEditor)

Specified by:

getNavigateActionText in interface NavigatableWithText

getWeight

public int getWeight()

Overrides:

getWeight in class NodeDescriptor<AbstractTreeNode<PsiDirectory>>

getTitle

public java.lang.String getTitle()

Overrides:

getTitle in class ProjectViewNode<PsiDirectory>

getSortKey

public java.lang.Comparable getSortKey()

Description copied from class: ProjectViewNode

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.

Overrides:

getSortKey in class ProjectViewNode<PsiDirectory>

Returns:

Comparable object.

getTypeSortKey

public java.lang.Comparable getTypeSortKey()

Description copied from class: ProjectViewNode

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.

Overrides:

getTypeSortKey in class ProjectViewNode<PsiDirectory>

Returns:

Comparable object.

getQualifiedNameSortKey

public java.lang.String getQualifiedNameSortKey()

Overrides:

getQualifiedNameSortKey in class ProjectViewNode<PsiDirectory>

getTypeSortWeight

public int getTypeSortWeight(boolean sortByType)

Overrides:

getTypeSortWeight in class ProjectViewNode<PsiDirectory>

shouldDrillDownOnEmptyElement

public boolean shouldDrillDownOnEmptyElement()

Overrides:

shouldDrillDownOnEmptyElement in class ProjectViewNode<PsiDirectory>

isAlwaysShowPlus

public boolean isAlwaysShowPlus()

Overrides:

isAlwaysShowPlus in class AbstractTreeNode<PsiDirectory>