Zimlet JavaScript API Reference - Index

Class List


Class Index




AjxCallback

This class represents a callback function which can be called standalone, or from a given object.

AjxDispatcher

This static class serves as a central location for registering and calling public API methods.


AjxTemplate

This class contains utility functions for using templates.

AjxColor

This class represents a color and is useful for color operations inspired by the code in SkinResources.java.

AjxException

This is the base class for all exceptions in the Zimbra Ajax Toolkit.

Dwt

Dwt is a static class that defines a number of constants and helper methods that support the ajax.dwt.

DwtException

This is the base class for all exceptions in the Ajax toolkit.

DwtId

This class is responsible for providing unique, predictable IDs for HTML elements.

DwtDragBox

A drag box is registered with a control to indicate that the control supports the presence of an elastic box created by clicking and dragging, and typically used to select visual objects within a space.

DwtDragEvent

DwtDragEvent is generated by the Drag and Drop framework when a drag operation is in process.

DwtDragSource

A drag source is registered with a control to indicate that the control is draggable.

DwtDropEvent

DwtDropEvent is generated by the Drag and Drop framework when a drag n drop operation is in process.

DwtDropTarget

A drop target is registered with a control to indicate that the control is a drop target.

DwtEvent

This class is the base class of all DWT events.

DwtOutsideMouseEventMgr

This class is designed to make it easy for a widget to detect mouse events that happen somewhere outside its HTML structure.

DwtPoint

This class represents a point.

DwtRectangle

This class represents a rectangle.

DwtKeyMap

This class provides the basic keyboard mappings for Dwt components.

DwtTabGroup

A tab group is used to manage keyboard focus among a group of related visual elements.

DwtAccordion

This class implements an accordion widget, which is a stack of expandable accordion headers.

DwtAccordionItem

This class represents a single expandable accordion item.

DwtAlert

This class represents an alert.

DwtBaseDialog

This is a base class for dialogs.

DwtBorderlessButton

This class represents a button without a border.

DwtButton

This class represents a button, which is basically a smart label that can handle various UI events.

DwtButtonColorPicker

This class ntegrates DwtButton with a popup DwtColorPicker.

DwtCalendar

This class provides a calendar view.

DwtCheckbox

This class represents a checkbox.

DwtChooser

This class creates and manages a control that lets the user select items from a list.

DwtChooserListView

This base class represents a list view which contains items that can be transferred from it (source) or to it (target).

DwtColorPicker

Instances of this class may be used with DwtMenu to create a DwtColorPicker menu.

DwtComboBox

This class represents a combo box.

DwtComposite

A composite may contain other controls.

DwtConfirmDialog

This class represents a confirmation dialog.

DwtControl

This class is the root class of the Dwt component hierarchy.

DwtDialog_ButtonDescriptor

This class represents a button descriptor.

DwtDialog

This class represents a popup dialog with a title and standard buttons.

DwtHeaderTreeItem

This class implements a tree item widget.

DwtIframe

This class represents a simple event proxy.

DwtInputField

This class represents an input field.

DwtLabel

This class represents a label, which consists of an image and/or text.

DwtListView

A list view presents a list of items as rows with fields (columns).

DwtMenu

Creates a menu object to menu items can be added.

DwtMenuItem

Menu items can be part of a radio group, or can be checked style menu items.

DwtMessageComposite

This class allows you to create a composite that is populated from a message pattern and inserts controls at the appropriate places.

DwtMessageDialog

Creates a new message dialog.

DwtOptionDialog

Creates a new option dialog.


DwtProgressBar

This class represents a progress bar.


DwtRadioButton

This class implements a radio button.

DwtSash

A sash is a thin moveable border between two components that can be moved in order to change the sizes of the elements on either side.

DwtSelectMenu

This class represents a select menu.

DwtSelectOption

This class encapsulates the option object that the DwtSelect widget uses.

DwtSelectMenuItem

This class represents a menu item.

DwtSelect

Widget to replace the native select element.

DwtShell

This class represents a shell, the first widget that must be instantiated in a Dwt based application.

DwtSlider

This class represents a slider.

DwtSoundPlugin

This class represents a widget that plays sounds.

DwtSpinner

Represents a entry field for entering numeric values.

DwtTabView

This class represents a tabbed view.

DwtTabButton

This class represents the tab in a tab view.

DwtTabBar

This class represents the tab bar, which is effectively a tool bar.

DwtTabViewPage

DwtTabViewPage abstract class for a page in a tabbed view.

DwtText

This class represents a container for a piece of text.

DwtToolBarButton

This class represents a toolbar button.

DwtToolBar

Creates a toolbar.

DwtTree

This class implements a tree widget.

DwtTreeItem

This class implements a tree item widget.

AjxListener

This class represents a listener, which is a function to be called in response to an event.

AjxRpc

This static class provides an interface for send requests to a server.

AjxRpcRequest

This class encapsulates the XML HTTP request, hiding differences between browsers.

AjxSoapDoc

Note: do not directly instantiate AjxSoapDoc.


AjxEmailAddress

This class represents an email address and defines some related constants.

AjxStringUtil

This class provides static methods to perform miscellaneous string-related utility functions.






AjxVector

This class represents a vector.

AjxXmlDoc

Do not directly instantiate AjxXmlDoc, use one of the create factory methods instead.

ZmErrorDialog

Creates an error dialog which will have a "Send Error Report" button.

ZmBatchCommand

This class represent a batch command, which is a collection of separate requests.

ZmCsfeCommand

This class represents a command.

ZmCsfeException

This class represents an exception returned by the server as a response, generally as a fault.

ZmCsfeResult

This class represents the result of a CSFE request.

ZmAddrBookTreeController

This class is a controller for the tree view used by the address book application.

ZmContactController

This class represents the contact controller.

ZmContactListController

This class manages list views of contacts.

ZmAddrBook

This class represents an address book.

ZmContact

This class represents a contact (typically a person) with all its associated versions of email address, home and work addresses, phone numbers, etc.

ZmContactList

This class represents a list of contacts.

ZmContactGroupMenu

This class represents a menu structure of contact groups that to which contacts can be added.

ZmContactPicker

This class creates and manages a dialog that lets the user select addresses from a contact list.

ZmContactAlphabetBar

This class represents the contact alphabet bar.

ZmContactsBaseView

This class represents the base view.

ZmContactSearch

This class creates and manages a component that lets the user search for and select one or more contacts.

ZmContactsHelper

Miscellaneous contacts-related utility functions.

ZmContactSimpleView

This class represents a simple contact list view (contains only full name).

ZmContactSplitView

This class represents the contact split view.

ZmEditContactView

This class represents the edit contact view.



ZmGroupView

This class represents the contact group view.

ZmNewAddrBookDialog

This class represents the address book dialog.

ZmNewContactGroupDialog

This class represents a new contact group dialog.

ZmContactsApp

The contacts app manages the creation and display of contacts, which are grouped into address books.

ZmBriefcaseController

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

ZmBriefcaseTreeController

This class is a controller for the tree view used by the briefcase application.

ZmBriefcase

This class represents a briefcase.

ZmBriefcaseItem

This class represents a briefcase item.

ZmBriefcaseBaseItem

This class is a base class for briefcase item classes.

ZmDocletMgr

This class represents a doclet manager.

ZmBriefcaseTabView

This class represents the briefcase tab view.

ZmBriefcaseBaseView

This class represents the base view.

ZmBriefcaseIconView

This class represents the briefcase icon view.

ZmBriefcaseTreeView

This class is a view for the tree view used by the briefcase application, supporting external DnD

ZmDetailListView

This class represents the briefcase detail list view.

ZmNewBriefcaseDialog

This class represents the new briefcase dialog.

ZmPreviewView

This class represents the contact split view.

ZmBriefcaseApp

The briefcase application manages the creation and display of briefcase items.

ZmApptComposeController

This class manages appointment creation/editing.


ZmCalendarTreeController

This class manages the calendar tree controller.

ZmCalItemComposeController

This class manages appointment creation/editing.

ZmCalViewController

The strategy for the calendar is to leverage the list view stuff by creating a single view (i.e.

ZmReminderController

This controller uses the following timed actions:
  1. one for refreshing our "cache" of upcoming appts to notify on
  2. one for when to next popup the reminder dialog.

ZmAppt

This class represents a calendar item.

ZmApptList

This class represents a list of appointments.

ZmCalBaseItem

This class represents the base calendar item.


ZmCalItem

This class represents a calendar item.

ZmRecurrence

This class represents a recurrence pattern.

ZmResource

This class represents a resource.

ZmResourceList

This class represents a list of calendar resources.

ZmApptAssistantView

This class displays suggested free locations for a new appointment

ZmApptComposeView

This class provides a form for creating/editing appointments.


ZmApptQuickAddDialog

This class represents a modal dialog which has at least a title and the standard buttons (OK/Cancel).

ZmApptRecurDialog

This class provides a dialog for creating/editing recurrences for an appointment

ZmAttendeePicker

This class allows the user to search for attendees, locations, or equipment.


ZmCalViewMgr

This class represents the calendar view manager.

ZmFreeBusySchedulerView

This class displays free/busy information for an appointment's attendees.

ZmLocationAssistantView

This class displays suggested free locations for a new appointment




ZmScheduleAssistantView

This class displays suggested free time/location for sending invites to attendees


ZmTimeSuggestionPrefDialog

This class represents a time/location preference dialog.


ZmCalendarApp

The calendar application manages the creation and display of appointments.

ZmApp

This object represents a Zimbra Application.

ZmAppCtxt

This class is a container for application context information.

ZmAppViewMgr

This class performs view and layout management.

ZmClientCmdHandler

This class represents a client command handler.

ZmId

This class is responsible for providing unique, predictable IDs for HTML elements.

ZmMimeTable

This class represents a mime table that contains utility methods for managing mime types.

ZmNewWindow

This class is the controller for a window created outside the main client window.

ZmOperation

This class provides the idea of an "operation", which is a user-initiated action exposed through a button or menu item.

ZmRequestMgr

This class manages the sending of requests to the server, and handles the responses, including refresh blocks and notifications.

ZmToolTipMgr

This singleton class manages tooltip content generation and retrieval.

ZmZimbraMail

This class is the "ubercontroller", as it manages all the apps as well as bootstrapping the ZimbraMail application.

ZmComposeController

This class manages message composition.

ZmConvController

This class manages the two-pane conversation view.

ZmConvListController

This class manages the conversations mail view.

ZmDoublePaneController

This class manages the two-pane view.

ZmMailConfirmController

This class represents the mail confirmation controller.

ZmMailListController

This class encapsulates controller behavior that is common to lists of mail items.

ZmMsgController

This class controls the display and management of a single message in the content area.

ZmConv

This class represents a conversation, which is a collection of mail messages which have the same subject.

ZmDataSource

This class represents a data source.

ZmDataSourceCollection

This class represents a data source collection.

ZmIdentity

This class represents an identity.

ZmIdentityCollection

This class represents the identity collection

ZmImapAccount

This class represents an IMAP account.

ZmMailItem

This class represents a mail item, which may be a conversation or a mail message.

ZmMailList

This class represents a list of mail items (conversations, messages, or attachments).

ZmMailMsg

Creates a new (empty) mail message.

ZmMimePart

This class represents a mime part.

ZmPopAccount

This class represents an POP account.

ZmSignature

This class represents a signature.

ZmSignatureCollection

This class represents a signature collection.

ZmGrantRightsDialog

This class represents a rename folder dialog.

ZmConvView2

This class displays and manages a conversation.

ZmInviteMsgView

When a user receives an invite, this class is instatiated to help ZmMailMsgView deal with invite-specific rendering/logic.

ZmMailItemView

Base class for a view displaying a single mail item (msg or conv).

ZmMailRedirectDialog

This class represents a Mail Redirect dialog.

ZmRecipients

This class provides a central area for managing email recipient fields.

ZmRetentionWarningDialog

Creates an retention warning can have a "Delete All", "Delete Valid" or Cancel buttons "Delete All" will delete all the messages that the user chose for deletion.

ZmMailApp

The mail app manages and displays mail messages.

ZmPortalController

This class represents the portal controller.

ZmPortlet

This class provides the implementation for portlet for use in the portal application.

ZmPortletMgr

This class represents the portlet manager.

ZmPortalView

This class represents the portal view.

ZmPortletView

This class represents the portlet view.

ZmPortalApp

This class represents the portal application.

ZmFilterController

This class represents the filter rules controller.

ZmFilterRulesController

This class represents the filter rules controller.

ZmMobileDevicesController

This class represents the mobile devices controller.

ZmPrefController

This class represents the preferences controller.

ZmPrefPageTreeController

This class represents the preferences page tree controller.

ZmFilterRule

ZmFilterRule represents a filter rule.

ZmFilterRules

This class represents a set of filter rules.

ZmLocale

This class represents a locale.

ZmMobileDevice

This class represents mobile device.

ZmPersona

This class represents a personna.

ZmPrefPage

This class represents the preference page in the preferences application.


ZmFilterRuleDialog

This class presents a dialog which a user can use to add or edit a filter rule.

ZmFilterRulesView

This class represents the filters tab view in preferences application.


ZmPreferencesPage

This class represents a single page of preferences available by selecting one of the preference tabs.

ZmPrefView

This class represents a tabbed view of the preference pages.

ZmPreferencesApp

This class represents the application for the preferences UI.

ZmActionController

Manages an undo stack (ZmActionStack) and the "Undo" toast messages Optimally there should only be one object of this class, globally reachable

ZmController

This class represents an application controller.

ZmFolderTreeController

This class controls a tree display of folders.

ZmImportExportController

This class represents an import/export controller.

ZmOverviewController

This singleton class manages overviews, each of which has a unique ID.

ZmSearchController

This class represents the search controller.

ZmSearchResultsController

This controller is used to display the results of a user-initiated search.

ZmSearchTreeController

This class controls a tree display of saved searches.

ZmTagTreeController

This class controls a tree display of tags.

ZmTreeController

This class is a base class for controllers for organizers.

ZmZimletAppController

This class represents a zimlet application controller.

ZmZimletTreeController

This class represents a Zimlet tree controller.

ZmAppEvent

This class represents an event related to a change of state for an individual application or for ZCS as a whole.

ZmEvent

This class represents an event that encapsulates some sort of change to a model (data).

ZmAccessControlEntry

An access control entry encapsulates the permission information pertaining to a user or users regarding a certain right.

ZmAccessControlList

An access control list is a collection of access control entries (ACEs).

ZmAccount

This class represents an account.

ZmAccountList

This class is used to store and manage a list of accounts for a mailbox.

ZmCompositeAction

Represents a collection of undoable actions that will be performed as a whole

ZmOrganizerMoveAction

Represents an undoable move action on an organizer

ZmItemMoveAction

Represents an undoable move action on an item

ZmOrganizerAction

Represents an undoable action on an organizer This class is a generic superclass that does very little on its own; the real work is being done in subclasses

ZmItemAction

Represents an undoable action on an item This class is a generic superclass that does very little on its own; the real work is being done in subclasses

ZmAction

Represents an undoable action (e.g.

ZmActionStack

Creates a stack of undoable actions (ZmAction objects)

ZmAttachmentTypeList

This class represents attachment types.

ZmAuthenticate

This class represents in-app authentication following the expiration of the session.

ZmPeopleSearchAutocomplete

This class supports auto-complete for searching the GAL and the user's personal contacts.

ZmSearchAutocomplete

This class supports auto-complete for our query language.

ZmAutocompleteMatch

This class represents an auto-complete result, with fields for the caller to look at, and fields to help with further matching.

ZmAutocomplete

This class manages auto-completion via <AutoCompleteRequest> calls to the server.

ZmDomain

This class represents a domain.

ZmDomain

This class represents a domain.

ZmDomainList

This class represents a list of domains that have shown up in email addresses.

ZmFolder

This class represents a folder, which may contain mail.

ZmFolderTree

This class represents a tree of folders.

ZmInvite

This class represents an invite to a calendar appointment.

ZmItem

An item is a piece of data that may contain user content.

ZmKeyMap

This class maps keys to actions for the ZCS application.

ZmList

This class represents a list of items (ZmItem objects).

ZmMetaData

This class provides a general way to store per-user data using arbitrary key/value pairs.

ZmModel

This class represents a data model which can process change events.

ZmMountpoint

This class represents a mountpoint organizer.

ZmObjectHandler

This class defines the default implementation for a zimlet object handler.

ZmObjectManager

This class is used to high-light objects within a given view.

ZmOrganizer

This class represents an "organizer", which is something used to classify or contain items.

ZmSearch

This class represents a search to be performed on the server.

ZmSearchFolder

This class represents a search folder.

ZmSearchResult

This class represents a search result.

ZmSetting

This class represents a single setting.

ZmSettings

This class is a collection of various sorts of settings: config values, preferences, and COS features.

ZmShare

A share comprises information about an object that is shared by one user with another user.

ZmTag

This class represents a tag.

ZmTagTree

This class represents the tag tree.

ZmTimezone

This class represents a timezone.

ZmTree

This class represents a tree.

ZmZimbraAccount

This class represents an account.

ZmZimlet

This class represents a zimlet.

ZmZimletBase

This class provides the default implementation for Zimlet functions.

ZmZimletContext

This class represents the Zimlet context.

ZmZimletMgr

This class represents the Zimlet manager.

ZmAcceptShareDialog

This class represents an "accept share" dialog.

ZmAttachDialog

This class represents an attachment dialog.

ZmChooseAccountDialog

This class represents choose account dialog.

ZmChooseFolderDialog

This class represents choose folder dialog.

ZmDebugLogDialog

This class represents a dialog for showing debug log messages.

ZmDeclineShareDialog

This class represents "decline share" dialog.

ZmDialog

This class is a base class for miscellaneous organizer-related dialogs.

ZmDumpsterDialog

This class represents a dumpster dialog.

ZmFindnReplaceDialog

This class represents a "find-and-replace" dialog.

ZmFolderDialogTabView

This class represents a dialog tab view displayed by a tabToolbar

ZmFolderNotifyDialog

This class represents a folder notification dialog.

ZmFolderPropertyView

This class represents a folder properties view

ZmFolderPropsDialog

This class represents a folder properties dialog.

ZmNewOrganizerDialog

This class represents a new organizer dialog.

ZmNewSearchDialog

This class represents a new search dialog.

ZmNewTagDialog

This class represents a new tag dialog.


ZmPasswordUpdateDialog

This class represents a password update dialog.

ZmPickTagDialog

This class presents the user with their list of tags in a tree view so that they can choose one.

ZmPromptDialog

This class represents a prompt dialog.

ZmQuickAddDialog

This class represents a modal dialog which has at least a title and the standard buttons (OK/Cancel) and widgets (i.e.

ZmRenameFolderDialog

This class represents a rename folder dialog.

ZmRenameTagDialog

This class represents a rename tag dialog.

ZmRevokeShareDialog

This class represents a revoke share dialog.

ZmSharePropsDialog

This class represents a share properties dialog.


ZmTimezonePicker

This class represents a timezone dialog.


ZmUploadDialog

This class represents an upload dialog.



ZmAccountAlert

This class represents an alert that highlights and flashes an account accordion item.

ZmAccountOverviewContainer

Creates a header tree item for an account if mailbox has multiple accounts configured.

ZmActionMenu

This class represents an action menu, which is a popup menu with a few added features.

ZmAddressBubbleList

This class manages selection events (click, double-click, and right-click) of a collection of bubbles, since those events are typically meaningful within a group of bubbles.

ZmAddressBubble

This class represents an object that allows various operations to be performed on an email address within a compose or display context.

ZmAddressInputField

This class creates and manages a control for entering email addresses and displaying them in bubbles.

ZmAlert

This is an abstract base class of flashing alerts.

ZmAppButton

This class represents a button that behaves like a "tab" button, designed specifically for the row of applications buttons at the top of the Zimbra Web Client interface.

ZmAppChooser

This class represents a zimbra application chooser.

ZmAppIframeView

This class displays an external URL in an iframe.

ZmAutocompleteListView

This class implements autocomplete functionality.

ZmBrowserAlert

Singleton alert class that alerts the user by flashing the favicon and document title.

ZmButtonToolBar

This class represents a toolbar that contains buttons.

ZmCommunityView

This class displays Community content in an iframe.

ZmDLAutocompleteListView

This class shows the members of an expanded distribution list (DL).

ZmFolderChooser

This is a folder choosing widget designed to be displayed as a dropdown hanging off a menu.

ZmListView

A list view presents a list of items as rows with fields (columns).

ZmNavToolBar

Navigation toolbar for the client.

ZmOverview

Creates an overview.

ZmOverviewContainer

Creates a header tree item for an account if mailbox has multiple accounts configured.

ZmPopupMenu

This class represents a basic popup menu which can add menu items, manage listeners, and enable/disabled its menu items.

ZmSearchResultsFilterPanel

This class represents a panel used to modify the current search.

ZmSearchResultsToolBar

This class represents a search toolbar that shows up above search results.

ZmSearchToolBar

This class represent a search toolbar.

ZmShareReply

This class implements a share reply query box and additional input controls to allow the user to specify the reply type and quick reply note, if wanted.

ZmToast

This class represents the "toaster".

ZmStatusView

This class represents the status view.

ZmTagMenu

This class represents a menu structure of tags that can be added to or removed from item(s).

ZmToolBar

This class represents a basic toolbar which can add buttons, manage listeners, and enable/disabled its buttons.

ZmTreeView

This class displays data in a tree structure.

ZmZimletApp

This object represents a Zimlet Application.

ZmEmailObjectHandler

Internal handler for email addresses.

ZmSearchApp

The search app manages user-initiated searches.

ZmSocialApp

This class represents the social application.

ZmUploadManager

This class represents the file uploading, with document creation

ZmTaskController

This class manages task creation/editing.

ZmTaskListController

This class represents the task list controller.

ZmTaskTreeController

This class represents the task tree controller.

ZmTask

This class represents a task.

ZmTaskFolder

This class represents a task folder.

ZmNewTaskFolderDialog

This class represents the new task folder dialog.

ZmTaskEditView

This class represents the edit task view.

ZmTaskListView

This class represents the task list view.

ZmTaskView

Simple read-only view of a task.

ZmTasksApp

This class represents the task application.

Documentation generated by JsDoc Toolkit 2.3.0