Classes

Files

Class YAHOO.widget.Tooltip

Object
   |
   +--YAHOO.widget.Tooltip
class YAHOO.widget.Tooltip
Quick Links:  Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

string CSS_TOOLTIP
Constant representing the Tooltip CSS class 

Constructor Summary [top]

YAHOO.widget.Tooltip
Copyright (c) 2006, Yahoo! 

Method Summary [top]

void configContainer (type, args, obj)
The default event handler fired when the "container" property is changed. 
void configContext (type, args, obj)
The default event handler fired when the "context" property is changed. 
void configText (type, args, obj)
The default event handler fired when the "text" property is changed. 
Object doHide ()
Sets the timeout for the auto-dismiss delay, which by default is 5 seconds, meaning that a tooltip will automatically dismiss itself after 5 seconds of being displayed. 
int doShow (<DOMEvent> e, context)
Processes the showing of the Tooltip by setting the timeout delay and offset of the Tooltip. 
void init (<string> <Element> el, <object> userConfig)
The Tooltip initialization method. 
void initDefaultConfig ()
Initializes the class's configurable properties which can be changed using the Overlay's Config object (cfg). 
void onContextMouseMove (<DOMEvent> e, <object> obj)
The default event handler fired when the user moves the mouse while over the context element. 
void onContextMouseOut (<DOMEvent> e, <object> obj)
The default event handler fired when the user mouses out of the context element. 
void onContextMouseOver (<DOMEvent> e, <object> obj)
The default event handler fired when the user mouses over the context element. 
void preventOverlap (pageX, pageY)
Fired when the Tooltip is moved, this event handler is used to prevent the Tooltip from overlapping with its context element. 
string toString ()
Returns a string representation of the object. 

Field Detail [top]

CSS_TOOLTIP

string   CSS_TOOLTIP
Constant representing the Tooltip CSS class

Constructor Detail [top]

YAHOO.widget.Tooltip

YAHOO.widget.Tooltip ()
Copyright (c) 2006, Yahoo! Inc. All rights reserved. Code licensed under the BSD License: http://developer.yahoo.net/yui/license.txt
Parameters:
el - The element ID representing the Tooltip OR
el - The element representing the Tooltip
userConfig - The configuration object literal containing the configuration that should be set for this Overlay. See configuration documentation for more details.
HASH(0x1dfe1c0)

Method Detail [top]

configContainer

void configContainer (type, args, obj)
The default event handler fired when the "container" property is changed. HASH(0x1da29ec)

configContext

void configContext (type, args, obj)
The default event handler fired when the "context" property is changed. HASH(0x1da2bf0)

configText

void configText (type, args, obj)
The default event handler fired when the "text" property is changed. HASH(0x1da2e48)

doHide

Object doHide ()
Sets the timeout for the auto-dismiss delay, which by default is 5 seconds, meaning that a tooltip will automatically dismiss itself after 5 seconds of being displayed. HASH(0x1da8d58)

doShow

int doShow (<DOMEvent> e, context)
Processes the showing of the Tooltip by setting the timeout delay and offset of the Tooltip.
Parameters:
e - The current DOM event
Returns:
The process ID of the timeout function associated with doShow
HASH(0x1da8c44)

init

void init (<string> <Element> el, <object> userConfig)
The Tooltip initialization method. This method is automatically called by the constructor. A Tooltip is automatically rendered by the init method, and it also is set to be invisible by default, and constrained to viewport by default as well.
Parameters:
el - The element ID representing the Tooltip OR
el - The element representing the Tooltip
userConfig - The configuration object literal containing the configuration that should be set for this Tooltip. See configuration documentation for more details.
HASH(0x1da91cc)

initDefaultConfig

void initDefaultConfig ()
Initializes the class's configurable properties which can be changed using the Overlay's Config object (cfg). HASH(0x1da92bc)

onContextMouseMove

void onContextMouseMove (<DOMEvent> e, <object> obj)
The default event handler fired when the user moves the mouse while over the context element.
Parameters:
e - The current DOM event
obj - The object argument
HASH(0x1da9694)

onContextMouseOut

void onContextMouseOut (<DOMEvent> e, <object> obj)
The default event handler fired when the user mouses out of the context element.
Parameters:
e - The current DOM event
obj - The object argument
HASH(0x1da9a00)

onContextMouseOver

void onContextMouseOver (<DOMEvent> e, <object> obj)
The default event handler fired when the user mouses over the context element.
Parameters:
e - The current DOM event
obj - The object argument
HASH(0x1d60440)

preventOverlap

void preventOverlap (pageX, pageY)
Fired when the Tooltip is moved, this event handler is used to prevent the Tooltip from overlapping with its context element. HASH(0x1d4a434)

toString

string toString ()
Returns a string representation of the object. HASH(0x1da262c)