org.openqa.selenium.interactions.SendKeysAction.java Source code

Introduction

Here is the source code for org.openqa.selenium.interactions.SendKeysAction.java

Source

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package org.openqa.selenium.interactions;

import org.openqa.selenium.WebElement;
import org.openqa.selenium.interactions.internal.KeysRelatedAction;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * Sending a sequence of keys to an element.
 *
 * @deprecated Use {@link Actions#sendKeys(WebElement, CharSequence...)}
 */
@Deprecated
public class SendKeysAction extends KeysRelatedAction implements Action {
    private final CharSequence[] keysToSend;

    public SendKeysAction(Keyboard keyboard, Mouse mouse, Locatable locationProvider, CharSequence... keysToSend) {
        super(keyboard, mouse, locationProvider);

        if (keysToSend == null || keysToSend.length == 0) {
            throw new IllegalArgumentException("Keys should be a not null CharSequence");
        }
        this.keysToSend = keysToSend;
    }

    public SendKeysAction(Keyboard keyboard, Mouse mouse, CharSequence... keysToSend) {
        this(keyboard, mouse, null, keysToSend);
    }

    @Override
    public void perform() {
        focusOnElement();

        keyboard.sendKeys(keysToSend);
    }

    @Override
    public List<Interaction> asInteractions(PointerInput mouse, KeyInput keyboard) {
        List<Interaction> interactions = new ArrayList<>(optionallyClickElement(mouse));

        for (CharSequence keys : keysToSend) {
            keys.codePoints().forEach(codePoint -> {
                interactions.add(keyboard.createKeyDown(codePoint));
                interactions.add(keyboard.createKeyUp(codePoint));
            });
        }

        return Collections.unmodifiableList(interactions);
    }
}