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