Zimlet JavaScript API Reference - ZmZimletContext

Class ZmZimletContext


This class represents the Zimlet context.

Defined in: ZmZimletContext.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmZimletContext(id, zimlet)
Creates the Zimlet context.
Field Summary
Field Attributes Field Name and Description
 
The zimlet description.
 
The zimlet name.
 
The zimlet version.
Method Summary
Method Attributes Method Name and Description
 
getConfig(name)
Gets the configuration value.
 
Gets the organizer.
 
Gets the panel action menu.
 
getProp(name)
Gets the property.
 
Gets the property.
 
Gets the URL.
 
getVal(key)
Gets the value.
 
getXslt(url)
Gets the xslt.
 
Sets the panel action menu.
 
setPropValue(name, val)
Sets the property.
 
Returns a string representation of the object.
Class Detail
ZmZimletContext(id, zimlet)
Creates the Zimlet context.
Parameters:
{String} id
the id
{ZmZimletBase} zimlet
the Zimlet
Field Detail
{String} description
The zimlet description.

{String} name
The zimlet name.

{String} version
The zimlet version.
Method Detail
{Object} getConfig(name)
Gets the configuration value.
Parameters:
{String} name
the config key name
Returns:
{Object} the config value or null if not set

{ZmOrganizer} getOrganizer()
Gets the organizer.
Returns:
{ZmOrganizer} the organizer

{ZmActionMenu} getPanelActionMenu()
Gets the panel action menu.
Returns:
{ZmActionMenu} the menu

{Object} getProp(name)
Gets the property.
Parameters:
{String} name
the name
Returns:
{Object} the property

{Object} getPropValue(name)
Gets the property.
Parameters:
{String} name
the name
Returns:
{Object} value

{String} getUrl()
Gets the URL.
Returns:
{String} the URL

{Object} getVal(key)
Gets the value.
Parameters:
{String} key
the key
Returns:
{Object} the value

{AjxXslt} getXslt(url)
Gets the xslt.
Parameters:
{String} url
the URL
Returns:
{AjxXslt} the xslt

setPanelActionMenu(menu)
Sets the panel action menu.
Parameters:
{ZmActionMenu} menu
the menu

setPropValue(name, val)
Sets the property.
Parameters:
{String} name
the name
{Object} val
the value

{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:39 GMT-0400 (EDT)