git.roojs.org Git - roojs1/blob - docs/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" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "Document",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "config",
  18       "type" : "Object",
  19       "desc" : "the methods and properties of the 'base' class for the application.\n\n Generic Page handler - implement this to start your app..\n\neg.\n MyProject = new Roo.Document({\n        events : {\n            'load' : true // your events..\n        },\n        listeners : {\n            'ready' : function() {\n                // fired on Roo.onReady()\n            }\n        }",
  20       "isOptional" : false
  21     }
  22   ],
  23   "returns" : [
  24   ],
  25   "config" : [
  26     {
  27       "name" : "listeners",
  28       "type" : "Object",
  29       "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>",
  30       "memberOf" : "Roo.util.Observable",
  31       "optvals" : [
  32       ]
  33     }
  34   ],
  35   "methods" : [
  36     {
  37       "name" : "purgeListeners",
  38       "desc" : "Removes all listeners for this object",
  39       "isStatic" : false,
  40       "isConstructor" : false,
  41       "isPrivate" : false,
  42       "memberOf" : "Roo.util.Observable",
  43       "example" : "",
  44       "deprecated" : "",
  45       "since" : "",
  46       "see" : "",
  47       "params" : [
  48       ],
  49       "returns" : [
  50       ]
  51     },
  52     {
  53       "name" : "on",
  54       "desc" : "Appends an event handler to this element (shorthand for addListener)",
  55       "isStatic" : false,
  56       "isConstructor" : false,
  57       "isPrivate" : false,
  58       "memberOf" : "Roo.util.Observable",
  59       "example" : "",
  60       "deprecated" : "",
  61       "since" : "",
  62       "see" : "",
  63       "params" : [
  64         {
  65           "name" : "eventName",
  66           "type" : "String",
  67           "desc" : "The type of event to listen for",
  68           "isOptional" : false
  69         },
  70         {
  71           "name" : "handler",
  72           "type" : "Function",
  73           "desc" : "The method the event invokes",
  74           "isOptional" : false
  75         },
  76         {
  77           "name" : "scope",
  78           "type" : "Object",
  79           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
  80           "isOptional" : false
  81         },
  82         {
  83           "name" : "options",
  84           "type" : "Object",
  85           "desc" : "(optional)",
  86           "isOptional" : false
  87         }
  88       ],
  89       "returns" : [
  90       ]
  91     },
  92     {
  93       "name" : "un",
  94       "desc" : "Removes a listener (shorthand for removeListener)",
  95       "isStatic" : false,
  96       "isConstructor" : false,
  97       "isPrivate" : false,
  98       "memberOf" : "Roo.util.Observable",
  99       "example" : "",
 100       "deprecated" : "",
 101       "since" : "",
 102       "see" : "",
 103       "params" : [
 104         {
 105           "name" : "eventName",
 106           "type" : "String",
 107           "desc" : "The type of event to listen for",
 108           "isOptional" : false
 109         },
 110         {
 111           "name" : "handler",
 112           "type" : "Function",
 113           "desc" : "The handler to remove",
 114           "isOptional" : false
 115         },
 116         {
 117           "name" : "scope",
 118           "type" : "Object",
 119           "desc" : "(optional) The scope (this object) for the handler",
 120           "isOptional" : false
 121         }
 122       ],
 123       "returns" : [
 124       ]
 125     },
 126     {
 127       "name" : "addEvents",
 128       "desc" : "Used to define events on this Observable",
 129       "isStatic" : false,
 130       "isConstructor" : false,
 131       "isPrivate" : false,
 132       "memberOf" : "Roo.util.Observable",
 133       "example" : "",
 134       "deprecated" : "",
 135       "since" : "",
 136       "see" : "",
 137       "params" : [
 138         {
 139           "name" : "object",
 140           "type" : "Object",
 141           "desc" : "The object with the events defined",
 142           "isOptional" : false
 143         }
 144       ],
 145       "returns" : [
 146       ]
 147     },
 148     {
 149       "name" : "releaseCapture",
 150       "desc" : "Removes <b>all</b> added captures from the Observable.",
 151       "isStatic" : true,
 152       "isConstructor" : false,
 153       "isPrivate" : false,
 154       "memberOf" : "Roo.util.Observable",
 155       "example" : "",
 156       "deprecated" : "",
 157       "since" : "",
 158       "see" : "",
 159       "params" : [
 160         {
 161           "name" : "o",
 162           "type" : "Observable",
 163           "desc" : "The Observable to release",
 164           "isOptional" : false
 165         }
 166       ],
 167       "returns" : [
 168       ]
 169     },
 170     {
 171       "name" : "removeListener",
 172       "desc" : "Removes a listener",
 173       "isStatic" : false,
 174       "isConstructor" : false,
 175       "isPrivate" : false,
 176       "memberOf" : "Roo.util.Observable",
 177       "example" : "",
 178       "deprecated" : "",
 179       "since" : "",
 180       "see" : "",
 181       "params" : [
 182         {
 183           "name" : "eventName",
 184           "type" : "String",
 185           "desc" : "The type of event to listen for",
 186           "isOptional" : false
 187         },
 188         {
 189           "name" : "handler",
 190           "type" : "Function",
 191           "desc" : "The handler to remove",
 192           "isOptional" : false
 193         },
 194         {
 195           "name" : "scope",
 196           "type" : "Object",
 197           "desc" : "(optional) The scope (this object) for the handler",
 198           "isOptional" : false
 199         }
 200       ],
 201       "returns" : [
 202       ]
 203     },
 204     {
 205       "name" : "fireEvent",
 206       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 207       "isStatic" : false,
 208       "isConstructor" : false,
 209       "isPrivate" : false,
 210       "memberOf" : "Roo.util.Observable",
 211       "example" : "",
 212       "deprecated" : "",
 213       "since" : "",
 214       "see" : "",
 215       "params" : [
 216         {
 217           "name" : "eventName",
 218           "type" : "String",
 219           "desc" : "",
 220           "isOptional" : false
 221         },
 222         {
 223           "name" : "args",
 224           "type" : "Object...",
 225           "desc" : "Variable number of parameters are passed to handlers",
 226           "isOptional" : false
 227         }
 228       ],
 229       "returns" : [
 230         {
 231           "name" : "",
 232           "type" : "Boolean",
 233           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 234         }
 235       ]
 236     },
 237     {
 238       "name" : "hasListener",
 239       "desc" : "Checks to see if this object has any listeners for a specified event",
 240       "isStatic" : false,
 241       "isConstructor" : false,
 242       "isPrivate" : false,
 243       "memberOf" : "Roo.util.Observable",
 244       "example" : "",
 245       "deprecated" : "",
 246       "since" : "",
 247       "see" : "",
 248       "params" : [
 249         {
 250           "name" : "eventName",
 251           "type" : "String",
 252           "desc" : "The name of the event to check for",
 253           "isOptional" : false
 254         }
 255       ],
 256       "returns" : [
 257         {
 258           "name" : "",
 259           "type" : "Boolean",
 260           "desc" : "True if the event is being listened for, else false"
 261         }
 262       ]
 263     },
 264     {
 265       "name" : "capture",
 266       "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.",
 267       "isStatic" : true,
 268       "isConstructor" : false,
 269       "isPrivate" : false,
 270       "memberOf" : "Roo.util.Observable",
 271       "example" : "",
 272       "deprecated" : "",
 273       "since" : "",
 274       "see" : "",
 275       "params" : [
 276         {
 277           "name" : "o",
 278           "type" : "Observable",
 279           "desc" : "The Observable to capture",
 280           "isOptional" : false
 281         },
 282         {
 283           "name" : "fn",
 284           "type" : "Function",
 285           "desc" : "The function to call",
 286           "isOptional" : false
 287         },
 288         {
 289           "name" : "scope",
 290           "type" : "Object",
 291           "desc" : "(optional) The scope (this object) for the fn",
 292           "isOptional" : false
 293         }
 294       ],
 295       "returns" : [
 296       ]
 297     },
 298     {
 299       "name" : "addListener",
 300       "desc" : "Appends an event handler to this component",
 301       "isStatic" : false,
 302       "isConstructor" : false,
 303       "isPrivate" : false,
 304       "memberOf" : "Roo.util.Observable",
 305       "example" : "",
 306       "deprecated" : "",
 307       "since" : "",
 308       "see" : "",
 309       "params" : [
 310         {
 311           "name" : "eventName",
 312           "type" : "String",
 313           "desc" : "The type of event to listen for",
 314           "isOptional" : false
 315         },
 316         {
 317           "name" : "handler",
 318           "type" : "Function",
 319           "desc" : "The method the event invokes",
 320           "isOptional" : false
 321         },
 322         {
 323           "name" : "scope",
 324           "type" : "Object",
 325           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 326           "isOptional" : false
 327         },
 328         {
 329           "name" : "options",
 330           "type" : "Object",
 331           "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>",
 332           "isOptional" : false
 333         }
 334       ],
 335       "returns" : [
 336       ]
 337     }
 338   ],
 339   "events" : [
 340   ]
 341 }