KeyEventDriver.java

/*
 * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.netbeans.jemmy.drivers.input;

import java.awt.Component;
import java.awt.event.KeyEvent;

import org.netbeans.jemmy.Timeout;
import org.netbeans.jemmy.drivers.KeyDriver;
import org.netbeans.jemmy.operators.ComponentOperator;

/**
 * KeyDriver using event dispatching.
 *
 * @author Alexandre Iline(alexandre.iline@oracle.com)
 */
public class KeyEventDriver extends EventDriver implements KeyDriver {

    /**
     * Constructs a KeyEventDriver object.
     *
     * @param supported an array of supported class names
     */
    public KeyEventDriver(String[] supported) {
        super(supported);
    }

    /**
     * Constructs an KeyEventDriver object suporting ComponentOperator.
     */
    public KeyEventDriver() {
        super();
    }

    @Override
    public void pressKey(ComponentOperator oper, int keyCode, int modifiers) {
        pressKey(findNativeParent(oper.getSource()), keyCode, modifiers);
    }

    @Override
    public void typedKey(ComponentOperator oper, int keyCode, char keyChar, int modifiers) {
        typedKey(findNativeParent(oper.getSource()), keyChar, modifiers);
    }

    @Override
    public void releaseKey(ComponentOperator oper, int keyCode, int modifiers) {
        releaseKey(findNativeParent(oper.getSource()), keyCode, modifiers);
    }

    @Override
    public void pushKey(ComponentOperator oper, int keyCode, int modifiers, Timeout pushTime) {
        Component nativeContainer = findNativeParent(oper.getSource());
        pressKey(nativeContainer, keyCode, modifiers);
        pushTime.sleep();
        releaseKey(nativeContainer, keyCode, modifiers);
    }

    @Override
    public void typeKey(ComponentOperator oper, int keyCode, char keyChar, int modifiers, Timeout pushTime) {
        Component nativeContainer = findNativeParent(oper.getSource());
        pressKey(nativeContainer, keyCode, modifiers);
        pushTime.sleep();
        typedKey(nativeContainer, keyChar, modifiers);
        releaseKey(nativeContainer, keyCode, modifiers);
    }

    @Deprecated
    private void pressKey(Component nativeContainer, int keyCode, int modifiers) {
        dispatchEvent(nativeContainer,
                new KeyEvent(nativeContainer,
                        KeyEvent.KEY_PRESSED,
                        System.currentTimeMillis(),
                        modifiers, keyCode));
    }

    private void typedKey(Component nativeContainer, char keyChar, int modifiers) {
        dispatchEvent(nativeContainer,
                new KeyEvent(nativeContainer,
                        KeyEvent.KEY_TYPED,
                        System.currentTimeMillis(),
                        modifiers, KeyEvent.VK_UNDEFINED, keyChar));
    }

    @Deprecated
    private void releaseKey(Component nativeContainer, int keyCode, int modifiers) {
        dispatchEvent(nativeContainer,
                new KeyEvent(nativeContainer,
                        KeyEvent.KEY_RELEASED,
                        System.currentTimeMillis(),
                        modifiers, keyCode));
    }

    private Component findNativeParent(Component source) {
        Component nativeOne = source;
        while (nativeOne != null) {
            if (!nativeOne.isLightweight()) {
                return nativeOne;
            }
            nativeOne = nativeOne.getParent();
        }
        return source;
    }
}