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