InputApi class

Constructors

InputApi(Client _client)

Properties

hashCode int
The hash code for this object.
no setterinherited
onDragIntercepted Stream<DragData>
Emitted only when Input.setInterceptDrags is enabled. Use this data with Input.dispatchDragEvent to restore normal drag and drop behavior.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancelDragging() Future<void>
Cancels any active dragging in the page.
dispatchDragEvent(String type, num x, num y, DragData data, {int? modifiers}) Future<void>
Dispatches a drag event into the page. type Type of the drag event. x X coordinate of the event relative to the main frame's viewport in CSS pixels. y Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport. modifiers Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).
dispatchKeyEvent(String type, {int? modifiers, TimeSinceEpoch? timestamp, String? text, String? unmodifiedText, String? keyIdentifier, String? code, String? key, int? windowsVirtualKeyCode, int? nativeVirtualKeyCode, bool? autoRepeat, bool? isKeypad, bool? isSystemKey, int? location, List<String>? commands}) Future<void>
Dispatches a key event to the page. type Type of the key event. modifiers Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). timestamp Time at which the event occurred. text Text as generated by processing a virtual key code with a keyboard layout. Not needed for for keyUp and rawKeyDown events (default: "") unmodifiedText Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: ""). keyIdentifier Unique key identifier (e.g., 'U+0041') (default: ""). code Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: ""). key Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: ""). windowsVirtualKeyCode Windows virtual key code (default: 0). nativeVirtualKeyCode Native virtual key code (default: 0). autoRepeat Whether the event was generated from auto repeat (default: false). isKeypad Whether the event was generated from the keypad (default: false). isSystemKey Whether the event was a system key event (default: false). location Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0). commands Editing commands to send with the key event (e.g., 'selectAll') (default: []). These are related to but not equal the command names used in document.execCommand and NSStandardKeyBindingResponding. See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.
dispatchMouseEvent(String type, num x, num y, {int? modifiers, TimeSinceEpoch? timestamp, MouseButton? button, int? buttons, int? clickCount, num? force, num? tangentialPressure, num? tiltX, num? tiltY, int? twist, num? deltaX, num? deltaY, String? pointerType}) Future<void>
Dispatches a mouse event to the page. type Type of the mouse event. x X coordinate of the event relative to the main frame's viewport in CSS pixels. y Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport. modifiers Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). timestamp Time at which the event occurred. button Mouse button (default: "none"). buttons A number indicating which buttons are pressed on the mouse when a mouse event is triggered. Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0. clickCount Number of times the mouse button was clicked (default: 0). force The normalized pressure, which has a range of 0,1 (default: 0). tangentialPressure The normalized tangential pressure, which has a range of -1,1 (default: 0). tiltX The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range -90,90, a positive tiltX is to the right (default: 0). tiltY The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range -90,90, a positive tiltY is towards the user (default: 0). twist The clockwise rotation of a pen stylus around its own major axis, in degrees in the range 0,359 (default: 0). deltaX X delta in CSS pixels for mouse wheel event (default: 0). deltaY Y delta in CSS pixels for mouse wheel event (default: 0). pointerType Pointer type (default: "mouse").
dispatchTouchEvent(String type, List<TouchPoint> touchPoints, {int? modifiers, TimeSinceEpoch? timestamp}) Future<void>
Dispatches a touch event to the page. type Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while TouchStart and TouchMove must contains at least one. touchPoints Active touch points on the touch device. One event per any changed point (compared to previous touch event in a sequence) is generated, emulating pressing/moving/releasing points one by one. modifiers Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). timestamp Time at which the event occurred.
emulateTouchFromMouseEvent(String type, int x, int y, MouseButton button, {TimeSinceEpoch? timestamp, num? deltaX, num? deltaY, int? modifiers, int? clickCount}) Future<void>
Emulates touch event from the mouse event parameters. type Type of the mouse event. x X coordinate of the mouse pointer in DIP. y Y coordinate of the mouse pointer in DIP. button Mouse button. Only "none", "left", "right" are supported. timestamp Time at which the event occurred (default: current time). deltaX X delta in DIP for mouse wheel event (default: 0). deltaY Y delta in DIP for mouse wheel event (default: 0). modifiers Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). clickCount Number of times the mouse button was clicked (default: 0).
imeSetComposition(String text, int selectionStart, int selectionEnd, {int? replacementStart, int? replacementEnd}) Future<void>
This method sets the current candidate text for IME. Use imeCommitComposition to commit the final text. Use imeSetComposition with empty string as text to cancel composition. text The text to insert selectionStart selection start selectionEnd selection end replacementStart replacement start replacementEnd replacement end
insertText(String text) Future<void>
This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME. text The text to insert.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setIgnoreInputEvents(bool ignore) Future<void>
Ignores input events (useful while auditing page). ignore Ignores input events processing when set to true.
setInterceptDrags(bool enabled) Future<void>
Prevents default drag and drop behavior and instead emits Input.dragIntercepted events. Drag and drop behavior can be directly controlled via Input.dispatchDragEvent.
synthesizePinchGesture(num x, num y, num scaleFactor, {int? relativeSpeed, GestureSourceType? gestureSourceType}) Future<void>
Synthesizes a pinch gesture over a time period by issuing appropriate touch events. x X coordinate of the start of the gesture in CSS pixels. y Y coordinate of the start of the gesture in CSS pixels. scaleFactor Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out). relativeSpeed Relative pointer speed in pixels per second (default: 800). gestureSourceType Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type).
synthesizeScrollGesture(num x, num y, {num? xDistance, num? yDistance, num? xOverscroll, num? yOverscroll, bool? preventFling, int? speed, GestureSourceType? gestureSourceType, int? repeatCount, int? repeatDelayMs, String? interactionMarkerName}) Future<void>
Synthesizes a scroll gesture over a time period by issuing appropriate touch events. x X coordinate of the start of the gesture in CSS pixels. y Y coordinate of the start of the gesture in CSS pixels. xDistance The distance to scroll along the X axis (positive to scroll left). yDistance The distance to scroll along the Y axis (positive to scroll up). xOverscroll The number of additional pixels to scroll back along the X axis, in addition to the given distance. yOverscroll The number of additional pixels to scroll back along the Y axis, in addition to the given distance. preventFling Prevent fling (default: true). speed Swipe speed in pixels per second (default: 800). gestureSourceType Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type). repeatCount The number of times to repeat the gesture (default: 0). repeatDelayMs The number of milliseconds delay between each repeat. (default: 250). interactionMarkerName The name of the interaction markers to generate, if not empty (default: "").
synthesizeTapGesture(num x, num y, {int? duration, int? tapCount, GestureSourceType? gestureSourceType}) Future<void>
Synthesizes a tap gesture over a time period by issuing appropriate touch events. x X coordinate of the start of the gesture in CSS pixels. y Y coordinate of the start of the gesture in CSS pixels. duration Duration between touchdown and touchup events in ms (default: 50). tapCount Number of times to perform the tap (e.g. 2 for double tap, default: 1). gestureSourceType Which type of input events to be generated (default: 'default', which queries the platform for the preferred input type).
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited