Namespace: events

Methods

add(obj, event, handler, opt_useCapture)

events.js, line 39

Registers an event listener to fire the given callback when a specified
event is triggered on the given object.

Name	Type	Description
obj	Element | Document | Window	Object which supports events. This includes DOM elements, the Document itself, and the Window object for example.
event	string	Name of the event for which to register the given callback.
handler	function	Function to be invoked when event is triggered on the given object.
opt_useCapture	boolean	optional Optional. Whether to add the handler in the capturing phase.

dispatch()

events.js, line 82

This function is missing documentation.

TODO

• Complete documentation.

hasKeyModifier(event){boolean}

events.js, line 108

Given an event object, checks whether the ctrl key is depressed.

Name	Type	Description
event	Event

is(obj){boolean}

events.js, line 213

Returns true if the given value is a native browser event object.

Name	Type	Description
obj	*

isSelectionEvent(obj){boolean}

selections.js, line 1538

Returns true if the given value is a Selection Event object as created by
aloha.selections.selectionEvent.

Name	Type	Description
obj	*

nextTick(fn)

events.js, line 124

Runs the given function after the current event handler returns
to the browser.

Currently implemented just with setTimeout() which is specced to
have a minimum timeout value of 4 milliseconds. Alternate
implementations are possible that are faster, for example:
https://github.com/NobleJS/setImmediate

Name	Type	Description
fn	function	a function to call

preventDefault(event)

events.js, line 171

Flags the given event to prevent native handlers from performing default
behavior for it.

Name	Type	Description
event	Event

remove(obj, event, handler, opt_useCapture)

events.js, line 65

Detaches the specified event callback from the given event.

Name	Type	Description
obj	Element | Document | Window	Object which supports events. This includes DOM elements, the Document itself, and the Window object for example.
event	string	Name of the event to detach.
handler	function	Function to be de-registered.
opt_useCapture	boolean	optional Optional. Must be true if the handler was registered with a true useCapture argument.

setup(editor, doc)

events.js, line 140

Sets up all editing browser events to call `editor` on the given
document.

Name	Type	Description
editor	function
doc	Document

See:

• https://en.wikipedia.org/wiki/DOM_Events http://www.w3.org/TR/DOM-Level-3-Events

stopPropagation(event)

events.js, line 185

Stops this event from bubbling any further up the DOM tree.

Name	Type	Description
event	Event

suppress(event)

events.js, line 201

"Suppresses" the given event such that it will not trigger default
behavior and nor propagate. This will prevent any parent handlers up of
the DOM tree from being notified of this event.

Name	Type	Description
event	Event