1 /*
   2  * Copyright (c) 2007, 2017 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  */
  23 
  24 package org.jemmy.input;
  25 
  26 import org.jemmy.interfaces.Button;
  27 import org.jemmy.interfaces.Modifier;
  28 
  29 /**
  30  *
  31  * Defines char-to-key binding.  The generation of a symbol will,
  32  * in general, require modifier keys to be pressed prior to pressing
  33  * a primary key.  Classes that implement <code>CharBindingMap</code>
  34  * communicate what modifiers and primary key are required to generate
  35  * a given symbol.
  36  *
  37  * @param <BUTTON>
  38  * @param <MODIFIER>
  39  * @author Alexandre Iline (alexandre.iline@sun.com)
  40  */
  41 
  42 public interface CharBindingMap<BUTTON extends Button, MODIFIER extends Modifier> {
  43 
  44     /**
  45      * Returns the code of the primary key used to type a symbol.
  46      * @param c Character.
  47      * @return a Button constant.
  48      */
  49     public BUTTON getCharKey(char c);
  50 
  51     /**
  52      * Returns the modifiers that should be pressed to type a symbol.
  53      * @param c Character.
  54      * @return an array of Modifier constants.
  55      */
  56     public MODIFIER[] getCharModifiers(char c);
  57 }