01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s): Alexandre Iline.
25: *
26: * The Original Software is the Jemmy library.
27: * The Initial Developer of the Original Software is Alexandre Iline.
28: * All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: *
41: *
42: *
43: * $Id: KeyDriver.java,v 1.6 2007/10/05 11:36:29 jskrivanek Exp $ $Revision: 1.6 $ $Date: 2007/10/05 11:36:29 $
44: *
45: */
46:
47: package org.netbeans.jemmy.drivers;
48:
49: import org.netbeans.jemmy.Timeout;
50:
51: import org.netbeans.jemmy.operators.ComponentOperator;
52:
53: /**
54: * Defines how to simulate keyboard operations.
55: */
56: public interface KeyDriver {
57:
58: /**
59: * Presses a key.
60: * @param oper Component operator.
61: * @param keyCode Key code (<code>KeyEvent.VK_*</code> value)
62: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
63: */
64: public void pressKey(ComponentOperator oper, int keyCode,
65: int modifiers);
66:
67: /**
68: * Releases a key.
69: * @param oper Component operator.
70: * @param keyCode Key code (<code>KeyEvent.VK_*</code> value)
71: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
72: */
73: public void releaseKey(ComponentOperator oper, int keyCode,
74: int modifiers);
75:
76: /**
77: * Pushes a key.
78: * @param oper Component operator.
79: * @param keyCode Key code (<code>KeyEvent.VK_*</code> value)
80: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
81: * @param pushTime Time between pressing and releasing.
82: */
83: public void pushKey(ComponentOperator oper, int keyCode,
84: int modifiers, Timeout pushTime);
85:
86: /**
87: * Types a symbol.
88: * @param oper Component operator.
89: * @param keyCode Key code (<code>KeyEvent.VK_*</code> value)
90: * @param keyChar Symbol to be typed.
91: * @param modifiers a combination of <code>InputEvent.*_MASK</code> fields.
92: * @param pushTime Time between pressing and releasing.
93: */
94: public void typeKey(ComponentOperator oper, int keyCode,
95: char keyChar, int modifiers, Timeout pushTime);
96: }
|