Zimlet JavaScript API Reference - ZmToolTipMgr

Class ZmToolTipMgr


This singleton class manages tooltip content generation and retrieval. Tooltips are broken down by type based on what they show (for example information about a person). Each type has a handler, which gets passed the appropriate data and generates the tooltip content.

Defined in: ZmToolTipMgr.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmToolTipMgr(container, mailApp)
Creates a tooltip manager.
Method Summary
Method Attributes Method Name and Description
 
getPersonToolTip(params, address, contact, ev, noRightClick, callback)
Returns tooltip content for a person based on an email address or contact.
 
getToolTip(type, params, callback)
Returns tooltip content for the given type with the given data.
 
registerToolTipHandler(type, handler)
Associates a type of tooltip with a function to generate its content.
Class Detail
ZmToolTipMgr(container, mailApp)
Creates a tooltip manager.
Author: Conrad Damon.
Parameters:
{DwtComposite} container
the containing shell
{ZmMailApp} mailApp
the containing app
Method Detail
getPersonToolTip(params, address, contact, ev, noRightClick, callback)
Returns tooltip content for a person based on an email address or contact.
Parameters:
{hash} params
hash of params:
{string|AjxEmailAddress} address
email address
{ZmContact} contact
contact - need either address or contact
{DwtMouseEvent} ev
mouseover event
{boolean} noRightClick
if true, don't show right click hint
{AjxCallback} callback
callback to run with results (optional)

getToolTip(type, params, callback)
Returns tooltip content for the given type with the given data.
Parameters:
{constant} type
type of tooltip
{hash} params
arbitrary data to pass to tooltip function
{AjxCallback} callback
callback to run with results (optional)

registerToolTipHandler(type, handler)
Associates a type of tooltip with a function to generate its content.
Parameters:
{constant} type
type of tooltip
{function} handler
function that returns tooltip content

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