git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.Document.json

   1 {
   2   "name" : "Roo.Document",
   3   "augments" : [
   4     "Roo.util.Observable"
   5   ],
   6   "desc" : "This is a convience class to wrap up the main document loading code.. , rather than adding Roo.onReady(......)",
   7   "isSingleton" : false,
   8   "isStatic" : true,
   9   "isBuiltin" : false,
  10   "config" : [
  11     {
  12       "name" : "listeners",
  13       "type" : "Object",
  14       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  15       "memberOf" : "Roo.util.Observable",
  16       "values" : [
  17       ]
  18     }
  19   ],
  20   "methods" : [
  21     {
  22       "name" : "purgeListeners",
  23       "desc" : "Removes all listeners for this object",
  24       "isStatic" : false,
  25       "isConstructor" : false,
  26       "isPrivate" : false,
  27       "memberOf" : "Roo.util.Observable",
  28       "example" : "",
  29       "deprecated" : "",
  30       "since" : "",
  31       "see" : "",
  32       "params" : [
  33       ],
  34       "returns" : [
  35       ]
  36     },
  37     {
  38       "name" : "on",
  39       "desc" : "Appends an event handler to this element (shorthand for addListener)",
  40       "isStatic" : false,
  41       "isConstructor" : false,
  42       "isPrivate" : false,
  43       "memberOf" : "Roo.util.Observable",
  44       "example" : "",
  45       "deprecated" : "",
  46       "since" : "",
  47       "see" : "",
  48       "params" : [
  49         {
  50           "name" : "eventName",
  51           "type" : "String",
  52           "desc" : "The type of event to listen for",
  53           "isOptional" : false
  54         },
  55         {
  56           "name" : "handler",
  57           "type" : "Function",
  58           "desc" : "The method the event invokes",
  59           "isOptional" : false
  60         },
  61         {
  62           "name" : "scope",
  63           "type" : "Object",
  64           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
  65           "isOptional" : false
  66         },
  67         {
  68           "name" : "options",
  69           "type" : "Object",
  70           "desc" : "(optional)",
  71           "isOptional" : false
  72         }
  73       ],
  74       "returns" : [
  75       ]
  76     },
  77     {
  78       "name" : "un",
  79       "desc" : "Removes a listener (shorthand for removeListener)",
  80       "isStatic" : false,
  81       "isConstructor" : false,
  82       "isPrivate" : false,
  83       "memberOf" : "Roo.util.Observable",
  84       "example" : "",
  85       "deprecated" : "",
  86       "since" : "",
  87       "see" : "",
  88       "params" : [
  89         {
  90           "name" : "eventName",
  91           "type" : "String",
  92           "desc" : "The type of event to listen for",
  93           "isOptional" : false
  94         },
  95         {
  96           "name" : "handler",
  97           "type" : "Function",
  98           "desc" : "The handler to remove",
  99           "isOptional" : false
 100         },
 101         {
 102           "name" : "scope",
 103           "type" : "Object",
 104           "desc" : "(optional) The scope (this object) for the handler",
 105           "isOptional" : false
 106         }
 107       ],
 108       "returns" : [
 109       ]
 110     },
 111     {
 112       "name" : "addEvents",
 113       "desc" : "Used to define events on this Observable",
 114       "isStatic" : false,
 115       "isConstructor" : false,
 116       "isPrivate" : false,
 117       "memberOf" : "Roo.util.Observable",
 118       "example" : "",
 119       "deprecated" : "",
 120       "since" : "",
 121       "see" : "",
 122       "params" : [
 123         {
 124           "name" : "object",
 125           "type" : "Object",
 126           "desc" : "The object with the events defined",
 127           "isOptional" : false
 128         }
 129       ],
 130       "returns" : [
 131       ]
 132     },
 133     {
 134       "name" : "releaseCapture",
 135       "desc" : "Removes <b>all</b> added captures from the Observable.",
 136       "isStatic" : true,
 137       "isConstructor" : false,
 138       "isPrivate" : false,
 139       "memberOf" : "Roo.util.Observable",
 140       "example" : "",
 141       "deprecated" : "",
 142       "since" : "",
 143       "see" : "",
 144       "params" : [
 145         {
 146           "name" : "o",
 147           "type" : "Observable",
 148           "desc" : "The Observable to release",
 149           "isOptional" : false
 150         }
 151       ],
 152       "returns" : [
 153       ]
 154     },
 155     {
 156       "name" : "removeListener",
 157       "desc" : "Removes a listener",
 158       "isStatic" : false,
 159       "isConstructor" : false,
 160       "isPrivate" : false,
 161       "memberOf" : "Roo.util.Observable",
 162       "example" : "",
 163       "deprecated" : "",
 164       "since" : "",
 165       "see" : "",
 166       "params" : [
 167         {
 168           "name" : "eventName",
 169           "type" : "String",
 170           "desc" : "The type of event to listen for",
 171           "isOptional" : false
 172         },
 173         {
 174           "name" : "handler",
 175           "type" : "Function",
 176           "desc" : "The handler to remove",
 177           "isOptional" : false
 178         },
 179         {
 180           "name" : "scope",
 181           "type" : "Object",
 182           "desc" : "(optional) The scope (this object) for the handler",
 183           "isOptional" : false
 184         }
 185       ],
 186       "returns" : [
 187       ]
 188     },
 189     {
 190       "name" : "fireEvent",
 191       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 192       "isStatic" : false,
 193       "isConstructor" : false,
 194       "isPrivate" : false,
 195       "memberOf" : "Roo.util.Observable",
 196       "example" : "",
 197       "deprecated" : "",
 198       "since" : "",
 199       "see" : "",
 200       "params" : [
 201         {
 202           "name" : "eventName",
 203           "type" : "String",
 204           "desc" : "",
 205           "isOptional" : false
 206         },
 207         {
 208           "name" : "args",
 209           "type" : "Object...",
 210           "desc" : "Variable number of parameters are passed to handlers",
 211           "isOptional" : false
 212         }
 213       ],
 214       "returns" : [
 215         {
 216           "name" : "",
 217           "type" : "Boolean",
 218           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 219         }
 220       ]
 221     },
 222     {
 223       "name" : "hasListener",
 224       "desc" : "Checks to see if this object has any listeners for a specified event",
 225       "isStatic" : false,
 226       "isConstructor" : false,
 227       "isPrivate" : false,
 228       "memberOf" : "Roo.util.Observable",
 229       "example" : "",
 230       "deprecated" : "",
 231       "since" : "",
 232       "see" : "",
 233       "params" : [
 234         {
 235           "name" : "eventName",
 236           "type" : "String",
 237           "desc" : "The name of the event to check for",
 238           "isOptional" : false
 239         }
 240       ],
 241       "returns" : [
 242         {
 243           "name" : "",
 244           "type" : "Boolean",
 245           "desc" : "True if the event is being listened for, else false"
 246         }
 247       ]
 248     },
 249     {
 250       "name" : "capture",
 251       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
 252       "isStatic" : true,
 253       "isConstructor" : false,
 254       "isPrivate" : false,
 255       "memberOf" : "Roo.util.Observable",
 256       "example" : "",
 257       "deprecated" : "",
 258       "since" : "",
 259       "see" : "",
 260       "params" : [
 261         {
 262           "name" : "o",
 263           "type" : "Observable",
 264           "desc" : "The Observable to capture",
 265           "isOptional" : false
 266         },
 267         {
 268           "name" : "fn",
 269           "type" : "Function",
 270           "desc" : "The function to call",
 271           "isOptional" : false
 272         },
 273         {
 274           "name" : "scope",
 275           "type" : "Object",
 276           "desc" : "(optional) The scope (this object) for the fn",
 277           "isOptional" : false
 278         }
 279       ],
 280       "returns" : [
 281       ]
 282     },
 283     {
 284       "name" : "addListener",
 285       "desc" : "Appends an event handler to this component",
 286       "isStatic" : false,
 287       "isConstructor" : false,
 288       "isPrivate" : false,
 289       "memberOf" : "Roo.util.Observable",
 290       "example" : "",
 291       "deprecated" : "",
 292       "since" : "",
 293       "see" : "",
 294       "params" : [
 295         {
 296           "name" : "eventName",
 297           "type" : "String",
 298           "desc" : "The type of event to listen for",
 299           "isOptional" : false
 300         },
 301         {
 302           "name" : "handler",
 303           "type" : "Function",
 304           "desc" : "The method the event invokes",
 305           "isOptional" : false
 306         },
 307         {
 308           "name" : "scope",
 309           "type" : "Object",
 310           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 311           "isOptional" : false
 312         },
 313         {
 314           "name" : "options",
 315           "type" : "Object",
 316           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
 317           "isOptional" : false
 318         }
 319       ],
 320       "returns" : [
 321       ]
 322     }
 323   ],
 324   "events" : [
 325   ]
 326 }