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

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