Class CAF.Tree.Row.Model

Object
   |
   +--CAF.Select.Item.Model
         |
         +--CAF.Table.Row.Model
               |
               +--CAF.Tree.Row.Model

class CAF.Tree.Row.Model

extends CAF.Table.Row.Model

CAF Tree.Row client-side model.
Defined in tree.js

Field Detail

classes

Object classes

CAF.Tree.Row.Model

CAF.Tree.Row.Model()

addChild

Object addChild(index, child)

Adds child to this node.

Parameters:
index - (optional) Zero-based item index. Less than zero signals add to end.
child - CAF.Tree.Row.Model or array of CAF.Tree.Row.Models.

getChildren

Object getChildren()

Array of this node's children, in order. Empty array if has no children.

getDepth

Object getDepth()

Depth of this node; roots have depth 0.

getHasChildren

void getHasChildren()

True if node has children.

getLastChildAncestors

Object getLastChildAncestors()

Array of the lastChild value for each of this node's ancestors, from the root to this node's parent. Empty array if this node is a root.

getParent

Object getParent()

Parent of this node. Null if this node is a root.

initialize

void initialize(id, values, description, disabled, style, styleClass)

Initializer.

Parameters:
id - Row id or element.
values - Values object (map of control ids to control model values).
description - (optional) Extended description.
disabled - (optional) True if item is disabled.
style - (optional) HTML "style" attribute value.
styleClass - (optional) HTML "class" attribute value.

isFirstChild

void isFirstChild()

True if this node is the first child of its parent. If this node is a root, true if it is the first root.

isLastChild

void isLastChild()

True if this node is the last child of its parent. If this node is a root, true if it is the last root.

isLoaded

void isLoaded()

True if this node has been loaded.

isOpen

void isOpen()

True if node is expanded.

isVisible

Object isVisible()

Returns true if this control is visible.

Returns:
true if this control is visible.

removeChild

Object removeChild(child)

Removes child from this node.

Parameters:
child - Zero-based item index or value or existing CAF.Tree.Row.Model, or array of indicies, values, or CAF.Tree.Row.Models.

Returns:
Old CAF.Tree.Row.Models, or null if all indicies out of range or no items found.

setOpen

void setOpen(open)

Expands or collapses this node.

Parameters:
open - (optional) True to expand, false to collapse. Defaults to true if collapsed, false if expandeded.