git.roojs.org Git - roojs1/blob - docs/symbols/Roo.QuickTips.json

   1 {
   2   "name" : "Roo.QuickTips",
   3   "augments" : [],
   4   "childClasses" : [],
   5   "desc" : "Provides attractive and customizable tooltips for any element.",
   6   "isSingleton" : true,
   7   "isStatic" : false,
   8   "isBuiltin" : false,
   9   "memberOf" : "QuickTips",
  10   "example" : "",
  11   "deprecated" : "",
  12   "since" : "",
  13   "see" : "",
  14   "params" : [],
  15   "returns" : [],
  16   "throws" : "",
  17   "requires" : "",
  18   "config" : [
  19     {
  20       "name" : "showDelay",
  21       "type" : "Number",
  22       "desc" : "Delay in milliseconds before the quick tip displays after the mouse enters the target element (defaults to 500)",
  23       "memberOf" : ""
  24     },
  25     {
  26       "name" : "maxWidth",
  27       "type" : "Number",
  28       "desc" : "The maximum width of the quick tip (defaults to 300)",
  29       "memberOf" : ""
  30     },
  31     {
  32       "name" : "Delay",
  33       "type" : "Number",
  34       "desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)",
  35       "memberOf" : ""
  36     },
  37     {
  38       "name" : "text",
  39       "type" : "String",
  40       "desc" : "Body text to display (defaults to '').  This can be any valid HTML markup.",
  41       "memberOf" : ""
  42     },
  43     {
  44       "name" : "hideOnClick",
  45       "type" : "Boolean",
  46       "desc" : "True to hide the quick tip if the user clicks anywhere in the document (defaults to true)",
  47       "memberOf" : ""
  48     },
  49     {
  50       "name" : "minWidth",
  51       "type" : "Number",
  52       "desc" : "The minimum width of the quick tip (defaults to 40)",
  53       "memberOf" : ""
  54     },
  55     {
  56       "name" : "hideDelay",
  57       "type" : "Number",
  58       "desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)",
  59       "memberOf" : ""
  60     },
  61     {
  62       "name" : "title",
  63       "type" : "String",
  64       "desc" : "Title text to display (defaults to '').  This can be any valid HTML markup.",
  65       "memberOf" : ""
  66     },
  67     {
  68       "name" : "cls",
  69       "type" : "String",
  70       "desc" : "A CSS class to apply to the base quick tip element (defaults to '').",
  71       "memberOf" : ""
  72     },
  73     {
  74       "name" : "width",
  75       "type" : "Number",
  76       "desc" : "Width in pixels of the quick tip (defaults to auto).  Width will be ignored if it exceeds the bounds of\nminWidth or maxWidth.",
  77       "memberOf" : ""
  78     },
  79     {
  80       "name" : "interceptTitles",
  81       "type" : "Boolean",
  82       "desc" : "True to automatically use the element's DOM title value if available (defaults to false)",
  83       "memberOf" : ""
  84     },
  85     {
  86       "name" : "trackMouse",
  87       "type" : "Boolean",
  88       "desc" : "True to have the quick tip follow the mouse as it moves over the target element (defaults to false)",
  89       "memberOf" : ""
  90     },
  91     {
  92       "name" : "True",
  93       "type" : "Boolean",
  94       "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.",
  95       "memberOf" : ""
  96     },
  97     {
  98       "name" : "animate",
  99       "type" : "Boolean",
 100       "desc" : "True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7).",
 101       "memberOf" : ""
 102     },
 103     {
 104       "name" : "autoHide",
 105       "type" : "Boolean",
 106       "desc" : "True to automatically hide the quick tip after the mouse exits the target element (defaults to true).\nUsed in conjunction with hideDelay.",
 107       "memberOf" : ""
 108     }
 109   ],
 110   "methods" : [
 111     {
 112       "name" : "isEnabled",
 113       "type" : "function",
 114       "desc" : "Returns true if the quick tip is enabled, else false.",
 115       "sig" : "()\n{\n\n}",
 116       "static" : false,
 117       "memberOf" : "",
 118       "isStatic" : false,
 119       "isConstructor" : false,
 120       "isPrivate" : false,
 121       "example" : "",
 122       "deprecated" : "",
 123       "since" : "",
 124       "see" : "",
 125       "exceptions" : "",
 126       "requires" : "",
 127       "params" : [],
 128       "returns" : []
 129     },
 130     {
 131       "name" : "disable",
 132       "type" : "function",
 133       "desc" : "Disable this quick tip.",
 134       "sig" : "()\n{\n\n}",
 135       "static" : false,
 136       "memberOf" : "",
 137       "isStatic" : false,
 138       "isConstructor" : false,
 139       "isPrivate" : false,
 140       "example" : "",
 141       "deprecated" : "",
 142       "since" : "",
 143       "see" : "",
 144       "exceptions" : "",
 145       "requires" : "",
 146       "params" : [],
 147       "returns" : []
 148     },
 149     {
 150       "name" : "unregister",
 151       "type" : "function",
 152       "desc" : "Removes this quick tip from its element and destroys it.",
 153       "sig" : "(el)",
 154       "static" : false,
 155       "memberOf" : "",
 156       "isStatic" : false,
 157       "isConstructor" : false,
 158       "isPrivate" : false,
 159       "example" : "",
 160       "deprecated" : "",
 161       "since" : "",
 162       "see" : "",
 163       "exceptions" : "",
 164       "requires" : "",
 165       "params" : [
 166         {
 167           "name" : "el",
 168           "type" : "String/HTMLElement/Element",
 169           "desc" : "The element from which the quick tip is to be removed.",
 170           "isOptional" : false
 171         }
 172       ],
 173       "returns" : []
 174     },
 175     {
 176       "name" : "enable",
 177       "type" : "function",
 178       "desc" : "Enable this quick tip.",
 179       "sig" : "()\n{\n\n}",
 180       "static" : false,
 181       "memberOf" : "",
 182       "isStatic" : false,
 183       "isConstructor" : false,
 184       "isPrivate" : false,
 185       "example" : "",
 186       "deprecated" : "",
 187       "since" : "",
 188       "see" : "",
 189       "exceptions" : "",
 190       "requires" : "",
 191       "params" : [],
 192       "returns" : []
 193     },
 194     {
 195       "name" : "init",
 196       "type" : "function",
 197       "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.",
 198       "sig" : "()\n{\n\n}",
 199       "static" : false,
 200       "memberOf" : "",
 201       "isStatic" : false,
 202       "isConstructor" : false,
 203       "isPrivate" : false,
 204       "example" : "",
 205       "deprecated" : "",
 206       "since" : "",
 207       "see" : "",
 208       "exceptions" : "",
 209       "requires" : "",
 210       "params" : [],
 211       "returns" : []
 212     },
 213     {
 214       "name" : "register",
 215       "type" : "function",
 216       "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>",
 217       "sig" : "(config)",
 218       "static" : false,
 219       "memberOf" : "",
 220       "isStatic" : false,
 221       "isConstructor" : false,
 222       "isPrivate" : false,
 223       "example" : "",
 224       "deprecated" : "",
 225       "since" : "",
 226       "see" : "",
 227       "exceptions" : "",
 228       "requires" : "",
 229       "params" : [
 230         {
 231           "name" : "config",
 232           "type" : "Object",
 233           "desc" : "The config object",
 234           "isOptional" : false
 235         }
 236       ],
 237       "returns" : []
 238     }
 239   ],
 240   "events" : []
 241 }