Zimlet JavaScript API Reference - ZmSearchTreeController

Class ZmSearchTreeController


Extends ZmFolderTreeController.

This class controls a tree display of saved searches.

Defined in: ZmSearchTreeController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a search tree controller.
Method Summary
Method Attributes Method Name and Description
 
Gets the tree style.
 
resetOperations(parent, type, id)
Resets and enables/disables operations based on context.
 
show(params)
Shows the tree of this type.
Methods borrowed from class ZmTreeController:
clearTreeView, dispose, getDataTree, getDropTarget, getTreeView, toString
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getTabGroup, getViewElements, handleKeyAction, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType, setSessionId
Class Detail
ZmSearchTreeController()
Creates a search tree controller.
Author: Conrad Damon.
Method Detail
{Object} getTreeStyle()
Gets the tree style.
Returns:
{Object} the tree style or null if not set

resetOperations(parent, type, id)
Resets and enables/disables operations based on context.
Parameters:
{ZmControl} parent
the widget that contains the operations
{constant} type
the type
{String} id
the currently selected/activated organizer

show(params)
Shows the tree of this type.
Parameters:
{Hash} params
a hash of parameters
{String} params.overviewId
the overview ID
{Boolean} params.showUnread
if true, unread counts will be shown
{Array} params.omit
a hash of organizer IDs to ignore
{Boolean} params.forceCreate
if true, tree view will be created
{ZmZimbraAccount} params.account
the account to show tree for (if not currently active account)

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