Zimlet JavaScript API Reference - ZmAppCtxt

Class ZmAppCtxt


This class is a container for application context information.

Defined in: ZmAppCtxt.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates an application context.
Method Summary
Method Attributes Method Name and Description
 
Adds the callback to the attachment dialog callbacks.
 
addAuthTokenWarningListener(listener, index)
Adds a listener to the auth token warning event.
 
addZimletsLoadedListener(listener, index)
Adds a listener to the zimlets loaded event.
 
Checks is all zimlets are loaded.
 
Checks if zimlets are loaded.
 
checkPrecondition(precondition, listAny)
Checks a precondition which may be in one of several forms: a boolean, a settings constant, a function, or a list.
 
clearAutocompleteCache(type, account)
Clears the autocomplete cache.
 
Dismisses the displayed status message, if any
 
get(id, key, account)
Gets the value of the given setting.
 
Gets the accept share dialog.
 
Gets the tag organizer tree's root.
 
getACL(account, callback)
Gets the ACL.
 
Gets the active account.
 
Gets the activity stream prompt dialog for running activity stream filters
 
Gets the prompt for moving files from the Activity Stream to the Inbox
 
getApp(appName)
Gets the application.
 
Gets the application chooser.
 
Gets the application controller.
 
Gets the application view manager.
 
Gets the attach dialog.
 
getAutocompleteCache(acType, str, account, create)
Gets the autocomplete cache for the given parameters, optionally creating one.
 
Gets the auto completer.
 
Gets the calendar manager.
 
Gets the cancel message dialog.
 
Opens a new change password window
 
 
Gets the choose folder dialog.
 
getClientCmdHandler(clientCmdHdlr)
Gets the client command handler.
 
Returns the singleton AjxClipboard instance, if it is supported.
 
Gets the confirm dialog.
 
Gets the quickadd dialog for creating a contact
 
Gets the current application.
 
Gets the name of the current application.
 
Gets the current controller.
 
Gets the current list.
 
Gets the current search.
 
Gets the current view.
 
Gets the current view id.
 
Gets the current view type.
 
Gets the data source collection.
 
Gets the debug log dialog.
 
Gets the decline share dialog.
 
Gets the dialog.
 
Gets the error dialog.
 
Gets the filter rule add/edit dialog.
 
Gets the folder notify dialog.
 
Gets the folder properties dialog.
 
getFolderTree(account)
Gets the folder organizer tree.
 
Gets the message dialog with a help button.
 
Gets the history manager.
 
Gets the identity collection.
 
Gets the import/export controller.
 
Gets the keyboard manager
 
 
Gets the mail redirect dialog.
 
Gets the message dialog.
 
Gets the new address book dialog.
 
Gets the new briefcase dialog.
 
Gets the new calendar dialog.
 
Gets the new contact group dialog.
 
Gets the new folder dialog.
 
Gets the new search dialog.
 
Gets the new tag dialog.
 
Gets the new task folder dialog.
 
getNewWindow(fullView, width, height, name)
Gets a new window.
 
Gets the offline settings dialog.
 
Gets the ok/cancel message dialog.
 
Gets the overview controller.
 
getOverviewId(parts, account)
Gets the overview ID, prepending account name if multi-account.
 
Gets the password update dialog.
 
Gets the pick tag dialog.
 
Gets the priority message filter dialog.
 
Gets the rename folder dialog.
 
Gets the rename tag dialog.
 
Gets the find-and-replace dialog.
 
Gets the request manager.
 
Gets the mail retention warning dialog.
 
Gets the revoke share dialog.
 
Gets the root tab group.
 
Gets the search bar controller.
 
getSettings(account)
Gets the settings for the given account.
 
Gets the share properties dialog.
 
Gets the shell.
 
getShortcutHint(keyMap, shortcut)
Gets the shortcut hint.
 
Gets the shortcuts panel.
 
Gets the signature collection.
 
Gets the skin hint for the given argument(s), which will be used to look successively down the properties chain.
 
Gets the new suggestion Preferences dialog
 
getTagTree(account)
Gets the tag organizer tree.
 
Gets the task manager.
 
Gets the timezone picker dialog.
 
getTree(type, account)
Gets the organizer tree.
 
Gets the upload conflict dialog.
 
Gets the upload dialog.
 
Gets the upload frame id.
 
Gets the upload manager.
 
getUserDomain(account)
Gets the user domain.
 
getUsername(account)
Gets the username (which is an email address).
 
Extracts the view type from a view ID.
 
Gets the yes/no/cancel message dialog.
 
Gets the yes/no message dialog.
 
Gets the zimlet manager
 
getZimletTree(account)
Gets the zimlet organizer tree.
 
Handle Popup bloker for a given window
<static>  
ZmAppCtxt.handleWindowOpener()
When using pre-auth window.opener.appCtxt may not be accessible.
 
Returns true if an address is an expandable DL.
 
Gets the active account.
 
isMyAddress(addr, allowLocal, excludeAllowFromAddress)
Checks if my address belongs to the current user (include aliases).
 
Returns true if the given ID is not local.
 
Gets the availability of the spell check feature based on the current locale and user's configuration
 
Returns true if Prism and the user is online
 
notifyZimlets(event, args, options)
Notifies zimlets if they are present and loaded.
 
Removes a listener for the auth token warning event.
 
set(id, value, key, setDefault, skipNotify, account, skipImplicit)
Sets the value of the given setting.
 
setAppController(appController)
Sets the application controller.
 
Sets the current list.
 
setIsExpandableDL(addr, isExpandableDL)
Cache whether an address is an expandable DL.
 
setRequestMgr(requestMgr)
Sets the request manager.
 
setSettings(settings, account)
Sets the settings for the given account.
 
setShell(the)
Sets the shell.
 
setStatusMsg(params)
Sets the status message to display.
 
setTree(type, tree, account)
Sets the organizer tree.
 
setZimletsPresent(zimletsPresent)
Sets if the zimlets are present.
 
showError(errMsg, details, style, title)
Displays an error message in dialog.
 
Returns a string representation of the application context.
 
Checks if the zimlets are present.
Class Detail
ZmAppCtxt()
Creates an application context.
Method Detail
addAttachmentDialogCallback(callback)
Adds the callback to the attachment dialog callbacks.
Parameters:
{AjxCallback} callback
the callback

{Boolean} addAuthTokenWarningListener(listener, index)
Adds a listener to the auth token warning event. This listener is fired once per minute when less than five minutes remain before token expiry.
Parameters:
{AjxCallback} listener
the listener
{int} index
the index to where to add the listener
Returns:
{Boolean} true if the listener is added; false otherwise

{Boolean} addZimletsLoadedListener(listener, index)
Adds a listener to the zimlets loaded event.
Parameters:
{AjxCallback} listener
the listener
{int} index
the index to where to add the listener
Returns:
{Boolean} true if the listener is added; false otherwise

{Boolean} allZimletsLoaded()
Checks is all zimlets are loaded.
Returns:
{Boolean} true if all zimlets are loaded

{Boolean} areZimletsLoaded()
Checks if zimlets are loaded.
Returns:
{Boolean} true if zimlets are loaded

checkPrecondition(precondition, listAny)
Checks a precondition which may be in one of several forms: a boolean, a settings constant, a function, or a list.
Parameters:
{Boolean|String|Function|Array} precondition
something that evaluates to true or false
{Boolean} listAny
(optional) if a list is provided, whether just one (instead of all) must be true
Returns:
boolean false if the precondition evaluates to false or null, otherwise true

clearAutocompleteCache(type, account)
Clears the autocomplete cache.
Parameters:
{String} type
item type
{ZmAccount} account
the account

dismissStatusMsg(all)
Dismisses the displayed status message, if any
Parameters:
all

{Object} get(id, key, account)
Gets the value of the given setting.
Parameters:
{constant} id
the setting id
{String} key
the setting key (for settings that are of the hash type)
{ZmZimbraAccount} account
the account
Returns:
{Object} the setting value

{ZmAcceptShareDialog} getAcceptShareDialog()
Gets the accept share dialog.
Returns:
{ZmAcceptShareDialog} the accept share dialog

{ZmTag} getAccountTagList(item)
Gets the tag organizer tree's root.
Parameters:
{ZmItem} item
item to look up the account of for and get the account tag list.
Returns:
{ZmTag} the root of the tree, which is also a list.

{ZmAccessControlList} getACL(account, callback)
Gets the ACL.
Parameters:
{ZmZimbrAccount} account
the account
{AjxCallback} callback
the callback
Returns:
{ZmAccessControlList} the ACL

{ZmZimbraAccount} getActiveAccount()
Gets the active account.
Returns:
{ZmZimbraAccount} the active account

{ZmActivityStreamPromptDialog} getActivityStreamFilterDialog()
Gets the activity stream prompt dialog for running activity stream filters
Returns:
{ZmActivityStreamPromptDialog}

{ZmActivityToInboxPromptDialog} getActivityToInboxFilterDialog()
Gets the prompt for moving files from the Activity Stream to the Inbox
Returns:
{ZmActivityToInboxPromptDialog}

{ZmApp} getApp(appName)
Gets the application.
Parameters:
{String} appName
the application name
Returns:
{ZmApp} the application or null if not found

{ZmAppChooser} getAppChooser()
Gets the application chooser.
Returns:
{ZmAppChooser} the chooser

{ZmController} getAppController()
Gets the application controller.
Returns:
{ZmController} the controller

{ZmAppViewMgr} getAppViewMgr()
Gets the application view manager.
Returns:
{ZmAppViewMgr} the view manager

{ZmAttachDialog} getAttachDialog()
Gets the attach dialog.
Returns:
{ZmAttachDialog} the attach dialog

getAutocompleteCache(acType, str, account, create)
Gets the autocomplete cache for the given parameters, optionally creating one.
Parameters:
{String} acType
the item type
{String} str
the autocomplete string
{ZmAccount} account
the account
{Boolean} create
if true, create a cache if none found

{ZmAutocomplete} getAutocompleter()
Gets the auto completer.
Returns:
{ZmAutocomplete} the auto completer

{ZmCalMgr} getCalManager()
Gets the calendar manager.
Returns:
{ZmCalMgr} the calendar manager

{DwtMessageDialog} getCancelMsgDialog()
Gets the cancel message dialog.
Returns:
{DwtMessageDialog} the message dialog

getChangePasswordWindow(ev)
Opens a new change password window
Parameters:
ev

getCharset()
Returns:
Returns language specific charset. Currently supports only Japanese. Returns "Windows-31J" for Japanese or returns "UTF-8" for everything else

{ZmChooseFolderDialog} getChooseFolderDialog(appName)
Gets the choose folder dialog.
Parameters:
appName
Returns:
{ZmChooseFolderDialog} the choose folder dialog

{ZmClientCmdHandler} getClientCmdHandler(clientCmdHdlr)
Gets the client command handler.
Parameters:
{ZmClientCmdHandler} clientCmdHdlr
not used
Returns:
{ZmClientCmdHandler} the command handler

{AjxClipboard} getClipboard()
Returns the singleton AjxClipboard instance, if it is supported.
Returns:
{AjxClipboard}

{DwtConfirmDialog} getConfirmationDialog(id)
Gets the confirm dialog.
Parameters:
id
Returns:
{DwtConfirmDialog} the confirmation dialog

{ZmContactQuickAddDialog} getContactQuickAddDialog()
Gets the quickadd dialog for creating a contact
Returns:
{ZmContactQuickAddDialog}

{ZmApp} getCurrentApp()
Gets the current application.
Returns:
{ZmApp} the current application

{String} getCurrentAppName()
Gets the name of the current application.
Returns:
{String} the application name

{ZmController} getCurrentController()
Gets the current controller.
Returns:
{ZmController} the current controller

{ZmList} getCurrentList()
Gets the current list.
Returns:
{ZmList} the current list

{ZmSearch} getCurrentSearch()
Gets the current search.
Returns:
{ZmSearch} the current search

{DwtComposite} getCurrentView()
Gets the current view.
Returns:
{DwtComposite} the current view

{String} getCurrentViewId()
Gets the current view id. If we're showing search results, returns the ID of the view within the search results (rather than the ID of the search results).
Returns:
{String} the current view id

{String} getCurrentViewType()
Gets the current view type. If we're showing search results, returns the type of the view within the search results (rather than the type of the search results).
Returns:
{String} the current view type

{ZmModel} getDataSourceCollection(account)
Gets the data source collection.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{ZmModel} the data source collection

{ZmDebugLogDialog} getDebugLogDialog()
Gets the debug log dialog.
Returns:
{ZmDebugLogDialog} the debug log dialog

{ZmDeclineShareDialog} getDeclineShareDialog()
Gets the decline share dialog.
Returns:
{ZmDeclineShareDialog} the decline share dialog

{DwtDialog} getDialog()
Gets the dialog.
Returns:
{DwtDialog} the dialog

{ZmErrorDialog} getErrorDialog()
Gets the error dialog.
Returns:
{ZmErrorDialog} the error dialog

{ZmFilterRuleDialog} getFilterRuleDialog()
Gets the filter rule add/edit dialog.
Returns:
{ZmFilterRuleDialog} the filter rule add/edit dialog

{ZmFolderNotifyDialog} getFolderNotifyDialog()
Gets the folder notify dialog.
Returns:
{ZmFolderNotifyDialog} the folder notify dialog

{ZmFolderPropsDialog} getFolderPropsDialog()
Gets the folder properties dialog.
Returns:
{ZmFolderPropsDialog} the folder properties dialog

{ZmFolderTree} getFolderTree(account)
Gets the folder organizer tree.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{ZmFolderTree} the tree
See:
#getTree

{DwtMessageDialog} getHelpMsgDialog()
Gets the message dialog with a help button.
Returns:
{DwtMessageDialog} the message dialog

{AjxHistoryMgr} getHistoryMgr()
Gets the history manager.
Returns:
{AjxHistoryMgr} the history manager

{ZmIdentityCollection} getIdentityCollection(account)
Gets the identity collection.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{ZmIdentityCollection} the identity collection

{ZmImportExportController} getImportExportController()
Gets the import/export controller.
Returns:
{ZmImportExportController} the controller

{DwtKeyboardMgr} getKeyboardMgr()
Gets the keyboard manager
Returns:
{DwtKeyboardMgr} the keyboard manager

getLoggedInUsername()

{ZmMailRedirectDialog} getMailRedirectDialog()
Gets the mail redirect dialog.
Returns:
{ZmMailRedirectDialog} the new mail redirect dialog

{DwtMessageDialog} getMsgDialog()
Gets the message dialog.
Returns:
{DwtMessageDialog} the message dialog

{ZmNewAddrBookDialog} getNewAddrBookDialog()
Gets the new address book dialog.
Returns:
{ZmNewAddrBookDialog} the new address book dialog

{ZmNewBriefcaseDialog} getNewBriefcaseDialog()
Gets the new briefcase dialog.
Returns:
{ZmNewBriefcaseDialog} the new briefcase dialog

{ZmNewCalendarDialog} getNewCalendarDialog()
Gets the new calendar dialog.
Returns:
{ZmNewCalendarDialog} the new calendar dialog

{ZmNewContactGroupDialog} getNewContactGroupDialog()
Gets the new contact group dialog.
Returns:
{ZmNewContactGroupDialog} the new contact group dialog

{ZmNewFolderDialog} getNewFolderDialog()
Gets the new folder dialog.
Returns:
{ZmNewFolderDialog} the new folder dialog

{ZmNewSearchDialog} getNewSearchDialog()
Gets the new search dialog.
Returns:
{ZmNewSearchDialog} the new search dialog

{ZmNewTagDialog} getNewTagDialog()
Gets the new tag dialog.
Returns:
{ZmNewTagDialog} the new tag dialog

{ZmNewTaskFolderDialog} getNewTaskFolderDialog()
Gets the new task folder dialog.
Returns:
{ZmNewTaskFolderDialog} the new task folder dialog

getNewWindow(fullView, width, height, name)
Gets a new window.
Parameters:
{Boolean} fullView
true to include the full version
{int} width
the width
{int} height
the height
{String} name
window name

{ZmOfflineSettingsDialog} getOfflineSettingsDialog()
Gets the offline settings dialog.
Returns:
{ZmOfflineSettingsDialog} offline settings dialog

{DwtMessageDialog} getOkCancelMsgDialog()
Gets the ok/cancel message dialog.
Returns:
{DwtMessageDialog} the message dialog

{ZmOverviewController} getOverviewController(dontCreate)
Gets the overview controller. Creates a new one if not already set, unless dontCreate is true.
Parameters:
{boolean} dontCreate
(optional) - don't create overviewController if not created already. (see ZmApp for usage with dontCreate == true)
Returns:
{ZmOverviewController} the overview controller

{String} getOverviewId(parts, account)
Gets the overview ID, prepending account name if multi-account.
Parameters:
{Array} parts
an array of {String} id components
{ZmAccount} account
the account
Returns:
{String} the id

{ZmPasswordUpdateDialog} getPasswordChangeDialog()
Gets the password update dialog.
Returns:
{ZmPasswordUpdateDialog} the rename tag dialog

{ZmPickTagDialog} getPickTagDialog()
Gets the pick tag dialog.
Returns:
{ZmPickTagDialog} the pick tag dialog

{ZmPriorityMessageFilterDialog} getPriorityMessageFilterDialog()
Gets the priority message filter dialog.
Returns:
{ZmPriorityMessageFilterDialog} the priority message filter dialog

{ZmRenameFolderDialog} getRenameFolderDialog()
Gets the rename folder dialog.
Returns:
{ZmRenameFolderDialog} the rename folder dialog

{ZmRenameTagDialog} getRenameTagDialog()
Gets the rename tag dialog.
Returns:
{ZmRenameTagDialog} the rename tag dialog

{ZmFindnReplaceDialog} getReplaceDialog()
Gets the find-and-replace dialog.
Returns:
{ZmFindnReplaceDialog} the find-and-replace dialog

{ZmRequestMgr} getRequestMgr()
Gets the request manager.
Returns:
{ZmRequestMgr} the request manager

{ZmRetetionWarningDialog} getRetentionWarningDialog()
Gets the mail retention warning dialog.
Returns:
{ZmRetetionWarningDialog} the new mail retention warning dialog

{ZmRevokeShareDialog} getRevokeShareDialog()
Gets the revoke share dialog.
Returns:
{ZmRevokeShareDialog} the revoke share dialog

{DwtTabGroup} getRootTabGroup()
Gets the root tab group.
Returns:
{DwtTabGroup} the root tab group

{ZmSearchController} getSearchController()
Gets the search bar controller.
Returns:
{ZmSearchController} the search controller

{ZmSettings} getSettings(account)
Gets the settings for the given account.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{ZmSettings} the settings

{ZmSharePropsDialog} getSharePropsDialog()
Gets the share properties dialog.
Returns:
{ZmSharePropsDialog} the share properties dialog

{DwtShell} getShell()
Gets the shell.
Returns:
{DwtShell} the shell

{String} getShortcutHint(keyMap, shortcut)
Gets the shortcut hint.
Parameters:
{String} keyMap
the key map
{String} shortcut
the shortcut action
Returns:
{String} the hint

{ZmShortcutsPanel} getShortcutsPanel()
Gets the shortcuts panel.
Returns:
{ZmShortcutsPanel} the shortcuts panel

{ZmSignatureCollection} getSignatureCollection(account)
Gets the signature collection.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{ZmSignatureCollection} the signature collection

{String} getSkinHint()
Gets the skin hint for the given argument(s), which will be used to look successively down the properties chain.

For example, getSkinHint("a", "b") will return the value of skin.hints.a.b.

Returns:
{String} the skin hint

{ZmTimeSuggestionPrefDialog} getSuggestionPreferenceDialog()
Gets the new suggestion Preferences dialog
Returns:
{ZmTimeSuggestionPrefDialog}

{ZmTagTree} getTagTree(account)
Gets the tag organizer tree.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{ZmTagTree} the tree
See:
#getTree

{ZmTaskMgr} getTaskManager()
Gets the task manager.
Returns:
{ZmTaskMgr} the task manager

{ZmTimezonePicker} getTimezonePickerDialog()
Gets the timezone picker dialog.
Returns:
{ZmTimezonePicker} the timezone picker dialog

{ZmTree} getTree(type, account)
Gets the organizer tree.
Parameters:
{ZmOrganizer.FOLDER|ZmOrganizer.TAG|ZmOrganizer.ZIMLET} type
the type
{ZmZimbraAccount} account
the account
Returns:
{ZmTree} the tree
See:
#getFolderTree
#getTagTree
#getZimletTree

{ZmUploadConflictDialog} getUploadConflictDialog()
Gets the upload conflict dialog.
Returns:
{ZmUploadConflictDialog} the upload conflict dialog

{ZmUploadDialog} getUploadDialog()
Gets the upload dialog.
Returns:
{ZmUploadDialog} the upload dialog

{String} getUploadFrameId()
Gets the upload frame id.
Returns:
{String} the frame id

{Object} getUploadManager()
Gets the upload manager.
Returns:
{Object} the upload manager

{String} getUserDomain(account)
Gets the user domain.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{String} the user domain

{String} getUsername(account)
Gets the username (which is an email address).
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{String} the username

{String} getViewTypeFromId(viewId)
Extracts the view type from a view ID.
Parameters:
{string} viewId
a view ID
Returns:
{String} the view type

{DwtMessageDialog} getYesNoCancelMsgDialog()
Gets the yes/no/cancel message dialog.
Returns:
{DwtMessageDialog} the message dialog

{DwtMessageDialog} getYesNoMsgDialog(id)
Gets the yes/no message dialog.
Parameters:
id
Returns:
{DwtMessageDialog} the message dialog

{ZmZimletMgr} getZimletMgr()
Gets the zimlet manager
Returns:
{ZmZimletMgr} the zimlet manager

{ZmFolderTree} getZimletTree(account)
Gets the zimlet organizer tree.
Parameters:
{ZmZimbraAccount} account
the account
Returns:
{ZmFolderTree} the tree
See:
#getTree

handlePopupBlocker(win)
Handle Popup bloker for a given window
Parameters:
{Object} win
A Window object

<static> {Object} ZmAppCtxt.handleWindowOpener()
When using pre-auth window.opener.appCtxt may not be accessible. This function handles appCtxt assignment to avoid a permission denied error
Returns:
{Object} ZmAppCtxt

isExpandableDL(addr)
Returns true if an address is an expandable DL.
Parameters:
{string} addr
email address

{ZmZimbraAccount} isExternalAccount()
Gets the active account.
Returns:
{ZmZimbraAccount} the active account

{Boolean} isMyAddress(addr, allowLocal, excludeAllowFromAddress)
Checks if my address belongs to the current user (include aliases).
Parameters:
{String} addr
the address
{Boolean} allowLocal
if true, domain is not required
{Boolean} excludeAllowFromAddress
if true, addresses in zimbraAllowFromAddresses are ignored
Returns:
{Boolean} true if the given address belongs to the current user; false otherwise

{Boolean} isRemoteId(id)
Returns true if the given ID is not local. That's the case if the ID has an account part that is not the active account.
Parameters:
{String|Number} id
Returns:
{Boolean} true if the given ID is not local

{Boolean} isSpellCheckerAvailable()
Gets the availability of the spell check feature based on the current locale and user's configuration
Returns:
{Boolean} true if the spell checker is available.

isZDOnline()
Returns true if Prism and the user is online

{Boolean} notifyZimlets(event, args, options)
Notifies zimlets if they are present and loaded.
Parameters:
{String} event
the zimlet event (called as a zimlet function)
{Array} args
a list of args to the function
{Hash} options
a hash of options
{Boolean} options.noChildWindow
if true, skip notify if we are in a child window
{Boolean} options.waitUntilLoaded
if true and zimlets are not yet loaded, add a listener so that notify happens on load
Returns:
{Boolean} Returns true if at least one Zimlet handles the notification

{Boolean} removeAuthTokenWarningListener(listener)
Removes a listener for the auth token warning event.
Parameters:
{AjxCallback} listener
the listener
Returns:
{Boolean} true if the listener is removed; false otherwise

set(id, value, key, setDefault, skipNotify, account, skipImplicit)
Sets the value of the given setting.
Parameters:
{constant} id
the setting id
{Object} value
the setting value
{String} key
the setting key (for settings that are of the hash type)
{Boolean} setDefault
if true, also replace setting default value
{Boolean} skipNotify
if true, do not notify setting listeners
{ZmZimbraAccount} account
if set, use this account setting instead of the currently active account
{Boolean} skipImplicit
if true, do not check for change to implicit pref

setAppController(appController)
Sets the application controller.
Parameters:
{ZmController} appController
the controller

setCurrentList(list)
Sets the current list.
Parameters:
{ZmList} list
the current list

setIsExpandableDL(addr, isExpandableDL)
Cache whether an address is an expandable DL.
Parameters:
{string} addr
email address
{boolean} isExpandableDL
if true, address is expandable DL TODO: consider caching AjxEmailAddress objects by addr so we also save display name

setRequestMgr(requestMgr)
Sets the request manager.
Parameters:
{ZmRequestMgr} requestMgr
the request manager

setSettings(settings, account)
Sets the settings for the given account.
Parameters:
{ZmSettings} settings
the settings
{ZmZimbraAccount} account
the account

setShell(the)
Sets the shell.
Parameters:
{DwtShell} the
shell

setStatusMsg(params)
Sets the status message to display.
Parameters:
{Hash} params
a hash of parameters
{String} params.msg
the status message
{constant} params.level
the status level ZmStatusView (may be null)
{String} params.detail
the details (may be null)
{Object} params.transitions
the transitions (may be null)
{Object} params.toast
the toast control (may be null)
{boolean} params.force
force any displayed toasts out of the way (dismiss them and run their dismissCallback). Enqueued messages that are not yet displayed will not be displayed
{AjxCallback} params.dismissCallback
callback to run when the toast is dismissed (by another message using [force], or explicitly calling ZmStatusView.prototype.dismiss())
{AjxCallback} params.finishCallback
callback to run when the toast finishes its transitions by itself (not when dismissed)

setTree(type, tree, account)
Sets the organizer tree.
Parameters:
{ZmOrganizer.FOLDER|ZmOrganizer.TAG|ZmOrganizer.ZIMLET} type
the type
{ZmTree} tree
the tree
{ZmZimbraAccount} account
the account
See:
#getTree

setZimletsPresent(zimletsPresent)
Sets if the zimlets are present.
Parameters:
{Boolean} zimletsPresent
if true, zimlets are present

showError(errMsg, details, style, title)
Displays an error message in dialog.
Parameters:
{string} errMsg
error message
{string} details
(optional) additional info to show using Details button
{string} style
(optional) style constant DwtMessageDialog.*_STYLE
{string} title
(optional) title for dialog (other than one for the style)

{String} toString()
Returns a string representation of the application context.
Returns:
{String} a string representation of the application context

{Boolean} zimletsPresent()
Checks if the zimlets are present.
Returns:
{Boolean} true if zimlets are present

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