X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.QuickTips.json;fp=docs%2Fsymbols%2FRoo.QuickTips.json;h=fedfe6951184e44103ef75c2d7ceb9af40d1a96f;hp=37c050b74ef96ddf6abf93f6999ea7b104666137;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.QuickTips.json b/docs/symbols/Roo.QuickTips.json index 37c050b74e..fedfe69511 100644 --- a/docs/symbols/Roo.QuickTips.json +++ b/docs/symbols/Roo.QuickTips.json @@ -1,10 +1,15 @@ { "name" : "Roo.QuickTips", "augments" : [], + "childClasses" : { }, + "tree_children" : [], + "tree_parent" : [], "desc" : "Provides attractive and customizable tooltips for any element.", "isSingleton" : true, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : false, "memberOf" : "QuickTips", "example" : "", "deprecated" : "", @@ -12,153 +17,155 @@ "see" : "", "params" : [], "returns" : [], + "throws" : "", + "requires" : "", "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", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "maxWidth", "type" : "Number", "desc" : "The maximum width of the quick tip (defaults to 300)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "Delay", "type" : "Number", "desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "text", "type" : "String", "desc" : "Body text to display (defaults to ''). This can be any valid HTML markup.", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "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", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "minWidth", "type" : "Number", "desc" : "The minimum width of the quick tip (defaults to 40)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "hideDelay", "type" : "Number", "desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "title", "type" : "String", "desc" : "Title text to display (defaults to ''). This can be any valid HTML markup.", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the base quick tip element (defaults to '').", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "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", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "interceptTitles", "type" : "Boolean", "desc" : "True to automatically use the element's DOM title value if available (defaults to false)", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "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", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "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", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "name" : "animate", "type" : "Boolean", "desc" : "True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7).", - "memberOf" : "Roo.QuickTips", - "optvals" : [] + "memberOf" : "Roo.QuickTips" }, { "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", - "optvals" : [] + "memberOf" : "Roo.QuickTips" } ], "methods" : [ { "name" : "isEnabled", + "type" : "function", "desc" : "Returns true if the quick tip is enabled, else false.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "disable", + "type" : "function", "desc" : "Disable this quick tip.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "unregister", + "type" : "function", "desc" : "Removes this quick tip from its element and destroys it.", + "sig" : "(el)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -171,43 +178,58 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this quick tip.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "init", + "type" : "function", "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.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.QuickTips", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "register", + "type" : "function", "desc" : "Configures a new quick tip instance and assigns it to a target element. The following config options\nare supported:\n
\nProperty    Type                   Description\n----------  ---------------------  ------------------------------------------------------------------------\ntarget      Element/String/Array   An Element, id or array of ids that this quick tip should be tied to\n",
+      "sig" : "(config)",
+      "static" : false,
+      "memberOf" : "",
       "isStatic" : false,
       "isConstructor" : false,
       "isPrivate" : false,
-      "memberOf" : "Roo.QuickTips",
       "example" : "",
       "deprecated" : "",
       "since" : "",
       "see" : "",
+      "exceptions" : "",
+      "requires" : "",
       "params" : [
         {
           "name" : "config",