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