--- /dev/null
+<html>\r
+<head>\r
+ <title>The source code</title>\r
+ <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
+ <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
+</head>\r
+<body onload="prettyPrint();">\r
+ <pre class="prettyprint lang-js"><div id="cls-Ext.QuickTips"></div>/**\r
+ * @class Ext.QuickTips\r
+ * <p>Provides attractive and customizable tooltips for any element. The QuickTips\r
+ * singleton is used to configure and manage tooltips globally for multiple elements\r
+ * in a generic manner. To create individual tooltips with maximum customizability,\r
+ * you should consider either {@link Ext.Tip} or {@link Ext.ToolTip}.</p>\r
+ * <p>Quicktips can be configured via tag attributes directly in markup, or by\r
+ * registering quick tips programmatically via the {@link #register} method.</p>\r
+ * <p>The singleton's instance of {@link Ext.QuickTip} is available via\r
+ * {@link #getQuickTip}, and supports all the methods, and all the all the\r
+ * configuration properties of Ext.QuickTip. These settings will apply to all\r
+ * tooltips shown by the singleton.</p>\r
+ * <p>Below is the summary of the configuration properties which can be used.\r
+ * For detailed descriptions see {@link #getQuickTip}</p>\r
+ * <p><b>QuickTips singleton configs (all are optional)</b></p>\r
+ * <div class="mdetail-params"><ul><li>dismissDelay</li>\r
+ * <li>hideDelay</li>\r
+ * <li>maxWidth</li>\r
+ * <li>minWidth</li>\r
+ * <li>showDelay</li>\r
+ * <li>trackMouse</li></ul></div>\r
+ * <p><b>Target element configs (optional unless otherwise noted)</b></p>\r
+ * <div class="mdetail-params"><ul><li>autoHide</li>\r
+ * <li>cls</li>\r
+ * <li>dismissDelay (overrides singleton value)</li>\r
+ * <li>target (required)</li>\r
+ * <li>text (required)</li>\r
+ * <li>title</li>\r
+ * <li>width</li></ul></div>\r
+ * <p>Here is an example showing how some of these config options could be used:</p>\r
+ * <pre><code>\r
+// Init the singleton. Any tag-based quick tips will start working.\r
+Ext.QuickTips.init();\r
+\r
+// Apply a set of config properties to the singleton\r
+Ext.apply(Ext.QuickTips.getQuickTip(), {\r
+ maxWidth: 200,\r
+ minWidth: 100,\r
+ showDelay: 50,\r
+ trackMouse: true\r
+});\r
+\r
+// Manually register a quick tip for a specific element\r
+Ext.QuickTips.register({\r
+ target: 'my-div',\r
+ title: 'My Tooltip',\r
+ text: 'This tooltip was added in code',\r
+ width: 100,\r
+ dismissDelay: 20\r
+});\r
+</code></pre>\r
+ * <p>To register a quick tip in markup, you simply add one or more of the valid QuickTip attributes prefixed with\r
+ * the <b>ext:</b> namespace. The HTML element itself is automatically set as the quick tip target. Here is the summary\r
+ * of supported attributes (optional unless otherwise noted):</p>\r
+ * <ul><li><b>hide</b>: Specifying "user" is equivalent to setting autoHide = false. Any other value will be the\r
+ * same as autoHide = true.</li>\r
+ * <li><b>qclass</b>: A CSS class to be applied to the quick tip (equivalent to the 'cls' target element config).</li>\r
+ * <li><b>qtip (required)</b>: The quick tip text (equivalent to the 'text' target element config).</li>\r
+ * <li><b>qtitle</b>: The quick tip title (equivalent to the 'title' target element config).</li>\r
+ * <li><b>qwidth</b>: The quick tip width (equivalent to the 'width' target element config).</li></ul>\r
+ * <p>Here is an example of configuring an HTML element to display a tooltip from markup:</p>\r
+ * <pre><code>\r
+// Add a quick tip to an HTML button\r
+<input type="button" value="OK" ext:qtitle="OK Button" ext:qwidth="100"\r
+ ext:qtip="This is a quick tip from markup!"></input>\r
+</code></pre>\r
+ * @singleton\r
+ */\r
+Ext.QuickTips = function(){\r
+ var tip, locks = [];\r
+ return {\r
+ <div id="method-Ext.QuickTips-init"></div>/**\r
+ * Initialize the global QuickTips instance and prepare any quick tips.\r
+ * @param {Boolean} autoRender True to render the QuickTips container immediately to preload images. (Defaults to true) \r
+ */\r
+ init : function(autoRender){\r
+ if(!tip){\r
+ if(!Ext.isReady){\r
+ Ext.onReady(function(){\r
+ Ext.QuickTips.init(autoRender);\r
+ });\r
+ return;\r
+ }\r
+ tip = new Ext.QuickTip({elements:'header,body'});\r
+ if(autoRender !== false){\r
+ tip.render(Ext.getBody());\r
+ }\r
+ }\r
+ },\r
+\r
+ <div id="method-Ext.QuickTips-enable"></div>/**\r
+ * Enable quick tips globally.\r
+ */\r
+ enable : function(){\r
+ if(tip){\r
+ locks.pop();\r
+ if(locks.length < 1){\r
+ tip.enable();\r
+ }\r
+ }\r
+ },\r
+\r
+ <div id="method-Ext.QuickTips-disable"></div>/**\r
+ * Disable quick tips globally.\r
+ */\r
+ disable : function(){\r
+ if(tip){\r
+ tip.disable();\r
+ }\r
+ locks.push(1);\r
+ },\r
+\r
+ <div id="method-Ext.QuickTips-isEnabled"></div>/**\r
+ * Returns true if quick tips are enabled, else false.\r
+ * @return {Boolean}\r
+ */\r
+ isEnabled : function(){\r
+ return tip !== undefined && !tip.disabled;\r
+ },\r
+\r
+ <div id="method-Ext.QuickTips-getQuickTip"></div>/**\r
+ * Gets the global QuickTips instance.\r
+ */\r
+ getQuickTip : function(){\r
+ return tip;\r
+ },\r
+\r
+ <div id="method-Ext.QuickTips-register"></div>/**\r
+ * Configures a new quick tip instance and assigns it to a target element. See\r
+ * {@link Ext.QuickTip#register} for details.\r
+ * @param {Object} config The config object\r
+ */\r
+ register : function(){\r
+ tip.register.apply(tip, arguments);\r
+ },\r
+\r
+ <div id="method-Ext.QuickTips-unregister"></div>/**\r
+ * Removes any registered quick tip from the target element and destroys it.\r
+ * @param {String/HTMLElement/Element} el The element from which the quick tip is to be removed.\r
+ */\r
+ unregister : function(){\r
+ tip.unregister.apply(tip, arguments);\r
+ },\r
+\r
+ <div id="method-Ext.QuickTips-tips"></div>/**\r
+ * Alias of {@link #register}.\r
+ * @param {Object} config The config object\r
+ */\r
+ tips :function(){\r
+ tip.register.apply(tip, arguments);\r
+ }\r
+ }\r
+}();</pre> \r
+</body>\r
+</html>
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff