Zimlet JavaScript API Reference - ZmZimletApp

Class ZmZimletApp


Extends ZmApp.

This object represents a Zimlet Application.

Defined in: ZmZimletApp.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmZimletApp(name, zimlet, container)
Method Summary
Method Attributes Method Name and Description
 
activate(active, viewId)
Activates the application.
 
Gets the controller.
 
Gets the toolbar.
 
launch(params, callback)
Launches the application.
 
setContent(html)
Sets the content on the view.
 
Sets the overview tree to display overview content for this application.
 
setView(view)
Sets the view.
 
Returns a string representation of the object.
Methods borrowed from class ZmApp:
addDeferredFolder, createView, deleteSessionController, disposeTreeControllers, getDisplayName, getInitialSearchType, getLimit, getName, getNumSessionControllers, getOverview, getOverviewContainer, getOverviewId, getOverviewPanelContent, getRemoteFolderIds, getSearchParams, getSessionController, getTypeFromController, isActive, popView, pushView, reset, resetOverview, resetWebClientOfflineOperations, setAppView, stageView, startAlert, stopAlert
Class Detail
ZmZimletApp(name, zimlet, container)
Parameters:
{String} name
the application name
{ZmZimlet} zimlet
the zimlet
{DwtControl} container
the container
Method Detail
activate(active, viewId)
Activates the application.
Parameters:
{Boolean} active
if true, active; false otherwise
{String} viewId
the view id

{ZmZimletAppController} getController()
Gets the controller.
Returns:
{ZmZimletAppController} the controller

{ZmToolbar} getToolbar()
Gets the toolbar.
Returns:
{ZmToolbar} the toolbar

launch(params, callback)
Launches the application.
Parameters:
{Hash} params
a hash of parameters
{AjxCallback} callback
the callback

setContent(html)
Sets the content on the view.
Parameters:
{String} html
the HTML content

setOverviewPanelContent(reset)
Sets the overview tree to display overview content for this application.
Parameters:
{Boolean} reset
if true, clear the content first

setView(view)
Sets the view.
Parameters:
{DwtComposite} view
the view

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

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