Zimlet JavaScript API Reference - ZmZimlet

Class ZmZimlet


Extends ZmOrganizer.

This class represents a zimlet.

Defined in: ZmZimlet.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmZimlet(id, name, parent, tree, color)
Creates the zimlet
Method Summary
Method Attributes Method Name and Description
<static>  
ZmZimlet.checkName(name)
Checks the name.
 
Gets the icon.
 
Gets the zimlet context.
 
Resets the names.
 
setName(name)
Sets the name
 
setToolTipText(control)
Sets the tool tip text on the control.
<static>  
ZmZimlet.sortCompare(zimletA, zimletB)
Compares and sorts the zimlets by name (case-insensitive).
 
Checks if the tag supports sharing.
 
Returns a string representation of the object.
Methods borrowed from class ZmOrganizer:
addChangeListener, addShare, clearShares, deleteLocal, empty, getAccount, getById, getByName, getByPath, getByType, getChild, getChildByPath, getColor, getDataSources, getFolder, getIconWithColor, getMainShare, getName, getOwner, getOwnerRestUrl, getPath, getRemoteId, getRestUrl, getSearchPath, getShares, getSyncUrl, getToolTip, getUrl, hasChild, hasFeeds, hasPrivateAccess, hasUnreadDescendent, isAdmin, isChildOf, isColorChanged, isDataSource, isFeed, isInTrash, isPermAllowed, isReadOnly, isRemote, isSystem, isUnder, markAllRead, move, notifyCreate, notifyDelete, notifyModify, removeChangeListener, rename, reparent, setColor, setGlobalMarkRead, setOfflineSyncInterval, setRetentionPolicy, setRGB, size, supportsPrivatePermission, supportsPublicAccess, sync, update
Class Detail
ZmZimlet(id, name, parent, tree, color)
Creates the zimlet
Parameters:
{String} id
the id
{String} name
the name
{Object} parent
the parent
{ZmTree} tree
the tree
{String} color
the color
Method Detail
<static> {String} ZmZimlet.checkName(name)
Checks the name.
Parameters:
{String} name
the name
Returns:
{String} the name
See:
ZmOrganizer.checkName()

{String} getIcon()
Gets the icon.
Returns:
{String} the icon

{ZmZimletContext} getZimletContext()
Gets the zimlet context.
Returns:
{ZmZimletContext} the context

resetNames()
Resets the names.

setName(name)
Sets the name
Parameters:
{String} name
the name

setToolTipText(control)
Sets the tool tip text on the control.
Parameters:
{DwtControl} control
the control

<static> {int} ZmZimlet.sortCompare(zimletA, zimletB)
Compares and sorts the zimlets by name (case-insensitive).
Parameters:
{ZmZimlet} zimletA
the zimlet
{ZmZimlet} zimletB
the zimlet
Returns:
{int} 0 if the zimlets match; 1 if "a" is before "b"; -1 if "b" is before "a"

{Boolean} supportsSharing()
Checks if the tag supports sharing.
Returns:
{Boolean} always returns false. Zimlets cannot be shared.

{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)