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