Package org.openqa.selenium.devtools.v112.input

Class Input

  • public class Input
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Input()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static org.openqa.selenium.devtools.Command<java.lang.Void> dispatchDragEvent​(Input.DispatchDragEventType type, java.lang.Number x, java.lang.Number y, DragData data, java.util.Optional<java.lang.Integer> modifiers)
      Dispatches a drag event into the page.
      static org.openqa.selenium.devtools.Command<java.lang.Void> dispatchKeyEvent​(Input.DispatchKeyEventType type, java.util.Optional<java.lang.Integer> modifiers, java.util.Optional<TimeSinceEpoch> timestamp, java.util.Optional<java.lang.String> text, java.util.Optional<java.lang.String> unmodifiedText, java.util.Optional<java.lang.String> keyIdentifier, java.util.Optional<java.lang.String> code, java.util.Optional<java.lang.String> key, java.util.Optional<java.lang.Integer> windowsVirtualKeyCode, java.util.Optional<java.lang.Integer> nativeVirtualKeyCode, java.util.Optional<java.lang.Boolean> autoRepeat, java.util.Optional<java.lang.Boolean> isKeypad, java.util.Optional<java.lang.Boolean> isSystemKey, java.util.Optional<java.lang.Integer> location, java.util.Optional<java.util.List<java.lang.String>> commands)
      Dispatches a key event to the page.
      static org.openqa.selenium.devtools.Command<java.lang.Void> dispatchMouseEvent​(Input.DispatchMouseEventType type, java.lang.Number x, java.lang.Number y, java.util.Optional<java.lang.Integer> modifiers, java.util.Optional<TimeSinceEpoch> timestamp, java.util.Optional<MouseButton> button, java.util.Optional<java.lang.Integer> buttons, java.util.Optional<java.lang.Integer> clickCount, java.util.Optional<java.lang.Number> force, java.util.Optional<java.lang.Number> tangentialPressure, java.util.Optional<java.lang.Integer> tiltX, java.util.Optional<java.lang.Integer> tiltY, java.util.Optional<java.lang.Integer> twist, java.util.Optional<java.lang.Number> deltaX, java.util.Optional<java.lang.Number> deltaY, java.util.Optional<Input.DispatchMouseEventPointerType> pointerType)
      Dispatches a mouse event to the page.
      static org.openqa.selenium.devtools.Command<java.lang.Void> dispatchTouchEvent​(Input.DispatchTouchEventType type, java.util.List<TouchPoint> touchPoints, java.util.Optional<java.lang.Integer> modifiers, java.util.Optional<TimeSinceEpoch> timestamp)
      Dispatches a touch event to the page.
      static org.openqa.selenium.devtools.Event<DragData> dragIntercepted()  
      static org.openqa.selenium.devtools.Command<java.lang.Void> emulateTouchFromMouseEvent​(Input.EmulateTouchFromMouseEventType type, java.lang.Integer x, java.lang.Integer y, MouseButton button, java.util.Optional<TimeSinceEpoch> timestamp, java.util.Optional<java.lang.Number> deltaX, java.util.Optional<java.lang.Number> deltaY, java.util.Optional<java.lang.Integer> modifiers, java.util.Optional<java.lang.Integer> clickCount)
      Emulates touch event from the mouse event parameters.
      static org.openqa.selenium.devtools.Command<java.lang.Void> imeSetComposition​(java.lang.String text, java.lang.Integer selectionStart, java.lang.Integer selectionEnd, java.util.Optional<java.lang.Integer> replacementStart, java.util.Optional<java.lang.Integer> replacementEnd)
      This method sets the current candidate text for ime.
      static org.openqa.selenium.devtools.Command<java.lang.Void> insertText​(java.lang.String text)
      This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME.
      static org.openqa.selenium.devtools.Command<java.lang.Void> setIgnoreInputEvents​(java.lang.Boolean ignore)
      Ignores input events (useful while auditing page).
      static org.openqa.selenium.devtools.Command<java.lang.Void> setInterceptDrags​(java.lang.Boolean enabled)
      Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events.
      static org.openqa.selenium.devtools.Command<java.lang.Void> synthesizePinchGesture​(java.lang.Number x, java.lang.Number y, java.lang.Number scaleFactor, java.util.Optional<java.lang.Integer> relativeSpeed, java.util.Optional<GestureSourceType> gestureSourceType)
      Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
      static org.openqa.selenium.devtools.Command<java.lang.Void> synthesizeScrollGesture​(java.lang.Number x, java.lang.Number y, java.util.Optional<java.lang.Number> xDistance, java.util.Optional<java.lang.Number> yDistance, java.util.Optional<java.lang.Number> xOverscroll, java.util.Optional<java.lang.Number> yOverscroll, java.util.Optional<java.lang.Boolean> preventFling, java.util.Optional<java.lang.Integer> speed, java.util.Optional<GestureSourceType> gestureSourceType, java.util.Optional<java.lang.Integer> repeatCount, java.util.Optional<java.lang.Integer> repeatDelayMs, java.util.Optional<java.lang.String> interactionMarkerName)
      Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
      static org.openqa.selenium.devtools.Command<java.lang.Void> synthesizeTapGesture​(java.lang.Number x, java.lang.Number y, java.util.Optional<java.lang.Integer> duration, java.util.Optional<java.lang.Integer> tapCount, java.util.Optional<GestureSourceType> gestureSourceType)
      Synthesizes a tap gesture over a time period by issuing appropriate touch events.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Input

        public Input()

    • Method Detail

      • dispatchDragEvent

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> dispatchDragEvent​(Input.DispatchDragEventType type,
                                                                                     java.lang.Number x,
                                                                                     java.lang.Number y,
                                                                                     DragData data,
                                                                                     java.util.Optional<java.lang.Integer> modifiers)
        Dispatches a drag event into the page.

      • dispatchKeyEvent

        public static org.openqa.selenium.devtools.Command<java.lang.Void> dispatchKeyEvent​(Input.DispatchKeyEventType type,
                                                                                    java.util.Optional<java.lang.Integer> modifiers,
                                                                                    java.util.Optional<TimeSinceEpoch> timestamp,
                                                                                    java.util.Optional<java.lang.String> text,
                                                                                    java.util.Optional<java.lang.String> unmodifiedText,
                                                                                    java.util.Optional<java.lang.String> keyIdentifier,
                                                                                    java.util.Optional<java.lang.String> code,
                                                                                    java.util.Optional<java.lang.String> key,
                                                                                    java.util.Optional<java.lang.Integer> windowsVirtualKeyCode,
                                                                                    java.util.Optional<java.lang.Integer> nativeVirtualKeyCode,
                                                                                    java.util.Optional<java.lang.Boolean> autoRepeat,
                                                                                    java.util.Optional<java.lang.Boolean> isKeypad,
                                                                                    java.util.Optional<java.lang.Boolean> isSystemKey,
                                                                                    java.util.Optional<java.lang.Integer> location,
                                                                                    java.util.Optional<java.util.List<java.lang.String>> commands)
        Dispatches a key event to the page.

      • insertText

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> insertText​(java.lang.String text)
        This method emulates inserting text that doesn't come from a key press, for example an emoji keyboard or an IME.

      • imeSetComposition

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> imeSetComposition​(java.lang.String text,
                                                                                     java.lang.Integer selectionStart,
                                                                                     java.lang.Integer selectionEnd,
                                                                                     java.util.Optional<java.lang.Integer> replacementStart,
                                                                                     java.util.Optional<java.lang.Integer> replacementEnd)
        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.

      • dispatchMouseEvent

        public static org.openqa.selenium.devtools.Command<java.lang.Void> dispatchMouseEvent​(Input.DispatchMouseEventType type,
                                                                                      java.lang.Number x,
                                                                                      java.lang.Number y,
                                                                                      java.util.Optional<java.lang.Integer> modifiers,
                                                                                      java.util.Optional<TimeSinceEpoch> timestamp,
                                                                                      java.util.Optional<MouseButton> button,
                                                                                      java.util.Optional<java.lang.Integer> buttons,
                                                                                      java.util.Optional<java.lang.Integer> clickCount,
                                                                                      java.util.Optional<java.lang.Number> force,
                                                                                      java.util.Optional<java.lang.Number> tangentialPressure,
                                                                                      java.util.Optional<java.lang.Integer> tiltX,
                                                                                      java.util.Optional<java.lang.Integer> tiltY,
                                                                                      java.util.Optional<java.lang.Integer> twist,
                                                                                      java.util.Optional<java.lang.Number> deltaX,
                                                                                      java.util.Optional<java.lang.Number> deltaY,
                                                                                      java.util.Optional<Input.DispatchMouseEventPointerType> pointerType)
        Dispatches a mouse event to the page.

      • dispatchTouchEvent

        public static org.openqa.selenium.devtools.Command<java.lang.Void> dispatchTouchEvent​(Input.DispatchTouchEventType type,
                                                                                      java.util.List<TouchPoint> touchPoints,
                                                                                      java.util.Optional<java.lang.Integer> modifiers,
                                                                                      java.util.Optional<TimeSinceEpoch> timestamp)
        Dispatches a touch event to the page.

      • emulateTouchFromMouseEvent

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> emulateTouchFromMouseEvent​(Input.EmulateTouchFromMouseEventType type,
                                                                                              java.lang.Integer x,
                                                                                              java.lang.Integer y,
                                                                                              MouseButton button,
                                                                                              java.util.Optional<TimeSinceEpoch> timestamp,
                                                                                              java.util.Optional<java.lang.Number> deltaX,
                                                                                              java.util.Optional<java.lang.Number> deltaY,
                                                                                              java.util.Optional<java.lang.Integer> modifiers,
                                                                                              java.util.Optional<java.lang.Integer> clickCount)
        Emulates touch event from the mouse event parameters.

      • setIgnoreInputEvents

        public static org.openqa.selenium.devtools.Command<java.lang.Void> setIgnoreInputEvents​(java.lang.Boolean ignore)
        Ignores input events (useful while auditing page).

      • setInterceptDrags

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> setInterceptDrags​(java.lang.Boolean enabled)
        Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events. Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.

      • synthesizePinchGesture

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> synthesizePinchGesture​(java.lang.Number x,
                                                                                          java.lang.Number y,
                                                                                          java.lang.Number scaleFactor,
                                                                                          java.util.Optional<java.lang.Integer> relativeSpeed,
                                                                                          java.util.Optional<GestureSourceType> gestureSourceType)
        Synthesizes a pinch gesture over a time period by issuing appropriate touch events.

      • synthesizeScrollGesture

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> synthesizeScrollGesture​(java.lang.Number x,
                                                                                           java.lang.Number y,
                                                                                           java.util.Optional<java.lang.Number> xDistance,
                                                                                           java.util.Optional<java.lang.Number> yDistance,
                                                                                           java.util.Optional<java.lang.Number> xOverscroll,
                                                                                           java.util.Optional<java.lang.Number> yOverscroll,
                                                                                           java.util.Optional<java.lang.Boolean> preventFling,
                                                                                           java.util.Optional<java.lang.Integer> speed,
                                                                                           java.util.Optional<GestureSourceType> gestureSourceType,
                                                                                           java.util.Optional<java.lang.Integer> repeatCount,
                                                                                           java.util.Optional<java.lang.Integer> repeatDelayMs,
                                                                                           java.util.Optional<java.lang.String> interactionMarkerName)
        Synthesizes a scroll gesture over a time period by issuing appropriate touch events.

      • synthesizeTapGesture

        @Beta
public static org.openqa.selenium.devtools.Command<java.lang.Void> synthesizeTapGesture​(java.lang.Number x,
                                                                                        java.lang.Number y,
                                                                                        java.util.Optional<java.lang.Integer> duration,
                                                                                        java.util.Optional<java.lang.Integer> tapCount,
                                                                                        java.util.Optional<GestureSourceType> gestureSourceType)
        Synthesizes a tap gesture over a time period by issuing appropriate touch events.

      • dragIntercepted

        public static org.openqa.selenium.devtools.Event<DragData> dragIntercepted()