Zimlet JavaScript API Reference - ZmBriefcaseController

Class ZmBriefcaseController


Extends ZmListController.

This class represents the briefcase controller for the content view used by the briefcase application.

Defined in: ZmBriefcaseController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmBriefcaseController(container, app, type, sessionId, searchResultsController)
Creates the briefcase controller.
Method Summary
Method Attributes Method Name and Description
 
Checks if the reading pane is "on".
 
Checks if the reading pane is "on" right.
 
show(results)
Shows the search results.
 
switchView(view, force)
Change how briefcase items are displayed.
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, getCurrentView, getItemView, isCurrent, setSessionId
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getViewElements, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType
Class Detail
ZmBriefcaseController(container, app, type, sessionId, searchResultsController)
Creates the briefcase controller.
Author: Parag Shah.
Parameters:
{DwtControl} container
the containing shell
{ZmApp} app
the containing application
{constant} type
type of controller
{string} sessionId
the session id
{ZmSearchResultsController} searchResultsController
containing controller
Method Detail
{Boolean} isReadingPaneOn()
Checks if the reading pane is "on".
Returns:
{Boolean} true if the reading pane is "on"

{Boolean} isReadingPaneOnRight()
Checks if the reading pane is "on" right.
Returns:
{Boolean} true if the reading pane is "on" right.

show(results)
Shows the search results.
Parameters:
{Object} results
the search results

switchView(view, force)
Change how briefcase items are displayed.
Parameters:
{constant} view
the view to show
{Boolean} force
if true, render view even if it's the current view

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