Class Ext.EventManager

Package:	Ext
Defined In:	EventManager.js
Class:	EventManager
Extends:	Object

Registers event handlers that want to receive a normalized EventObject instead of the standard browser event and provides several useful events directly. See Ext.EventObject for more details on normalized event objects.

This class is a singleton and cannot be created directly.

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	addListener( `String/HTMLElement el`, `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to an element. The shorthand version on is equivalent. Typically you will use Ext.Element.... Appends an event handler to an element. The shorthand version on is equivalent. Typically you will use Ext.Element.addListener directly on an Element in favor of calling this version. Parameters: `el` : String/HTMLElement The html element or id to assign the event handler to. `eventName` : String The name of the event to listen for. `handler` : Function The handler function the event invokes. This function is passed the following parameters: evt : EventObject The EventObject describing the event. t : Element The Element which was the target of the event. Note that this may be filtered by using the `delegate` option. o : Object The options object from the addListener call. `scope` : Object (optional) The scope (`this` reference) in which the handler function is executed. Defaults to the Element. `options` : Object (optional) An object containing handler configuration properties. This may contain any of the following properties: scope : Object The scope (`this` reference) in which the handler function is executed. Defaults to the Element. delegate : String A simple selector to filter the target or look for a descendant of the target stopEvent : Boolean True to stop the event. That is stop propagation, and prevent the default action. preventDefault : Boolean True to prevent the default action stopPropagation : Boolean True to prevent event propagation normalized : Boolean False to pass a browser event to the handler function instead of an Ext.EventObject 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 Ext.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. target : Element Only call the handler if the event was fired on the target Element, not if the event was bubbled up from a child node. See Ext.Element.addListener for examples of how to use these options. Returns: void	EventManager
	getPageX() : Number Gets the x coordinate of the event. Gets the x coordinate of the event. Parameters: None. Returns: `Number`	EventManager
	getPageY() : Number Gets the y coordinate of the event. Gets the y coordinate of the event. Parameters: None. Returns: `Number`	EventManager
	getTarget( [`String selector`], [`Number/Mixed maxDepth`], [`Boolean returnEl`] ) : HTMLelement Gets the target for the event. Gets the target for the event. Parameters: `selector` : String (optional) A simple selector to filter the target or look for an ancestor of the target `maxDepth` : Number/Mixed (optional) The max depth to search as a number or element (defaults to 10 \|\| document.body) `returnEl` : Boolean (optional) True to return a Ext.Element object instead of DOM node Returns: `HTMLelement`	EventManager
	getXY() : Array Gets the page coordinates of the event. Gets the page coordinates of the event. Parameters: None. Returns: `Array` The xy values like [x, y]	EventManager
	on( `String/HTMLElement el`, `String eventName`, `Function handler`, [`Object scope`], [`Object options`] ) : void Appends an event handler to an element. Shorthand for addListener. Appends an event handler to an element. Shorthand for addListener. Parameters: `el` : String/HTMLElement The html element or id to assign the event handler to `eventName` : String The name of the event to listen for. `handler` : Function The handler function the event invokes. `scope` : Object (optional) (`this` reference) in which the handler function executes. Defaults to the Element. `options` : Object (optional) An object containing standard addListener options Returns: void	EventManager
	onDocumentReady( `Function fn`, [`Object scope`], [`boolean options`] ) : void Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be access... Adds a listener to be notified when the document is ready (before onload and before images are loaded). Can be accessed shorthanded as Ext.onReady(). Parameters: `fn` : Function The method the event invokes. `scope` : Object (optional) The scope (`this` reference) in which the handler function executes. Defaults to the browser window. `options` : boolean (optional) Options object as passed to Ext.Element.addListener. It is recommended that the options `{single: true}` be used so that the handler is removed on first invocation. Returns: void	EventManager
	onWindowResize( `Function fn`, `Object scope`, `boolean options` ) : void Adds a listener to be notified when the browser window is resized and provides resize event buffering (50 millisecond... Adds a listener to be notified when the browser window is resized and provides resize event buffering (50 milliseconds), passes new viewport width and height to handlers. Parameters: `fn` : Function The handler function the window resize event invokes. `scope` : Object The scope (`this` reference) in which the handler function executes. Defaults to the browser window. `options` : boolean Options object as passed to Ext.Element.addListener Returns: void	EventManager
	preventDefault() : void Prevents the browsers default handling of the event. Prevents the browsers default handling of the event. Parameters: None. Returns: void	EventManager
	removeAll( `String/HTMLElement el` ) : void Removes all event handers from an element. Typically you will use Ext.Element.removeAllListeners directly on an Elem... Removes all event handers from an element. Typically you will use Ext.Element.removeAllListeners directly on an Element in favor of calling this version. Parameters: `el` : String/HTMLElement The id or html element from which to remove all event handlers. Returns: void	EventManager
	removeListener( `String/HTMLElement el`, `String eventName`, `Function fn`, `Object scope` ) : void Removes an event handler from an element. The shorthand version un is equivalent. Typically you will use Ext.Elemen... Removes an event handler from an element. The shorthand version un is equivalent. Typically you will use Ext.Element.removeListener directly on an Element in favor of calling this version. Parameters: `el` : String/HTMLElement The id or html element from which to remove the listener. `eventName` : String The name of the event. `fn` : Function The handler function to remove. This must be a reference to the function passed into the addListener call. `scope` : Object If a scope (`this` reference) was specified when the listener was added, then this must refer to the same object. Returns: void	EventManager
	stopEvent() : void Stop the event (preventDefault and stopPropagation) Stop the event (preventDefault and stopPropagation) Parameters: None. Returns: void	EventManager
	stopPropagation() : void Cancels bubbling of the event. Cancels bubbling of the event. Parameters: None. Returns: void	EventManager
	un( `String/HTMLElement el`, `String eventName`, `Function fn`, `Object scope` ) : void Removes an event handler from an element. Shorthand for removeListener. Removes an event handler from an element. Shorthand for removeListener. Parameters: `el` : String/HTMLElement The id or html element from which to remove the listener. `eventName` : String The name of the event. `fn` : Function The handler function to remove. This must be a reference to the function passed into the on call. `scope` : Object If a scope (`this` reference) was specified when the listener was added, then this must refer to the same object. Returns: void	EventManager

Public Events

This class has no public events.