X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.tip.QuickTipManager.js?ds=sidebyside diff --git a/docs/output/Ext.tip.QuickTipManager.js b/docs/output/Ext.tip.QuickTipManager.js new file mode 100644 index 00000000..ebafc115 --- /dev/null +++ b/docs/output/Ext.tip.QuickTipManager.js @@ -0,0 +1,257 @@ +Ext.data.JsonP.Ext_tip_QuickTipManager({ + "tagname": "class", + "name": "Ext.tip.QuickTipManager", + "doc": "
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 Ext.tip.Tip or Ext.tip.ToolTip.
\n\nQuicktips can be configured via tag attributes directly in markup, or by\nregistering quick tips programmatically via the register method.
\n\nThe singleton's instance of Ext.tip.QuickTip is available via\ngetQuickTip, and supports all the methods, and all the all the\nconfiguration properties of Ext.tip.QuickTip. These settings will apply to all\ntooltips shown by the singleton.
\n\nBelow is the summary of the configuration properties which can be used.\nFor detailed descriptions see the config options for the QuickTip class
\n\ndismissDelay
hideDelay
maxWidth
minWidth
showDelay
trackMouse
autoHide
cls
dismissDelay
(overrides singleton value)target
(required)text
(required)title
width
Here is an example showing how some of these config options could be used:
\n\n\n\n// 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
\n\nTo register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with\nthe data- namespace. The HTML element itself is automatically set as the quick tip target. Here is the summary\nof supported attributes (optional unless otherwise noted):
\n\nhide
: Specifying \"user\" is equivalent to setting autoHide = false. Any other value will be the same as autoHide = true.qclass
: A CSS class to be applied to the quick tip (equivalent to the 'cls' target element config).qtip (required)
: The quick tip text (equivalent to the 'text' target element config).qtitle
: The quick tip title (equivalent to the 'title' target element config).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:
\n\n// Add a quick tip to an HTML button\n<input type=\"button\" value=\"OK\" data-qtitle=\"OK Button\" data-qwidth=\"100\"\n data-qtip=\"This is a quick tip from markup!\"></input>\n
\n",
+ "extends": null,
+ "mixins": [
+
+ ],
+ "alternateClassNames": [
+
+ ],
+ "xtype": null,
+ "author": null,
+ "docauthor": null,
+ "singleton": true,
+ "private": false,
+ "cfg": [
+
+ ],
+ "method": [
+ {
+ "tagname": "method",
+ "name": "destroy",
+ "member": "Ext.tip.QuickTipManager",
+ "doc": "Destroy the QuickTips instance.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 150, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-destroy", + "shortDoc": "Destroy the QuickTips instance.
\n" + }, + { + "tagname": "method", + "name": "disable", + "member": "Ext.tip.QuickTipManager", + "doc": "Disable quick tips globally.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 187, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-disable", + "shortDoc": "Disable quick tips globally.
\n" + }, + { + "tagname": "method", + "name": "enable", + "member": "Ext.tip.QuickTipManager", + "doc": "Enable quick tips globally.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 177, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-enable", + "shortDoc": "Enable quick tips globally.
\n" + }, + { + "tagname": "method", + "name": "getQuickTip", + "member": "Ext.tip.QuickTipManager", + "doc": "Gets the single QuickTip instance used to show tips from all registered elements.
\n", + "params": [ + + ], + "return": { + "type": "Ext.tip.QuickTip", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 205, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-getQuickTip", + "shortDoc": "Gets the single QuickTip instance used to show tips from all registered elements.
\n" + }, + { + "tagname": "method", + "name": "init", + "member": "Ext.tip.QuickTipManager", + "doc": "Initialize the global QuickTips instance and prepare any quick tips.
\n", + "params": [ + { + "type": "Boolean", + "name": "autoRender", + "doc": "True to render the QuickTips container immediately to\npreload images. (Defaults to true)
\n", + "optional": false + }, + { + "type": "Object", + "name": "config", + "doc": "An optional config object for the created QuickTip. By\ndefault, the QuickTip 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.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 103, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-init", + "shortDoc": "Initialize the global QuickTips instance and prepare any quick tips.
\n" + }, + { + "tagname": "method", + "name": "isEnabled", + "member": "Ext.tip.QuickTipManager", + "doc": "Returns true if quick tips are enabled, else false.
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 197, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-isEnabled", + "shortDoc": "Returns true if quick tips are enabled, else false.
\n" + }, + { + "tagname": "method", + "name": "register", + "member": "Ext.tip.QuickTipManager", + "doc": "Configures a new quick tip instance and assigns it to a target element. See\nExt.tip.QuickTip.register for details.
\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "The config object
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 213, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-register", + "shortDoc": "Configures a new quick tip instance and assigns it to a target element. See\nExt.tip.QuickTip.register for details.
\n" + }, + { + "tagname": "method", + "name": "tips", + "member": "Ext.tip.QuickTipManager", + "doc": "Alias of register.
\n", + "params": [ + { + "type": "Object", + "name": "config", + "doc": "The config object
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 230, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-tips", + "shortDoc": "Alias of register.
\n" + }, + { + "tagname": "method", + "name": "unregister", + "member": "Ext.tip.QuickTipManager", + "doc": "Removes any registered quick tip from the target element and destroys it.
\n", + "params": [ + { + "type": "String/HTMLElement/Element", + "name": "el", + "doc": "The element from which the quick tip is to be removed.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 222, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager-method-unregister", + "shortDoc": "Removes any registered quick tip from the target element and destroys it.
\n" + } + ], + "property": [ + + ], + "event": [ + + ], + "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/tip/QuickTipManager.js", + "linenr": 1, + "html_filename": "QuickTipManager.html", + "href": "QuickTipManager.html#Ext-tip-QuickTipManager", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + + ] +}); \ No newline at end of file