Upgrade to ExtJS 4.0.7 - Released 10/19/2011
[extjs.git] / docs / source / QuickTipManager.html
index f9fa6bf..0bef62e 100644 (file)
@@ -3,8 +3,8 @@
 <head>
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   <title>The source code</title>
-  <link href="../prettify/prettify.css" type="text/css" rel="stylesheet" />
-  <script type="text/javascript" src="../prettify/prettify.js"></script>
+  <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+  <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
   <style type="text/css">
     .highlight { display: block; background-color: #ddd; }
   </style>
  *
  * Here is an example showing how some of these config options could be used:
  *
- * {@img Ext.tip.QuickTipManager/Ext.tip.QuickTipManager.png Ext.tip.QuickTipManager component}
- *
- * ## Code
- *
+ *     @example
  *     // 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',
@@ -79,8 +76,8 @@
  *         },
  *         renderTo: Ext.getBody()
  *     });
- *     
- *     
+ *
+ *
  *     // Manually register a quick tip for a specific element
  *     Ext.tip.QuickTipManager.register({
  *         target: 'quickTipContainer',
  *  - `qwidth`: The quick tip width (equivalent to the 'width' target element config).
  *
  * Here is an example of configuring an HTML element to display a tooltip from markup:
- *     
+ *
  *     // Add a quick tip to an HTML button
  *     &lt;input type=&quot;button&quot; value=&quot;OK&quot; data-qtitle=&quot;OK Button&quot; data-qwidth=&quot;100&quot;
  *          data-qtip=&quot;This is a quick tip from markup!&quot;&gt;&lt;/input&gt;
@@ -119,9 +116,9 @@ Ext.define('Ext.tip.QuickTipManager', function() {
 
 <span id='Ext-tip-QuickTipManager-method-init'>        /**
 </span>         * Initialize the global QuickTips instance and prepare any quick tips.
-         * @param {Boolean} autoRender True to render the QuickTips container immediately to
+         * @param {Boolean} autoRender (optional) True to render the QuickTips container immediately to
          * preload images. (Defaults to true)
-         * @param {Object} config An optional config object for the created QuickTip. By
+         * @param {Object} config (optional) config object for the created QuickTip. By
          * default, the {@link Ext.tip.QuickTip QuickTip} class is instantiated, but this can
          * be changed by supplying an xtype property or a className property in this object.
          * All other properties on this object are configuration for the created component.
@@ -238,7 +235,7 @@ Ext.define('Ext.tip.QuickTipManager', function() {
 
 <span id='Ext-tip-QuickTipManager-method-unregister'>        /**
 </span>         * Removes any registered quick tip from the target element and destroys it.
-         * @param {String/HTMLElement/Element} el The element from which the quick tip is to be removed.
+         * @param {String/HTMLElement/Ext.Element} el The element from which the quick tip is to be removed or ID of the element.
          */
         unregister : function(){
             tip.unregister.apply(tip, arguments);