KeyEvent abstract class

Base class for Key events. The native keyboard events are somewhat a mess (http://www.quirksmode.org/js/keys.html), we do some trivial normalization here, but do not attempt any complex patching, so user be warned.

@param <H> The event handler type

abstract class KeyEvent extends DomEvent {

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

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

 /**
  * Does this event have any modifier keys down? Specifically. is the control,
  * meta, shift, or alt key currently pressed?
  *
  * @return whether this event have any modifier key down
  */
 bool isAnyModifierKeyDown() {
   return isControlKeyDown() || isShiftKeyDown() || isMetaKeyDown() || isAltKeyDown();
 }

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

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

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

Extends

IEvent<H> > DwtEvent > DomEvent > KeyEvent

Subclasses

KeyCodeEvent

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

KeyboardEvent getKeyboardEvent() #

Cast native event to KeyboardEvent.

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

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

bool isAltKeyDown() #

Is the <code>alt</code> key down?

@return whether the alt key is down

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

bool isAnyModifierKeyDown() #

Does this event have any modifier keys down? Specifically. is the control, meta, shift, or alt key currently pressed?

@return whether this event have any modifier key down

bool isAnyModifierKeyDown() {
 return isControlKeyDown() || isShiftKeyDown() || isMetaKeyDown() || isAltKeyDown();
}

bool isControlKeyDown() #

Is the <code>control</code> key down?

@return whether the control key is down

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

bool isLive() #

inherited from DwtEvent

Is the event current live?

@return whether the event is live

bool isLive() {
 return !_dead;
}

bool isMetaKeyDown() #

Is the <code>meta</code> key down?

@return whether the meta key is down

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

bool isShiftKeyDown() #

Is the <code>shift</code> key down?

@return whether the shift key is down

bool isShiftKeyDown() {
 return getKeyboardEvent().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";
}

KeyEvent abstract class

Extends

Subclasses

Methods

Code void assertLive() #

abstract void dispatch(H handler) #

Code EventType<EventHandler> getAssociatedType() #

Code KeyboardEvent getKeyboardEvent() #

Code Event getNativeEvent() #

Code Element getRelativeElement() #

Code Object getSource() #

Code bool isAltKeyDown() #

Code bool isAnyModifierKeyDown() #

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() #

KeyboardEvent getKeyboardEvent() #

Event getNativeEvent() #

Element getRelativeElement() #

Object getSource() #

bool isAltKeyDown() #

bool isAnyModifierKeyDown() #

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() #