webgui/www/extras/yui/docs/YAHOO.widget.Tooltip.html
JT Smith 20f8df1291 upgrading to YUI 2.6
data tables are going to need some work yet, but the other stuff seems to be working 100%
2008-10-22 23:53:29 +00:00

1716 lines
98 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: container YAHOO.widget.Tooltip (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>Container&nbsp; <span class="subtitle">2.6.0</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_container.html">container</a>
&gt; YAHOO.widget.Tooltip
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<h2>
Class <b>YAHOO.widget.Tooltip</b>
<span class="extends">
- extends <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>
</span>
<span class="extends">
</span>
</code>
</h2>
<!-- class tree goes here -->
<div class="summary description">
Tooltip is an implementation of Overlay that behaves like an OS tooltip,
displaying when the user mouses over a particular element, and
disappearing on mouse out.
</div>
<div class="section constructor details">
<h3 id="constructor">Constructor</h3>
<div class="content">
<div class="detail">
<strong>YAHOO.widget.Tooltip</strong>
<code>
(
el
,
userConfig
)
</code>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el
&lt;String&gt;
</code>
The element ID representing the Tooltip <em>OR</em>
</dd>
<dd>
<code>el
&lt;HTMLElement&gt;
</code>
The element representing the Tooltip
</dd>
<dd>
<code>userConfig
&lt;Object&gt;
</code>
The configuration object literal containing
the configuration that should be set for this Overlay. See configuration
documentation for more details.
</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="section field details">
<h3 id="properties">Properties</h3>
<div class="content">
<div class="private">
<h4><a name="property_DEFAULT_CONFIG">DEFAULT_CONFIG</a>
<code>- private final Object</code>
</h4>
<div class="detail">
<div class="description">
Constant representing the Tooltip's configuration properties
</div>
</div>
<hr />
</div>
<div class="private">
<h4><a name="property_EVENT_TYPES">EVENT_TYPES</a>
<code>- private final Object</code>
</h4>
<div class="detail">
<div class="description">
Constant representing the name of the Tooltip's events
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_showProcId">showProcId</a>
<code>- int</code>
</h4>
<div class="detail">
<div class="description">
The unique process ID associated with the thread responsible
for showing the Tooltip.
</div>
</div>
<hr />
</div>
<div class="">
<h4><a name="property_YAHOO.widget.Tooltip.CSS_TOOLTIP">YAHOO.widget.Tooltip.CSS_TOOLTIP</a>
<code>- static final String</code>
</h4>
<div class="detail">
<div class="description">
Constant representing the Tooltip CSS class
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Module.html#property_body">body</a><span class="">,</span>
<a class=" deprecated" href="YAHOO.widget.Module.html#property_browser">browser</a><span class=" deprecated">,</span>
<a class="" href="YAHOO.widget.Module.html#property_cfg">cfg</a><span class="">,</span>
<a class="" href="YAHOO.widget.Module.html#property_contructor">contructor</a><span class="">,</span>
<a class="private" href="YAHOO.widget.Module.html#property_DEFAULT_CONFIG">DEFAULT_CONFIG</a><span class="private">,</span>
<a class="" href="YAHOO.widget.Module.html#property_element">element</a><span class="">,</span>
<a class="private" href="YAHOO.widget.Module.html#property_EVENT_TYPES">EVENT_TYPES</a><span class="private">,</span>
<a class="" href="YAHOO.widget.Module.html#property_footer">footer</a><span class="">,</span>
<a class="" href="YAHOO.widget.Module.html#property_header">header</a><span class="">,</span>
<a class="" href="YAHOO.widget.Module.html#property_id">id</a><span class="">,</span>
<a class=" deprecated" href="YAHOO.widget.Module.html#property_imageRoot">imageRoot</a><span class=" deprecated">,</span>
<a class="" href="YAHOO.widget.Module.html#property_isSecure">isSecure</a><span class="">,</span>
<a class="" href="YAHOO.widget.Module.html#property_platform">platform</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Properties inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Overlay.html#property_CONTEXT_TRIGGERS">CONTEXT_TRIGGERS</a><span class="">,</span>
<a class="private" href="YAHOO.widget.Overlay.html#property_DEFAULT_CONFIG">DEFAULT_CONFIG</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.Overlay.html#property_EVENT_TYPES">EVENT_TYPES</a><span class="private">,</span>
<a class="private" href="YAHOO.widget.Overlay.html#property_YAHOO.widget.Overlay._initialized">YAHOO.widget.Overlay._initialized</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="methods">Methods</h3>
<div class="content">
<div class="protected">
<h4>
<a name="method__removeEventListeners">_removeEventListeners</a></h4>
<div class="detail">
<code>
protected
void
<strong>_removeEventListeners</strong>
(
)
</code>
<div class="description">
Removes all of the DOM event handlers from the HTML
element(s) that trigger the display of the tooltip.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configContainer">configContainer</a></h4>
<div class="detail">
<code>
void
<strong>configContainer</strong>
(
type
,
args
,
obj
)
</code>
<div class="description">
The default event handler fired when the "container" property
is changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>type &lt;String&gt;</code>
The CustomEvent type (usually the property name)
</dd>
<dd>
<code>args &lt;Object[]&gt;</code>
The CustomEvent arguments. For
configuration handlers, args[0] will equal the newly applied value
for the property.
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The scope object. For configuration handlers,
this will usually equal the owner.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configContext">configContext</a></h4>
<div class="detail">
<code>
void
<strong>configContext</strong>
(
type
,
args
,
obj
)
</code>
<div class="description">
The default event handler fired when the "context" property
is changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>type &lt;String&gt;</code>
The CustomEvent type (usually the property name)
</dd>
<dd>
<code>args &lt;Object[]&gt;</code>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The scope object. For configuration handlers,
this will usually equal the owner.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_configText">configText</a></h4>
<div class="detail">
<code>
void
<strong>configText</strong>
(
type
,
args
,
obj
)
</code>
<div class="description">
The default event handler fired when the "text" property is changed.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>type &lt;String&gt;</code>
The CustomEvent type (usually the property name)
</dd>
<dd>
<code>args &lt;Object[]&gt;</code>
The CustomEvent arguments. For configuration
handlers, args[0] will equal the newly applied value for the property.
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The scope object. For configuration handlers,
this will usually equal the owner.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_destroy">destroy</a></h4>
<div class="detail">
<code>
void
<strong>destroy</strong>
(
)
</code>
<div class="description">
Removes the Tooltip element from the DOM and sets all child
elements to null.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doHide">doHide</a></h4>
<div class="detail">
<code>
void
<strong>doHide</strong>
(
)
</code>
<div class="description">
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.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_doShow">doShow</a></h4>
<div class="detail">
<code>
Number
<strong>doShow</strong>
(
e
,
context
)
</code>
<div class="description">
Processes the showing of the Tooltip by setting the timeout delay
and offset of the Tooltip.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The current DOM event
</dd>
<dd>
<code>context &lt;HTMLElement&gt;</code>
The current context element
</dd>
</dl>
<dl>
<dt>Returns:
<code>
Number
</code></dt>
<dd>The process ID of the timeout function associated
with doShow</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_init">init</a></h4>
<div class="detail">
<code>
void
<strong>init</strong>
(
el
,
userConfig
)
</code>
<div class="description">
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.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>el &lt;String&gt;</code>
The element ID representing the Tooltip <em>OR</em>
</dd>
<dd>
<code>el &lt;HTMLElement&gt;</code>
The element representing the Tooltip
</dd>
<dd>
<code>userConfig &lt;Object&gt;</code>
The configuration object literal
containing the configuration that should be set for this Tooltip.
See configuration documentation for more details.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initDefaultConfig">initDefaultConfig</a></h4>
<div class="detail">
<code>
void
<strong>initDefaultConfig</strong>
(
)
</code>
<div class="description">
Initializes the class's configurable properties which can be
changed using the Overlay's Config object (cfg).
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_initEvents">initEvents</a></h4>
<div class="detail">
<code>
void
<strong>initEvents</strong>
(
)
</code>
<div class="description">
Initializes the custom events for Tooltip
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onContextMouseMove">onContextMouseMove</a></h4>
<div class="detail">
<code>
void
<strong>onContextMouseMove</strong>
(
e
,
obj
)
</code>
<div class="description">
The default event handler fired when the user moves the mouse while
over the context element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The current DOM event
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The object argument
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onContextMouseOut">onContextMouseOut</a></h4>
<div class="detail">
<code>
void
<strong>onContextMouseOut</strong>
(
e
,
obj
)
</code>
<div class="description">
The default event handler fired when the user mouses out of
the context element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The current DOM event
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The object argument
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onContextMouseOver">onContextMouseOver</a></h4>
<div class="detail">
<code>
void
<strong>onContextMouseOver</strong>
(
e
,
obj
)
</code>
<div class="description">
The default event handler fired when the user mouses over the
context element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The current DOM event
</dd>
<dd>
<code>obj &lt;Object&gt;</code>
The object argument
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_onRender">onRender</a></h4>
<div class="detail">
<code>
void
<strong>onRender</strong>
(
p_sType
,
p_aArgs
)
</code>
<div class="description">
"render" event handler for the Tooltip.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>p_sType &lt;String&gt;</code>
String representing the name of the event
that was fired.
</dd>
<dd>
<code>p_aArgs &lt;Array&gt;</code>
Array of arguments sent when the event
was fired.
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_preventOverlay">preventOverlay</a></h4>
<div class="detail">
<code>
void
<strong>preventOverlay</strong>
(
pageX
,
pageY
)
</code>
<div class="description">
Fired when the Tooltip is moved, this event handler is used to
prevent the Tooltip from overlapping with its context element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>pageX &lt;Number&gt;</code>
The x coordinate position of the mouse pointer
</dd>
<dd>
<code>pageY &lt;Number&gt;</code>
The y coordinate position of the mouse pointer
</dd>
</dl>
<dl>
<dt>Returns:
<code>
void
</code></dt>
<dd></dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="method_toString">toString</a></h4>
<div class="detail">
<code>
String
<strong>toString</strong>
(
)
</code>
<div class="description">
Returns a string representation of the object.
</div>
<div class="description">
<dl>
<dt>Returns:
<code>
String
</code></dt>
<dd>The string representation of the Tooltip</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a class="protected" href="YAHOO.widget.Module.html#method__addToParent">_addToParent</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Module.html#method__initResizeMonitor">_initResizeMonitor</a><span class="protected">,</span> <a class="private" href="YAHOO.widget.Module.html#method__supportsCWResize">_supportsCWResize</a><span class="private">,</span> <a class="" href="YAHOO.widget.Module.html#method_appendToBody">appendToBody</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_appendToFooter">appendToFooter</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_appendToHeader">appendToHeader</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_configMonitorResize">configMonitorResize</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_configVisible">configVisible</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_destroy">destroy</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_hide">hide</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_init">init</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_initDefaultConfig">initDefaultConfig</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_initEvents">initEvents</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_initResizeMonitor">initResizeMonitor</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_onDomResize">onDomResize</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_render">render</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_setBody">setBody</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_setFooter">setFooter</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_setHeader">setHeader</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_show">show</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#method_toString">toString</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Methods inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a class="protected" href="YAHOO.widget.Overlay.html#method__alignOnTrigger">_alignOnTrigger</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Overlay.html#method__autoFillOnHeightChange">_autoFillOnHeightChange</a><span class="protected">,</span> <a class="private" href="YAHOO.widget.Overlay.html#method__findTriggerCE">_findTriggerCE</a><span class="private">,</span> <a class="private" href="YAHOO.widget.Overlay.html#method__getComputedHeight">_getComputedHeight</a><span class="private">,</span> <a class="private" href="YAHOO.widget.Overlay.html#method__getPreciseHeight">_getPreciseHeight</a><span class="private">,</span> <a class="protected" href="YAHOO.widget.Overlay.html#method__primeXYFromDOM">_primeXYFromDOM</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Overlay.html#method__processTriggers">_processTriggers</a><span class="protected">,</span> <a class="protected" href="YAHOO.widget.Overlay.html#method__validateAutoFillHeight">_validateAutoFillHeight</a><span class="protected">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_align">align</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_bringToTop">bringToTop</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_center">center</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configAutoFillHeight">configAutoFillHeight</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configConstrainToViewport">configConstrainToViewport</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configContext">configContext</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configFixedCenter">configFixedCenter</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configHeight">configHeight</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configIframe">configIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configVisible">configVisible</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configWidth">configWidth</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configX">configX</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configXY">configXY</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configY">configY</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_configzIndex">configzIndex</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_destroy">destroy</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_doCenterOnDOMEvent">doCenterOnDOMEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_enforceConstraints">enforceConstraints</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_fillHeight">fillHeight</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_getConstrainedX">getConstrainedX</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_getConstrainedXY">getConstrainedXY</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_getConstrainedY">getConstrainedY</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_hideIframe">hideIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_hideMacGeckoScrollbars">hideMacGeckoScrollbars</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_init">init</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_initDefaultConfig">initDefaultConfig</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_initEvents">initEvents</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_moveTo">moveTo</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_onDomResize">onDomResize</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_showIframe">showIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_showMacGeckoScrollbars">showMacGeckoScrollbars</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_stackIframe">stackIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_syncIframe">syncIframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_syncPosition">syncPosition</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#method_toString">toString</a>
</code>
</div>
</div>
<div class="section method details">
<h3 id="events">Events</h3>
<div class="content">
<div class="">
<h4>
<a name="event_contextMouseOutEvent">contextMouseOutEvent</a></h4>
<div class="detail">
<code>
<strong>contextMouseOutEvent</strong>
(
context
,
e
)
</code>
<div class="description">
CustomEvent fired when the user mouses out of a context element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>context &lt;HTMLElement&gt;</code>
The context element which the user just moused out of
</dd>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The DOM event object, associated with the mouse out
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_contextMouseOverEvent">contextMouseOverEvent</a></h4>
<div class="detail">
<code>
<strong>contextMouseOverEvent</strong>
(
context
,
e
)
</code>
<div class="description">
CustomEvent fired when user mouses over a context element. Returning false from
a subscriber to this event will prevent the tooltip from being displayed for
the current context element.
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>context &lt;HTMLElement&gt;</code>
The context element which the user just moused over
</dd>
<dd>
<code>e &lt;DOMEvent&gt;</code>
The DOM event object, associated with the mouse over
</dd>
</dl>
</div>
</div>
<hr />
</div>
<div class="">
<h4>
<a name="event_contextTriggerEvent">contextTriggerEvent</a></h4>
<div class="detail">
<code>
<strong>contextTriggerEvent</strong>
(
context
)
</code>
<div class="description">
CustomEvent fired just before the tooltip is displayed for the current context.
<p>
You can subscribe to this event if you need to set up the text for the
tooltip based on the context element for which it is about to be displayed.
</p>
<p>This event differs from the beforeShow event in following respects:</p>
<ol>
<li>
When moving from one context element to another, if the tooltip is not
hidden (the <code>hidedelay</code> is not reached), the beforeShow and Show events will not
be fired when the tooltip is displayed for the new context since it is already visible.
However the contextTrigger event is always fired before displaying the tooltip for
a new context.
</li>
<li>
The trigger event provides access to the context element, allowing you to
set the text of the tooltip based on context element for which the tooltip is
triggered.
</li>
</ol>
<p>
It is not possible to prevent the tooltip from being displayed
using this event. You can use the contextMouseOverEvent if you need to prevent
the tooltip from being displayed.
</p>
</div>
<div class="description">
<dl>
<dt>Parameters:</dt>
<dd>
<code>context &lt;HTMLElement&gt;</code>
The context element for which the tooltip is triggered
</dd>
</dl>
</div>
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Module.html#event_appendEvent">appendEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_beforeHideEvent">beforeHideEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_beforeInitEvent">beforeInitEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_beforeRenderEvent">beforeRenderEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_beforeShowEvent">beforeShowEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_changeBodyEvent">changeBodyEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_changeContentEvent">changeContentEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_changeFooterEvent">changeFooterEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_changeHeaderEvent">changeHeaderEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_destroyEvent">destroyEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#event_hideEvent">hideEvent</a> <a class="" href="YAHOO.widget.Module.html#event_initEvent">initEvent</a> <a class="" href="YAHOO.widget.Module.html#event_renderEvent">renderEvent</a> <a class="" href="YAHOO.widget.Module.html#event_showEvent">showEvent</a> <a class="" href="YAHOO.widget.Module.html#event_YAHOO.widget.Module.textResizeEvent">YAHOO.widget.Module.textResizeEvent</a>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Events inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Overlay.html#event_beforeMoveEvent">beforeMoveEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#event_moveEvent">moveEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#event_YAHOO.widget.Overlay.windowResizeEvent">YAHOO.widget.Overlay.windowResizeEvent</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#event_YAHOO.widget.Overlay.windowScrollEvent">YAHOO.widget.Overlay.windowScrollEvent</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field details">
<h3 id="configattributes">Configuration Attributes</h3>
<div class="content">
<div class="">
<h4><a name="config_autodismissdelay">autodismissdelay</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The number of milliseconds to wait before automatically
dismissing a Tooltip after the mouse has been resting on the
context element.
</div>
</div>
<div class="default">
Default Value: 5000
</div>
<hr />
</div>
<div class="">
<h4><a name="config_container">container</a>
<code>- HTMLElement/String</code>
</h4>
<div class="detail">
<div class="description">
Specifies the container element that the Tooltip's markup
should be rendered into.
</div>
</div>
<div class="default">
Default Value: document.body
</div>
<hr />
</div>
<div class="">
<h4><a name="config_context">context</a>
<code>- HTMLElement[]/String[]</code>
</h4>
<div class="detail">
<div class="description">
Specifies the element or elements that the Tooltip should be
anchored to on mouseover.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_disabled">disabled</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Specifies whether or not the tooltip is disabled. Disabled tooltips
will not be displayed. If the tooltip is driven by the title attribute
of the context element, the title attribute will still be removed for
disabled tooltips, to prevent default tooltip behavior.
</div>
</div>
<div class="default">
Default Value: false
</div>
<hr />
</div>
<div class="">
<h4><a name="config_hidedelay">hidedelay</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The number of milliseconds to wait before hiding a Tooltip
after mouseout.
</div>
</div>
<div class="default">
Default Value: 250
</div>
<hr />
</div>
<div class="">
<h4><a name="config_preventoverlap">preventoverlap</a>
<code>- Boolean</code>
</h4>
<div class="detail">
<div class="description">
Specifies whether the Tooltip should be kept from overlapping
its context element.
</div>
</div>
<div class="default">
Default Value: true
</div>
<hr />
</div>
<div class="">
<h4><a name="config_showdelay">showdelay</a>
<code>- Number</code>
</h4>
<div class="detail">
<div class="description">
The number of milliseconds to wait before showing a Tooltip
on mouseover.
</div>
</div>
<div class="default">
Default Value: 200
</div>
<hr />
</div>
<div class="">
<h4><a name="config_text">text</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
Specifies the Tooltip's text.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
<div class="">
<h4><a name="config_width">width</a>
<code>- String</code>
</h4>
<div class="detail">
<div class="description">
String representing the width of the Tooltip. <em>Please note:
</em> As of version 2.3 if either no value or a value of "auto"
is specified, and the Toolip's "container" configuration property
is set to something other than <code>document.body</code> or
its "context" element resides outside the immediately visible
portion of the document, the width of the Tooltip will be
calculated based on the offsetWidth of its root HTML and set just
before it is made visible. The original value will be
restored when the Tooltip is hidden. This ensures the Tooltip is
rendered at a usable width. For more information see
SourceForge bug #1685496 and SourceForge
bug #1735423.
</div>
</div>
<div class="default">
Default Value: null
</div>
<hr />
</div>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Module.html#config_appendtodocumentbody">appendtodocumentbody</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#config_effect">effect</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#config_monitorresize">monitorresize</a><span class="">,</span> <a class="" href="YAHOO.widget.Module.html#config_visible">visible</a><span class="">,</span>
</code>
</div>
</div>
<div class="section field inheritance">
<h4>Configuration attributes inherited from <a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a>:</h4>
<div class="content">
<code>
<a class="" href="YAHOO.widget.Overlay.html#config_autofillheight">autofillheight</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_constraintoviewport">constraintoviewport</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_context">context</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_fixedcenter">fixedcenter</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_height">height</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_iframe">iframe</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_preventcontextoverlap">preventcontextoverlap</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_width">width</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_x">x</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_xy">xy</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_y">y</a><span class="">,</span> <a class="" href="YAHOO.widget.Overlay.html#config_zIndex">zIndex</a><span class="">,</span>
</code>
</div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_carousel.html">carousel</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class="selected"><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_paginator.html">paginator</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class=""><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.util.Config.html">YAHOO.util.Config</a></li>
<li class=""><a href="YAHOO.widget.ContainerEffect.html">YAHOO.widget.ContainerEffect</a></li>
<li class=""><a href="YAHOO.widget.Dialog.html">YAHOO.widget.Dialog</a></li>
<li class=""><a href="YAHOO.widget.Module.html">YAHOO.widget.Module</a></li>
<li class=""><a href="YAHOO.widget.Overlay.html">YAHOO.widget.Overlay</a></li>
<li class=""><a href="YAHOO.widget.OverlayManager.html">YAHOO.widget.OverlayManager</a></li>
<li class=""><a href="YAHOO.widget.Panel.html">YAHOO.widget.Panel</a></li>
<li class=""><a href="YAHOO.widget.SimpleDialog.html">YAHOO.widget.SimpleDialog</a></li>
<li class="selected"><a href="YAHOO.widget.Tooltip.html">YAHOO.widget.Tooltip</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="Config.js.html">Config.js</a></li>
<li class=""><a href="ContainerEffect.js.html">ContainerEffect.js</a></li>
<li class=""><a href="Dialog.js.html">Dialog.js</a></li>
<li class=""><a href="Module.js.html">Module.js</a></li>
<li class=""><a href="Overlay.js.html">Overlay.js</a></li>
<li class=""><a href="OverlayManager.js.html">OverlayManager.js</a></li>
<li class=""><a href="Panel.js.html">Panel.js</a></li>
<li class=""><a href="SimpleDialog.js.html">SimpleDialog.js</a></li>
<li class=""><a href="Tooltip.js.html">Tooltip.js</a></li>
</ul>
</div>
<div class="module">
<h4>Properties</h4>
<ul class="content">
<li class="private"><a href="#property_DEFAULT_CONFIG">DEFAULT_CONFIG</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class="private"><a href="#property_EVENT_TYPES">EVENT_TYPES</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_showProcId">showProcId</a>
<!--<code>&lt;String&gt;</code>-->
</li>
<li class=""><a href="#property_YAHOO.widget.Tooltip.CSS_TOOLTIP">YAHOO.widget.Tooltip.CSS_TOOLTIP</a>
<!--<code>&lt;String&gt;</code>-->
</li>
</ul>
</div>
<div class="module">
<h4>Methods</h4>
<ul class="content">
<li class="protected"><!--<code>void</code>-->
<a href="#method__removeEventListeners">_removeEventListeners</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configContainer">configContainer</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configContext">configContext</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_configText">configText</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_destroy">destroy</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_doHide">doHide</a>
</li>
<li class=""><!--<code>Number</code>-->
<a href="#method_doShow">doShow</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_init">init</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initDefaultConfig">initDefaultConfig</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_initEvents">initEvents</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onContextMouseMove">onContextMouseMove</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onContextMouseOut">onContextMouseOut</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onContextMouseOver">onContextMouseOver</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_onRender">onRender</a>
</li>
<li class=""><!--<code>void</code>-->
<a href="#method_preventOverlay">preventOverlay</a>
</li>
<li class=""><!--<code>String</code>-->
<a href="#method_toString">toString</a>
</li>
</ul>
</div>
<div class="module">
<h4>Events</h4>
<ul class="content">
<li class="">
<a href="#event_contextMouseOutEvent">contextMouseOutEvent</a>
</li>
<li class="">
<a href="#event_contextMouseOverEvent">contextMouseOverEvent</a>
</li>
<li class="">
<a href="#event_contextTriggerEvent">contextTriggerEvent</a>
</li>
</ul>
</div>
<div class="module">
<h4>Configuration Attributes</h4>
<ul class="content">
<li class="">
<a href="#config_autodismissdelay">autodismissdelay</a>
</li>
<li class="">
<a href="#config_container">container</a>
</li>
<li class="">
<a href="#config_context">context</a>
</li>
<li class="">
<a href="#config_disabled">disabled</a>
</li>
<li class="">
<a href="#config_hidedelay">hidedelay</a>
</li>
<li class="">
<a href="#config_preventoverlap">preventoverlap</a>
</li>
<li class="">
<a href="#config_showdelay">showdelay</a>
</li>
<li class="">
<a href="#config_text">text</a>
</li>
<li class="">
<a href="#config_width">width</a>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>