Package ghidra.plugins.fsbrowser
Class FSBRootNode
java.lang.Object
docking.widgets.tree.GTreeNode
docking.widgets.tree.GTreeLazyNode
docking.widgets.tree.GTreeSlowLoadingNode
ghidra.plugins.fsbrowser.FSBNode
ghidra.plugins.fsbrowser.FSBRootNode
- All Implemented Interfaces:
Cloneable
,Comparable<GTreeNode>
A GTreeNode that represents the root of a
GFileSystem
, and keeps the
filesystem pinned in memory with its FileSystemRef
.
The FileSystemRef
is released when this node is dispose()
d.
Since GTreeNodes are cloned during GTree filtering, and this class has a reference to an external resource that needs managing, this class needs to keeps track of the original modelNode and does all state modification using the modelNode's context.
-
Field Summary
Fields inherited from class ghidra.plugins.fsbrowser.FSBNode
FSBNODE_NAME_TYPE_COMPARATOR
-
Method Summary
Modifier and TypeMethodDescriptionchildren()
clone()
Creates a clone of this node.void
dispose()
protected void
Adds a node to this node's children at the given index and notifies the tree.protected void
Adds a node to this node's children.protected void
doAddNodes
(List<GTreeNode> nodes) Adds the given nodes to this node's children.protected void
doFireNodeAdded
(GTreeNode newNode) protected void
protected void
doFireNodeRemoved
(GTreeNode removedNode, int index) protected void
protected void
doRemoveNode
(GTreeNode node) Removes the node from this node's children and notifies the tree.protected void
doSetChildren
(List<GTreeNode> childList) Sets the children of this node to the given list of child nodes, but does not notify the tree.protected void
doSetChildrenAndFireEvent
(List<GTreeNode> childList) Sets the children of this node to the given list of child nodes and fires the appropriate tree event to kick the tree to update the display.generateChildren
(TaskMonitor monitor) Subclass must implement this method to generate their children.getFSRef()
getFSRL()
Returns theFSRL
of the filesystem object that this node represents.getGFile()
getGFileFSBNode
(GFile file, TaskMonitor monitor) getName()
Returns the name of the node.final GTreeNode
Returns the parent of this node.getProgramProviderFSRL
(FSRL fsrl) Returns the string to be displayed as a tooltip when the user hovers the mouse on this node in the treegetTree()
Returns the GTree that this node is attached tovoid
init
(TaskMonitor monitor) final boolean
Returns true if the node is in the process of loading its children.boolean
isLeaf()
Returns true if this node never has childrenboolean
isLoaded()
True if the children for this node have been loaded yet.final boolean
isRoot()
Returns true if this is a root node of a GTreevoid
refreshNode
(TaskMonitor monitor) void
setCryptoStatusUpdated
(boolean cryptoStatusUpdated) void
Methods inherited from class ghidra.plugins.fsbrowser.FSBNode
createNodeFromFile, createNodesFromFileList, findContainingFileSystemFSBRootNode, findMatchingNode, getFormattedTreePath, getFSBRootNode, getIcon, loadChildrenIfNeeded, refreshChildren
Methods inherited from class docking.widgets.tree.GTreeSlowLoadingNode
generateChildren, loadAll
Methods inherited from class docking.widgets.tree.GTreeLazyNode
addNode, addNode, addNodes, removeAll, removeNode, unloadChildren
Methods inherited from class docking.widgets.tree.GTreeNode
collapse, compareTo, equals, expand, filter, fireNodeChanged, fireNodeStructureChanged, getChild, getChild, getChild, getChildCount, getChildren, getDisplayText, getIndexInParent, getIndexOfChild, getLeafCount, getNodeCount, getRoot, getTreePath, hashCode, isAncestor, isAutoExpandPermitted, isEditable, isExpanded, iterator, setChildren, stream, toString, valueChanged
-
Method Details
-
clone
Creates a clone of this node. The clone should contain a shallow copy of all the node's attributes except that the parent and children are null.- Returns:
- the clone of this object.
- Throws:
CloneNotSupportedException
- if some implementation prevents itself from being cloned.
-
dispose
public void dispose() -
init
- Overrides:
init
in classFSBNode
- Throws:
CancelledException
-
setCryptoStatusUpdated
public void setCryptoStatusUpdated(boolean cryptoStatusUpdated) -
swapBackPrevModelNodeAndDispose
public void swapBackPrevModelNodeAndDispose() -
getGFile
-
getFSRef
-
refreshNode
- Specified by:
refreshNode
in classFSBNode
- Throws:
CancelledException
-
getName
Description copied from class:GTreeNode
Returns the name of the node. IfGTreeNode.getDisplayText()
is not overridden, then this is also the text that will be displayed in the tree for that node. In general, the name of a node should not change. If the text displayed in the tree changes over time, overrideGTreeNode.getDisplayText()
. -
getToolTip
Description copied from class:GTreeNode
Returns the string to be displayed as a tooltip when the user hovers the mouse on this node in the tree- Overrides:
getToolTip
in classFSBNode
- Returns:
- the tooltip to be displayed
-
isLeaf
public boolean isLeaf()Description copied from class:GTreeNode
Returns true if this node never has children -
generateChildren
Description copied from class:GTreeSlowLoadingNode
Subclass must implement this method to generate their children. This operation will always be performed in a background thread (i.e. Not the swing thread)- Specified by:
generateChildren
in classGTreeSlowLoadingNode
- Parameters:
monitor
- a TaskMonitor for reporting progress and cancel notification.- Returns:
- the list of children for this node.
- Throws:
CancelledException
- if the monitor is cancelled
-
getFSRL
Description copied from class:FSBNode
-
getGFileFSBNode
-
getContainer
-
getContainerName
-
getProgramProviderFSRL
-
getLoadableFSRL
- Specified by:
getLoadableFSRL
in classFSBNode
-
getParent
Returns the parent of this node. Note: this method is deliberately not synchronized (See comments above)- Returns:
- the parent of this node.
-
isRoot
public final boolean isRoot()Returns true if this is a root node of a GTree- Returns:
- true if this is a root node of a GTree
-
children
-
doSetChildrenAndFireEvent
Sets the children of this node to the given list of child nodes and fires the appropriate tree event to kick the tree to update the display. Note: This method must be called from the swing thread because it will notify the underlying JTree.- Parameters:
childList
- the list of child nodes to assign as children to this node- See Also:
-
doSetChildren
Sets the children of this node to the given list of child nodes, but does not notify the tree. This method does not have to be called from the swing thread. It is intended to be used by background threads that want to populate all or part of the tree, but wait until the bulk operations are completed before notifying the tree.- Parameters:
childList
- the list of child nodes to assign as children to this node
-
doAddNode
Adds a node to this node's children. Must be called from the swing thread.- Parameters:
node
- the node to add as a child to this node
-
doAddNode
Adds a node to this node's children at the given index and notifies the tree. Must be called from the swing thread.- Parameters:
index
- the index at which to add the new nodenode
- the node to add as a child to this node
-
doRemoveNode
Removes the node from this node's children and notifies the tree. Must be called from the swing thread.- Parameters:
node
- the node to remove
-
doAddNodes
Adds the given nodes to this node's children. Must be called from the swing thread.- Parameters:
nodes
- the nodes to add to the children this node
-
isInProgress
public final boolean isInProgress()Returns true if the node is in the process of loading its children. SeeGTreeSlowLoadingNode
- Returns:
- true if the node is in the process of loading its children.
-
isLoaded
public boolean isLoaded()True if the children for this node have been loaded yet. Some GTree nodes are lazy in that they don't load their children until needed. Nodes that have the IN_PROGRESS node as it child is considered loaded if in the swing thread, otherwise they are considered not loaded.- Returns:
- true if the children for this node have been loaded.
-
getTree
Returns the GTree that this node is attached to- Returns:
- the GTree that this node is attached to
-
doFireNodeAdded
-
doFireNodeRemoved
-
doFireNodeStructureChanged
protected void doFireNodeStructureChanged() -
doFireNodeChanged
protected void doFireNodeChanged()
-