Upgrade to ExtJS 3.2.0 - Released 03/30/2010
[extjs.git] / docs / source / QuickTips.html
1 <html>
2 <head>
3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    
4   <title>The source code</title>
5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
7 </head>
8 <body  onload="prettyPrint();">
9     <pre class="prettyprint lang-js">/*!
10  * Ext JS Library 3.2.0
11  * Copyright(c) 2006-2010 Ext JS, Inc.
12  * licensing@extjs.com
13  * http://www.extjs.com/license
14  */
15 <div id="cls-Ext.QuickTips"></div>/**
16  * @class Ext.QuickTips
17  * <p>Provides attractive and customizable tooltips for any element. The QuickTips
18  * singleton is used to configure and manage tooltips globally for multiple elements
19  * in a generic manner.  To create individual tooltips with maximum customizability,
20  * you should consider either {@link Ext.Tip} or {@link Ext.ToolTip}.</p>
21  * <p>Quicktips can be configured via tag attributes directly in markup, or by
22  * registering quick tips programmatically via the {@link #register} method.</p>
23  * <p>The singleton's instance of {@link Ext.QuickTip} is available via
24  * {@link #getQuickTip}, and supports all the methods, and all the all the
25  * configuration properties of Ext.QuickTip. These settings will apply to all
26  * tooltips shown by the singleton.</p>
27  * <p>Below is the summary of the configuration properties which can be used.
28  * For detailed descriptions see {@link #getQuickTip}</p>
29  * <p><b>QuickTips singleton configs (all are optional)</b></p>
30  * <div class="mdetail-params"><ul><li>dismissDelay</li>
31  * <li>hideDelay</li>
32  * <li>maxWidth</li>
33  * <li>minWidth</li>
34  * <li>showDelay</li>
35  * <li>trackMouse</li></ul></div>
36  * <p><b>Target element configs (optional unless otherwise noted)</b></p>
37  * <div class="mdetail-params"><ul><li>autoHide</li>
38  * <li>cls</li>
39  * <li>dismissDelay (overrides singleton value)</li>
40  * <li>target (required)</li>
41  * <li>text (required)</li>
42  * <li>title</li>
43  * <li>width</li></ul></div>
44  * <p>Here is an example showing how some of these config options could be used:</p>
45  * <pre><code>
46 // Init the singleton.  Any tag-based quick tips will start working.
47 Ext.QuickTips.init();
48
49 // Apply a set of config properties to the singleton
50 Ext.apply(Ext.QuickTips.getQuickTip(), {
51     maxWidth: 200,
52     minWidth: 100,
53     showDelay: 50,
54     trackMouse: true
55 });
56
57 // Manually register a quick tip for a specific element
58 Ext.QuickTips.register({
59     target: 'my-div',
60     title: 'My Tooltip',
61     text: 'This tooltip was added in code',
62     width: 100,
63     dismissDelay: 20
64 });
65 </code></pre>
66  * <p>To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with
67  * the <b>ext:</b> namespace.  The HTML element itself is automatically set as the quick tip target. Here is the summary
68  * of supported attributes (optional unless otherwise noted):</p>
69  * <ul><li><b>hide</b>: Specifying "user" is equivalent to setting autoHide = false.  Any other value will be the
70  * same as autoHide = true.</li>
71  * <li><b>qclass</b>: A CSS class to be applied to the quick tip (equivalent to the 'cls' target element config).</li>
72  * <li><b>qtip (required)</b>: The quick tip text (equivalent to the 'text' target element config).</li>
73  * <li><b>qtitle</b>: The quick tip title (equivalent to the 'title' target element config).</li>
74  * <li><b>qwidth</b>: The quick tip width (equivalent to the 'width' target element config).</li></ul>
75  * <p>Here is an example of configuring an HTML element to display a tooltip from markup:</p>
76  * <pre><code>
77 // Add a quick tip to an HTML button
78 &lt;input type="button" value="OK" ext:qtitle="OK Button" ext:qwidth="100"
79      ext:qtip="This is a quick tip from markup!">&lt;/input>
80 </code></pre>
81  * @singleton
82  */
83 Ext.QuickTips = function(){
84     var tip, locks = [];
85     return {
86         <div id="method-Ext.QuickTips-init"></div>/**
87          * Initialize the global QuickTips instance and prepare any quick tips.
88          * @param {Boolean} autoRender True to render the QuickTips container immediately to preload images. (Defaults to true) 
89          */
90         init : function(autoRender){
91             if(!tip){
92                 if(!Ext.isReady){
93                     Ext.onReady(function(){
94                         Ext.QuickTips.init(autoRender);
95                     });
96                     return;
97                 }
98                 tip = new Ext.QuickTip({elements:'header,body'});
99                 if(autoRender !== false){
100                     tip.render(Ext.getBody());
101                 }
102             }
103         },
104
105         <div id="method-Ext.QuickTips-enable"></div>/**
106          * Enable quick tips globally.
107          */
108         enable : function(){
109             if(tip){
110                 locks.pop();
111                 if(locks.length < 1){
112                     tip.enable();
113                 }
114             }
115         },
116
117         <div id="method-Ext.QuickTips-disable"></div>/**
118          * Disable quick tips globally.
119          */
120         disable : function(){
121             if(tip){
122                 tip.disable();
123             }
124             locks.push(1);
125         },
126
127         <div id="method-Ext.QuickTips-isEnabled"></div>/**
128          * Returns true if quick tips are enabled, else false.
129          * @return {Boolean}
130          */
131         isEnabled : function(){
132             return tip !== undefined && !tip.disabled;
133         },
134
135         <div id="method-Ext.QuickTips-getQuickTip"></div>/**
136          * Gets the global QuickTips instance.
137          */
138         getQuickTip : function(){
139             return tip;
140         },
141
142         <div id="method-Ext.QuickTips-register"></div>/**
143          * Configures a new quick tip instance and assigns it to a target element.  See
144          * {@link Ext.QuickTip#register} for details.
145          * @param {Object} config The config object
146          */
147         register : function(){
148             tip.register.apply(tip, arguments);
149         },
150
151         <div id="method-Ext.QuickTips-unregister"></div>/**
152          * Removes any registered quick tip from the target element and destroys it.
153          * @param {String/HTMLElement/Element} el The element from which the quick tip is to be removed.
154          */
155         unregister : function(){
156             tip.unregister.apply(tip, arguments);
157         },
158
159         <div id="method-Ext.QuickTips-tips"></div>/**
160          * Alias of {@link #register}.
161          * @param {Object} config The config object
162          */
163         tips :function(){
164             tip.register.apply(tip, arguments);
165         }
166     }
167 }();</pre>    
168 </body>
169 </html>