docs/output/Ext.tip.QuickTipManager.js

   1 Ext.data.JsonP.Ext_tip_QuickTipManager({
   2   "tagname": "class",
   3   "name": "Ext.tip.QuickTipManager",
   4   "doc": "<p>Provides attractive and customizable tooltips for any element. The QuickTips\nsingleton is used to configure and manage tooltips globally for multiple elements\nin a generic manner.  To create individual tooltips with maximum customizability,\nyou should consider either <a href=\"#/api/Ext.tip.Tip\" rel=\"Ext.tip.Tip\" class=\"docClass\">Ext.tip.Tip</a> or <a href=\"#/api/Ext.tip.ToolTip\" rel=\"Ext.tip.ToolTip\" class=\"docClass\">Ext.tip.ToolTip</a>.</p>\n\n<p>Quicktips can be configured via tag attributes directly in markup, or by\nregistering quick tips programmatically via the <a href=\"#/api/Ext.tip.QuickTipManager-method-register\" rel=\"Ext.tip.QuickTipManager-method-register\" class=\"docClass\">register</a> method.</p>\n\n<p>The singleton's instance of <a href=\"#/api/Ext.tip.QuickTip\" rel=\"Ext.tip.QuickTip\" class=\"docClass\">Ext.tip.QuickTip</a> is available via\n<a href=\"#/api/Ext.tip.QuickTipManager-method-getQuickTip\" rel=\"Ext.tip.QuickTipManager-method-getQuickTip\" class=\"docClass\">getQuickTip</a>, and supports all the methods, and all the all the\nconfiguration properties of <a href=\"#/api/Ext.tip.QuickTip\" rel=\"Ext.tip.QuickTip\" class=\"docClass\">Ext.tip.QuickTip</a>. These settings will apply to all\ntooltips shown by the singleton.</p>\n\n<p>Below is the summary of the configuration properties which can be used.\nFor detailed descriptions see the config options for the <a href=\"#/api/Ext.tip.QuickTip\" rel=\"Ext.tip.QuickTip\" class=\"docClass\">QuickTip</a> class</p>\n\n<h2>QuickTips singleton configs (all are optional)</h2>\n\n<ul>\n<li><code>dismissDelay</code></li>\n<li><code>hideDelay</code></li>\n<li><code>maxWidth</code></li>\n<li><code>minWidth</code></li>\n<li><code>showDelay</code></li>\n<li><code>trackMouse</code></li>\n</ul>\n\n\n<h2>Target element configs (optional unless otherwise noted)</h2>\n\n<ul>\n<li><code>autoHide</code></li>\n<li><code>cls</code></li>\n<li><code>dismissDelay</code> (overrides singleton value)</li>\n<li><code>target</code> (required)</li>\n<li><code>text</code> (required)</li>\n<li><code>title</code></li>\n<li><code>width</code></li>\n</ul>\n\n\n<p>Here is an example showing how some of these config options could be used:</p>\n\n<p><p><img src=\"doc-resources/Ext.tip.QuickTipManager/Ext.tip.QuickTipManager.png\" alt=\"Ext.tip.QuickTipManager component\"></p></p>\n\n<h2>Code</h2>\n\n<pre><code>// Init the singleton.  Any tag-based quick tips will start working.\nExt.tip.QuickTipManager.init();\n\n// Apply a set of config properties to the singleton\nExt.apply(Ext.tip.QuickTipManager.getQuickTip(), {\n    maxWidth: 200,\n    minWidth: 100,\n    showDelay: 50      // Show 50ms after entering target\n});\n\n// Create a small panel to add a quick tip to\nExt.create('Ext.container.Container', {\n    id: 'quickTipContainer',\n    width: 200,\n    height: 150,\n    style: {\n        backgroundColor:'#000000'\n    },\n    renderTo: Ext.getBody()\n});\n\n\n// Manually register a quick tip for a specific element\nExt.tip.QuickTipManager.register({\n    target: 'quickTipContainer',\n    title: 'My Tooltip',\n    text: 'This tooltip was added in code',\n    width: 100,\n    dismissDelay: 10000 // Hide after 10 seconds hover\n});\n</code></pre>\n\n<p>To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with\nthe <strong>data-</strong> namespace.  The HTML element itself is automatically set as the quick tip target. Here is the summary\nof supported attributes (optional unless otherwise noted):</p>\n\n<ul>\n<li><code>hide</code>: Specifying \"user\" is equivalent to setting autoHide = false.  Any other value will be the same as autoHide = true.</li>\n<li><code>qclass</code>: A CSS class to be applied to the quick tip (equivalent to the 'cls' target element config).</li>\n<li><code>qtip (required)</code>: The quick tip text (equivalent to the 'text' target element config).</li>\n<li><code>qtitle</code>: The quick tip title (equivalent to the 'title' target element config).</li>\n<li><code>qwidth</code>: The quick tip width (equivalent to the 'width' target element config).</li>\n</ul>\n\n\n<p>Here is an example of configuring an HTML element to display a tooltip from markup:</p>\n\n<pre><code>// Add a quick tip to an HTML button\n&lt;input type=\"button\" value=\"OK\" data-qtitle=\"OK Button\" data-qwidth=\"100\"\n     data-qtip=\"This is a quick tip from markup!\"&gt;&lt;/input&gt;\n</code></pre>\n",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": true,
  16   "private": false,
  17   "cfg": [
  18
  19   ],
  20   "method": [
  21     {
  22       "tagname": "method",
  23       "name": "destroy",
  24       "member": "Ext.tip.QuickTipManager",
  25       "doc": "<p>Destroy the QuickTips instance.</p>\n",
  26       "params": [
  27
  28       ],
  29       "return": {
  30         "type": "void",
  31         "doc": "\n"
  32       },
  33       "private": false,
  34       "static": false,
  35       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
  36       "linenr": 150,
  37       "html_filename": "QuickTipManager.html",
  38       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-destroy",
  39       "shortDoc": "<p>Destroy the QuickTips instance.</p>\n"
  40     },
  41     {
  42       "tagname": "method",
  43       "name": "disable",
  44       "member": "Ext.tip.QuickTipManager",
  45       "doc": "<p>Disable quick tips globally.</p>\n",
  46       "params": [
  47
  48       ],
  49       "return": {
  50         "type": "void",
  51         "doc": "\n"
  52       },
  53       "private": false,
  54       "static": false,
  55       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
  56       "linenr": 187,
  57       "html_filename": "QuickTipManager.html",
  58       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-disable",
  59       "shortDoc": "<p>Disable quick tips globally.</p>\n"
  60     },
  61     {
  62       "tagname": "method",
  63       "name": "enable",
  64       "member": "Ext.tip.QuickTipManager",
  65       "doc": "<p>Enable quick tips globally.</p>\n",
  66       "params": [
  67
  68       ],
  69       "return": {
  70         "type": "void",
  71         "doc": "\n"
  72       },
  73       "private": false,
  74       "static": false,
  75       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
  76       "linenr": 177,
  77       "html_filename": "QuickTipManager.html",
  78       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-enable",
  79       "shortDoc": "<p>Enable quick tips globally.</p>\n"
  80     },
  81     {
  82       "tagname": "method",
  83       "name": "getQuickTip",
  84       "member": "Ext.tip.QuickTipManager",
  85       "doc": "<p>Gets the single <a href=\"#/api/Ext.tip.QuickTip\" rel=\"Ext.tip.QuickTip\" class=\"docClass\">QuickTip</a> instance used to show tips from all registered elements.</p>\n",
  86       "params": [
  87
  88       ],
  89       "return": {
  90         "type": "Ext.tip.QuickTip",
  91         "doc": "\n"
  92       },
  93       "private": false,
  94       "static": false,
  95       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
  96       "linenr": 205,
  97       "html_filename": "QuickTipManager.html",
  98       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-getQuickTip",
  99       "shortDoc": "<p>Gets the single <a href=\"#/api/Ext.tip.QuickTip\" rel=\"Ext.tip.QuickTip\" class=\"docClass\">QuickTip</a> instance used to show tips from all registered elements.</p>\n"
 100     },
 101     {
 102       "tagname": "method",
 103       "name": "init",
 104       "member": "Ext.tip.QuickTipManager",
 105       "doc": "<p>Initialize the global QuickTips instance and prepare any quick tips.</p>\n",
 106       "params": [
 107         {
 108           "type": "Boolean",
 109           "name": "autoRender",
 110           "doc": "<p>True to render the QuickTips container immediately to\npreload images. (Defaults to true)</p>\n",
 111           "optional": false
 112         },
 113         {
 114           "type": "Object",
 115           "name": "config",
 116           "doc": "<p>An optional config object for the created QuickTip. By\ndefault, the <a href=\"#/api/Ext.tip.QuickTip\" rel=\"Ext.tip.QuickTip\" class=\"docClass\">QuickTip</a> class is instantiated, but this can\nbe changed by supplying an xtype property or a className property in this object.\nAll other properties on this object are configuration for the created component.</p>\n",
 117           "optional": false
 118         }
 119       ],
 120       "return": {
 121         "type": "void",
 122         "doc": "\n"
 123       },
 124       "private": false,
 125       "static": false,
 126       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
 127       "linenr": 103,
 128       "html_filename": "QuickTipManager.html",
 129       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-init",
 130       "shortDoc": "<p>Initialize the global QuickTips instance and prepare any quick tips.</p>\n"
 131     },
 132     {
 133       "tagname": "method",
 134       "name": "isEnabled",
 135       "member": "Ext.tip.QuickTipManager",
 136       "doc": "<p>Returns true if quick tips are enabled, else false.</p>\n",
 137       "params": [
 138
 139       ],
 140       "return": {
 141         "type": "Boolean",
 142         "doc": "\n"
 143       },
 144       "private": false,
 145       "static": false,
 146       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
 147       "linenr": 197,
 148       "html_filename": "QuickTipManager.html",
 149       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-isEnabled",
 150       "shortDoc": "<p>Returns true if quick tips are enabled, else false.</p>\n"
 151     },
 152     {
 153       "tagname": "method",
 154       "name": "register",
 155       "member": "Ext.tip.QuickTipManager",
 156       "doc": "<p>Configures a new quick tip instance and assigns it to a target element.  See\n<a href=\"#/api/Ext.tip.QuickTip-method-register\" rel=\"Ext.tip.QuickTip-method-register\" class=\"docClass\">Ext.tip.QuickTip.register</a> for details.</p>\n",
 157       "params": [
 158         {
 159           "type": "Object",
 160           "name": "config",
 161           "doc": "<p>The config object</p>\n",
 162           "optional": false
 163         }
 164       ],
 165       "return": {
 166         "type": "void",
 167         "doc": "\n"
 168       },
 169       "private": false,
 170       "static": false,
 171       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
 172       "linenr": 213,
 173       "html_filename": "QuickTipManager.html",
 174       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-register",
 175       "shortDoc": "<p>Configures a new quick tip instance and assigns it to a target element.  See\n<a href=\"#/api/Ext.tip.QuickTip-method-register\" rel=\"Ext.tip.QuickTip-method-register\" class=\"docClass\">Ext.tip.QuickTip.register</a> for details.</p>\n"
 176     },
 177     {
 178       "tagname": "method",
 179       "name": "tips",
 180       "member": "Ext.tip.QuickTipManager",
 181       "doc": "<p>Alias of <a href=\"#/api/Ext.tip.QuickTipManager-method-register\" rel=\"Ext.tip.QuickTipManager-method-register\" class=\"docClass\">register</a>.</p>\n",
 182       "params": [
 183         {
 184           "type": "Object",
 185           "name": "config",
 186           "doc": "<p>The config object</p>\n",
 187           "optional": false
 188         }
 189       ],
 190       "return": {
 191         "type": "void",
 192         "doc": "\n"
 193       },
 194       "private": false,
 195       "static": false,
 196       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
 197       "linenr": 230,
 198       "html_filename": "QuickTipManager.html",
 199       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-tips",
 200       "shortDoc": "<p>Alias of <a href=\"#/api/Ext.tip.QuickTipManager-method-register\" rel=\"Ext.tip.QuickTipManager-method-register\" class=\"docClass\">register</a>.</p>\n"
 201     },
 202     {
 203       "tagname": "method",
 204       "name": "unregister",
 205       "member": "Ext.tip.QuickTipManager",
 206       "doc": "<p>Removes any registered quick tip from the target element and destroys it.</p>\n",
 207       "params": [
 208         {
 209           "type": "String/HTMLElement/Element",
 210           "name": "el",
 211           "doc": "<p>The element from which the quick tip is to be removed.</p>\n",
 212           "optional": false
 213         }
 214       ],
 215       "return": {
 216         "type": "void",
 217         "doc": "\n"
 218       },
 219       "private": false,
 220       "static": false,
 221       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
 222       "linenr": 222,
 223       "html_filename": "QuickTipManager.html",
 224       "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-unregister",
 225       "shortDoc": "<p>Removes any registered quick tip from the target element and destroys it.</p>\n"
 226     }
 227   ],
 228   "property": [
 229
 230   ],
 231   "event": [
 232
 233   ],
 234   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js",
 235   "linenr": 1,
 236   "html_filename": "QuickTipManager.html",
 237   "href": "QuickTipManager.html#Ext-tip-QuickTipManager",
 238   "cssVar": [
 239
 240   ],
 241   "cssMixin": [
 242
 243   ],
 244   "component": false,
 245   "superclasses": [
 246
 247   ],
 248   "subclasses": [
 249
 250   ],
 251   "mixedInto": [
 252
 253   ],
 254   "allMixins": [
 255
 256   ]
 257 });