Zimlet JavaScript API Reference - ZmSearchResultsController

Class ZmSearchResultsController


Extends ZmController.

This controller is used to display the results of a user-initiated search. The results are displayed in a tab which has three parts: a search bar at the top that can be used to modify the search, a filtering mechanism on the left that can be used to refine the search, and the results themselves. The results may be of any type: messages, contacts, etc.

Defined in: ZmSearchResultsController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmSearchResultsController(container, app, type, sessionId)
Method Summary
Method Attributes Method Name and Description
 
show(results, resultsCtlr)
Displays the given results in a search tab managed by this controller.
 
Shows the overview or the filter panel, and the mini-calendar.
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getTabGroup, getViewElements, handleKeyAction, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType, setSessionId
Class Detail
ZmSearchResultsController(container, app, type, sessionId)
Parameters:
{DwtShell} container
the application container
{ZmApp} app
the application
{constant} type
type of controller
{string} sessionId
the session id
Method Detail
show(results, resultsCtlr)
Displays the given results in a search tab managed by this controller.
Parameters:
{ZmSearchResults} results
search results
resultsCtlr

showOverview(show)
Shows the overview or the filter panel, and the mini-calendar. The overview is shown during a DnD operation.
Parameters:
{Boolean} show
if true, show the overview; if false, show the filter panel

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