Zimlet JavaScript API Reference - ZmNewWindow

Class ZmNewWindow


Extends ZmController.

This class is the controller for a window created outside the main client window. It is a very stripped down and specialized version of ZmZimbraMail. The child window is single-use; it does not support switching among multiple views.

Defined in: ZmNewWindow.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Creates a controller to run ZmNewWindow.
Method Summary
Method Attributes Method Name and Description
 
cancelRequest(reqId, errorCallback, noBusyOverlay)
Cancels the request.
 
getApp(appName)
Gets a handle to the given app.
 
Gets a handle to the app view manager.
 
Gets the key map manager.
 
Gets the key map name.
 
handleKeyAction(actionCode, ev)
Handles the key action.
 
popupErrorDialog(msg, ex, noExecReset, hideReportButton)
Popup the error dialog.
<static>  
ZmNewWindow.run()
Sets up new window and then starts it by calling its constructor.
 
sendRequest(params)
Sends the server requests to the main controller.
 
setStatusMsg(params)
Set status messages via the main controller, so they show up in the client's status area.
 
Presents a view based on a command passed through the window object.
<static>  
ZmNewWindow.unload(ev)
Allows this child window to inform parent it's going away
Methods borrowed from class ZmController:
getCurrentViewId, getCurrentViewType, getNewFolderCallback, getSessionId, getTabGroup, getViewElements, isTransient, mapSupported, popupUploadErrorDialog, setCurrentViewId, setCurrentViewType, setSessionId
Class Detail
ZmNewWindow()
Creates a controller to run ZmNewWindow. Do not call directly, instead use the run() factory method.
Author: Parag Shah.
See:
#run
Method Detail
cancelRequest(reqId, errorCallback, noBusyOverlay)
Cancels the request.
Parameters:
{String} reqId
the request id
{AjxCallback} errorCallback
the callback
{Boolean} noBusyOverlay
if true, do not show a busy overlay

{ZmApp} getApp(appName)
Gets a handle to the given app.
Parameters:
{String} appName
the app name
Returns:
{ZmApp} the application

{ZmAppViewMgr} getAppViewMgr()
Gets a handle to the app view manager.
Returns:
{ZmAppViewMgr} the view manager

{DwtKeyMapMgr} getKeyMapMgr()
Gets the key map manager.
Returns:
{DwtKeyMapMgr} the key map manager

{String} getKeyMapName()
Gets the key map name.
Returns:
{String} the key map name

{Boolean} handleKeyAction(actionCode, ev)
Handles the key action.
Parameters:
{Object} actionCode
the action code
{Object} ev
the event
Returns:
{Boolean} true if the action is handled

popupErrorDialog(msg, ex, noExecReset, hideReportButton)
Popup the error dialog.
Parameters:
{String} msg
the message
{AjxException} ex
the exception
{Boolean} noExecReset
{Boolean} hideReportButton

<static> ZmNewWindow.run()
Sets up new window and then starts it by calling its constructor. It is assumed that the CSFE is on the same host.

sendRequest(params)
Sends the server requests to the main controller.
Parameters:
{Hash} params
a hash of parameters

setStatusMsg(params)
Set status messages via the main controller, so they show up in the client's status area.
Parameters:
{Hash} params
a hash of parameters

startup()
Presents a view based on a command passed through the window object. Possible commands are:
  • compose compose window launched in child window
  • composeDetach compose window detached from client
  • msgViewDetach msg view detached from client

<static> ZmNewWindow.unload(ev)
Allows this child window to inform parent it's going away
Parameters:
ev

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