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

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