Zimlet JavaScript API Reference - ZmConvListController

Class ZmConvListController


Extends ZmDoublePaneController.

This class manages the conversations mail view. Conversations are listed, and any conversation with more than one message is expandable. Expanding a conversation shows its messages in the list just below it.

Defined in: ZmConvListController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmConvListController(container, mailApp, type, sessionId, searchResultsController)
Creates a new, empty conversation list controller.
Method Summary
Method Attributes Method Name and Description
 
getMsg(params)
Returns the first matching msg in the conv, if available.
 
popShield(viewId, callback, newViewId)
Figure out if the given view change is destructive.
 
show(searchResults, force)
Displays the given conversation list in a two-pane view.
 
switchView(view, force)
Handles switching the order of messages within expanded convs.
Methods borrowed from class ZmDoublePaneController:
getCurrentView, getItemView, reset
Methods borrowed from class ZmMailListController:
isReadingPaneOn, isReadingPaneOnRight, sendReadReceipt
Methods borrowed from class ZmListController:
getCurrentSearchResults, getItemCount, getItems, getList, getListView, getSearchString, getSearchStringHint, getTabGroup, handleKeyAction, isDraftsFolder, isOutboxFolder, isSyncFailuresFolder, setHasMore, setList
Methods borrowed from class ZmBaseController:
getCurrentToolbar, isCurrent, setSessionId
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getViewElements, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType
Class Detail
ZmConvListController(container, mailApp, type, sessionId, searchResultsController)
Creates a new, empty conversation list controller.
Author: Conrad Damon.
Parameters:
{DwtControl} container
the containing shell
{ZmApp} mailApp
the containing application
{constant} type
type of controller
{string} sessionId
the session id
{ZmSearchResultsController} searchResultsController
containing controller
Method Detail
getMsg(params)
Returns the first matching msg in the conv, if available. No request will be made to the server if the conv has not been loaded.
Parameters:
params

popShield(viewId, callback, newViewId)
Figure out if the given view change is destructive. If so, put up pop shield.
Parameters:
{string} viewId
ID of view being hidden
{function} callback
function to call if user agrees to leave
{string} newViewId
ID of view that will be shown

show(searchResults, force)
Displays the given conversation list in a two-pane view.
Parameters:
{ZmSearchResult} searchResults
the current search results
force

switchView(view, force)
Handles switching the order of messages within expanded convs.
Parameters:
view
[constant]* the id of the new order
force
[boolean] if true, always redraw view

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