Zimlet JavaScript API Reference - _global_

Built-In Namespace _global_



Field Summary
Field Attributes Field Name and Description
 
List of toolbar operations to *disable* Default is to enable-all
 
List of toolbar operations to enable when multiple items are selected - Default is to enable: ZmOperation.NEW_MENU, ZmOperation.TAG_MENU, ZmOperation.DELETE, ZmOperation.MOVE, ZmOperation.MOVE_MENU, ZmOperation.FORWARD & ZmOperation.ACTIONS_MENU
 
List of toolbar operations to enable on Zero/no selection - Default is only enable ZmOperation.NEW_MENU
Method Summary
Method Attributes Method Name and Description
 
AjxListFormat(formatter, separator, lastSeparator, twoSeparator)
This class allows the user to format a list by applying a specific format to each object in an array and joining the results.
 
DwtToolTip(shell, className, dialog)
Singleton tooltip class.
 
Allows the user to search by address or domain.
 
Allows the user to search for appts by date (before, after, or on a particular date).
 
ZmApptListView(parent, posStyle, controller, dropTgt)
Appointment list view.
 
Allows the user to search by attachment type (MIME type).
 
ZmBaseController(container, app, type, sessionId, searchResultsController)
This class is a base class for any controller that manages items such as messages, contacts, appointments, tasks, etc.
 
ZmCalNewScheduleView(parent, posStyle, controller, dropTgt)
*************** NEW VERSION OF SCHEDULE VIEW ********************
 
ZmCalScheduleView(parent, posStyle, controller, dropTgt)
*************** OLD VERSION OF SCHEDULE VIEW ********************
 
ZmColorMenu(params)
 
A custom menu item class for the "More colors.
 
ZmContactView(params)
View for displaying the contact information.
 
ZmCustomWorkHoursDlg(parent, templateId, workHours)
Create the custom work hours dialog box
 
Allows the user to search by date (before, after, or on a particular date).
 
ZmDumpsterBriefcaseListView(parent, controller)
Listview showing deleted briefcase items
 
ZmDumpsterCalendarListView(parent, controller)
Listview showing deleted calendar items
 
ZmDumpsterContactListView(parent, controller)
Listview showing deleted contact items
 
Controller for the ZmDumpsterListView
 
ZmDumpsterListView(parent, controller)
Listview showing deleted items
 
ZmDumpsterMailListView(parent, controller)
Listview showing deleted mail items
 
ZmDumpsterTaskListView(parent, controller)
Listview showing deleted task items
 
ZmFilterWork(filterSel, outgoing)
class that holds the work specification (in this case, filtering specific filters.
 
Allows the user to search by folder.
 
Minimal version of ZmRecipients that has no UI.
 
ZmListController(container, app, type, sessionId, searchResultsController)
This class is a base class for any controller that manages a list of items such as mail messages or contacts.
 
Date group divides messages into the following sections: Today Yesterday Day of week -- not today or yesterday, but still within this week Last Week Two Weeks Ago Three Weeks Ago Earlier this Month Last Month Older
 
From Group divides messages into sort by sender.
 
ZmMailListGroup is the base class for creating a mail group to be displayed by the ListView.
 
Priority Group divides a mail list into sections: Important & Unread, Important, Flagged, Everything else This implemenation is experimental and based on Tag which will change in the future.
 
ZmMailListSectionHeader(group, params)
Section header provides a header to divide groups into sections.
 
Size group divides messages into the following sections: Enormous > 5MB Huge 1-5MB Very Large 500KB-1MB Large 100KB-500KB Medium 25KB-100KB Small 10KB-25KB Tiny < 10KB
 
ZmMailMsgCapsuleView(params, className, parent, msgId, sessionId, controller, actionsMenu, forceExpand, forceCollapse, isDraft)
The capsule view of a message is intended to be brief so that all the messages in a conv can be shown together in a natural way.
 
The header bar of a capsule message view: - shows minimal header info (from, date) - has an expansion icon - is used to drag the message - is the drop target for tags
 
Adds a types button and support for a custom search menu item to a search toolbar
 
ZmNotificationsPage(parent, section, controller)
Creates a preferences page for displaying notifications.
 
This class is a parsed representation of a query string.
 
Subclass of ZmAutocompleteListView so we can customize the "listview"
 
ZmProgressController(container, app)
 
ZmProgressRun(folderList)
internal class to keep track of progress, with last item processed, total messages processed, and the folder list we work on
 
ZmSearchFilter(params, parent, id, searchOp, updateCallback, resultsApp)
Base class for widget that adds a term to the current search.
 
ZmSearchToken(op, arg)
This class represents one unit of a search query.
 
Allows the user to search by size (larger or smaller than a particular size).
 
Helper class for applying snooze 'before' times to a set of appointments that were handled en-masse in the reminder dialog.
 
Allows the user to search by various message statuses (unread, flagged, etc).
 
Allows the user to search by tags.
Field Detail
operationsToDisableOnSingleSelection
List of toolbar operations to *disable* Default is to enable-all
Defined in: ZmBaseController.js.

operationsToEnableOnMultiSelection
List of toolbar operations to enable when multiple items are selected - Default is to enable: ZmOperation.NEW_MENU, ZmOperation.TAG_MENU, ZmOperation.DELETE, ZmOperation.MOVE, ZmOperation.MOVE_MENU, ZmOperation.FORWARD & ZmOperation.ACTIONS_MENU
Defined in: ZmBaseController.js.

operationsToEnableOnZeroSelection
List of toolbar operations to enable on Zero/no selection - Default is only enable ZmOperation.NEW_MENU
Defined in: ZmBaseController.js.
Method Detail
AjxListFormat(formatter, separator, lastSeparator, twoSeparator)
This class allows the user to format a list by applying a specific format to each object in an array and joining the results. Each formatted item in the list is separated by a list separator string.

Note: This format is not one of the standard formatter classes available in Java.
Defined in: AjxText.js.

Parameters:
{AjxFormat} formatter
The formatter.
{string} separator
Optional. The list separator string. If not specified, AjxMsg.separatorList is used.
{string} lastSeparator
Optional. The list separator string for the last item in the list (e.g. " and "). If not specified, AjxMsg.separatorListLast is used.
{string} twoSeparator
Optional. Separator used if the list consists of exactly two items. If not specified, AjxMsg.listSeparatorTwo is used.

DwtToolTip(shell, className, dialog)
Singleton tooltip class.
Defined in: DwtToolTip.js.
Parameters:
shell
className
dialog

ZmAddressSearchFilter(params)
Allows the user to search by address or domain.
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
params

ZmApptDateSearchFilter(params)
Allows the user to search for appts by date (before, after, or on a particular date).
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
params

ZmApptListView(parent, posStyle, controller, dropTgt)
Appointment list view.
Defined in: ZmApptListView.js.
Parameters:
parent
posStyle
controller
dropTgt

ZmAttachmentSearchFilter(params)
Allows the user to search by attachment type (MIME type).
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
params

ZmBaseController(container, app, type, sessionId, searchResultsController)
This class is a base class for any controller that manages items such as messages, contacts, appointments, tasks, etc. It handles operations that can be performed on those items such as move, delete, tag, print, etc.
Defined in: ZmBaseController.js.
Author: Conrad Damon.
Parameters:
{DwtControl} container
the containing shell
{ZmApp} app
the containing application
{constant} type
type of controller (typically a view type)
{string} sessionId
the session id
{ZmSearchResultsController} searchResultsController
containing controller

ZmCalNewScheduleView(parent, posStyle, controller, dropTgt)
*************** NEW VERSION OF SCHEDULE VIEW ********************
Defined in: ZmCalScheduleView.js.
Parameters:
parent
posStyle
controller
dropTgt

ZmCalScheduleView(parent, posStyle, controller, dropTgt)
*************** OLD VERSION OF SCHEDULE VIEW ********************
Defined in: ZmCalScheduleView.js.
Parameters:
parent
posStyle
controller
dropTgt

ZmColorMenu(params)

Defined in: ZmColorMenu.js.
Parameters:
{hash} params
Constructor parameters.
{DwtComposite} params.parent
Parent control.
{string} params.image
Item image to display next to each color choice.
{boolean} params.hideNone
True to hide the "None" option.
{boolean} params.hideNoFill
True to hide the no-fill/use-default option.

ZmColorMenuItem(params)
A custom menu item class for the "More colors..." and "Fewer colors..." options which should not leave space for an image next to the text. A sub-class is also needed so that we can avoid the default handling of the item click.
Defined in: ZmColorMenu.js.
Parameters:
params

ZmContactView(params)
View for displaying the contact information. Provides events for enabling text selection.
Defined in: ZmContactSplitView.js.
Parameters:
{Object} params
hash of params: parent parent control controller owning controller

ZmCustomWorkHoursDlg(parent, templateId, workHours)
Create the custom work hours dialog box
Defined in: ZmCalendarPrefsPage.js.
Parameters:
parent
templateId
workHours
the work hours parsed array

ZmDateSearchFilter(params)
Allows the user to search by date (before, after, or on a particular date).
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
params

ZmDumpsterBriefcaseListView(parent, controller)
Listview showing deleted briefcase items
Defined in: ZmDumpsterDialog.js.
Parameters:
parent
controller

ZmDumpsterCalendarListView(parent, controller)
Listview showing deleted calendar items
Defined in: ZmDumpsterDialog.js.
Parameters:
parent
controller

ZmDumpsterContactListView(parent, controller)
Listview showing deleted contact items
Defined in: ZmDumpsterDialog.js.
Parameters:
parent
controller

ZmDumpsterListController(container)
Controller for the ZmDumpsterListView
Defined in: ZmDumpsterDialog.js.
Parameters:
container
[DwtControl] container this controller "controls"

ZmDumpsterListView(parent, controller)
Listview showing deleted items
Defined in: ZmDumpsterDialog.js.
Parameters:
parent
controller

ZmDumpsterMailListView(parent, controller)
Listview showing deleted mail items
Defined in: ZmDumpsterDialog.js.
Parameters:
parent
controller

ZmDumpsterTaskListView(parent, controller)
Listview showing deleted task items
Defined in: ZmDumpsterDialog.js.
Parameters:
parent
controller

ZmFilterWork(filterSel, outgoing)
class that holds the work specification (in this case, filtering specific filters. Keeps track of progress stats too. an instance of this is passed to ZmFilterRulesController to callback for stuff specific to this work. (template pattern, I believe)
Defined in: ZmFilterRulesController.js.
Parameters:
filterSel
outgoing

ZmFolderSearchFilter(params)
Allows the user to search by folder.
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
params

ZmHiddenRecipients()
Minimal version of ZmRecipients that has no UI. Note that addresses are stored in arrays rather than vectors.
Defined in: ZmComposeView.js.

ZmListController(container, app, type, sessionId, searchResultsController)
This class is a base class for any controller that manages a list of items such as mail messages or contacts. It can handle alternative views of the same list.
Defined in: ZmListController.js.
Author: 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

ZmMailListDateGroup()
Date group divides messages into the following sections: Today Yesterday Day of week -- not today or yesterday, but still within this week Last Week Two Weeks Ago Three Weeks Ago Earlier this Month Last Month Older
Defined in: ZmMailListDateGroup.js.

ZmMailListFromGroup()
From Group divides messages into sort by sender.
Defined in: ZmMailListFromGroup.js.

ZmMailListGroup()
ZmMailListGroup is the base class for creating a mail group to be displayed by the ListView. A mail group consists of sections and a section header. Each section is an array of HTML strings that divide the group. For example, ZmMailListSizeGroup has sections to divide the group based on size: Enormous, Huge, Very Large, etc. Each section consists of an HTML representation of the message and a section header.
Defined in: ZmMailListGroup.js.

ZmMailListPriorityGroup(group)
Priority Group divides a mail list into sections: Important & Unread, Important, Flagged, Everything else This implemenation is experimental and based on Tag which will change in the future. TODO: Search needs to be batch request based. (implementation outside the scope of this object, but noting here)
Defined in: ZmMailListPriorityGroup.js.
Parameters:
group

ZmMailListSectionHeader(group, params)
Section header provides a header to divide groups into sections. The bar supports actions for click, mouseover, mouseout, expand and collapse sections.
Defined in: ZmMailListSectionHeader.js.
Parameters:
{ZmMailListGroup} group
Group object
{objet} params
hash of params for DwtControl

ZmMailListSizeGroup()
Size group divides messages into the following sections: Enormous > 5MB Huge 1-5MB Very Large 500KB-1MB Large 100KB-500KB Medium 25KB-100KB Small 10KB-25KB Tiny < 10KB
Defined in: ZmMailListSizeGroup.js.

ZmMailMsgCapsuleView(params, className, parent, msgId, sessionId, controller, actionsMenu, forceExpand, forceCollapse, isDraft)
The capsule view of a message is intended to be brief so that all the messages in a conv can be shown together in a natural way. Quoted content is stripped.
Defined in: ZmConvView2.js.
Parameters:
{hash} params
hash of params:
{string} className
(optional) defaults to "ZmMailMsgCapsuleView"
{ZmConvView2} parent
parent conv view
{string} msgId
ID of msg
{string} sessionId
ID of containing session (used with above param to create DOM IDs)
{ZmController} controller
owning conv list controller
{ZmActionMenu} actionsMenu
shared action menu
{boolean} forceExpand
if true, show header, body, and footer
{boolean} forceCollapse
if true, just show header
{boolean} isDraft
is this message a draft

ZmMailMsgCapsuleViewHeader(params)
The header bar of a capsule message view: - shows minimal header info (from, date) - has an expansion icon - is used to drag the message - is the drop target for tags
Defined in: ZmConvView2.js.
Parameters:
params

ZmMainSearchToolBar(params)
Adds a types button and support for a custom search menu item to a search toolbar
Defined in: ZmSearchToolBar.js.
Parameters:
params

ZmNotificationsPage(parent, section, controller)
Creates a preferences page for displaying notifications.
Defined in: ZmNotificationsPage.js.
Parameters:
{DwtControl} parent
the containing widget
{Object} section
the page
{ZmPrefController} controller
the prefs controller

ZmParsedQuery(query)
This class is a parsed representation of a query string. It parses the string into tokens. A token is a paren, a conditional operator, or a search term (which has an operator and an argument). The query string is assumed to be valid. Compound terms such as "in:(inbox or sent)" will be exploded into multiple terms.
Defined in: ZmSearch.js.
Parameters:
{string} query
a query string TODO: handle "field[lastName]" and "#lastName"

ZmPeopleAutocompleteListView(params)
Subclass of ZmAutocompleteListView so we can customize the "listview"
Defined in: ZmPeopleAutocompleteListView.js.
Parameters:
params

ZmProgressController(container, app)

Defined in: ZmProgressController.js.
Author: Eran Yarkon.
Parameters:
{DwtControl} container
the containing shell
{ZmApp} app
the containing application

ZmProgressRun(folderList)
internal class to keep track of progress, with last item processed, total messages processed, and the folder list we work on
Defined in: ZmProgressController.js.
Parameters:
folderList

ZmSearchFilter(params, parent, id, searchOp, updateCallback, resultsApp)
Base class for widget that adds a term to the current search.
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
{hash} params
hash of params:
{DwtControl} parent
usually a DwtMenu
{string} id
ID of filter
{string} searchOp
search operator for this filter (optional)
{function} updateCallback
called when value of filter (as a search term) has changed
{constant} resultsApp
name of app corresponding to type of results

ZmSearchToken(op, arg)
This class represents one unit of a search query. That may be a search term ("is:unread"), and conditional operator (AND, OR, NOT), or a grouping operator (left or right paren).
Defined in: ZmSearch.js.
Parameters:
{string} op
operator
{string} arg
argument part of search term

ZmSizeSearchFilter(params)
Allows the user to search by size (larger or smaller than a particular size).
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
params

ZmSnoozeBeforeProcessor(apptType)
Helper class for applying snooze 'before' times to a set of appointments that were handled en-masse in the reminder dialog. For each appointment - If the appointment has already started (whether in-progress or completed) then the before value is not applied, and we store this appt for later processing. - For appointments that have not started yet: - If the appointment startTime + snoozeTime is in the future (> now) then set the appt reminder untilTime. - If the startTime + snoozeTime is in the past (< now), loop over the standard set of 'before' snooze times and find the max before time that we can apply and still have the reminder occur in the future. Once a time for the appointment's reminder is calculated, save the minimum one (i.e. the reminder for the earlier occuring appt) as earliestUntilTime. Finally, loop over each of the appointments whose start time is past. - Set their snooze time to the soonestUntilTime. When the soonest appt reminder goes off, any past appointments will appear too. The user should dismiss them, but till then they are dragged along
Defined in: ZmSnoozeBeforeProcessor.js.
Parameters:
apptType

ZmStatusSearchFilter(params)
Allows the user to search by various message statuses (unread, flagged, etc).
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
params

ZmTagSearchFilter(params)
Allows the user to search by tags.
Defined in: ZmSearchResultsFilterPanel.js.
Parameters:
params
TODO: filter should not show up if no tags

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