MouseEvent abstract class

Abstract class representing mouse events.

@param <H> handler type

abstract class MouseEvent extends DomEvent {

 /**
  * Cast native event to [MouseEvent].
  */
 dart_html.MouseEvent getMouseEvent() {
   if (getNativeEvent() is dart_html.MouseEvent) {
     return getNativeEvent() as dart_html.MouseEvent;
   }
   throw new Exception("Native event is not subtype of MouseEvent");
 }

 /**
  * Is <code>alt</code> key down.
  *
  * @return whether the alt key is down
  */
 bool isAltKeyDown() {
   return getMouseEvent().altKey;
 }

 /**
  * Is <code>control</code> key down.
  *
  * @return whether the control key is down
  */
 bool isControlKeyDown() {
   return getMouseEvent().ctrlKey;
 }

 /**
  * Is <code>meta</code> key down.
  *
  * @return whether the meta key is down
  */
 bool isMetaKeyDown() {
   return getMouseEvent().metaKey;
 }

 /**
  * Is <code>shift</code> key down.
  *
  * @return whether the shift key is down
  */
 bool isShiftKeyDown() {
   return getMouseEvent().shiftKey;
 }

 /**
  * Gets the mouse x-position within the browser window's client area.
  *
  * @return the mouse x-position
  */
 int getClientX() {
   return getMouseEvent().client.x;
 }

 /**
  * Gets the mouse y-position within the browser window's client area.
  *
  * @return the mouse y-position
  */
 int getClientY() {
   return getMouseEvent().client.y;
 }

 /**
  * Gets the button value. Compare it to
  * {@link com.google.gwt.dom.client.NativeEvent#BUTTON_LEFT},
  * {@link com.google.gwt.dom.client.NativeEvent#BUTTON_RIGHT},
  * {@link com.google.gwt.dom.client.NativeEvent#BUTTON_MIDDLE}
  *
  * @return the button value
  */
 int getNativeButton() {
   return getMouseEvent().button;
 }

 /**
  * Gets the mouse x-position relative to a given element.
  *
  * @param target the element whose coordinate system is to be used
  * @return the relative x-position
  */
 int getRelativeX(dart_html.Element target) {
   return getMouseEvent().client.x - Dom.getAbsoluteLeft(target) + target.scrollLeft + target.document.documentElement.scrollLeft;
 }

 /**
  * Gets the mouse y-position relative to a given element.
  *
  * @param target the element whose coordinate system is to be used
  * @return the relative y-position
  */
 int getRelativeY(dart_html.Element target) {
   return getMouseEvent().client.y - Dom.getAbsoluteTop(target) + target.scrollTop + target.document.documentElement.scrollTop;
 }

 /**
  * Gets the mouse x-position on the user's display.
  *
  * @return the mouse x-position
  */
 int getScreenX() {
   return getMouseEvent().screen.x;
 }

 /**
  * Gets the mouse y-position on the user's display.
  *
  * @return the mouse y-position
  */
 int getScreenY() {
   return getMouseEvent().screen.y;
 }

 /**
  * Gets the mouse x-position relative to the event's current target element.
  *
  * @return the relative x-position
  */
 int getX() {
   dart_html.Element relativeElem = getRelativeElement();
   if (relativeElem != null) {
     return getRelativeX(relativeElem);
   }
   return getClientX();
 }

 /**
  * Gets the mouse y-position relative to the event's current target element.
  *
  * @return the relative y-position
  */
 int getY() {
   dart_html.Element relativeElem = getRelativeElement();
   if (relativeElem != null) {
     return getRelativeY(relativeElem);
   }
   return getClientY();
 }
}

Extends

IEvent<H> > DwtEvent > DomEvent > MouseEvent

Subclasses

ClickEvent, DoubleClickEvent, DragDropEventBase, MouseDownEvent, MouseMoveEvent, MouseOutEvent, MouseOverEvent, MouseUpEvent, MouseWheelEvent

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";
}

abstract void dispatch(H handler) #

inherited from IEvent

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)

EventType<EventHandler> getAssociatedType() #

inherited from DomEvent

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>

EventType<EventHandler> getAssociatedType() {
 return TYPE;
}

int getClientX() #

Gets the mouse x-position within the browser window's client area.

@return the mouse x-position

int getClientX() {
 return getMouseEvent().client.x;
}

int getClientY() #

Gets the mouse y-position within the browser window's client area.

@return the mouse y-position

int getClientY() {
 return getMouseEvent().client.y;
}

MouseEvent getMouseEvent() #

Cast native event to MouseEvent.

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

int getNativeButton() #

Gets the button value. Compare it to {@link com.google.gwt.dom.client.NativeEvent#BUTTONLEFT}, {@link com.google.gwt.dom.client.NativeEvent#BUTTONRIGHT}, {@link com.google.gwt.dom.client.NativeEvent#BUTTON_MIDDLE}

@return the button value

int getNativeButton() {
 return getMouseEvent().button;
}

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;
}

int getRelativeX(Element target) #

Gets the mouse x-position relative to a given element.

@param target the element whose coordinate system is to be used @return the relative x-position

int getRelativeX(dart_html.Element target) {
 return getMouseEvent().client.x - Dom.getAbsoluteLeft(target) + target.scrollLeft + target.document.documentElement.scrollLeft;
}

int getRelativeY(Element target) #

Gets the mouse y-position relative to a given element.

@param target the element whose coordinate system is to be used @return the relative y-position

int getRelativeY(dart_html.Element target) {
 return getMouseEvent().client.y - Dom.getAbsoluteTop(target) + target.scrollTop + target.document.documentElement.scrollTop;
}

int getScreenX() #

Gets the mouse x-position on the user's display.

@return the mouse x-position

int getScreenX() {
 return getMouseEvent().screen.x;
}

int getScreenY() #

Gets the mouse y-position on the user's display.

@return the mouse y-position

int getScreenY() {
 return getMouseEvent().screen.y;
}

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();
}

int getX() #

Gets the mouse x-position relative to the event's current target element.

@return the relative x-position

int getX() {
 dart_html.Element relativeElem = getRelativeElement();
 if (relativeElem != null) {
   return getRelativeX(relativeElem);
 }
 return getClientX();
}

int getY() #

Gets the mouse y-position relative to the event's current target element.

@return the relative y-position

int getY() {
 dart_html.Element relativeElem = getRelativeElement();
 if (relativeElem != null) {
   return getRelativeY(relativeElem);
 }
 return getClientY();
}

bool isAltKeyDown() #

Is <code>alt</code> key down.

@return whether the alt key is down

bool isAltKeyDown() {
 return getMouseEvent().altKey;
}

bool isControlKeyDown() #

Is <code>control</code> key down.

@return whether the control key is down

bool isControlKeyDown() {
 return getMouseEvent().ctrlKey;
}

bool isLive() #

inherited from DwtEvent

Is the event current live?

@return whether the event is live

bool isLive() {
 return !_dead;
}

bool isMetaKeyDown() #

Is <code>meta</code> key down.

@return whether the meta key is down

bool isMetaKeyDown() {
 return getMouseEvent().metaKey;
}

bool isShiftKeyDown() #

Is <code>shift</code> key down.

@return whether the shift key is down

bool isShiftKeyDown() {
 return getMouseEvent().shiftKey;
}

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";
}

MouseEvent abstract class

Extends

Subclasses

Methods

Code void assertLive() #

abstract void dispatch(H handler) #

Code EventType<EventHandler> getAssociatedType() #

Code int getClientX() #

Code int getClientY() #

Code MouseEvent getMouseEvent() #

Code int getNativeButton() #

Code Event getNativeEvent() #

Code Element getRelativeElement() #

Code int getRelativeX(Element target) #

Code int getRelativeY(Element target) #

Code int getScreenX() #

Code int getScreenY() #

Code Object getSource() #

Code int getX() #

Code int getY() #

Code bool isAltKeyDown() #

Code bool isControlKeyDown() #

Code bool isLive() #

Code bool isMetaKeyDown() #

Code bool isShiftKeyDown() #

Code void kill() #

Code void overrideSource(Object source) #

Code void preventDefault() #

Code void revive() #

Code void setSource(source) #

Code void stopPropagation() #

Code String toString() #

toDebugString to get more information about the event.

void assertLive() #

EventType<EventHandler> getAssociatedType() #

int getClientX() #

int getClientY() #

MouseEvent getMouseEvent() #

int getNativeButton() #

Event getNativeEvent() #

Element getRelativeElement() #

int getRelativeX(Element target) #

int getRelativeY(Element target) #

int getScreenX() #

int getScreenY() #

Object getSource() #

int getX() #

int getY() #

bool isAltKeyDown() #

bool isControlKeyDown() #

bool isLive() #

bool isMetaKeyDown() #

bool isShiftKeyDown() #

void kill() #

void overrideSource(Object source) #

void preventDefault() #

void revive() #

void setSource(source) #

void stopPropagation() #

String toString() #