2 "name" : "Roo.util.Observable",
4 "desc" : "Base class that provides a common interface for publishing events. Subclasses are expected to\nto have a property \"events\" with all the events defined.<br>\nFor example:\n<pre><code>\n Employee = function(name){\n this.name = name;\n this.addEvents({\n \"fired\" : true,\n \"quit\" : true\n });\n }\n Roo.extend(Employee, Roo.util.Observable);\n</code></pre>",
8 "memberOf" : "Observable",
17 "desc" : "properties to use (incuding events / listeners)",
26 "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>",
27 "memberOf" : "Roo.util.Observable",
33 "name" : "purgeListeners",
34 "desc" : "Removes all listeners for this object",
36 "isConstructor" : false,
38 "memberOf" : "Roo.util.Observable",
48 "desc" : "Appends an event handler to this element (shorthand for addListener)",
50 "isConstructor" : false,
52 "memberOf" : "Roo.util.Observable",
61 "desc" : "The type of event to listen for",
67 "desc" : "The method the event invokes",
73 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
79 "desc" : "(optional)",
87 "desc" : "Removes a listener (shorthand for removeListener)",
89 "isConstructor" : false,
91 "memberOf" : "Roo.util.Observable",
100 "desc" : "The type of event to listen for",
106 "desc" : "The handler to remove",
112 "desc" : "(optional) The scope (this object) for the handler",
119 "name" : "addEvents",
120 "desc" : "Used to define events on this Observable",
122 "isConstructor" : false,
124 "memberOf" : "Roo.util.Observable",
133 "desc" : "The object with the events defined",
140 "name" : "releaseCapture",
141 "desc" : "Removes <b>all</b> added captures from the Observable.",
143 "isConstructor" : false,
145 "memberOf" : "Roo.util.Observable",
153 "type" : "Observable",
154 "desc" : "The Observable to release",
161 "name" : "removeListener",
162 "desc" : "Removes a listener",
164 "isConstructor" : false,
166 "memberOf" : "Roo.util.Observable",
173 "name" : "eventName",
175 "desc" : "The type of event to listen for",
181 "desc" : "The handler to remove",
187 "desc" : "(optional) The scope (this object) for the handler",
194 "name" : "fireEvent",
195 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
197 "isConstructor" : false,
199 "memberOf" : "Roo.util.Observable",
206 "name" : "eventName",
213 "type" : "Object...",
214 "desc" : "Variable number of parameters are passed to handlers",
222 "desc" : "returns false if any of the handlers return false otherwise it returns true"
227 "name" : "hasListener",
228 "desc" : "Checks to see if this object has any listeners for a specified event",
230 "isConstructor" : false,
232 "memberOf" : "Roo.util.Observable",
239 "name" : "eventName",
241 "desc" : "The name of the event to check for",
249 "desc" : "True if the event is being listened for, else false"
255 "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.",
257 "isConstructor" : false,
259 "memberOf" : "Roo.util.Observable",
267 "type" : "Observable",
268 "desc" : "The Observable to capture",
274 "desc" : "The function to call",
280 "desc" : "(optional) The scope (this object) for the fn",
287 "name" : "addListener",
288 "desc" : "Appends an event handler to this component",
290 "isConstructor" : false,
292 "memberOf" : "Roo.util.Observable",
299 "name" : "eventName",
301 "desc" : "The type of event to listen for",
307 "desc" : "The method the event invokes",
313 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
319 "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>",