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.3.1
  11  * Copyright(c) 2006-2010 Sencha Inc.
  12  * licensing@sencha.com
  13  * http://www.sencha.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 the config options for the {@link Ext.QuickTip QuickTip} class</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,      // Show 50ms after entering target
  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: 10000 // Hide after 10 seconds hover
  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,
  85         disabled = false;
  86
  87     return {
  88         <div id="method-Ext.QuickTips-init"></div>/**
  89          * Initialize the global QuickTips instance and prepare any quick tips.
  90          * @param {Boolean} autoRender True to render the QuickTips container immediately to preload images. (Defaults to true)
  91          */
  92         init : function(autoRender){
  93             if(!tip){
  94                 if(!Ext.isReady){
  95                     Ext.onReady(function(){
  96                         Ext.QuickTips.init(autoRender);
  97                     });
  98                     return;
  99                 }
 100                 tip = new Ext.QuickTip({
 101                     elements:'header,body',
 102                     disabled: disabled
 103                 });
 104                 if(autoRender !== false){
 105                     tip.render(Ext.getBody());
 106                 }
 107             }
 108         },
 109
 110         // Protected method called by the dd classes
 111         ddDisable : function(){
 112             // don't disable it if we don't need to
 113             if(tip && !disabled){
 114                 tip.disable();
 115             }
 116         },
 117
 118         // Protected method called by the dd classes
 119         ddEnable : function(){
 120             // only enable it if it hasn't been disabled
 121             if(tip && !disabled){
 122                 tip.enable();
 123             }
 124         },
 125
 126         <div id="method-Ext.QuickTips-enable"></div>/**
 127          * Enable quick tips globally.
 128          */
 129         enable : function(){
 130             if(tip){
 131                 tip.enable();
 132             }
 133             disabled = false;
 134         },
 135
 136         <div id="method-Ext.QuickTips-disable"></div>/**
 137          * Disable quick tips globally.
 138          */
 139         disable : function(){
 140             if(tip){
 141                 tip.disable();
 142             }
 143             disabled = true;
 144         },
 145
 146         <div id="method-Ext.QuickTips-isEnabled"></div>/**
 147          * Returns true if quick tips are enabled, else false.
 148          * @return {Boolean}
 149          */
 150         isEnabled : function(){
 151             return tip !== undefined && !tip.disabled;
 152         },
 153
 154         <div id="method-Ext.QuickTips-getQuickTip"></div>/**
 155          * Gets the single {@link Ext.QuickTip QuickTip} instance used to show tips from all registered elements.
 156          * @return {Ext.QuickTip}
 157          */
 158         getQuickTip : function(){
 159             return tip;
 160         },
 161
 162         <div id="method-Ext.QuickTips-register"></div>/**
 163          * Configures a new quick tip instance and assigns it to a target element.  See
 164          * {@link Ext.QuickTip#register} for details.
 165          * @param {Object} config The config object
 166          */
 167         register : function(){
 168             tip.register.apply(tip, arguments);
 169         },
 170
 171         <div id="method-Ext.QuickTips-unregister"></div>/**
 172          * Removes any registered quick tip from the target element and destroys it.
 173          * @param {String/HTMLElement/Element} el The element from which the quick tip is to be removed.
 174          */
 175         unregister : function(){
 176             tip.unregister.apply(tip, arguments);
 177         },
 178
 179         <div id="method-Ext.QuickTips-tips"></div>/**
 180          * Alias of {@link #register}.
 181          * @param {Object} config The config object
 182          */
 183         tips : function(){
 184             tip.register.apply(tip, arguments);
 185         }
 186     };
 187 }();</pre>
 188 </body>
 189 </html>