KeyTranslatorImpl (Nenya Core 1.6.1 API)

java.lang.Object
- com.threerings.util.KeyTranslatorImpl

All Implemented Interfaces:

KeyTranslator
```
public class KeyTranslatorImpl
extends Object
implements KeyTranslator
```
A basic implementation of the KeyTranslator interface that provides facilities for mapping key codes to action command strings for use by the KeyboardManager.

Constructor Summary

Constructors
Constructor and Description

KeyTranslatorImpl()

Constructors
Constructor and Description
`KeyTranslatorImpl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPressCommand(int keyCode, String command)` Adds a mapping from a key press to an action command string that will auto-repeat at a default repeat rate.
`void`	`addPressCommand(int keyCode, String command, int rate)` Adds a mapping from a key press to an action command string that will auto-repeat at the specified repeat rate.
`void`	`addPressCommand(int keyCode, String command, int rate, long repeatDelay)` Adds a mapping from a key press to an action command string that will auto-repeat at the specified repeat rate after the specified auto-repeat delay has expired.
`void`	`addReleaseCommand(int keyCode, String command)` Adds a mapping from a key release to an action command string.
`Iterator<String>`	`enumeratePressCommands()` Returns an iterator that iterates over the available press commands.
`Iterator<String>`	`enumerateReleaseCommands()` Returns an iterator that iterates over the available release commands.
`String`	`getPressCommand(char ch)` Returns the action command string associated with a key press of the given character, or `null` if there is no associated command.
`String`	`getPressCommand(int keyCode)` Returns the action command string associated with a key press of the key corresponding to the given key code, or `null` if there is no associated command.
`String`	`getReleaseCommand(char ch)` Returns the action command string associated with a key release of the given character, or `null` if there is no associated command.
`String`	`getReleaseCommand(int keyCode)` Returns the action command string associated with a key release of the key corresponding to the given key code, or `null` if there is no associated command.
`long`	`getRepeatDelay(char ch)` Returns the delay in milliseconds before generating auto-repeated key press events for the specified key.
`long`	`getRepeatDelay(int keyCode)` Returns the delay in milliseconds before generating auto-repeated key press events for the specified key.
`int`	`getRepeatRate(char ch)` Returns the number of times each second that key presses are to be automatically repeated while the key is held down, or `0` to disable auto-repeat for the key.
`int`	`getRepeatRate(int keyCode)` Returns the number of times each second that key presses are to be automatically repeated while the key is held down, or `0` to disable auto-repeat for the key.
`boolean`	`hasCommand(char ch)` Returns whether there is an action command for the key corresponding to the given character in the case of a keyTyped event corresponding to it.
`boolean`	`hasCommand(int keyCode)` Returns whether there is an action command for the key corresponding to the given keycode.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - KeyTranslatorImpl
```
public KeyTranslatorImpl()
```
- Method Detail
  - addPressCommand
```
public void addPressCommand(int keyCode,
                            String command)
```
    Adds a mapping from a key press to an action command string that will auto-repeat at a default repeat rate.
  - addPressCommand
```
public void addPressCommand(int keyCode,
                            String command,
                            int rate)
```
    Adds a mapping from a key press to an action command string that will auto-repeat at the specified repeat rate. Overwrites any existing mapping and repeat rate that may have already been registered.
    
    Parameters:
    
    rate - the number of times each second that the key press should be repeated while the key is down, or 0 to disable auto-repeat for the key.
  - addPressCommand
```
public void addPressCommand(int keyCode,
                            String command,
                            int rate,
                            long repeatDelay)
```
    Adds a mapping from a key press to an action command string that will auto-repeat at the specified repeat rate after the specified auto-repeat delay has expired. Overwrites any existing mapping for the specified key code that may have already been registered.
    
    Parameters:
    
    rate - the number of times each second that the key press should be repeated while the key is down; passing 0 will result in no repeating.
    
    repeatDelay - the delay in milliseconds before auto-repeating key press events will be generated for the key.
  - addReleaseCommand
```
public void addReleaseCommand(int keyCode,
                              String command)
```
    Adds a mapping from a key release to an action command string. Overwrites any existing mapping that may already have been registered.
  - hasCommand
```
public boolean hasCommand(int keyCode)
```
    Description copied from interface: KeyTranslator
    
    Returns whether there is an action command for the key corresponding to the given keycode. The translator may have an action command for either a key press or a key release of the key, or both.
    
    Specified by:
    
    hasCommand in interface KeyTranslator
  - hasCommand
```
public boolean hasCommand(char ch)
```
    Description copied from interface: KeyTranslator
    
    Returns whether there is an action command for the key corresponding to the given character in the case of a keyTyped event corresponding to it.
    
    Specified by:
    
    hasCommand in interface KeyTranslator
  - getPressCommand
```
public String getPressCommand(int keyCode)
```
    Description copied from interface: KeyTranslator
    
    Returns the action command string associated with a key press of the key corresponding to the given key code, or null if there is no associated command.
    
    Specified by:
    
    getPressCommand in interface KeyTranslator
  - getPressCommand
```
public String getPressCommand(char ch)
```
    Description copied from interface: KeyTranslator
    
    Returns the action command string associated with a key press of the given character, or null if there is no associated command.
    
    Specified by:
    
    getPressCommand in interface KeyTranslator
  - getReleaseCommand
```
public String getReleaseCommand(int keyCode)
```
    Description copied from interface: KeyTranslator
    
    Returns the action command string associated with a key release of the key corresponding to the given key code, or null if there is no associated command.
    
    Specified by:
    
    getReleaseCommand in interface KeyTranslator
  - getReleaseCommand
```
public String getReleaseCommand(char ch)
```
    Description copied from interface: KeyTranslator
    
    Returns the action command string associated with a key release of the given character, or null if there is no associated command.
    
    Specified by:
    
    getReleaseCommand in interface KeyTranslator
  - getRepeatRate
```
public int getRepeatRate(int keyCode)
```
    Description copied from interface: KeyTranslator
    
    Returns the number of times each second that key presses are to be automatically repeated while the key is held down, or 0 to disable auto-repeat for the key.
    
    Specified by:
    
    getRepeatRate in interface KeyTranslator
  - getRepeatRate
```
public int getRepeatRate(char ch)
```
    Description copied from interface: KeyTranslator
    
    Returns the number of times each second that key presses are to be automatically repeated while the key is held down, or 0 to disable auto-repeat for the key.
    
    Specified by:
    
    getRepeatRate in interface KeyTranslator
  - getRepeatDelay
```
public long getRepeatDelay(int keyCode)
```
    Description copied from interface: KeyTranslator
    
    Returns the delay in milliseconds before generating auto-repeated key press events for the specified key.
    
    Specified by:
    
    getRepeatDelay in interface KeyTranslator
  - getRepeatDelay
```
public long getRepeatDelay(char ch)
```
    Description copied from interface: KeyTranslator
    
    Returns the delay in milliseconds before generating auto-repeated key press events for the specified key.
    
    Specified by:
    
    getRepeatDelay in interface KeyTranslator
  - enumeratePressCommands
```
public Iterator<String> enumeratePressCommands()
```
    Description copied from interface: KeyTranslator
    
    Returns an iterator that iterates over the available press commands.
    
    Specified by:
    
    enumeratePressCommands in interface KeyTranslator
  - enumerateReleaseCommands
```
public Iterator<String> enumerateReleaseCommands()
```
    Description copied from interface: KeyTranslator
    
    Returns an iterator that iterates over the available release commands.
    
    Specified by:
    
    enumerateReleaseCommands in interface KeyTranslator

Class KeyTranslatorImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyTranslatorImpl

Method Detail

addPressCommand

addPressCommand

addPressCommand

addReleaseCommand

hasCommand

hasCommand

getPressCommand

getPressCommand

getReleaseCommand

getReleaseCommand

getRepeatRate

getRepeatRate

getRepeatDelay

getRepeatDelay

enumeratePressCommands

enumerateReleaseCommands