Zimlet JavaScript API Reference - ZmOverviewController

Class ZmOverviewController


Extends ZmController.

This singleton class manages overviews, each of which has a unique ID.

Defined in: ZmOverviewController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates an overview as a set of tree views.
Method Summary
Method Attributes Method Name and Description
 
Creates a new overview with the given options.
 
createOverviewContainer(containerParams, overviewParams)
Creates a new overview container with the given options.
 
getOverview(overviewId)
Gets the overview with the given id.
 
getOverviewContainer(containerId)
Gets the overview container for the given app.
 
getTreeController(treeId, noCreate)
Gets the tree controller.
 
getTreeData(treeId)
Gets the tree data for the given organizer type.
 
getTreeView(overviewId, treeId)
Gets the tree view in the given overview.
 
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
ZmOverviewController(container)
Creates an overview as a set of tree views. When the overview is created, various characteristics of its tree views can be provided. Each type of tree view has a corresponding tree controller (also a singleton), which is lazily created.
Author: Conrad Damon.
Parameters:
{DwtControl} container
the top-level container
Method Detail
createOverview(params)
Creates a new overview with the given options.
Parameters:
{Hash} params
a hash of params (see ZmOverview)

createOverviewContainer(containerParams, overviewParams)
Creates a new overview container with the given options. Used when mailbox has multiple accounts.
Parameters:
{Hash} containerParams
a hash of params (see ZmOverviewContainer)
{Hash} overviewParams
a hash of params (see ZmOverview)

{ZmOverview} getOverview(overviewId)
Gets the overview with the given id.
Parameters:
{String} overviewId
the overview id
Returns:
{ZmOverview} the overview

{ZmOverviewContainer} getOverviewContainer(containerId)
Gets the overview container for the given app.
Parameters:
{String} containerId
the container ID (defaults to current app name)
Returns:
{ZmOverviewContainer} the container

{ZmTreeController} getTreeController(treeId, noCreate)
Gets the tree controller.
Parameters:
{String} treeId
the tree id
{Boolean} noCreate
if true, only return an already created controller
Returns:
{ZmTreeController} the tree controller

{ZmTree} getTreeData(treeId)
Gets the tree data for the given organizer type.
Parameters:
{String} treeId
the tree id
Returns:
{ZmTree} the tree

{ZmTreeView} getTreeView(overviewId, treeId)
Gets the tree view in the given overview.
Parameters:
{String} overviewId
the overview id
{String} treeId
the organizer type
Returns:
{ZmTreeView} the tree view or null if not found

{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)