Class Index | File Index

Classes


Class upTreeControl


Extends upContainer.
Tree Control
Defined in: <treecontrol.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
addListener(p_strEventName, p_Listener, p_strKey)
Registers a callback for a particular event
 
canDeleteItem(p_strKey)
Check if item with given key can be deleted
 
canInsertArticle(p_strKey)
Check if item with given key can create new article
 
canModifyItem(p_strKey)
Check if item with given key can be modified
 
Close all expanded items
 
deleteItem(p_strKey)
Delete tree item with given key
 
getItemById(p_strId)
Get tree item with given item id (record id)
 
getItemByTreeId(p_strTreeId)
Get tree item with given item tree id
 
getItems(p_strKey)
 
Returns currently selected item
 
loadSubTree(p_oOption, p_bAsync, p_Callback)
Reload Subtree via xmlHttp
 
Expand all (loaded) tree items
 
reload(p_bAsync, p_oRqParams)
Reload tree control via xmlHttp
 
reset(p_bTriggerChange)
Reset selected tree items
 
selectItem(p_strKey)
Methods borrowed from class upContainer:
serializeArray, validatePattern, validateRequired, validateValue
Class Detail
upTreeControl()
Method Detail
{string} addListener(p_strEventName, p_Listener, p_strKey)
Registers a callback for a particular event
Parameters:
p_strEventName
{string} event name
p_Listener
{function} Callback function
p_strKey
Returns:
{string} event key or NULL

{boolean} canDeleteItem(p_strKey)
Check if item with given key can be deleted
Parameters:
p_strKey
{string} tree item key
Returns:
{boolean}

{boolean} canInsertArticle(p_strKey)
Check if item with given key can create new article
Parameters:
p_strKey
{string} tree item key
Returns:
{boolean}

{boolean} canModifyItem(p_strKey)
Check if item with given key can be modified
Parameters:
p_strKey
{string} tree item key
Returns:
{boolean}

closeAll()
Close all expanded items

{boolean} deleteItem(p_strKey)
Delete tree item with given key
Parameters:
p_strKey
{string} tree item key
Returns:
{boolean} successful

{upGroovySelectOption} getItemById(p_strId)
Get tree item with given item id (record id)
Parameters:
p_strId
Returns:
{upGroovySelectOption} tree item, if not found false

{upGroovySelectOption} getItemByTreeId(p_strTreeId)
Get tree item with given item tree id
Parameters:
p_strTreeId
Returns:
{upGroovySelectOption} tree item, if not found false

{Array} getItems(p_strKey)
Parameters:
p_strKey
Returns:
{Array} top-level items upGroovySelectOption

{upGroovySelectOption} getSelectedItem()
Returns currently selected item
Returns:
{upGroovySelectOption} item

loadSubTree(p_oOption, p_bAsync, p_Callback)
Reload Subtree via xmlHttp
Parameters:
p_oOption
{object} tree item
p_bAsync
{boolean} load asynchronous or synchron
p_Callback
{function} Callback function

openAll()
Expand all (loaded) tree items

reload(p_bAsync, p_oRqParams)
Reload tree control via xmlHttp
Parameters:
p_bAsync
p_oRqParams

reset(p_bTriggerChange)
Reset selected tree items
Parameters:
p_bTriggerChange

selectItem(p_strKey)
Parameters:
p_strKey
{string} tree item key

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Nov 23 2012 12:16:41 GMT+0100 (MEZ)