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

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