API Reference 0.3.24dart_web_toolkit_eventTouchStartEvent

TouchStartEvent class

Represents a native touch start event.

class TouchStartEvent extends TouchEvent {

 /**
  * The event type.
  */
 static DomEventType<TouchStartHandler> TYPE = new DomEventType<TouchStartHandler>(BrowserEvents.TOUCHCANCEL, new TouchStartEvent());

 DomEventType<TouchStartHandler> getAssociatedType() {
   return TYPE;
 }

 TouchStartEvent();

 void dispatch(TouchStartHandler handler) {
   handler.onTouchStart(this);
 }

}

Extends

IEvent<H> > DwtEvent > DomEvent > TouchEvent > TouchStartEvent

Static Properties

DomEventType<TouchStartHandler> TYPE #

The event type.

static DomEventType<TouchStartHandler> TYPE = new DomEventType<TouchStartHandler>(BrowserEvents.TOUCHCANCEL, new TouchStartEvent())

Constructors

new TouchStartEvent() #

Constructor.

docs inherited from IEvent<H>
TouchStartEvent();

Methods

void assertLive() #

inherited from DwtEvent

Asserts that the event still should be accessed. All events are considered to be "dead" after their original handler manager finishes firing them. An event can be revived by calling {@link GwtEvent#revive()}.

void assertLive() {
 assert (!_dead) ; //: "This event has already finished being processed by its original handler manager, so you can no longer access it";
}

void dispatch(TouchStartHandler handler) #

Implemented by subclasses to invoke their handlers in a type safe manner. Intended to be called by EventBus#fireEvent(Event) or EventBus#fireEventFromSource(Event, Object).

@param handler handler @see EventBus#dispatchEvent(Event, Object)

docs inherited from IEvent<H>
void dispatch(TouchStartHandler handler) {
 handler.onTouchStart(this);
}

DomEventType<TouchStartHandler> getAssociatedType() #

Returns the EventType used to register this event, allowing an EventBus to find handlers of the appropriate class.

@return the type

docs inherited from IEvent<H>
DomEventType<TouchStartHandler> getAssociatedType() {
 return TYPE;
}

List<Touch> getChangedTouches() #

inherited from TouchEvent

Get an array of {@link Touch touches} which have changed since the last touch event fired. Note, that for {@link TouchEndEvent touch end events}, the touch which has just ended will not be present in the array. Moreover, if the touch which just ended was the last remaining touch, then a zero length array will be returned.

@return an array of touches

List<dart_html.Touch> getChangedTouches() {
 return getTouchEvent().changedTouches;
}

Event getNativeEvent() #

inherited from DomEvent

Gets the underlying native event.

@return the native event

docs inherited from HasNativeEvent
dart_html.Event getNativeEvent() {
 assertLive();
 return _nativeEvent;
}

Element getRelativeElement() #

inherited from DomEvent

Gets the element relative to which event coordinates will be measured. If this element is <code>null</code>, event coordinates will be measured relative to the window's client area.

@return the event's relative element

dart_html.Element getRelativeElement() {
 assertLive();
 return _relativeElem;
}

Object getSource() #

inherited from DwtEvent

Returns the source for this event. The type and meaning of the source is arbitrary, and is most useful as a secondary key for handler registration. (See EventBus#addHandlerToSource, which allows a handler to register for events of a particular type, tied to a particular source.)

Note that the source is actually set at dispatch time, e.g. via EventBus#fireEventFromSource(Event, Object).

@return object representing the source of this event

docs inherited from IEvent<H>
Object getSource() {
 assertLive();
 return super.getSource();
}

List<Touch> getTargetTouches() #

inherited from TouchEvent

Get an array of {@link Touch touches} all touch which originated at the same target as the current touch event. Note, that for {@link TouchEndEvent touch end events}, the touch which has just ended will not be present in the array. Moreover, if the touch which just ended was the last remaining touch, then a zero length array will be returned.

@return an array of touches

List<dart_html.Touch> getTargetTouches() {
 return getTouchEvent().targetTouches;
}

List<Touch> getTouches() #

inherited from TouchEvent

Get an array of all current {@link Touch touches}. Note, that for {@link TouchEndEvent touch end events}, the touch which has just ended will not be present in the array. Moreover, if the touch which just ended was the last remaining touch, then a zero length array will be returned.

@return an array of touches

List<dart_html.Touch> getTouches() {
 return getTouchEvent().touches;
}

TouchEvent getTouchEvent() #

inherited from TouchEvent

Cast native event to TouchEvent.

dart_html.TouchEvent getTouchEvent() {
 if (getNativeEvent() is dart_html.TouchEvent) {
   return getNativeEvent() as dart_html.TouchEvent;
 }
 throw new Exception("Native event is not subtype of TouchEvent");
}

bool isLive() #

inherited from DwtEvent

Is the event current live?

@return whether the event is live

bool isLive() {
 return !_dead;
}

void kill() #

inherited from DwtEvent

Kill the event. After the event has been killed, users cannot really on its values or functions being available.

void kill() {
 _dead = true;
 setSource(null);
}

void overrideSource(Object source) #

inherited from DwtEvent
void overrideSource(Object source) {
 super.setSource(source);
}

void preventDefault() #

inherited from DomEvent

Prevents the wrapped native event's default action.

void preventDefault() {
 assertLive();
 _nativeEvent.preventDefault();
}

void revive() #

inherited from DwtEvent

Revives the event. Used when recycling event instances.

void revive() {
 _dead = false;
 setSource(null);
}

void setSource(source) #

inherited from IEvent

Set the source that triggered this event. Intended to be called by the EventBus during dispatch.

@param source the source of this event. @see EventBus#fireEventFromSource(Event, Object) @see EventBus#setSourceOfEvent(Event, Object)

void setSource(dynamic source) {
 this._source = source;
}

void stopPropagation() #

inherited from DomEvent

Stops the propagation of the underlying native event.

void stopPropagation() {
 assertLive();
 _nativeEvent.stopPropagation();
}

String toString() #

inherited from IEvent

The toString() for abstract event is overridden to avoid accidently including class literals in the the compiled output. Use Event

toDebugString to get more information about the event.

String toString() {
 return "An event type";
}