Package com.intellij.usages.impl

Class UsageNode

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

com.intellij.usages.impl.Node

com.intellij.usages.impl.UsageNode

All Implemented Interfaces:

Navigatable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<UsageNode>, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode

public class UsageNode
extends Node
implements java.lang.Comparable<UsageNode>, Navigatable

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

Constructors

Constructor and Description
UsageNode(Node parent, Usage usage)
UsageNode(Usage usage, UsageViewTreeModelBuilder model) Deprecated. use UsageNode(Node, Usage) instead

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).
int	compareTo(UsageNode usageNode)
protected java.lang.String	getText(UsageView view)
Usage	getUsage()
protected boolean	isDataExcluded()
protected boolean	isDataReadOnly()
protected boolean	isDataValid() isDataXXX methods perform actual (expensive) data computation.
void	navigate(boolean requestFocus) Open editor and select/navigate to the object there if possible.
java.lang.String	toString()
java.lang.String	tree2string(int indent, java.lang.String lineSeparator) debug method for producing string tree presentation
protected void	updateCachedPresentation()

Methods inherited from class com.intellij.usages.impl.Node

isExcluded, isReadOnly, isValid, updateNotify

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildAt, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, insert, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, remove, remove, removeAllChildren, removeFromParent, setAllowsChildren, setParent, setUserObject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UsageNode

@Deprecated
public UsageNode(Usage usage,
                 UsageViewTreeModelBuilder model)

Deprecated. use UsageNode(Node, Usage) instead

UsageNode

public UsageNode(Node parent,
                 Usage usage)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class javax.swing.tree.DefaultMutableTreeNode

tree2string

public java.lang.String tree2string(int indent,
                                    java.lang.String lineSeparator)

Description copied from class: Node

debug method for producing string tree presentation

Specified by:

tree2string in class Node

compareTo

public int compareTo(UsageNode usageNode)

Specified by:

compareTo in interface java.lang.Comparable<UsageNode>

getUsage

public Usage getUsage()

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

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

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

Returns:

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

isDataValid

protected boolean isDataValid()

Description copied from class: Node

isDataXXX methods perform actual (expensive) data computation. Called from Node.update(UsageView, Consumer)) to be compared later with cached data stored in Node.myCachedFlags and Node.myCachedTextHash

Specified by:

isDataValid in class Node

isDataReadOnly

protected boolean isDataReadOnly()

Specified by:

isDataReadOnly in class Node

isDataExcluded

protected boolean isDataExcluded()

Specified by:

isDataExcluded in class Node

getText

protected java.lang.String getText(UsageView view)

Specified by:

getText in class Node

updateCachedPresentation

protected void updateCachedPresentation()

Overrides:

updateCachedPresentation in class Node