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

   1 {
   2   "name" : "Roo.EventObject",
   3   "augments" : [],
   4   "childClasses" : {  },
   5   "tree_children" : [],
   6   "tree_parent" : [],
   7   "desc" : "EventObject exposes the Yahoo! UI Event functionality directly on the object\npassed to your event handler. It exists mostly for convenience. It also fixes the annoying null checks automatically to cleanup your code \nExample:\n<pre><code>\n function handleClick(e){ // e is not a standard event object, it is a Roo.EventObject\n    e.preventDefault();\n    var target = e.getTarget();\n    ...\n }\n var myDiv = Roo.get(\"myDiv\");\n myDiv.on(\"click\", handleClick);\n //or\n Roo.EventManager.on(\"myDiv\", 'click', handleClick);\n Roo.EventManager.addListener(\"myDiv\", 'click', handleClick);\n </code></pre>",
   8   "isSingleton" : true,
   9   "isStatic" : true,
  10   "isBuiltin" : false,
  11   "isAbstract" : false,
  12   "isBuilderTop" : false,
  13   "memberOf" : "EventObject",
  14   "example" : "",
  15   "deprecated" : "",
  16   "since" : "",
  17   "see" : "",
  18   "params" : [],
  19   "returns" : [],
  20   "throws" : "",
  21   "requires" : "",
  22   "config" : [],
  23   "methods" : [
  24     {
  25       "name" : "getPageX",
  26       "type" : "function",
  27       "desc" : "Gets the x coordinate of the event.",
  28       "sig" : "()\n{\n\n}",
  29       "static" : false,
  30       "memberOf" : "",
  31       "isStatic" : false,
  32       "isConstructor" : false,
  33       "isPrivate" : false,
  34       "example" : "",
  35       "deprecated" : "",
  36       "since" : "",
  37       "see" : "",
  38       "exceptions" : "",
  39       "requires" : "",
  40       "params" : [],
  41       "returns" : [
  42         {
  43           "name" : "",
  44           "type" : "Number",
  45           "desc" : ""
  46         }
  47       ]
  48     },
  49     {
  50       "name" : "getPageY",
  51       "type" : "function",
  52       "desc" : "Gets the y coordinate of the event.",
  53       "sig" : "()\n{\n\n}",
  54       "static" : false,
  55       "memberOf" : "",
  56       "isStatic" : false,
  57       "isConstructor" : false,
  58       "isPrivate" : false,
  59       "example" : "",
  60       "deprecated" : "",
  61       "since" : "",
  62       "see" : "",
  63       "exceptions" : "",
  64       "requires" : "",
  65       "params" : [],
  66       "returns" : [
  67         {
  68           "name" : "",
  69           "type" : "Number",
  70           "desc" : ""
  71         }
  72       ]
  73     },
  74     {
  75       "name" : "getTime",
  76       "type" : "function",
  77       "desc" : "Gets the time of the event.",
  78       "sig" : "()\n{\n\n}",
  79       "static" : false,
  80       "memberOf" : "",
  81       "isStatic" : false,
  82       "isConstructor" : false,
  83       "isPrivate" : false,
  84       "example" : "",
  85       "deprecated" : "",
  86       "since" : "",
  87       "see" : "",
  88       "exceptions" : "",
  89       "requires" : "",
  90       "params" : [],
  91       "returns" : [
  92         {
  93           "name" : "",
  94           "type" : "Number",
  95           "desc" : ""
  96         }
  97       ]
  98     },
  99     {
 100       "name" : "getXY",
 101       "type" : "function",
 102       "desc" : "Gets the page coordinates of the event.",
 103       "sig" : "()\n{\n\n}",
 104       "static" : false,
 105       "memberOf" : "",
 106       "isStatic" : false,
 107       "isConstructor" : false,
 108       "isPrivate" : false,
 109       "example" : "",
 110       "deprecated" : "",
 111       "since" : "",
 112       "see" : "",
 113       "exceptions" : "",
 114       "requires" : "",
 115       "params" : [],
 116       "returns" : [
 117         {
 118           "name" : "",
 119           "type" : "Array",
 120           "desc" : "The xy values like [x, y]"
 121         }
 122       ]
 123     },
 124     {
 125       "name" : "getRelatedTarget",
 126       "type" : "function",
 127       "desc" : "Gets the related target.",
 128       "sig" : "()\n{\n\n}",
 129       "static" : false,
 130       "memberOf" : "",
 131       "isStatic" : false,
 132       "isConstructor" : false,
 133       "isPrivate" : false,
 134       "example" : "",
 135       "deprecated" : "",
 136       "since" : "",
 137       "see" : "",
 138       "exceptions" : "",
 139       "requires" : "",
 140       "params" : [],
 141       "returns" : [
 142         {
 143           "name" : "",
 144           "type" : "HTMLElement",
 145           "desc" : ""
 146         }
 147       ]
 148     },
 149     {
 150       "name" : "getWheelDelta",
 151       "type" : "function",
 152       "desc" : "Normalizes mouse wheel delta across browsers",
 153       "sig" : "()\n{\n\n}",
 154       "static" : false,
 155       "memberOf" : "",
 156       "isStatic" : false,
 157       "isConstructor" : false,
 158       "isPrivate" : false,
 159       "example" : "",
 160       "deprecated" : "",
 161       "since" : "",
 162       "see" : "",
 163       "exceptions" : "",
 164       "requires" : "",
 165       "params" : [],
 166       "returns" : [
 167         {
 168           "name" : "",
 169           "type" : "Number",
 170           "desc" : "The delta"
 171         }
 172       ]
 173     },
 174     {
 175       "name" : "stopPropagation",
 176       "type" : "function",
 177       "desc" : "Cancels bubbling of the event.",
 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" : "stopEvent",
 195       "type" : "function",
 196       "desc" : "Stop the event (preventDefault and stopPropagation)",
 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" : "within",
 214       "type" : "function",
 215       "desc" : "Returns true if the target of this event equals el or is a child of el",
 216       "sig" : "(el, related)",
 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" : "el",
 231           "type" : "String/HTMLElement/Element",
 232           "desc" : "",
 233           "isOptional" : false
 234         },
 235         {
 236           "name" : "related",
 237           "type" : "Boolean",
 238           "desc" : "(optional) true to test if the related target is within el instead of the target",
 239           "isOptional" : false
 240         }
 241       ],
 242       "returns" : [
 243         {
 244           "name" : "",
 245           "type" : "Boolean",
 246           "desc" : ""
 247         }
 248       ]
 249     },
 250     {
 251       "name" : "hasModifier",
 252       "type" : "function",
 253       "desc" : "Returns true if the control, meta, shift or alt key was pressed during this event.",
 254       "sig" : "()\n{\n\n}",
 255       "static" : false,
 256       "memberOf" : "",
 257       "isStatic" : false,
 258       "isConstructor" : false,
 259       "isPrivate" : false,
 260       "example" : "",
 261       "deprecated" : "",
 262       "since" : "",
 263       "see" : "",
 264       "exceptions" : "",
 265       "requires" : "",
 266       "params" : [],
 267       "returns" : [
 268         {
 269           "name" : "",
 270           "type" : "Boolean",
 271           "desc" : ""
 272         }
 273       ]
 274     },
 275     {
 276       "name" : "getTarget",
 277       "type" : "function",
 278       "desc" : "Gets the target for the event.",
 279       "sig" : "(selector, maxDepth, returnEl)",
 280       "static" : false,
 281       "memberOf" : "",
 282       "isStatic" : false,
 283       "isConstructor" : false,
 284       "isPrivate" : false,
 285       "example" : "",
 286       "deprecated" : "",
 287       "since" : "",
 288       "see" : "",
 289       "exceptions" : "",
 290       "requires" : "",
 291       "params" : [
 292         {
 293           "name" : "selector",
 294           "type" : "String",
 295           "desc" : "(optional) A simple selector to filter the target or look for an ancestor of the target",
 296           "isOptional" : false
 297         },
 298         {
 299           "name" : "maxDepth",
 300           "type" : "Number/String/HTMLElement/Element",
 301           "desc" : "(optional) The max depth to\n                search as a number or element (defaults to 10 || document.body)",
 302           "isOptional" : false
 303         },
 304         {
 305           "name" : "returnEl",
 306           "type" : "Boolean",
 307           "desc" : "(optional) True to return a Roo.Element object instead of DOM node",
 308           "isOptional" : false
 309         }
 310       ],
 311       "returns" : [
 312         {
 313           "name" : "",
 314           "type" : "HTMLelement",
 315           "desc" : ""
 316         }
 317       ]
 318     },
 319     {
 320       "name" : "preventDefault",
 321       "type" : "function",
 322       "desc" : "Prevents the browsers default handling of the event.",
 323       "sig" : "()\n{\n\n}",
 324       "static" : false,
 325       "memberOf" : "",
 326       "isStatic" : false,
 327       "isConstructor" : false,
 328       "isPrivate" : false,
 329       "example" : "",
 330       "deprecated" : "",
 331       "since" : "",
 332       "see" : "",
 333       "exceptions" : "",
 334       "requires" : "",
 335       "params" : [],
 336       "returns" : []
 337     },
 338     {
 339       "name" : "getCharCode",
 340       "type" : "function",
 341       "desc" : "Gets the key code for the event.",
 342       "sig" : "()\n{\n\n}",
 343       "static" : false,
 344       "memberOf" : "",
 345       "isStatic" : false,
 346       "isConstructor" : false,
 347       "isPrivate" : false,
 348       "example" : "",
 349       "deprecated" : "",
 350       "since" : "",
 351       "see" : "",
 352       "exceptions" : "",
 353       "requires" : "",
 354       "params" : [],
 355       "returns" : [
 356         {
 357           "name" : "",
 358           "type" : "Number",
 359           "desc" : ""
 360         }
 361       ]
 362     },
 363     {
 364       "name" : "getKey",
 365       "type" : "function",
 366       "desc" : "Returns a normalized keyCode for the event.",
 367       "sig" : "()\n{\n\n}",
 368       "static" : false,
 369       "memberOf" : "",
 370       "isStatic" : false,
 371       "isConstructor" : false,
 372       "isPrivate" : false,
 373       "example" : "",
 374       "deprecated" : "",
 375       "since" : "",
 376       "see" : "",
 377       "exceptions" : "",
 378       "requires" : "",
 379       "params" : [],
 380       "returns" : [
 381         {
 382           "name" : "",
 383           "type" : "Number",
 384           "desc" : "The key code"
 385         }
 386       ]
 387     }
 388   ],
 389   "events" : []
 390 }