DOMEventFacade Class
Wraps a DOM event, properties requiring browser abstraction are fixed here. Provids a security layer when required.
Index
Methods
Methods
_define
-
o -
prop -
valueFn
Wrapper function for Object.defineProperty that creates a property whose value will be calulated only when asked for. After calculating the value, the getter wll be removed, so it will behave as a normal property beyond that point. A setter is also assigned so assigning to the property will clear the getter, so foo.prop = 'a'; foo.prop; won't trigger the getter, overwriting value 'a'.
Used only by the DOMEventFacades used by IE8 when the YUI configuration <code>lazyEventFacade</code> is set to true.
Parameters:
-
oDOMObjectA DOM object to add the property to
-
propStringThe name of the new property
-
valueFnFunctionThe function that will return the initial, default value for the property.
_touch
-
ev -
currentTarget -
wrapper
Adds touch event facade normalization properties to the DOM event facade
Parameters:
-
evEventthe DOM event
-
currentTargetHTMLElementthe element the listener was attached to
-
wrapperCustomEventthe custom event wrapper for this DOM event
halt
-
immediate
Stops the event propagation and prevents the default event behavior.
Parameters:
-
immediateBooleanif true additional listeners on the current target will not be executed
preventDefault
-
returnValue
Prevents the event's default behavior
Parameters:
-
returnValueStringsets the returnValue of the event to this value (rather than the default false value). This can be used to add a customized confirmation query to the beforeunload event).
resolve
()
private
Returns a wrapped node. Intended to be used on event targets, so it will return the node's parent if the target is a text node.
If accessing a property of the node throws an error, this is probably the anonymous div wrapper Gecko adds inside text nodes. This likely will only occur when attempting to access the relatedTarget. In this case, we now return null because the anonymous div is completely useless and we do not know what the related target was because we can't even get to the element's parent node.
stopImmediatePropagation
()
Stops the propagation to the next bubble target and prevents any additional listeners from being exectued on the current target.
stopPropagation
()
Stops the propagation to the next bubble target
Properties
_event
DOMEvent
private
The native event
_GESTURE_MAP
Object
static
A object literal with keys "start", "end", and "move". The value for each key is a string representing the event for that environment. For touch environments, the respective values are "touchstart", "touchend" and "touchmove". Mouse and MSPointer environments are also supported via feature detection.
altKey
Boolean
true if the "alt" or "option" key is pressed.
changedTouches
DOMEventFacade[]
An array of event-specific touch events.
For touchstart, the touch points that became active with the current
event.
For touchmove, the touch points that have changed since the last
event.
For touchend, the touch points that have been removed from the touch
surface.
ctrlKey
Boolean
true if the "Ctrl" or "control" key is pressed.
metaKey
Boolean
true if the "Windows" key on a Windows keyboard, "command" key on an
Apple keyboard, or "meta" key on other keyboards is pressed.
shiftKey
Boolean
true if the shift key is pressed.
targetTouches
DOMEventFacade[]
Array of individual touch events still in contact with the touch
surface and whose touchstart event occurred inside the same taregt
element as the current target element.
touches
DOMEventFacade[]
Array of individual touch events for touch points that are still in contact with the touch surface.
type
String
The name of the event (e.g. "click")
webkitKeymap
Unknown
private
webkit key remapping required for Safari < 3.1
wheelDelta
Number
Number representing the direction and velocity of the movement of the mousewheel. Negative is down, the higher the number, the faster. Applies to the mousewheel event.