Zimlet JavaScript API Reference - ZmCalendarTreeController

Class ZmCalendarTreeController


Extends ZmTreeController.

This class manages the calendar tree controller.

Defined in: ZmCalendarTreeController.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a calendar tree controller.
Method Summary
Method Attributes Method Name and Description
 
getCalendars(overviewId, includeTrash)
Gets all calendars.
 
getOwnedCalendars(overviewId, owner)
Gets the owned calendars.
 
show(params)
Displays the tree of this type.
Methods borrowed from class ZmTreeController:
clearTreeView, dispose, getDataTree, getDropTarget, getTreeView, toString
Methods borrowed from class ZmController:
getApp, getCurrentViewId, getCurrentViewType, getKeyMapName, getNewFolderCallback, getSessionId, getTabGroup, getViewElements, handleKeyAction, isTransient, mapSupported, popupErrorDialog, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType, setSessionId
Class Detail
ZmCalendarTreeController()
Creates a calendar tree controller.
Author: Parag Shah.
Method Detail
{Array} getCalendars(overviewId, includeTrash)
Gets all calendars.
Parameters:
{String} overviewId
the overview id
{boolean} includeTrash
True to include trash, if checked.
Returns:
{Array} an array of ZmCalendar objects

{Array} getOwnedCalendars(overviewId, owner)
Gets the owned calendars.
Parameters:
{String} overviewId
the overview id
{String} owner
the owner
Returns:
{Array} an array of ZmCalendar objects

show(params)
Displays the tree of this type.
Parameters:
{Hash} params
a hash of parameters
{constant} params.overviewId
the overview ID
{Boolean} params.showUnread
if true, unread counts will be shown
{Object} params.omit
a hash of organizer IDs to ignore
{Object} params.include
a hash of organizer IDs to include
{Boolean} params.forceCreate
if true, tree view will be created
{String} params.app
the app that owns the overview
{Boolean} params.hideEmpty
if true, don't show header if there is no data
{Boolean} params.noTooltips
if true, don't show tooltips for tree items

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