Upgrade to ExtJS 3.3.1 - Released 11/30/2010

[extjs.git] / docs / output / Ext.QuickTips.html

diff --git a/docs/output/Ext.QuickTips.html b/docs/output/Ext.QuickTips.html
index 4cd089a..be3b843 100644 (file)
--- a/docs/output/Ext.QuickTips.html
+++ b/docs/output/Ext.QuickTips.html
@@ -1,4 +1,4 @@
-<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.QuickTips-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.QuickTips-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.QuickTips-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.QuickTips"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/QuickTips.html#cls-Ext.QuickTips">Ext.QuickTips</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/QuickTips.html#cls-Ext.QuickTips">QuickTips.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/QuickTips.html#cls-Ext.QuickTips">QuickTips</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>Provides attractive and customizable tooltips for any element. The QuickTips
+<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.QuickTips-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.QuickTips-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.QuickTips-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.QuickTips"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/QuickTips.html#cls-Ext.QuickTips">Ext.QuickTips</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/QuickTips.html#cls-Ext.QuickTips">QuickTips.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/QuickTips.html#cls-Ext.QuickTips">QuickTips</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description"><p>Provides attractive and customizable tooltips for any element. The QuickTips
 singleton is used to configure and manage tooltips globally for multiple elements
 in a generic manner.  To create individual tooltips with maximum customizability,
 you should consider either <a href="output/Ext.Tip.html" ext:cls="Ext.Tip">Ext.Tip</a> or <a href="output/Ext.ToolTip.html" ext:cls="Ext.ToolTip">Ext.ToolTip</a>.</p>
@@ -9,7 +9,7 @@ registering quick tips programmatically via the <a href="output/Ext.QuickTips.ht
 configuration properties of Ext.QuickTip. These settings will apply to all
 tooltips shown by the singleton.</p>
 <p>Below is the summary of the configuration properties which can be used.
-For detailed descriptions see <a href="output/Ext.QuickTips.html#Ext.QuickTips-getQuickTip" ext:member="getQuickTip" ext:cls="Ext.QuickTips">getQuickTip</a></p>
+For detailed descriptions see the config options for the <a href="output/Ext.QuickTip.html" ext:cls="Ext.QuickTip">QuickTip</a> class</p>
 <p><b>QuickTips singleton configs (all are optional)</b></p>
 <div class="mdetail-params"><ul><li>dismissDelay</li>
 <li>hideDelay</li>
@@ -33,7 +33,7 @@ Ext.QuickTips.init();
 Ext.apply(Ext.QuickTips.getQuickTip(), {
     maxWidth: 200,
     minWidth: 100,
-    showDelay: 50,
+    showDelay: 50,      <i>// Show 50ms after entering target</i>
     trackMouse: true
 });
 
@@ -43,7 +43,7 @@ Ext.QuickTips.register({
     title: <em>'My Tooltip'</em>,
     text: <em>'This tooltip was added <b>in</b> code'</em>,
     width: 100,
-    dismissDelay: 20
+    dismissDelay: 10000 <i>// Hide after 10 seconds hover</i>
 });</code></pre>
 <p>To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with
 the <b>ext:</b> namespace.  The HTML element itself is automatically set as the quick tip target. Here is the summary
@@ -63,7 +63,7 @@ same as autoHide = true.</li>
     :
                                         void<div class="mdesc"><div class="short">Enable quick tips globally.</div><div class="long">Enable quick tips globally.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">QuickTips</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.QuickTips-getQuickTip"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-getQuickTip">getQuickTip</a></b>()
     :
-                                        void<div class="mdesc"><div class="short">Gets the global QuickTips instance.</div><div class="long">Gets the global QuickTips instance.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">QuickTips</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.QuickTips-init"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-init">init</a></b>(&nbsp;<code>Boolean&nbsp;autoRender</code>&nbsp;)
+                                        Ext.QuickTip<div class="mdesc"><div class="short">Gets the single QuickTip instance used to show tips from all registered elements.</div><div class="long">Gets the single <a href="output/Ext.QuickTip.html" ext:cls="Ext.QuickTip">QuickTip</a> instance used to show tips from all registered elements.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.QuickTip</code><div class="sub-desc"></div></li></ul></div></div></div></td><td class="msource">QuickTips</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.QuickTips-init"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-init">init</a></b>(&nbsp;<code>Boolean&nbsp;autoRender</code>&nbsp;)
     :
                                         void<div class="mdesc"><div class="short">Initialize the global QuickTips instance and prepare any quick tips.</div><div class="long">Initialize the global QuickTips instance and prepare any quick tips.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>autoRender</code> : Boolean<div class="sub-desc">True to render the QuickTips container immediately to preload images. (Defaults to true)</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">QuickTips</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.QuickTips-isEnabled"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-isEnabled">isEnabled</a></b>()
     :