2 "name" : "Roo.Document",
9 "desc" : "This is a convience class to wrap up the main document loading code.. , rather than adding Roo.onReady(......)",
10 "isSingleton" : false,
14 "isBuilderTop" : false,
15 "memberOf" : "Document",
24 "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 }",
35 "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>",
36 "memberOf" : "Roo.util.Observable",
43 "name" : "purgeListeners",
45 "desc" : "Removes all listeners for this object",
48 "memberOf" : "Roo.util.Observable",
50 "isConstructor" : false,
64 "desc" : "Appends an event handler to this element (shorthand for addListener)",
65 "sig" : "(eventName, handler, scope, options)",
67 "memberOf" : "Roo.util.Observable",
69 "isConstructor" : false,
81 "desc" : "The type of event to listen for",
87 "desc" : "The method the event invokes",
93 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
99 "desc" : "(optional)",
108 "desc" : "Removes a listener (shorthand for removeListener)",
109 "sig" : "(eventName, handler, scope)",
111 "memberOf" : "Roo.util.Observable",
113 "isConstructor" : false,
123 "name" : "eventName",
125 "desc" : "The type of event to listen for",
131 "desc" : "The handler to remove",
137 "desc" : "(optional) The scope (this object) for the handler",
144 "name" : "addEvents",
146 "desc" : "Used to define events on this Observable",
149 "memberOf" : "Roo.util.Observable",
151 "isConstructor" : false,
163 "desc" : "The object with the events defined",
170 "name" : "releaseCapture",
172 "desc" : "Removes <b>all</b> added captures from the Observable.",
175 "memberOf" : "Roo.util.Observable",
177 "isConstructor" : false,
188 "type" : "Observable",
189 "desc" : "The Observable to release",
196 "name" : "removeListener",
198 "desc" : "Removes a listener",
199 "sig" : "(eventName, handler, scope)",
201 "memberOf" : "Roo.util.Observable",
203 "isConstructor" : false,
213 "name" : "eventName",
215 "desc" : "The type of event to listen for",
221 "desc" : "The handler to remove",
227 "desc" : "(optional) The scope (this object) for the handler",
234 "name" : "fireEvent",
236 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
237 "sig" : "(eventName, args)",
239 "memberOf" : "Roo.util.Observable",
241 "isConstructor" : false,
251 "name" : "eventName",
258 "type" : "Object...",
259 "desc" : "Variable number of parameters are passed to handlers",
267 "desc" : "returns false if any of the handlers return false otherwise it returns true"
272 "name" : "hasListener",
274 "desc" : "Checks to see if this object has any listeners for a specified event",
275 "sig" : "(eventName)",
277 "memberOf" : "Roo.util.Observable",
279 "isConstructor" : false,
289 "name" : "eventName",
291 "desc" : "The name of the event to check for",
299 "desc" : "True if the event is being listened for, else false"
306 "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.",
307 "sig" : "(o, fn, scope)",
309 "memberOf" : "Roo.util.Observable",
311 "isConstructor" : false,
322 "type" : "Observable",
323 "desc" : "The Observable to capture",
329 "desc" : "The function to call",
335 "desc" : "(optional) The scope (this object) for the fn",
342 "name" : "addListener",
344 "desc" : "Appends an event handler to this component",
345 "sig" : "(eventName, handler, scope, options)",
347 "memberOf" : "Roo.util.Observable",
349 "isConstructor" : false,
359 "name" : "eventName",
361 "desc" : "The type of event to listen for",
367 "desc" : "The method the event invokes",
373 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
379 "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>",