Zimlet JavaScript API Reference - ZmContactListController

Class ZmContactListController


Extends ZmListController.

This class manages list views of contacts. So far there are two different list views, one that shows the contacts in a traditional list format, and the other which shows them as business cards. Since there are two views, we need to keep track of which is the current view.

Defined in: ZmContactListController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmContactListController(container, app, type, sessionId, searchResultsController)
Creates an empty contact list controller.
Method Summary
Method Attributes Method Name and Description
 
Returns the split view.
 
Gets the folder id.
 
Checks if the search is a GAL search.
 
searchAlphabet(letter, endLetter)
Search the alphabet.
 
show(searchResult, isGalSearch, folderId)
Shows the search results.
 
switchView(view, force, initialized, stageView)
Change how contacts 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, getItemView, isCurrent, setSessionId
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getViewElements, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType
Class Detail
ZmContactListController(container, app, type, sessionId, searchResultsController)
Creates an empty contact list controller.
Author: Roland Schemers, Conrad Damon.
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
{ZmContactSplitView} getCurrentView()
Returns the split view.
Returns:
{ZmContactSplitView} the split view

{String} getFolderId()
Gets the folder id.
Returns:
{String} the folder id

{Boolean} isGalSearch()
Checks if the search is a GAL search.
Returns:
{Boolean} true if GAL search

searchAlphabet(letter, endLetter)
Search the alphabet.
Parameters:
{String} letter
the letter
{String} endLetter
the end letter

show(searchResult, isGalSearch, folderId)
Shows the search results.
Parameters:
{Object} searchResult
the search results
{Boolean} isGalSearch
true if results from GAL search
{String} folderId
the folder id

switchView(view, force, initialized, stageView)
Change how contacts are displayed. There are two views: the "simple" view shows a list of contacts on the left and the selected contact on the right; the "cards" view shows contacts as business cards.
Parameters:
{constant} view
the view to show
{Boolean} force
if true, render view even if it's the current view
{Boolean} initialized
if true, app has been initialized
{Boolean} stageView
if true, stage the view but don't push it

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