Zimlet JavaScript API Reference - ZmTag

Class ZmTag


Extends ZmOrganizer.

This class represents a tag.

Defined in: ZmTag.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmTag(params)
Creates a tag
Method Summary
Method Attributes Method Name and Description
<static>  
ZmTag.checkColor(color)
Checks the color.
<static>  
ZmTag.checkName(name)
Checks the tag name.
<static>  
ZmTag.create(params)
Creates a tag.
 
Creates a query for this tag.
 
Gets the icon.
 
map from tag names to tags.
 
Gets the tool tip.
<static>  
ZmTag.sortCompare(tagA, tagB)
Compares the tags by name.
 
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, 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
ZmTag(params)
Creates a tag
Parameters:
{Hash} params
a hash of parameters
Method Detail
<static> {Number} ZmTag.checkColor(color)
Checks the color.
Parameters:
{String} color
the color
Returns:
{Number} the valid color

<static> {String} ZmTag.checkName(name)
Checks the tag name.
Parameters:
{String} name
the name
Returns:
{String} null if the name is valid or a error message

<static> ZmTag.create(params)
Creates a tag.
Parameters:
{Hash} params
a hash of parameters

{String} createQuery()
Creates a query for this tag.
Returns:
{String} the tag query

{String} getIcon()
Gets the icon.
Returns:
{String} the icon or null for no icon

getTagNameMap()
map from tag names to tags. used by getByNameOrRemote

{String} getToolTip()
Gets the tool tip.
Returns:
{String} the tool tip

<static> {int} ZmTag.sortCompare(tagA, tagB)
Compares the tags by name.
Parameters:
{ZmTag} tagA
the first tag
{ZmTag} tagB
the second tag
Returns:
{int} 0 if the tag names match (case-insensitive); 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. Tags 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)