MutableTreeNode Abstract tree node structure to use with FvTree componant.
Take a look at FvTreeNode class for concrete implementation.
Based on on AsWing DefaultMutableTreeNode implementation.
static public function defaultSortingProcess(a:FvAbstractTreeNode, b:FvAbstractTreeNode):NumberDefault sorting process for childnodes arrangement.
public function isDraggable():Boolean
Returns true if tree node which contain this item is
draggable.
Overrides this method to define your own behaviour.
public function isEditable():Boolean
Returns true if tree node which contain this item is
editable.
Overrides this method to define your own behaviour.
public function isDeletable():Boolean
Returns true if tree node which contain this item is
deletable.
Overrides this method to define your own behaviour.
public function getAllowsData(sourceData:TreeSourceData, order:Boolean, himSelf:Boolean, dndMode:Number):Boolean
Returns true is passed-in sourceData is available data for
dropping process. ( default returns true
Overrides this method to define your own behaviour.
public function insert(newChild:MutableTreeNode, childIndex:Number):Void
Adds child to the receiver at index.
child will be messaged with setParent.
public function removeAt(childIndex:Number):Void
Removes the child at the specified index from this node's children
and sets that node's parent to null. The child node to remove
must be a MutableTreeNode.
childIndex | the index in this node's child array
of the child to remove, nothing happen if
childIndex is out of bounds
|
public function setParent(newParent:MutableTreeNode):Void
Sets this node's parent to newParent but does not
change the parent's child array. This method is called from
insert() and remove() to
reassign a child's parent, it should not be messaged from anywhere
else.
newParent | this node's new parent |
public function getParent():TreeNodeReturns this node's parent or null if this node has no parent.
this node's parent TreeNode, or null if this node has no parent
public function getChildAt(index:Number):TreeNodeReturns the child at the specified index in this node's child array.
index | an index into this node's child array |
the TreeNode in this node's child array at the specified index
| ArrayIndexOutOfBoundsException | if index
is out of bounds
|
public function getChildCount():NumberReturns the number of children of this node.
an int giving the number of children of this node
public function getIndex(aChild:TreeNode):Number
Returns the index of the specified child in this node's child array.
If the specified node is not a child of this node, returns
-1. This method performs a linear search and is O(n)
where n is the number of children.
aChild | the TreeNode to search for among this node's children |
an int giving the index of the node in this node's child
array, or -1 if the specified node is a not
a child of this node
public function children():ArrayCreates and returns a forward-order enumeration of this node's children. Modifying this node's child array invalidates any child enumerations created before the modification.
an Enumeration of this node's children
public function sortChildren(compare:Function, options:Number):VoidSorts children list.
public function setAllowsChildren(allows:Boolean):Void
Determines whether or not this node is allowed to have children.
If allows is false, all of this node's children are
removed.
Note: By default, a node allows children.
allows | true if this node is allowed to have children |
public function getAllowsChildren():BooleanReturns true if this node is allowed to have children.
public function setUserObject(userObject:Object):Void
Sets the user object for this node to userObject.
userObject | the Object that constitutes this node's user-specified data |
public function removeFromParent():VoidRemoves the subtree rooted at this node from the tree, giving this node a null parent. Does nothing if this node is the root of its tree.
public function remove(aChild:MutableTreeNode):Void
Removes aChild from this node's child array, giving it a
null parent.
aChild | a child of this node to remove |
public function removeAllChildren():VoidRemoves all of this node's children, setting their parents to null. If this node has no children, this method does nothing.
public function append(newChild:MutableTreeNode):Void
Removes newChild from its parent and makes it a child of
this node by adding it to the end of this node's child array.
newChild | node to add as a child of this node |
public function isNodeAncestor(anotherNode:TreeNode):Boolean
Returns true if anotherNode is an ancestor of this node
-- if it is this node, this node's parent, or an ancestor of this
node's parent. (Note that a node is considered an ancestor of itself.)
If anotherNode is null, this method returns false. This
operation is at worst O(h) where h is the distance from the root to
this node.
anotherNode | node to test as an ancestor of this node |
true if this node is a descendant of anotherNode
public function isNodeDescendant(anotherNode:FvAbstractTreeNode):Boolean
Returns true if anotherNode is a descendant of this node
-- if it is this node, one of this node's children, or a descendant of
one of this node's children. Note that a node is considered a
descendant of itself. If anotherNode is null, returns
false. This operation is at worst O(h) where h is the distance from the
root to anotherNode.
anotherNode | node to test as descendant of this node |
true if this node is an ancestor of anotherNode
public function getSharedAncestor(aNode:FvAbstractTreeNode):TreeNode
Returns the nearest common ancestor to this node and aNode.
Returns null, if no such ancestor exists -- if this node and
aNode are in different trees or if aNode is
null. A node is considered an ancestor of itself.
aNode | node to find common ancestor with |
nearest ancestor common to this node and aNode,
or null if none
public function isNodeRelated(aNode:FvAbstractTreeNode):Boolean
Returns true if and only if aNode is in the same tree
as this node. Returns false if aNode is null.
true if aNode is in the same tree as this node;
false if aNode is null
public function getDepth():Number
Returns the depth of the tree rooted at this node -- the longest
distance from this node to a leaf. If this node has no children,
returns 0. This operation is much more expensive than
getLevel() because it must effectively traverse the entire
tree rooted at this node.
the depth of the tree whose root is this node
public function getLevel():NumberReturns the number of levels above this node -- the distance from the root to this node. If this node is the root, returns 0.
the number of levels above this node
public function getPath():ArrayReturns the path from the root, to get to this node. The last element in the path is this node.
an array of TreeNode objects giving the path, where the
first element in the path is the root and the last
element is this node.
public function getUserObjectPath():ArrayReturns the user object path, from the root, to get to this node. If some of the TreeNodes in the path have null user objects, the returned path will contain nulls.
public function getRoot():TreeNodeReturns the root of the tree that contains this node. The root is the ancestor with a null parent.
the root of the tree that contains this node
public function isRoot():BooleanReturns true if this node is the root of the tree. The root is the only node in the tree with a null parent; every tree has exactly one root.
true if this node is the root of its tree
public function getNextNode():FvAbstractTreeNodeReturns the node that follows this node in a preorder traversal of this node's tree. Returns null if this node is the last node of the traversal. This is an inefficient way to traverse the entire tree; use an enumeration, instead.
the node that follows this node in a preorder traversal, or null if this node is last
public function getPreviousNode():FvAbstractTreeNode
Returns the node that precedes this node in a preorder traversal of
this node's tree. Returns null if this node is the
first node of the traversal -- the root of the tree.
This is an inefficient way to
traverse the entire tree; use an enumeration, instead.
the node that precedes this node in a preorder traversal, or null if this node is the first
public function preorderEnumeration():Array
Creates and returns an enumeration that traverses the subtree rooted at
this node in preorder. The first node returned by the enumeration's
nextElement() method is this node.
Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
an enumeration for traversing the tree in preorder
public function postorderEnumeration():Array
Creates and returns an enumeration that traverses the subtree rooted at
this node in postorder. The first node returned by the enumeration's
nextElement() method is the leftmost leaf. This is the
same as a depth-first traversal.
Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
an enumeration for traversing the tree in postorder
public function breadthFirstEnumeration():Array
Creates and returns an enumeration that traverses the subtree rooted at
this node in breadth-first order. The first node returned by the
enumeration's nextElement() method is this node.
Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
an enumeration for traversing the tree in breadth-first order
public function depthFirstEnumeration():Array
Creates and returns an enumeration that traverses the subtree rooted at
this node in depth-first order. The first node returned by the
enumeration's nextElement() method is the leftmost leaf.
This is the same as a postorder traversal.
Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
an enumeration for traversing the tree in depth-first order
public function pathFromAncestorEnumeration(ancestor:TreeNode):Array
Creates and returns an enumeration that follows the path from
ancestor to this node. The enumeration's
nextElement() method first returns ancestor,
then the child of ancestor that is an ancestor of this
node, and so on, and finally returns this node. Creation of the
enumeration is O(m) where m is the number of nodes between this node
and ancestor, inclusive. Each nextElement()
message is O(1).
Modifying the tree by inserting, removing, or moving a node invalidates any enumerations created before the modification.
an enumeration for following the path from an ancestor of this node to this one
| IllegalArgumentException | if ancestor is
not an ancestor of this node
|
public function isNodeChild(aNode:TreeNode):Boolean
Returns true if aNode is a child of this node. If
aNode is null, this method returns false.
true if aNode is a child of this node; false if
aNode is null
public function getFirstChild():TreeNodeReturns this node's first child.
the first child of this node, null if this node has no children
public function getLastChild():TreeNodeReturns this node's last child.
the last child of this node, null if this node has no children
public function getChildAfter(aChild:TreeNode):TreeNode
Returns the child in this node's child array that immediately
follows aChild, which must be a child of this node. If
aChild is the last child, returns null. This method
performs a linear search of this node's children for
aChild and is O(n) where n is the number of children; to
traverse the entire array of children, use an enumeration instead.
the child of this node that immediately follows
aChild
| Error | if aChild is
null or is not a child of this node
|
public function getChildBefore(aChild:TreeNode):TreeNode
Returns the child in this node's child array that immediately
precedes aChild, which must be a child of this node. If
aChild is the first child, returns null. This method
performs a linear search of this node's children for aChild
and is O(n) where n is the number of children.
the child of this node that immediately precedes
aChild
| IllegalArgumentException | if aChild is null
or is not a child of this node
|
public function isNodeSibling(anotherNode:TreeNode):Boolean
Returns true if anotherNode is a sibling of (has the
same parent as) this node. A node is its own sibling. If
anotherNode is null, returns false.
anotherNode | node to test as sibling of this node |
true if anotherNode is a sibling of this node
public function getSiblingCount():Number
Returns the number of siblings of this node. A node is its own sibling
(if it has no parent or no siblings, this method returns
1).
the number of siblings of this node
public function getNextSibling():FvAbstractTreeNodeReturns the next sibling of this node in the parent's children array. Returns null if this node has no parent or is the parent's last child. This method performs a linear search that is O(n) where n is the number of children; to traverse the entire array, use the parent's child enumeration instead.
the sibling of this node that immediately follows this node
public function getPreviousSibling():FvAbstractTreeNodeReturns the previous sibling of this node in the parent's children array. Returns null if this node has no parent or is the parent's first child. This method performs a linear search that is O(n) where n is the number of children.
the sibling of this node that immediately precedes this node
public function isLeaf():Boolean
Returns true if this node has no children. To distinguish between
nodes that have no children and nodes that cannot have
children (e.g. to distinguish files from empty directories), use this
method in conjunction with getAllowsChildren
true if this node has no children
public function getFirstLeaf():FvAbstractTreeNodeFinds and returns the first leaf that is a descendant of this node -- either this node or its first child's first leaf. Returns this node if it is a leaf.
the first leaf in the subtree rooted at this node
public function getLastLeaf():FvAbstractTreeNodeFinds and returns the last leaf that is a descendant of this node -- either this node or its last child's last leaf. Returns this node if it is a leaf.
the last leaf in the subtree rooted at this node
public function getNextLeaf():FvAbstractTreeNodeReturns the leaf after this node or null if this node is the last leaf in the tree.
In this implementation of the MutableNode interface,
this operation is very inefficient. In order to determine the
next node, this method first performs a linear search in the
parent's child-list in order to find the current node.
That implementation makes the operation suitable for short
traversals from a known position. But to traverse all of the
leaves in the tree, you should use depthFirstEnumeration
to enumerate the nodes in the tree and use isLeaf
on each node to determine which are leaves.
returns the next leaf past this node
public function getPreviousLeaf():FvAbstractTreeNodeReturns the leaf before this node or null if this node is the first leaf in the tree.
In this implementation of the MutableNode interface,
this operation is very inefficient. In order to determine the
previous node, this method first performs a linear search in the
parent's child-list in order to find the current node.
That implementation makes the operation suitable for short
traversals from a known position. But to traverse all of the
leaves in the tree, you should use depthFirstEnumeration
to enumerate the nodes in the tree and use isLeaf
on each node to determine which are leaves.
returns the leaf before this node