Upgrade to ExtJS 4.0.0 - Released 04/26/2011
[extjs.git] / src / tip / QuickTipManager.js
similarity index 66%
rename from src/widgets/tips/QuickTips.js
rename to src/tip/QuickTipManager.js
index 774a654..b8d34ba 100644 (file)
@@ -1,23 +1,17 @@
-/*!
- * Ext JS Library 3.3.1
- * Copyright(c) 2006-2010 Sencha Inc.
- * licensing@sencha.com
- * http://www.sencha.com/license
- */
 /**
- * @class Ext.QuickTips
+ * @class Ext.tip.QuickTipManager
  * <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 {@link Ext.Tip} or {@link Ext.ToolTip}.</p>
+ * you should consider either {@link Ext.tip.Tip} or {@link Ext.tip.ToolTip}.</p>
  * <p>Quicktips can be configured via tag attributes directly in markup, or by
  * registering quick tips programmatically via the {@link #register} method.</p>
- * <p>The singleton's instance of {@link Ext.QuickTip} is available via
+ * <p>The singleton's instance of {@link Ext.tip.QuickTip} is available via
  * {@link #getQuickTip}, and supports all the methods, and all the all the
- * configuration properties of Ext.QuickTip. These settings will apply to all
+ * configuration properties of Ext.tip.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 the config options for the {@link Ext.QuickTip QuickTip} class</p>
+ * For detailed descriptions see the config options for the {@link Ext.tip.QuickTip QuickTip} class</p>
  * <p><b>QuickTips singleton configs (all are optional)</b></p>
  * <div class="mdetail-params"><ul><li>dismissDelay</li>
  * <li>hideDelay</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>
-// Init the singleton.  Any tag-based quick tips will start working.
-Ext.QuickTips.init();
-
-// Apply a set of config properties to the singleton
-Ext.apply(Ext.QuickTips.getQuickTip(), {
-    maxWidth: 200,
-    minWidth: 100,
-    showDelay: 50,      // Show 50ms after entering target
-    trackMouse: true
-});
-
-// Manually register a quick tip for a specific element
-Ext.QuickTips.register({
-    target: 'my-div',
-    title: 'My Tooltip',
-    text: 'This tooltip was added in code',
-    width: 100,
-    dismissDelay: 10000 // Hide after 10 seconds hover
-});
+ *
+ * {@img Ext.tip.QuickTipManager/Ext.tip.QuickTipManager.png Ext.tip.QuickTipManager component}
+ *
+ * ## Code
+ *    // Init the singleton.  Any tag-based quick tips will start working.
+ *    Ext.tip.QuickTipManager.init();
+ *    
+ *    // Apply a set of config properties to the singleton
+ *    Ext.apply(Ext.tip.QuickTipManager.getQuickTip(), {
+ *        maxWidth: 200,
+ *        minWidth: 100,
+ *        showDelay: 50      // Show 50ms after entering target
+ *    });
+ *    
+ *    // Create a small panel to add a quick tip to
+ *    Ext.create('Ext.container.Container', {
+ *        id: 'quickTipContainer',
+ *        width: 200,
+ *        height: 150,
+ *        style: {
+ *            backgroundColor:'#000000'
+ *        },
+ *        renderTo: Ext.getBody()
+ *    });
+ *
+ *    
+ *    // Manually register a quick tip for a specific element
+ *    Ext.tip.QuickTipManager.register({
+ *        target: 'quickTipContainer',
+ *        title: 'My Tooltip',
+ *        text: 'This tooltip was added in code',
+ *        width: 100,
+ *        dismissDelay: 10000 // Hide after 10 seconds hover
+ *    });
 </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
@@ -68,45 +76,56 @@ Ext.QuickTips.register({
  * <pre><code>
 // Add a quick tip to an HTML button
 &lt;input type="button" value="OK" ext:qtitle="OK Button" ext:qwidth="100"
-     ext:qtip="This is a quick tip from markup!">&lt;/input>
+     data-qtip="This is a quick tip from markup!">&lt;/input>
 </code></pre>
  * @singleton
  */
-Ext.QuickTips = function(){
+Ext.define('Ext.tip.QuickTipManager', function() {
     var tip,
         disabled = false;
-        
+
     return {
+        requires: ['Ext.tip.QuickTip'],
+        singleton: true,
+        alternateClassName: 'Ext.QuickTips',
         /**
          * Initialize the global QuickTips instance and prepare any quick tips.
          * @param {Boolean} autoRender True to render the QuickTips container immediately to preload images. (Defaults to true) 
          */
         init : function(autoRender){
-            if(!tip){
-                if(!Ext.isReady){
+            if (!tip) {
+                if (!Ext.isReady) {
                     Ext.onReady(function(){
-                        Ext.QuickTips.init(autoRender);
+                        Ext.tip.QuickTipManager.init(autoRender);
                     });
                     return;
                 }
-                tip = new Ext.QuickTip({
-                    elements:'header,body', 
-                    disabled: disabled
+                tip = Ext.create('Ext.tip.QuickTip', {
+                    disabled: disabled,
+                    renderTo: autoRender !== false ? document.body : undefined
                 });
-                if(autoRender !== false){
-                    tip.render(Ext.getBody());
-                }
             }
         },
-        
+
+        /**
+         * Destroy the QuickTips instance.
+         */
+        destroy: function() {
+            if (tip) {
+                var undef;
+                tip.destroy();
+                tip = undef;
+            }
+        },
+
         // Protected method called by the dd classes
         ddDisable : function(){
             // don't disable it if we don't need to
             if(tip && !disabled){
                 tip.disable();
-            }    
+            }
         },
-        
+
         // Protected method called by the dd classes
         ddEnable : function(){
             // only enable it if it hasn't been disabled
@@ -144,8 +163,8 @@ Ext.QuickTips = function(){
         },
 
         /**
-         * Gets the single {@link Ext.QuickTip QuickTip} instance used to show tips from all registered elements.
-         * @return {Ext.QuickTip}
+         * Gets the single {@link Ext.tip.QuickTip QuickTip} instance used to show tips from all registered elements.
+         * @return {Ext.tip.QuickTip}
          */
         getQuickTip : function(){
             return tip;
@@ -153,7 +172,7 @@ Ext.QuickTips = function(){
 
         /**
          * Configures a new quick tip instance and assigns it to a target element.  See
-         * {@link Ext.QuickTip#register} for details.
+         * {@link Ext.tip.QuickTip#register} for details.
          * @param {Object} config The config object
          */
         register : function(){
@@ -176,4 +195,4 @@ Ext.QuickTips = function(){
             tip.register.apply(tip, arguments);
         }
     };
-}();
\ No newline at end of file
+}());
\ No newline at end of file