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

Class AbstractModuleNode

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

com.intellij.ide.projectView.impl.nodes.AbstractModuleNode

All Implemented Interfaces:

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

Direct Known Subclasses:

MvcModuleNode, PackageViewModuleNode, ProjectViewModuleNode, StructureViewModuleNode

public abstract class AbstractModuleNode
extends ProjectViewNode<Module>
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.projectView.ProjectViewNode

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	AbstractModuleNode(Project project, Module module, ViewSettings viewSettings)

Method Summary

Modifier and Type	Method and Description
boolean	canNavigate() Indicates whether this instance supports navigation of any kind.
boolean	contains(VirtualFile file) Checks if this node or one of its children represents the specified virtual file.
java.lang.String	getNavigateActionText(boolean focusEditor)
java.util.Collection<VirtualFile>	getRoots()
java.lang.String	getTestPresentation()
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
protected boolean	showModuleNameInBold()
void	update(PresentationData presentation)

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

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

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

apply, canNavigateToSource, canRepresent, equals, getChildren, getChildToHighlightAt, getElement, getEqualityObject, getFileStatus, getFileStatusColor, getLeafState, getName, getNullValueSetTrace, getParent, getParentDescriptor, getParentValue, 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.pom.Navigatable

canNavigateToSource

Methods inherited from interface com.intellij.navigation.NavigationItem

getPresentation

Constructor Detail

AbstractModuleNode

protected AbstractModuleNode(Project project,
                             Module module,
                             ViewSettings viewSettings)

Method Detail

update

public void update(PresentationData presentation)

Specified by:

update in class PresentableNodeDescriptor<AbstractTreeNode<Module>>

showModuleNameInBold

protected boolean showModuleNameInBold()

getRoots

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

Specified by:

getRoots in interface RootsProvider

Overrides:

getRoots in class ProjectViewNode<Module>

Returns:

a collection of corresponding virtual files

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

Parameters:

file - the file to check for.

Returns:

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

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

Parameters:

requestFocus - true if focus requesting is necessary

getNavigateActionText

public java.lang.String getNavigateActionText(boolean focusEditor)

Specified by:

getNavigateActionText in interface NavigatableWithText

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

Returns:

false if navigation is not possible for any reason.

getTestPresentation

public java.lang.String getTestPresentation()

Overrides:

getTestPresentation in class AbstractTreeNode<Module>