guk.im
Class LocaleHandler

java.lang.Object
  |
  +--guk.im.LocaleHandler

public class LocaleHandler
extends Object

A Handler for a locale. A locale handler is actually a finite state machine (FSM) that maps input events (presseed keys) to other input events(typed characters).


Field Summary
(package private)  State initialState
          The initial state of the fsm.
(package private)  Map keycap
          maps from string (the English description of the key) to string (the string to be displayed on the key)
(package private)  Locale locale
          The locale this handler handles.
 
Constructor Summary
LocaleHandler(Locale locale, String fileName)
          Creates a locale handler for a given locale using the definitions from the file provided.
 
Method Summary
protected  State addAction(String keyDesc, String textToAdd, String keycapStr)
           
 State getInitialState()
          The initial state of the FSM.
 Map getKeyCap()
          Gets the map with the keycaps (the strings to be painted on virtual keys).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

initialState

State initialState
The initial state of the fsm.


keycap

Map keycap
maps from string (the English description of the key) to string (the string to be displayed on the key)


locale

Locale locale
The locale this handler handles.

Constructor Detail

LocaleHandler

public LocaleHandler(Locale locale,
                     String fileName)
              throws IOException
Creates a locale handler for a given locale using the definitions from the file provided.

Parameters:
locale -
fileName -
Throws:
IOException
Method Detail

addAction

protected State addAction(String keyDesc,
                          String textToAdd,
                          String keycapStr)
Parameters:
keyDesc -
textToAdd -
keycapStr -

getInitialState

public State getInitialState()
The initial state of the FSM.


getKeyCap

public Map getKeyCap()
Gets the map with the keycaps (the strings to be painted on virtual keys).