X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.dd.DD.html;fp=docs%2Fsymbols%2FRoo.dd.DD.html;h=afadad3629bceae97d17455f221958f11a42c752;hb=3809347c8003225f3d55f11104b3aff8191b1f32;hp=0cbcff0869b2bf88640fef0d94f73decc2fd0fab;hpb=7898cefff4301c31417a6027f5f0f024f8e5d5f7;p=roojs1 diff --git a/docs/symbols/Roo.dd.DD.html b/docs/symbols/Roo.dd.DD.html index 0cbcff0869..afadad3629 100644 --- a/docs/symbols/Roo.dd.DD.html +++ b/docs/symbols/Roo.dd.DD.html @@ -43,8 +43,9 @@
- 
Roo.dd.DragDrop
-Roo.dd.DD 
+		   
Roo.util.Observable
+Roo.dd.DragDrop
+Roo.dd.DD
@@ -114,14 +115,55 @@ + - - -
Config Options - Has None
- + + + - - + + + + + + + + + + + + + + + + + + +
Config Options (Usually are also Properties)
OptionsDefined By
+ @@ -253,6 +295,68 @@   + + +
+ addEvents + + (Object object) + + + +
+
+ +
Used to define events on this Observable
+ + + +
+ + Used to define events on this Observable + + + + + + +
+
Parameters:
+ +
+ Object object + +
+
The object with the events defined
+ +
+ + + + + + + + + + + +
+
+ + + + + Roo.util.Observable +   + + + + + +   + +
@@ -311,7 +415,7 @@ - +   @@ -373,7 +477,7 @@ - +   @@ -435,6 +539,86 @@ + +   + + + + +
+ addListener + + (String eventName, Function handler, Object scope, Object options) + + + +
+
+ +
Appends an event handler to this component
+ + + +
+ + Appends an event handler to this component + + + + + + +
+
Parameters:
+ +
+ String eventName + +
+
The type of event to listen for
+ +
+ Function handler + +
+
The method the event invokes
+ +
+ Object scope + +
+
(optional) The scope in which to execute the handler
function. The handler function's "this" context.
+ +
+ Object options + +
+
(optional) An object containing handler configuration
properties. This may contain any of the following properties:

  • scope {Object} The scope in which to execute the handler function. The handler function's "this" context.

  • delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.

  • single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.

  • buffer {Number} Causes the handler to be scheduled to run in an {link Roo.util.DelayedTask} delayed
    by the specified number of milliseconds. If the event fires again within that time, the original
    handler is not invoked, but the new handler is scheduled in its place.




Combining Options

Using the options argument, it is possible to combine different types of listeners:



A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)


		el.on('click', this.onClick, this, {
 			single: true,
    		delay: 100,
    		forumId: 4
		});


Attaching multiple handlers in 1 call

The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.


		el.on({
			'click': {
        		fn: this.onClick,
        		scope: this,
        		delay: 100
    		}, 
    		'mouseover': {
        		fn: this.onMouseOver,
        		scope: this
    		},
    		'mouseout': {
        		fn: this.onMouseOut,
        		scope: this
    		}
		});


Or a shorthand syntax which passes the same scope object to all handlers:


		el.on({
			'click': this.onClick,
    		'mouseover': this.onMouseOver,
    		'mouseout': this.onMouseOut,
    		scope: this
		});
+ +
+ + + + + + + + + + + +
+
+ + + + + Roo.util.Observable +   + + + +   @@ -926,6 +1110,89 @@   + + +
+ fireEvent + + (String eventName, Object... args) + + + : + + + Boolean + + + + + +
+
+ +
Fires the specified event with the passed parameters (minus the event name).
+ + + +
+ + Fires the specified event with the passed parameters (minus the event name). + + + + + + +
+
Parameters:
+ +
+ String eventName + +
+
+ +
+ Object... args + +
+
Variable number of parameters are passed to handlers
+ +
+ + + + + +
+
Returns:
+ +
Boolean returns false if any of the handlers return false otherwise it returns true
+ +
+ + + + + + + +
+
+ + + + + Roo.util.Observable +   + + + + + +   + + +   @@ -1060,7 +1327,7 @@ - +   @@ -1126,6 +1393,83 @@ + +   + + + + +
+ hasListener + + (String eventName) + + + : + + + Boolean + + + + + +
+
+ +
Checks to see if this object has any listeners for a specified event
+ + + +
+ + Checks to see if this object has any listeners for a specified event + + + + + + +
+
Parameters:
+ +
+ String eventName + +
+
The name of the event to check for
+ +
+ + + + + +
+
Returns:
+ +
Boolean True if the event is being listened for, else false
+ +
+ + + + + + + +
+
+ + + + + Roo.util.Observable +   + + + +   @@ -1428,27 +1772,78 @@ -
-
Parameters:
- -
- HTMLElement node - -
-
the HTMLElement to evaluate
- -
+
+
Parameters:
+ +
+ HTMLElement node + +
+
the HTMLElement to evaluate
+ +
+ + + + + +
+
Returns:
+ +
boolean true if this is a valid tag type, false if not
+ +
+ + + + + + + +
+ + + + + + Roo.dd.DragDrop +   + + + + + +   + + + + +
+ lock + + () + + + +
+
+ +
Lock this instance
+ + + +
+ + Lock this instance + + + + -
-
Returns:
- -
boolean true if this is a valid tag type, false if not
- -
@@ -1468,35 +1863,64 @@ - +   - +
- lock + on - () + (String eventName, Function handler, Object scope, Object options)
-
Lock this instance
+
Appends an event handler to this element (shorthand for addListener)
- Lock this instance + Appends an event handler to this element (shorthand for addListener) +
+
Parameters:
+ +
+ String eventName + +
+
The type of event to listen for
+ +
+ Function handler + +
+
The method the event invokes
+ +
+ Object scope + +
+
(optional) The scope in which to execute the handler
function. The handler function's "this" context.
+ +
+ Object options + +
+
(optional)
+ +
+ @@ -1513,13 +1937,13 @@ - Roo.dd.DragDrop + Roo.util.Observable   - +   @@ -1570,7 +1994,7 @@ - +   @@ -1632,7 +2056,7 @@ - +   @@ -1700,7 +2124,7 @@ - +   @@ -1768,7 +2192,7 @@ - +   @@ -1836,7 +2260,7 @@ - +   @@ -1904,7 +2328,7 @@ - +   @@ -1966,7 +2390,7 @@ - +   @@ -2028,7 +2452,7 @@ - +   @@ -2090,7 +2514,7 @@ - +   @@ -2141,6 +2565,57 @@ + +   + + + + +
+ purgeListeners + + () + + + +
+
+ +
Removes all listeners for this object
+ + + +
+ + Removes all listeners for this object + + + + + + + + + + + + + + + + +
+
+ + + + + Roo.util.Observable +   + + + +   @@ -2393,6 +2868,80 @@   + + +
+ removeListener + + (String eventName, Function handler, Object scope) + + + +
+
+ +
Removes a listener
+ + + +
+ + Removes a listener + + + + + + +
+
Parameters:
+ +
+ String eventName + +
+
The type of event to listen for
+ +
+ Function handler + +
+
The handler to remove
+ +
+ Object scope + +
+
(optional) The scope (this object) for the handler
+ +
+ + + + + + + + + + + +
+
+ + + + + Roo.util.Observable +   + + + + + +   + +
@@ -2451,7 +3000,7 @@ - +   @@ -2519,7 +3068,7 @@ - +   @@ -2581,7 +3130,7 @@ - +   @@ -2649,7 +3198,7 @@ - +   @@ -2711,7 +3260,7 @@ - +   @@ -2779,7 +3328,7 @@ - +   @@ -2841,7 +3390,7 @@ - +   @@ -2921,7 +3470,7 @@ - +   @@ -2995,7 +3544,7 @@ - +   @@ -3069,7 +3618,7 @@ - +   @@ -3137,6 +3686,80 @@ + +   + + + + +
+ un + + (String eventName, Function handler, Object scope) + + + +
+
+ +
Removes a listener (shorthand for removeListener)
+ + + +
+ + Removes a listener (shorthand for removeListener) + + + + + + +
+
Parameters:
+ +
+ String eventName + +
+
The type of event to listen for
+ +
+ Function handler + +
+
The handler to remove
+ +
+ Object scope + +
+
(optional) The scope (this object) for the handler
+ +
+ + + + + + + + + + + +
+
+ + + + + Roo.util.Observable +   + + + +   @@ -3266,7 +3889,7 @@
- Documentation generated by Introspection Doc Generator on Fri Jan 14 2011 17:01:50 GMT+0800 (HKT) + Documentation generated by Introspection Doc Generator on Thu Feb 10 2011 17:59:23 GMT+0800 (HKT) Based on JsDoc Toolkit