Class: GestureEmitter

GestureEmitter

<abstract> new GestureEmitter(options)

Base class for gesture emitters. The purpose of this class is to abstract away different types of gesture and UI events and re-emit the events in a normalized structures (DecksEvent), via a decks Emitter.
Parameters:
Name Type Description
options Object gesture configuration options
Properties
Name Type Argument Default Description
emitter Emitter | Object <optional>
<nullable>
 {} Emitter instance or options on which to emit events
element Element Element for which to listen for and emit gesture/DOM events
hammer Hammer Hammer instance for the element
enabled boolean whether this GestureEmitter is enabled (binds to/re-emits gesture events)
Source:

Mixes In

Members

defaultOptions

Default options
Source:

enabled

Indicates if this emitter is enabled (listens for events, and forwards them on the Emitter)
Source:

Methods

bind() → {undefined}

Binds all events (element and Hammer)
Source:
Returns:
Type
undefined

bindElementEvents() → {undefined}

Binds all of the Element-level events specified by GestureEmitter#getElementEvents
Source:
Returns:
Type
undefined

bindHammerEvents() → {undefined}

Binds to Hammer events specified by GestureEmitter#getHammerEvents
Source:
Returns:
Type
undefined

destroy() → {undefined}

Destroys this instance by unbinding from all bound events (Element-level, and Hammer).
Source:
Returns:
Type
undefined

getElementEvents() → {undefined}

Gets a map of Element/DOM event names to method names for which to bind. This method should be implemented by a subclass, if the subclass is interested in DOM element-level events.
Source:
Returns:
Type
undefined

getHammerEvents() → {undefined}

Gets a map of Hammer event names to method names for which to bind. This method should be implemented by the subclass, if the subclass is interested in Hammer events.
Source:
Returns:
Type
undefined

setElement(element) → {undefined}

Sets the Element monitored by this GestureEmitter
Parameters:
Name Type Description
element Element element to monitor
Source:
Returns:
Type
undefined

setHammer(hammer) → {undefined}

Sets the Hammer instance for this GestureEmitter The Hammer instance also wraps the element, and recognizes gestures.
Parameters:
Name Type Description
hammer
Source:
Returns:
Type
undefined

unbind() → {undefined}

Unbinds all events (element and Hammer)
Source:
Returns:
Type
undefined

unbindElementEvents() → {undefined}

Unbinds all the Element-level events specified by GestureEmitter#getElementEvents
Source:
Returns:
Type
undefined

unbindHammerEvents() → {undefined}

Unbinds from hammer events specified by GestureEmitter#getHammerEvents
Source:
Returns:
Type
undefined