KeyEvent class
A custom KeyboardEvent that attempts to eliminate cross-browserinconsistencies, and also provide both keyCode and charCode informationfor all key events (when such information can be determined).
KeyEvent tries to provide a higher level, more polished keyboard eventinformation on top of the "raw"KeyboardEvent.
The mechanics of using KeyEvents is a little different from the underlyingKeyboardEvent. To use KeyEvents, you need to create a stream and then addKeyEvents to the stream, rather than using theEventTarget.dispatchEvent.Here's an example usage:
// Initialize a stream for the KeyEvents:var stream = KeyEvent.keyPressEvent.forTarget(document.body);// Start listening to the stream of KeyEvents.stream.listen((keyEvent) => window.console.log('KeyPress event detected ${keyEvent.charCode}'));...// Add a new KeyEvent of someone pressing the 'A' key to the stream so// listeners can know a KeyEvent happened.stream.add(new KeyEvent('keypress', keyCode: 65, charCode: 97));This class is very much a work in progress, and we'd love to get informationon how we can make this class work with as many international keyboards aspossible. Bugs welcome!
- Implemented types
Constructors
- KeyEvent(Stringtype, {Window?view,boolcanBubble =true,boolcancelable =true,intkeyCode =0,intcharCode =0,intlocation =1,boolctrlKey =false,boolaltKey =false,boolshiftKey =false,boolmetaKey =false,EventTarget?currentTarget})
- Programmatically create a new KeyEvent (and KeyboardEvent).factory
- KeyEvent.wrap(KeyboardEventparent)
- Construct a KeyEvent with
parentas the event we're emulating.
Properties
- altKey→bool
- Calculated value of whether the alt key is pressed is for this event.no setteroverride
- bubbles→bool
- no setterinherited
- cancelable→bool
- no setterinherited
- charCode→int
- Calculated value of what the estimated charCode is for this event.no setteroverride
- code→String
- no setteroverride
- composed→bool
- no setterinherited
- ctrlKey→bool
- True if the ctrl key is pressed during this event.no setteroverride
- currentTarget→EventTarget?
- The currently registered target for this event.no setter
- defaultPrevented→bool
- no setterinherited
- detail→int
- no setteroverride
- eventPhase→int
- no setterinherited
- hashCode→int
- The hash code for this object.no setterinherited
- isComposed→bool
- no setter
- isComposing→bool
- no setteroverride
- isTrusted→bool
- no setterinherited
- key→String
- no setteroverride
- keyCode→int
- Calculated value of what the estimated keyCode is for this event.no setteroverride
- location→int
- Accessor to the part of the keyboard that the key was pressed from (one ofKeyLocation.STANDARD, KeyLocation.RIGHT, KeyLocation.LEFT,KeyLocation.NUMPAD, KeyLocation.MOBILE, KeyLocation.JOYSTICK).no setteroverride
- matchingTarget→Element
- A pointer to the element whose CSS selector matched within which an eventwas fired. If this Event was not associated with any Event delegation,accessing this value will throw anUnsupportedError.no setterinherited
- metaKey→bool
- True if the Meta (or Mac command) key is pressed during this event.no setteroverride
- path→List<
Node> - This event's path, taking into account shadow DOM.no setterinherited
- repeat→bool
- no setteroverride
- runtimeType→Type
- A representation of the runtime type of the object.no setterinherited
- shiftKey→bool
- True if the shift key was pressed during this event.no setteroverride
- sourceCapabilities→InputDeviceCapabilities?
- no setteroverride
- target→EventTarget?
- no setterinherited
- timeStamp→double
- no setterinherited
- type→String
- no setterinherited
- view→WindowBase?
- no setteroverride
- which→int
- Calculated value of what the estimated keyCode is for this event.no setteroverride
- wrapped→Event
- finalinherited
Methods
- composedPath(
)→List< EventTarget> - inherited
- getModifierState(
StringkeyArgument)→bool - override
- noSuchMethod(
Invocationinvocation)→ dynamic - Invoked when a nonexistent method or property is accessed.inherited
- preventDefault(
)→ void - inherited
- stopImmediatePropagation(
)→ void - inherited
- stopPropagation(
)→ void - inherited
- toString(
)→String - A string representation of this object.inherited
Operators
- operator ==(
Objectother)→bool - The equality operator.inherited
Static Properties
- canUseDispatchEvent→bool
- no setter
- keyDownEvent↔EventStreamProvider<
KeyEvent> - Accessor to provide a stream of KeyEvents on the desired target.getter/setter pair
- keyPressEvent↔EventStreamProvider<
KeyEvent> - Accessor to provide a stream of KeyEvents on the desired target.getter/setter pair
- keyUpEvent↔EventStreamProvider<
KeyEvent> - Accessor to provide a stream of KeyEvents on the desired target.getter/setter pair