OmniOutliner: TreeNode

TreeNode

According to Wikipedia a “tree” is a widely used abstract data type that simulates a hierarchical tree structure, with a root value and subtrees of children with a parent node, represented as a set of linked nodes. A TreeNode is one element in the chain of nodes that make up a tree.

Some of the terms used by both the TreeNode and Item classes incorporate terms that define hierarchical human relationships mixed with those terms defining the elements of actual trees. Here is a list of common terms used by both classes:

Root • The top node in a tree.
Child • A node directly connected to another node when moving away from the Root.
Parent • The converse notion of a child.
Siblings • A group of nodes with the same parent.
Descendant • A node reachable by repeated proceeding from parent to child.
Ancestor • A node reachable by repeated proceeding from child to parent.
Leaf • A node with no children.

However, in terms of Omni Automation and OmniOutliner, a TreeNode represents a row in an OmniOutliner outline document. The following documentation describes the properties and functions of the TreeNode class.

TreeNode Properties

Here are the properties of an instance of the TreeNode class:

canCollapse (boolean r/o) • Returns true if this TreeNode can be collapsed.
canExpand (boolean r/o) • Returns true if this TreeNode can be expanded.
children (TreeNodes r/o) • Returns the array of children that are visible under this node, according to any filtering that is being done, and in the order specified by any sorting rules that have been established.
index (Number r/o) • Returns the index of this TreeNode among its siblings, or zero for the rootNode.
isExpanded (boolean r/o) • Returns true if this TreeNode is currently expanded.
isNoteExpanded (boolean r/o) • Returns true if the note of this TreeNode is currently expanded.
isRevealed (boolean r/o) • Returns true if the TreeNode is the rootNode or all of its ancestor nodes are expanded.
isRootNode (boolean r/o) • Returns true if this node is the rootNode of its tree.
isSelectable (boolean r/o) • Returns true if this TreeNode can be selected. The rootNode cannot be selected, nor can nodes that aren’t revealed.
isSelected (boolean) • Set to true if this TreeNode is in the list of selected nodes for its tree. Attempting to set this to true will do nothing if the node is not revealed (or is the root node).
level (Number r/o) • Returns the nesting level of the TreeNode, relative to the root of the tree. The rootNode of an Outline has level zero, its children have level one, and so on. Note that if only a portion of the model is being shown, this level may not match the level of the underlying object.
object (Object r/o) • The model object (Item) which this node wraps.
parent (TreeNode or nil r/o) • Returns the TreeNode that contains this node, or null if this is the rootNode.
rootNode (TreeNode r/o) • Returns the root TreeNode for the tree that this node belongs to.

TreeNode Functions

Here are the methods used with an instance of the TreeNode class:

expand(completely:Boolean or nil) • Attempts to expand the TreeNode. If the value of the completely parameter is true, then all the child nodes will be expanded as they allow.
collapse(completely:Boolean or nil) • Attempts to collapse the TreeNode. If completely is passed, all the child nodes will be collapse as they allow.
expandNote(completely:Boolean or nil) • Attempts to expand the inline note of the TreeNode. If completely is passed, all the child node notes will be expanded.
collapseNote(completely:Boolean or nil) • Attempts to collapse the inline note of the TreeNode. If completely is passed, all the child node notes will be collapsed.
nodeForObject(object:Object) (TreeNode or null) • Returns the TreeNode that represents the object in this Tree, or null if it cannot be found (possibly filtered out).
nodesForObjects(object:Array of Object) (Array of TreeNode) • Returns an array of TreeNodes for the objects that are currently in the Tree, according to the same filters as nodeForObject(). The size of the resulting node array may be smaller (even empty) than the passed in objects array.
reveal() • Expands all the ancestors
apply(Function) • Calls the supplied function for each TreeNode in the receiver (including the receiver), passing that node as the single argument.

Here’s how to convert an item (row) reference into a node reference:

var row = rootItem.children[0] var editor = document.editors[0] var node = editor.nodeForObject(row)

Node for Item

var row = rootItem.children[0]

var editor = document.editors[0]

var node = editor.nodeForObject(row)

Here are two scripts that use the rootNode property of the Editor class to expand or collapse the top-level items in an outline:

var editor = document.editors[0] editor.rootNode.children.forEach(function(node){ if(node.canExpand){node.expand()} })

omnioutliner:///omnijs-run?script=editor%20%3D%20document%2Eeditors%5B0%5D%0Aeditor%2ErootNode%2Echildren%2EforEach%28function%28node%29%7B%0A%09if%28node%2EcanExpand%29%7Bnode%2Eexpand%28%29%7D%0A%7D%29

Expand Top-Level Items

var editor = document.editors[0]

editor.rootNode.children.forEach(function(node){

if(node.canExpand){node.expand()}

})

var editor = document.editors[0] editor.rootNode.children.forEach(function(node){ if(node.canCollapse){node.collapse()} })

Collapse Top-Level Items

var editor = document.editors[0]

editor.rootNode.children.forEach(function(node){

if(node.canCollapse){node.collapse()}

})

To completely expand the top-level items, including their children, pass a boolean value of true into the expand() function:

var editor = document.editors[0] editor.rootNode.children.forEach(function(node){ if(node.canExpand){node.expand(true)} })

Expand Top-Level Items

var editor = document.editors[0]

editor.rootNode.children.forEach(function(node){

if(node.canExpand){node.expand(true)}

})

ItemTreeNode

An ItemTreeNode is an instance of the TreeNode class. The ItemTreeNode class is designed to serve as an mechanism for retrieving and setting the values for the state property and the contents of columns, providing parity with the functionality of the Item class.

Here are the properties of an instance of the ItemTreeNode class:

state (State or nil) • The computed status value for this node (which maps to the Outline’s statusColumn). Setting the state on a parent node will propagate the state down to the children, skipping any children that have their state disabled by having a null applied locally.

The properties of the State class are used as the value for the state property of the ItemTreeNode class:

Checked • The checkbox value is checked.
Mixed • The checkbox value has a mixed state, due to child items having a combination of Checked and Unchecked states.
Unchecked • The checkbox value is not checked.

var node = document.editors[0].selectedNodes[0] if(node.state === State.Checked){ var message = "Selected row status is checked." } else if (node.state === State.Mixed){ var message = "Selected row status is mixed." } else { var message = "Selected row status is unchecked." } new Alert('STATUS',message).show()

omnioutliner:///omnijs-run?script=node%20%3D%20document%2Eeditors%5B0%5D%2EselectedNodes%5B0%5D%0Aif%28node%2Estate%20%3D%3D%3D%20State%2EChecked%29%7B%0A%09message%20%3D%20%22Selected%20row%20status%20is%20checked%2E%22%0A%7D%20else%20if%20%28node%2Estate%20%3D%3D%3D%20State%2EMixed%29%7B%0A%09message%20%3D%20%22Selected%20row%20status%20is%20mixed%2E%22%0A%7D%20else%20%7B%0A%09message%20%3D%20%22Selected%20row%20status%20is%20unchecked%2E%22%0A%7D%0Anew%20Alert%28%27STATUS%27%2Cmessage%29%2Eshow%28function%28result%29%7B%7D%29

State of Selected Item

var node = document.editors[0].selectedNodes[0]

if(node.state == State.Checked){

var message = "Selected row status is checked."

} else if (node.state == State.Mixed){

var message = "Selected row status is mixed."

} else {

var message = "Selected row status is unchecked."

}

new Alert('STATUS',message).show()

Here are the methods used with an instance of the ItemTreeNode class:

setValueForColumn(value:Object or nil, column:Column) • This method is used to set the value of the specified column to the provided value.
valueForColumn(column:Column) --> Object or nil • This method is used to get the value of the specified column.

An example script using the Editor’s selection property to get the topic text of the first selected node:

var editor = document.editors[0] var topicColumn = document.outline.outlineColumn var node = editor.selection.nodes[0] if(node){ var topic = node.valueForColumn(topicColumn) var topicStr = (topic === null) ? '':topic.string console.log(topicStr) }

omnioutliner://localhost/omnijs-run?script=try%7Bvar%20editor%20%3D%20document%2Eeditors%5B0%5D%0Avar%20topicColumn%20%3D%20document%2Eoutline%2EoutlineColumn%0Avar%20node%20%3D%20editor%2Eselection%2Enodes%5B0%5D%0Aif%28node%29%7B%0A%09var%20topic%20%3D%20node%2EvalueForColumn%28topicColumn%29%0A%09var%20topicStr%20%3D%20%28topic%20%3D%3D%3D%20null%29%20%3F%20%27%27%3Atopic%2Estring%0A%09console%2Elog%28topicStr%29%0A%7D%7Dcatch%28err%29%7Bconsole%2Elog%28err%29%7D

Get Topic for Selected Node

var editor = document.editors[0]

var topicColumn = document.outline.outlineColumn

var node = editor.selection.nodes[0]

if(node){

var topic = node.valueForColumn(topicColumn)

var topicStr = (topic === null) ? '':topic.string

console.log(topicStr)

}

An example script using the Editor’s selectedNodes property to get the topic text of the first selected node:

var editor = document.editors[0] var topicColumn = document.outline.outlineColumn var node = editor.selectedNodes[0] if(node){ var topic = node.valueForColumn(topicColumn) var topicStr = (topic === null) ? '':topic.string console.log(topicStr) }

omnioutliner://localhost/omnijs-run?script=try%7Bvar%20editor%20%3D%20document%2Eeditors%5B0%5D%0Avar%20topicColumn%20%3D%20document%2Eoutline%2EoutlineColumn%0Avar%20node%20%3D%20editor%2EselectedNodes%5B0%5D%0Aif%28node%29%7B%0A%09var%20topic%20%3D%20node%2EvalueForColumn%28topicColumn%29%0A%09var%20topicStr%20%3D%20%28topic%20%3D%3D%3D%20null%29%20%3F%20%27%27%3Atopic%2Estring%0A%09console%2Elog%28topicStr%29%0A%7D%7Dcatch%28err%29%7Bconsole%2Elog%28err%29%7D

Get Topic for Selected Node

var editor = document.editors[0]

var topicColumn = document.outline.outlineColumn

var node = editor.selectedNodes[0]

if(node){

var topic = node.valueForColumn(topicColumn)

var topicStr = (topic === null) ? '':topic.string

console.log(topicStr)

}

An example script for appending to the note of the first selected node:

var editor = document.editors[0] var notesColumn = document.outline.noteColumn var node = editor.selection.nodes[0] if(node){ var note = node.valueForColumn(notesColumn) if (note === null){ var newNote = "How now brown cow." } else { var newNote = note.string + " " + "How now brown cow." } node.setValueForColumn(newNote, notesColumn) }

omnioutliner://localhost/omnijs-run?script=try%7Bvar%20editor%20%3D%20document%2Eeditors%5B0%5D%0Avar%20notesColumn%20%3D%20document%2Eoutline%2EnoteColumn%0Avar%20node%20%3D%20editor%2Eselection%2Enodes%5B0%5D%0Aif%28node%29%7B%0A%09var%20note%20%3D%20node%2EvalueForColumn%28notesColumn%29%0A%09if%20%28note%20%3D%3D%3D%20null%29%7B%0A%09%09newNote%20%3D%20%22How%20now%20brown%20cow%2E%22%0A%09%7D%20else%20%7B%0A%09%09newNote%20%3D%20note%2Estring%20%2B%20%22%20%22%20%2B%20%22How%20now%20brown%20cow%2E%22%0A%09%7D%0A%09node%2EsetValueForColumn%28newNote%2C%20notesColumn%29%0A%7D%7Dcatch%28err%29%7Bconsole%2Elog%28err%29%7D

Append to Note of Selected Row

var editor = document.editors[0]

var notesColumn = document.outline.noteColumn

var node = editor.selection.nodes[0]

if(node){

var note = node.valueForColumn(notesColumn)

if (note === null){

var newNote = "How now brown cow."

} else {

var newNote = note.string + " " + "How now brown cow."

}

node.setValueForColumn(newNote, notesColumn)

}

UNDER CONSTRUCTION

This webpage is in the process of being developed. Any content may change and may not be accurate or complete at this time.

DISCLAIMER

Mention of third-party websites and products is for informational purposes only and constitutes neither an endorsement nor a recommendation. OMNI-AUTOMATION.COM assumes no responsibility with regard to the selection, performance or use of information or products found at third-party websites. OMNI-AUTOMATION.COM provides this only as a convenience to our users. OMNI-AUTOMATION.COM has not tested the information found on these sites and makes no representations regarding its accuracy or reliability. There are risks inherent in the use of any information or products found on the Internet, and OMNI-AUTOMATION.COM assumes no responsibility in this regard. Please understand that a third-party site is independent from OMNI-AUTOMATION.COM and that OMNI-AUTOMATION.COM has no control over the content on that website. Please contact the vendor for additional information.