Upgrade to ExtJS 3.2.1 - Released 04/27/2010
[extjs.git] / docs / output / Ext.QuickTips.html
index b7cb83d..4cd089a 100644 (file)
@@ -1,31 +1,15 @@
-        <div class="body-wrap">
-        <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>
-            <a class="inner-link" href="#Ext.QuickTips-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
-            <a class="inner-link" href="#Ext.QuickTips-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
-                        <a class="bookmark" href="../docs/?class=Ext.QuickTips"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
-        </div>
-                <h1>Class Ext.QuickTips</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="../src/QuickTips.js" target="_blank">QuickTips.js</a></td></tr>
-            <tr><td class="label">Class:</td><td class="hd-info">QuickTips</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,
 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 ext:cls="Ext.Tip" href="output/Ext.Tip.html">Ext.Tip</a> or <a ext:cls="Ext.ToolTip" href="output/Ext.ToolTip.html">Ext.ToolTip</a>.</p>
+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>
 <p>Quicktips can be configured via tag attributes directly in markup, or by
 <p>Quicktips can be configured via tag attributes directly in markup, or by
-registering quick tips programmatically via the <a ext:cls="Ext.QuickTips" ext:member="register" href="output/Ext.QuickTips.html#register">register</a> method.</p>
-<p>The singleton's instance of <a ext:cls="Ext.QuickTip" href="output/Ext.QuickTip.html">Ext.QuickTip</a> is available via
-<a ext:cls="Ext.QuickTips" ext:member="getQuickTip" href="output/Ext.QuickTips.html#getQuickTip">getQuickTip</a>, and supports all the methods, and all the all the
+registering quick tips programmatically via the <a href="output/Ext.QuickTips.html#Ext.QuickTips-register" ext:member="register" ext:cls="Ext.QuickTips">register</a> method.</p>
+<p>The singleton's instance of <a href="output/Ext.QuickTip.html" ext:cls="Ext.QuickTip">Ext.QuickTip</a> is available via
+<a href="output/Ext.QuickTips.html#Ext.QuickTips-getQuickTip" ext:member="getQuickTip" ext:cls="Ext.QuickTips">getQuickTip</a>, and supports all the methods, and all the all the
 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.
 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 ext:cls="Ext.QuickTips" ext:member="getQuickTip" href="output/Ext.QuickTips.html#getQuickTip">getQuickTip</a></p>
+For detailed descriptions see <a href="output/Ext.QuickTips.html#Ext.QuickTips-getQuickTip" ext:member="getQuickTip" ext:cls="Ext.QuickTips">getQuickTip</a></p>
 <p><b>QuickTips singleton configs (all are optional)</b></p>
 <div class="mdetail-params"><ul><li>dismissDelay</li>
 <li>hideDelay</li>
 <p><b>QuickTips singleton configs (all are optional)</b></p>
 <div class="mdetail-params"><ul><li>dismissDelay</li>
 <li>hideDelay</li>
@@ -73,182 +57,22 @@ same as autoHide = true.</li>
 <p>Here is an example of configuring an HTML element to display a tooltip from markup:</p>
 <pre><code><i>// Add a quick tip to an HTML button</i>
 &lt;input type=<em>"button"</em> value=<em>"OK"</em> ext:qtitle=<em>"OK Button"</em> ext:qwidth=<em>"100"</em>
 <p>Here is an example of configuring an HTML element to display a tooltip from markup:</p>
 <pre><code><i>// Add a quick tip to an HTML button</i>
 &lt;input type=<em>"button"</em> value=<em>"OK"</em> ext:qtitle=<em>"OK Button"</em> ext:qwidth=<em>"100"</em>
-     ext:qtip=<em>"This is a quick tip from markup!"</em>>&lt;/input></code></pre><br><br><i>This class is a singleton and cannot be created directly.</i>        </div>
-        
-        <div class="hr"></div>
-                <a id="Ext.QuickTips-props"></a>
-        <h2>Public Properties</h2>
-        <div class="no-members">This class has no public properties.</div>        <a id="Ext.QuickTips-methods"></a>
-        <h2>Public Methods</h2>
-                <table cellspacing="0" class="member-table">
-            <tr>
-                <th class="sig-header" colspan="2">Method</th>
-                <th class="msource-header">Defined By</th>
-            </tr>
-                <tr class="method-row expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.QuickTips-disable"></a>\r
-            <b>disable</b>() : void            <div class="mdesc">\r
-                        <div class="short">Disable quick tips globally.</div>\r
-            <div class="long">\r
-                Disable quick tips globally.    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li>None.</li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">QuickTips</td>\r
-    </tr>\r
-        <tr class="method-row alt expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.QuickTips-enable"></a>\r
-            <b>enable</b>() : void            <div class="mdesc">\r
-                        <div class="short">Enable quick tips globally.</div>\r
-            <div class="long">\r
-                Enable quick tips globally.    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li>None.</li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">QuickTips</td>\r
-    </tr>\r
-        <tr class="method-row expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.QuickTips-getQuickTip"></a>\r
-            <b>getQuickTip</b>() : void            <div class="mdesc">\r
-                        <div class="short">Gets the global QuickTips instance.</div>\r
-            <div class="long">\r
-                Gets the global QuickTips instance.    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li>None.</li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">QuickTips</td>\r
-    </tr>\r
-        <tr class="method-row alt expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.QuickTips-init"></a>\r
-            <b>init</b>(&nbsp;<code>Boolean autoRender</code>&nbsp;) : void            <div class="mdesc">\r
-                        <div class="short">Initialize the global QuickTips instance and prepare any quick tips.</div>\r
-            <div class="long">\r
-                Initialize the global QuickTips instance and prepare any quick tips.    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <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>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">QuickTips</td>\r
-    </tr>\r
-        <tr class="method-row expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.QuickTips-isEnabled"></a>\r
-            <b>isEnabled</b>() : Boolean            <div class="mdesc">\r
-                        <div class="short">Returns true if quick tips are enabled, else false.</div>\r
-            <div class="long">\r
-                Returns true if quick tips are enabled, else false.    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li>None.</li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>Boolean</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">QuickTips</td>\r
-    </tr>\r
-        <tr class="method-row alt expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.QuickTips-register"></a>\r
-            <b>register</b>(&nbsp;<code>Object config</code>&nbsp;) : void            <div class="mdesc">\r
-                        <div class="short">Configures a new quick tip instance and assigns it to a target element.  See
-<a ext:cls="Ext.QuickTip" ext:member="register" href="output/Ext.QuickTip.html#register">Ext.QuickTip.register</a> for details.</div>\r
-            <div class="long">\r
-                Configures a new quick tip instance and assigns it to a target element.  See
-<a ext:cls="Ext.QuickTip" ext:member="register" href="output/Ext.QuickTip.html#register">Ext.QuickTip.register</a> for details.    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li><code>config</code> : Object<div class="sub-desc">The config object</div></li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">QuickTips</td>\r
-    </tr>\r
-        <tr class="method-row expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.QuickTips-tips"></a>\r
-            <b>tips</b>(&nbsp;<code>Object config</code>&nbsp;) : void            <div class="mdesc">\r
-                        <div class="short">Alias of <a ext:cls="Ext.QuickTips" ext:member="register" href="output/Ext.QuickTips.html#register">register</a>.</div>\r
-            <div class="long">\r
-                Alias of <a ext:cls="Ext.QuickTips" ext:member="register" href="output/Ext.QuickTips.html#register">register</a>.    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li><code>config</code> : Object<div class="sub-desc">The config object</div></li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">QuickTips</td>\r
-    </tr>\r
-        <tr class="method-row alt expandable">\r
-        <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
-        <td class="sig">\r
-        <a id="Ext.QuickTips-unregister"></a>\r
-            <b>unregister</b>(&nbsp;<code>String/HTMLElement/Element el</code>&nbsp;) : void            <div class="mdesc">\r
-                        <div class="short">Removes any registered quick tip from the target element and destroys it.</div>\r
-            <div class="long">\r
-                Removes any registered quick tip from the target element and destroys it.    <div class="mdetail-params">\r
-        <strong>Parameters:</strong>\r
-        <ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The element from which the quick tip is to be removed.</div></li>        </ul>\r
-        <strong>Returns:</strong>\r
-        <ul>\r
-            <li><code>void</code></li>\r
-        </ul>\r
-    </div>\r
-                </div>\r
-                        </div>\r
-        </td>\r
-        <td class="msource">QuickTips</td>\r
-    </tr>\r
-            </table>
-                <a id="Ext.QuickTips-events"></a>
-        <h2>Public Events</h2>
-        <div class="no-members">This class has no public events.</div>
-        </div>
\ No newline at end of file
+     ext:qtip=<em>"This is a quick tip from markup!"</em>>&lt;/input></code></pre><br><br><i>This class is a singleton and cannot be created directly.</i></div><div class="hr"></div><a id="Ext.QuickTips-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.QuickTips-methods"></a><h2>Public Methods</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Method</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.QuickTips-disable"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-disable">disable</a></b>()
+    :
+                                        void<div class="mdesc"><div class="short">Disable quick tips globally.</div><div class="long">Disable 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-enable"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-enable">enable</a></b>()
+    :
+                                        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;)
+    :
+                                        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>()
+    :
+                                        Boolean<div class="mdesc"><div class="short">Returns true if quick tips are enabled, else false.</div><div class="long">Returns true if quick tips are enabled, else false.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</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-register"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-register">register</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Configures a new quick tip instance and assigns it to a target element.  See
+Ext.QuickTip.register for details.</div><div class="long">Configures a new quick tip instance and assigns it to a target element.  See
+<a href="output/Ext.QuickTip.html#Ext.QuickTip-register" ext:member="register" ext:cls="Ext.QuickTip">Ext.QuickTip.register</a> for details.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The config object</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-tips"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-tips">tips</a></b>(&nbsp;<code>Object&nbsp;config</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Alias of register.</div><div class="long">Alias of <a href="output/Ext.QuickTips.html#Ext.QuickTips-register" ext:member="register" ext:cls="Ext.QuickTips">register</a>.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>config</code> : Object<div class="sub-desc">The config object</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-unregister"></a><b><a href="source/QuickTips.html#method-Ext.QuickTips-unregister">unregister</a></b>(&nbsp;<code>String/HTMLElement/Element&nbsp;el</code>&nbsp;)
+    :
+                                        void<div class="mdesc"><div class="short">Removes any registered quick tip from the target element and destroys it.</div><div class="long">Removes any registered quick tip from the target element and destroys it.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>el</code> : String/HTMLElement/Element<div class="sub-desc">The element from which the quick tip is to be removed.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource">QuickTips</td></tr></tbody></table><a id="Ext.QuickTips-events"></a><h2>Public Events</h2><div class="no-members">This class has no public events.</div></div>
\ No newline at end of file