Zimlet JavaScript API Reference - ZmOverviewContainer

Class ZmOverviewContainer


Creates a header tree item for an account if mailbox has multiple accounts configured. For each account header, a ZmOverview is added a child. If mailbox only has one account configured, no account header is created and the ZmOverview is added as a child of the container.

Defined in: ZmOverviewContainer.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates an overview container.
Method Summary
Method Attributes Method Name and Description
 
deselectAll(exception)
Deselects all tree views for each overview in this container
 
Gets the header item.
 
getOverview(overviewId)
Gets the overview.
 
Gets the overviews.
 
Gets the selected overview.
 
initialize(params)
Initializes the overview container.
 
resetOperations(parent, acctId)
Resets the operations.
 
Sets the overview trees.
Class Detail
ZmOverviewContainer(params)
Creates an overview container.
Author: Parag Shah.
Parameters:
{Hash} params
a hash of parameters
Method Detail
deselectAll(exception)
Deselects all tree views for each overview in this container
Parameters:
exception
[ZmOverview]* If set, this overview is skipped during deselection

getHeaderItem()
Gets the header item.

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

{Array} getOverviews()
Gets the overviews.
Returns:
{Array} an array of {ZmOverview} objects

{ZmOverview} getSelected()
Gets the selected overview.
Returns:
{ZmOverview} the overview

initialize(params)
Initializes the overview container.
Parameters:
{Hash} params
a hash of parameters

resetOperations(parent, acctId)
Resets the operations.
Parameters:
parent
acctId

setOverviewTrees(treeIds)
Sets the overview trees.
Parameters:
{Array} treeIds
an array of tree ids

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