Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs / symbols / Roo.QuickTips.json
diff --git a/docs/symbols/Roo.QuickTips.json b/docs/symbols/Roo.QuickTips.json
new file mode 100644 (file)
index 0000000..8ccd5d5
--- /dev/null
@@ -0,0 +1,252 @@
+{
+  "name" : "Roo.QuickTips",
+  "augments" : [
+  ],
+  "desc" : "Provides attractive and customizable tooltips for any element.",
+  "isSingleton" : true,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "QuickTips",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+  ],
+  "returns" : [
+  ],
+  "config" : [
+    {
+      "name" : "showDelay",
+      "type" : "Number",
+      "desc" : "Delay in milliseconds before the quick tip displays after the mouse enters the target element (defaults to 500)",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "maxWidth",
+      "type" : "Number",
+      "desc" : "The maximum width of the quick tip (defaults to 300)",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "Delay",
+      "type" : "Number",
+      "desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "text",
+      "type" : "String",
+      "desc" : "Body text to display (defaults to '').  This can be any valid HTML markup.",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "hideOnClick",
+      "type" : "Boolean",
+      "desc" : "True to hide the quick tip if the user clicks anywhere in the document (defaults to true)",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "minWidth",
+      "type" : "Number",
+      "desc" : "The minimum width of the quick tip (defaults to 40)",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "hideDelay",
+      "type" : "Number",
+      "desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "title",
+      "type" : "String",
+      "desc" : "Title text to display (defaults to '').  This can be any valid HTML markup.",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "cls",
+      "type" : "String",
+      "desc" : "A CSS class to apply to the base quick tip element (defaults to '').",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "width",
+      "type" : "Number",
+      "desc" : "Width in pixels of the quick tip (defaults to auto).  Width will be ignored if it exceeds the bounds of\nminWidth or maxWidth.",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "interceptTitles",
+      "type" : "Boolean",
+      "desc" : "True to automatically use the element's DOM title value if available (defaults to false)",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "trackMouse",
+      "type" : "Boolean",
+      "desc" : "True to have the quick tip follow the mouse as it moves over the target element (defaults to false)",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "True",
+      "type" : "Boolean",
+      "desc" : "to automatically hide the quick tip after a set period of time, regardless of the user's actions\n(defaults to true).  Used in conjunction with autoDismissDelay.",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "animate",
+      "type" : "Boolean",
+      "desc" : "True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7).",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "autoHide",
+      "type" : "Boolean",
+      "desc" : "True to automatically hide the quick tip after the mouse exits the target element (defaults to true).\nUsed in conjunction with hideDelay.",
+      "memberOf" : "Roo.QuickTips",
+      "values" : [
+      ]
+    }
+  ],
+  "methods" : [
+    {
+      "name" : "isEnabled",
+      "desc" : "Returns true if the quick tip is enabled, else false.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.QuickTips",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "disable",
+      "desc" : "Disable this quick tip.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.QuickTips",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "unregister",
+      "desc" : "Removes this quick tip from its element and destroys it.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.QuickTips",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "el",
+          "type" : "String/HTMLElement/Element",
+          "desc" : "The element from which the quick tip is to be removed.",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "enable",
+      "desc" : "Enable this quick tip.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.QuickTips",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "init",
+      "desc" : "Initialize and enable QuickTips for first use.  This should be called once before the first attempt to access\nor display QuickTips in a page.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.QuickTips",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "register",
+      "desc" : "Configures a new quick tip instance and assigns it to a target element.  The following config options\nare supported:\n<pre>\nProperty    Type                   Description\n----------  ---------------------  ------------------------------------------------------------------------\ntarget      Element/String/Array   An Element, id or array of ids that this quick tip should be tied to\n</ul>",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.QuickTips",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "config",
+          "type" : "Object",
+          "desc" : "The config object",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file