Zimlet JavaScript API Reference - ZmTree

Class ZmTree


Extends ZmModel.

This class represents a tree.

Defined in: ZmTree.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmTree(type)
Creates the tree
Method Summary
Method Attributes Method Name and Description
 
asList(options)
Gets the tree as a list.
 
Gets this tree as a string.
 
getById(id)
Gets the item by id.
 
getByName(name)
Gets the item by name.
 
getByType(name)
Gets the item by type.
 
Gets the item type by name.
 
getUnreadHash(unread)
Gets the unread hash.
 
Resets the tree.
 
size()
Gets the size of the tree.
 
Returns a string representation of the object.
Methods borrowed from class ZmModel:
addChangeListener, removeAllChangeListeners, removeChangeListener
Class Detail
ZmTree(type)
Creates the tree
Parameters:
{constant} type
the type
Method Detail
{Array} asList(options)
Gets the tree as a list.
Parameters:
options
Returns:
{Array} an array

{String} asString()
Gets this tree as a string.
Returns:
{String} the tree

{Object} getById(id)
Gets the item by id.
Parameters:
{String} id
the id
Returns:
{Object} the item

{Object} getByName(name)
Gets the item by name.
Parameters:
{String} name
the name
Returns:
{Object} the item

{Object} getByType(name)
Gets the item by type.
Parameters:
{String} name
the type name
Returns:
{Object} the item

{String} getFolderTypeByName(name)
Gets the item type by name.
Parameters:
{String} name
the name
Returns:
{String} type of folder

{Hash} getUnreadHash(unread)
Gets the unread hash.
Parameters:
{Hash} unread
the unread hash
Returns:
{Hash} the unread tree as a hash

reset()
Resets the tree.

{int} size()
Gets the size of the tree.
Returns:
{int} the size

{String} toString()
Returns a string representation of the object.
Returns:
{String} a string representation of the object

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:39 GMT-0400 (EDT)