+++ /dev/null
- <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
-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>
-<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
-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>
-<p><b>QuickTips singleton configs (all are optional)</b></p>
-<div class="mdetail-params"><ul><li>dismissDelay</li>
-<li>hideDelay</li>
-<li>maxWidth</li>
-<li>minWidth</li>
-<li>showDelay</li>
-<li>trackMouse</li></ul></div>
-<p><b>Target element configs (optional unless otherwise noted)</b></p>
-<div class="mdetail-params"><ul><li>autoHide</li>
-<li>cls</li>
-<li>dismissDelay (overrides singleton value)</li>
-<li>target (required)</li>
-<li>text (required)</li>
-<li>title</li>
-<li>width</li></ul></div>
-<p>Here is an example showing how some of these config options could be used:</p>
-<pre><code><i>// Init the singleton. Any tag-based quick tips will start working.</i>
-Ext.QuickTips.init();
-
-<i>// Apply a set of config properties to the singleton</i>
-Ext.apply(Ext.QuickTips.getQuickTip(), {
- maxWidth: 200,
- minWidth: 100,
- showDelay: 50,
- trackMouse: true
-});
-
-<i>// Manually register a quick tip <b>for</b> a specific element</i>
-Ext.QuickTips.register({
- target: <em>'my-div'</em>,
- title: <em>'My Tooltip'</em>,
- text: <em>'This tooltip was added <b>in</b> code'</em>,
- width: 100,
- dismissDelay: 20
-});</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
-of supported attributes (optional unless otherwise noted):</p>
-<ul><li><b>hide</b>: Specifying "user" is equivalent to setting autoHide = false. Any other value will be the
-same as autoHide = true.</li>
-<li><b>qclass</b>: A CSS class to be applied to the quick tip (equivalent to the 'cls' target element config).</li>
-<li><b>qtip (required)</b>: The quick tip text (equivalent to the 'text' target element config).</li>
-<li><b>qtitle</b>: The quick tip title (equivalent to the 'title' target element config).</li>
-<li><b>qwidth</b>: The quick tip width (equivalent to the 'width' target element config).</li></ul>
-<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>
-<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>></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"> </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"> </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"> </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"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.QuickTips-init"></a>\r
- <b>init</b>( <code>Boolean autoRender</code> ) : 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"> </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"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.QuickTips-register"></a>\r
- <b>register</b>( <code>Object config</code> ) : 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"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.QuickTips-tips"></a>\r
- <b>tips</b>( <code>Object config</code> ) : 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"> </a></td>\r
- <td class="sig">\r
- <a id="Ext.QuickTips-unregister"></a>\r
- <b>unregister</b>( <code>String/HTMLElement/Element el</code> ) : 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
git.ithinksw.org / extjs.git / blobdiff