linb.UI.TreeBar

Direct Super Classes

linb.Base

linb.iBox

linb.iDataBinder

linb.UI

linb.UI.iList

linb.UI.iWidget

Events

afterCreated (profile)
Fired after component is created. At this time, component object has not been attached to DOM.
profile: UIProfile. See profile name.

afterRendered (profile)
Fired after component is rendered in DOM. At this time, component object has been attached to DOM.
profile: UIProfile. See profile name.

afterValueSet (profile, oldValue, newValue, showValue)
Fired after value is set. See Sigma Linb component value model.
profile: UIProfile. See profile name.
oldValue: Boolean. Value before setting.
newValue: Boolean. Value after setting.
showValue: Boolean. Presentation value.

afterValueUpdated (profile, oldValue, newValue, showValue)
Fired after value is uppadeted. See Sigma Linb component value model.
profile: UIProfile. See profile name.
oldValue: Boolean. Value before setting.
newValue: Boolean. Value after setting.
showValue: Boolean. Presentation value.

beforeClickEffect (profile, item, src, type)
When end uese is clicking this component, this component will high-light itself. This action is called clicking effect. Developer can change default effect in this event handler. If false returned, default effect will be disabled.
profile: UIProfile. See profile name.
item: Always be null.
src: DOM node. The DOM host of this event.
type: String. Could be "mousedown" or "mouseup".

beforeDestroy (profile)
Fired before component is destroyed.
profile: UIProfile. See profile name.

beforeHoverEffect (profile, item, src, type)
When mouse pointer is hovering over this component, this component will high-light itself. This action is called clicking effect. Developer can change default effect in this event handler. If false returned, default effect will be disabled.
profile: UIProfile. See profile name.
item: Always be null.
src: DOM node. The DOM host of this event.
type: String. Could be "mousedown" or "mouseup".

beforeNextFocus (profile, e, src)
Fired before next component gets focus.
profile: UIProfile. See profile name.
e: See event object.
src: DOM node. The DOM host of this event.

beforeValueSet (profile, oldValue, newValue, showValue)
Fired before value is set. See Sigma Linb component value model.
profile: UIProfile. See profile name.
oldValue: Boolean. Value before setting.
newValue: Boolean. Value after setting.
showValue: Boolean. Presentation value.

beforeValueUpdated (profile, oldValue, newValue, showValue)
Fired before value is updated. See Sigma Linb component value model.
profile: UIProfile. See profile name.
oldValue: Boolean. Value before setting.
newValue: Boolean. Value after setting.
showValue: Boolean. Presentation value.

onHotKeydown (profile, key, control, shift, alt, e, src)
Fired when key is down.
profile: UIProfile. See profile name.
key: String. Example - "a","b","c","enter","tab".
control: Boolean. True for user pressing Ctrl key , false for not.
shift: Boolean. True for user pressing Shift key , false for not.
alt: Boolean. True for user pressing Alt key , false for not.
e: See event object.
src: DOM node. Event host.

onHotKeypress (profile, key, control, shift, alt, e, src)
Fired when key is pressed.
profile: UIProfile. See profile name.
key: String. Example - "a","b","c","enter","tab".
control: Boolean. True for user pressing Ctrl key , false for not.
shift: Boolean. True for user pressing Shift key , false for not.
alt: Boolean. True for user pressing Alt key , false for not.
e: See event object.
src: DOM node. Event host.

onHotKeyup (profile, key, control, shift, alt, e, src)
Fired when key is up.
profile: UIProfile. See profile name.
key: String. Example - "a","b","c","enter","tab".
control: Boolean. True for user pressing Ctrl key , false for not.
shift: Boolean. True for user pressing Shift key , false for not.
alt: Boolean. True for user pressing Alt key , false for not.
e: See event object.
src: DOM node. Event host.

onItemSelected(profile, item, src)
Fired when list item is selected.
profile: UIProfile. See profile name.
item: Object. Item selected. Sample - {"id":"item a","caption":"item a","tips":"item a","icon":"img/demo.gif"}.
src: DOM node. The DOM host of this event.

onRequestData(profile, item, threadid)
Fired when tree is to request data from server. This is alway fired when user clicks plus in the front the node to see its sub-nodes.
profile: UIProfile. See profile name.
item: Node item.
thread id: Id of thread.

Instance Methods

clearItems()
Clear all the tree nodes

getDynBuild ( )
Determine whether children nodes are loaded dynamically or not.
returns: Boolean. true for dynamically false for not.

getGroup ( )
To determine whether nodes are displayed by groups.
returns: Boolean. True for showing by groups, false for not.

getItemByItemId (id)
Get node item by item id.
id: String. Item id.
returns: Tree node object.

getSelMode ( )
Get how many nodes can be selected at same time.
returns: string. Selection type. Could be "multi", "single","none".

getSingleOpen ( )
To determine whether only one node can be expand at one time.
returns: Boolean. If value is true, any other node will collapse when one node expands. If value is false, multi-node can expands at one time.

insertItems ( arr, pid, base, before )
Insert new node(s) to tree bar.
arr: node(s) data to be inserted.
pid:
base:
before:

moveItems ( ids, toPid )
Move nodes to be under another node.
ids: Array. Id array of nodes to be moved.
toPid: String. Parent id.

openToNode ( id )
Collapse parent nodes until node with id shows up.

selectItem ( id )
Select one node by its item id.
id: string. Item id of node to be selected.

setDynBuild ( value, flag )
Specify whether children nodes are loaded dynamically or not. Event onRequestData will be fired if setDynBuild(true).
value: Boolean. true for dynamically false for not.

setGroup ( value, flag )
To specify whether nodes are displayed by groups.
value: Boolean. True for showing by groups, false for not.

setItems(value)
Set tree nodes. Sample -
setItems([{"id":"a","caption":"itema","tips":"item a","sub":[{"id":"aa","caption":"suba"},{"id":"ab","caption":"subb"}]},{"id":"b","caption":"itemb","tips":"item b"},{"id":"c","caption":"itemc","tips":"item c"}])
value: object.

setSelMode ( value, flag )
Set how many nodes can be selected at same time.
value: string. Selection type. Could be "multi", "single","none"

setSingleOpen ( value, flag )
To specify whether only one node can be expand at one time.
value: Boolean. If value is true, any other node will collapse when one node expands. If value is false, multi-node can expands at one time.

setValue ( value, flag )
To set value.
value: Any.

toggleNode ( id, flag, recursive )
To expand or collapse node with specific id.
id. String. Id of node to be expanded or collapsed.
flag. Boolean. True for expanding, false for collapsing.
recursive. Boolean. True for collapsing or expanding recursively, false for not.

toggleNodes ( items, flag, recursive )
To expand or collapse specific nodes.
items. Array. Array of nodes to be expanded or collapsed.
flag. Boolean. True for expanding, false for collapsing.
recursive. Boolean. True for collapsing or expanding recursively, false for not.

updateItem ( id, name, value )
Update tree node's name and value by tree node id.