Default model to use with FvTree component.
Extends fvaswing.components.FvAbstractTreeModel class to deploy strong typing strategy.
Allow childnodes sorting.
new FvTreeModel()public function FvTreeModel(root:FvTreeNode, asc:Boolean)Creates a tree specifying whether any node can have children, or whether only certain nodes can have children.
root | a TreeNode object that is the root of the tree |
asc | (optional)a boolean, false if any node can have children, true if each node is asked to see if it can have children. Default is false. |
public function getRoot():FvTreeNodeReturns the root of the tree. Returns null only if the tree has no nodes.
the root of the tree
public function getNodeById(nodeID:Number):FvTreeNode
Returns tree node resgitred with passed-in nodeID in
current tree.
If not, return null
public function valueForPathChanged(path:TreePath, newValue):VoidThis sets the user object of the TreeNode identified by path and posts a node changed.
If you use custom user objects in the TreeModel you're going to need to subclass this and set the user object of the changed node to something meaningful.
public function getIndexOfChild(parent:FvTreeNode, child:FvTreeNode):Number
Returns the index of child in parent.
If either the parent or child is null, returns -1.
parent | a note in the tree, obtained from this data source |
child | the node we are interested in |
the index of the child in the parent, or -1
if either the parent or the child is null
getIndexOfChild() in fvaswing.components.tree.FvAbstractTreeModel
public function getChild(parent:FvTreeNode, index:Number):FvTreeNodeReturns the child of parent at index index in the parent's child array. parent must be a node previously obtained from this data source. This should not return null if index is a valid index for parent (that is index >= 0 && index < getChildCount(parent)).
parent | a node in the tree, obtained from this data source |
the child of parent at index index
public function getChildCount(parent:FvTreeNode):NumberReturns the number of children of parent. Returns 0 if the node is a leaf or if it has no children. parent must be a node previously obtained from this data source.
parent | a node in the tree, obtained from this data source |
the number of children of the node parent
getChildCount() in fvaswing.components.tree.FvAbstractTreeModel
public function isLeaf(node:FvTreeNode):Boolean
Returns whether the specified node is a leaf node.
The way the test is performed depends on the
askAllowsChildren setting.
node | the node to check |
true if the node is a leaf node
public function insertNodeInto(newChild:FvTreeNode, parent:FvTreeNode, index:Number):VoidInvoked this to insert newChild at location index in parents children.
This will then message nodesWereInserted to create the appropriate event.
This is the preferred way to add children as it will create the appropriate event.
public function removeNodeFromParent(node:FvTreeNode):VoidMessage this to remove node from its parent. This will message nodesWereRemoved to create the appropriate event. This is the preferred way to remove a node as it handles the event creation for you.
public function nodeChanged(node:FvTreeNode):VoidInvoke this method after you've changed how node is to be represented in the tree.
public function reload(node:FvTreeNode):Void
Invoke this method if you've modified the TreeNodes upon which this
model depends. The model will notify all of its listeners that the
model has changed below the node node (PENDING).
node | (optional). Default is root. |
public function nodesWereInserted(node:FvTreeNode, childIndices:Array):VoidInvoke this method after you've inserted some TreeNodes into node. childIndices should be the index of the new elements and must be sorted in ascending order.
public function nodesWereRemoved(node:FvTreeNode, childIndices:Array, removedChildren:Array):VoidInvoke this method after you've removed some TreeNodes from node. childIndices should be the index of the removed elements and must be sorted in ascending order. And removedChildren should be the array of the children objects that were removed.
public function nodesChanged(node:FvTreeNode, childIndices:Array):VoidInvoke this method after you've changed how the children identified by childIndicies are to be represented in the tree.
public function nodeStructureChanged(node:FvTreeNode):VoidInvoke this method if you've totally changed the children of node and its childrens children.
This will post a treeStructureChanged event.