Zimlet JavaScript API Reference - ZmDoublePaneController

Class ZmDoublePaneController


Extends ZmMailListController.

This class manages the two-pane view. The top pane contains a list view of items, and the bottom pane contains the selected item content.

Defined in: ZmDoublePaneController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmDoublePaneController(container, mailApp, type, sessionId, searchResultsController)
Creates a new, empty double pane controller.
Method Summary
Method Attributes Method Name and Description
 
Returns the double-pane view.
 
Returns the item view.
 
Clears the conversation view, which actually just clears the message view.
 
show(results, mailList, callback, markRead)
Displays the given list of mail items in a two-pane view where one pane shows the list and the other shows the currently selected mail item (msg or conv).
Methods borrowed from class ZmMailListController:
getMsg, isReadingPaneOn, isReadingPaneOnRight, sendReadReceipt, switchView
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
ZmDoublePaneController(container, mailApp, type, sessionId, searchResultsController)
Creates a new, empty double pane controller.
Author: Parag Shah.
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
{ZmDoublePaneView} getCurrentView()
Returns the double-pane view.
Returns:
{ZmDoublePaneView} double-pane view

{ZmMailItemView} getItemView()
Returns the item view.
Returns:
{ZmMailItemView} item view

reset()
Clears the conversation view, which actually just clears the message view.

show(results, mailList, callback, markRead)
Displays the given list of mail items in a two-pane view where one pane shows the list and the other shows the currently selected mail item (msg or conv). This method takes care of displaying the list. Displaying an item is typically handled via selection.
Parameters:
{ZmSearchResults} results
the current search results
{ZmMailList} mailList
list of mail items
{AjxCallback} callback
the client callback
{Boolean} markRead
if true, mark msg read

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