Zimlet JavaScript API Reference - ZmTreeController

Class ZmTreeController


Extends ZmController.

This class is a base class for controllers for organizers. Those are represented by trees, both as data and visually. This class uses the support provided by ZmOperation. Each type of organizer has a singleton tree controller which manages all the tree views of that type.

Defined in: ZmTreeController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a tree controller.
Method Summary
Method Attributes Method Name and Description
 
clearTreeView(overviewId)
Clears the tree view for the given overview.
 
Dispose of this controller.
 
getDataTree(account)
Gets the data tree.
 
Gets the controller drop target.
 
getTreeView(overviewId, force)
Gets the tree view for the given overview.
 
show(params)
Displays the tree of this type.
 
Returns a string representation of the object.
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getTabGroup, getViewElements, handleKeyAction, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType, setSessionId
Class Detail
ZmTreeController(type)
Creates a tree controller.
Author: Conrad Damon.
Parameters:
{constant} type
the type of organizer we are displaying/controlling
Method Detail
clearTreeView(overviewId)
Clears the tree view for the given overview.
Parameters:
{constant} overviewId
the overview ID

dispose()
Dispose of this controller. Removes the tree change listener. called when ZmComposeController is disposed (new window). If the change listener stayed we would get exceptions since this window will no longer exist.

{Object} getDataTree(account)
Gets the data tree.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{Object} the data tree

{DwtDropTarget} getDropTarget()
Gets the controller drop target.
Returns:
{DwtDropTarget} the drop target

{ZmTreeView} getTreeView(overviewId, force)
Gets the tree view for the given overview.
Parameters:
{constant} overviewId
the overview ID
{Boolean} force
if true, force tree view creation
Returns:
{ZmTreeView} the tree view

show(params)
Displays the tree of this type.
Parameters:
{Hash} params
a hash of parameters
{constant} params.overviewId
the overview ID
{Boolean} params.showUnread
if true, unread counts will be shown
{Object} params.omit
a hash of organizer IDs to ignore
{Object} params.include
a hash of organizer IDs to include
{Boolean} params.forceCreate
if true, tree view will be created
{String} params.app
the app that owns the overview
{Boolean} params.hideEmpty
if true, don't show header if there is no data
{Boolean} params.noTooltips
if true, don't show tooltips for tree items

{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:37 GMT-0400 (EDT)