Class CQ.Ext.EventManager

Package:	CQ.Ext
Class:	EventManager
Extends:	Object
Clientlib:	cq.widgets

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

This class is a singleton and cannot be created directly.

Public Properties

Property		Defined By
	correctRightMargin : Object In Webkit, there is an issue with getting the margin right property, see https://bugs.webkit.org/show_bug.cgi?id=13343	EventManager
	correctTransparentColor : Object Webkit browsers return rgba(0, 0, 0) when a transparent color is used	EventManager
	cssFloat : Object IE uses styleFloat, not cssFloat for the float property.	EventManager
	fireDocReady : Object Forces a document ready state transition for the framework. Used when Ext is loaded into a DOM structure AFTER initi... Forces a document ready state transition for the framework. Used when Ext is loaded into a DOM structure AFTER initial page load (Google API or other dynamic load scenario. Any pending 'onDocumentReady' handlers will be fired (if not already handled).	EventManager

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 CQ.Ext.Eleme... Appends an event handler to an element. The shorthand version on is equivalent. Typically you will use CQ.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 CQ.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 CQ.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 CQ.Ext.Element.addListener for examples of how to use these options. Returns: `void`	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 CQ.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 CQ.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
	onWindowLoaded( `Function fn`, [`Object scope`], [`boolean options`] ) : void Fires when the window is loaded. Fires when the window is loaded. Parameters: `fn` : Function The method the event invokes `scope` : Object (optional) An object that becomes the scope of the handler `options` : boolean (optional) An object containing standard addListener options Returns: `void`	EventManager
	removeAll( `String/HTMLElement el` ) : void Removes all event handers from an element. Typically you will use CQ.Ext.Element.removeAllListeners directly on an E... Removes all event handers from an element. Typically you will use CQ.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 CQ.Ext.Ele... Removes an event handler from an element. The shorthand version un is equivalent. Typically you will use CQ.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
	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.