KeyDriver.java revision 13978:1993af50385d 
1/*
2 * Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23package org.netbeans.jemmy.drivers;
24
25import org.netbeans.jemmy.Timeout;
26import org.netbeans.jemmy.operators.ComponentOperator;
27
28/**
29 * Defines how to simulate keyboard operations.
30 */
31public interface KeyDriver {
32
33    /**
34     * Presses a key.
35     *
36     * @param oper Component operator.
37     * @param keyCode Key code ({@code KeyEvent.VK_*} value)
38     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
39     */
40    public void pressKey(ComponentOperator oper, int keyCode, int modifiers);
41
42    /**
43     * Typed a key.
44     *
45     * @param oper Component operator.
46     * @param keyChar Symbol to be typed.
47     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
48     */
49    public void typedKey(ComponentOperator oper, int keyCode, char keyChar, int modifiers);
50
51    /**
52     * Releases a key.
53     *
54     * @param oper Component operator.
55     * @param keyCode Key code ({@code KeyEvent.VK_*} value)
56     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
57     */
58    public void releaseKey(ComponentOperator oper, int keyCode, int modifiers);
59
60    /**
61     * Pushes a key.
62     *
63     * @param oper Component operator.
64     * @param keyCode Key code ({@code KeyEvent.VK_*} value)
65     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
66     * @param pushTime Time between pressing and releasing.
67     */
68    public void pushKey(ComponentOperator oper, int keyCode, int modifiers, Timeout pushTime);
69
70    /**
71     * Types a symbol.
72     *
73     * @param oper Component operator.
74     * @param keyCode Key code ({@code KeyEvent.VK_*} value)
75     * @param keyChar Symbol to be typed.
76     * @param modifiers a combination of {@code InputEvent.*_MASK} fields.
77     * @param pushTime Time between pressing and releasing.
78     */
79    public void typeKey(ComponentOperator oper, int keyCode, char keyChar, int modifiers, Timeout pushTime);
80}
81