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

Class PsiFileNode

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

com.intellij.ide.projectView.impl.nodes.PsiFileNode

All Implemented Interfaces:

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

Direct Known Subclasses:

CustomResourceBundlePropertiesFileNode, NestingTreeNode, PyFileNode, TodoFileNode

public class PsiFileNode
extends BasePsiNode<PsiFile>
implements NavigatableWithText

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PsiFileNode.ExtensionSortKey

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
PsiFileNode(Project project, PsiFile value, ViewSettings viewSettings)

Method Summary

Modifier and Type	Method and Description
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	canRepresent(java.lang.Object element)
boolean	contains(VirtualFile file) Checks if this node or one of its children represents the specified virtual file.
static java.lang.String	extension(PsiFile file)
java.util.Collection<AbstractTreeNode<?>>	getChildrenImpl()
java.lang.String	getNavigateActionText(boolean focusEditor)
java.lang.String	getTitle()
java.lang.Comparable<PsiFileNode.ExtensionSortKey>	getTypeSortKey() When nodes are sorted by type all objects with same weigh will be sorted using some common algorithm (e.g alpha comparator).
int	getWeight()
protected boolean	isMarkReadOnly()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
boolean	shouldDrillDownOnEmptyElement()
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, canNavigateToSource, computeFileStatus, getChildren, getIconableFlags, getNavigationItem, isDeprecated, isValid, navigate, patchIcon, update, validate

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

canHaveChildrenMatching, createTreeNode, getDefaultRootsFor, getManualOrderKey, getQualifiedNameSortKey, getRoots, getSettings, getSortKey, getTypeSortWeight, 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, 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, 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.pom.Navigatable

canNavigateToSource

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Constructor Detail

PsiFileNode

public PsiFileNode(Project project,
                   PsiFile value,
                   ViewSettings viewSettings)

Method Detail

getChildrenImpl

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

Specified by:

getChildrenImpl in class AbstractPsiBasedNode<PsiFile>

updateImpl

protected void updateImpl(PresentationData data)

Specified by:

updateImpl in class AbstractPsiBasedNode<PsiFile>

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

Returns:

false if navigation 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<PsiFile>

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

getTitle

public java.lang.String getTitle()

Overrides:

getTitle in class ProjectViewNode<PsiFile>

isMarkReadOnly

protected boolean isMarkReadOnly()

Overrides:

isMarkReadOnly in class AbstractPsiBasedNode<PsiFile>

getTypeSortKey

public java.lang.Comparable<PsiFileNode.ExtensionSortKey> 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<PsiFile>

Returns:

Comparable object.

extension

public static java.lang.String extension(PsiFile file)

shouldDrillDownOnEmptyElement

public boolean shouldDrillDownOnEmptyElement()

Overrides:

shouldDrillDownOnEmptyElement in class ProjectViewNode<PsiFile>

canRepresent

public boolean canRepresent(java.lang.Object element)

Overrides:

canRepresent in class AbstractTreeNode<PsiFile>

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

Parameters:

file - the file to check for.

Returns:

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