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