uk.ac.gate.guk.im
Class GateIMDescriptor

java.lang.Object
  |
  +--uk.ac.gate.guk.im.GateIMDescriptor
All Implemented Interfaces:
java.awt.im.spi.InputMethodDescriptor

public class GateIMDescriptor
extends java.lang.Object
implements java.awt.im.spi.InputMethodDescriptor

Provides a way for the Gate input method to be discovered by the system.

See Also:
java.awt.im, java.awt.im.spi

Field Summary
(package private)  java.util.Map supportedLocales
          The available locales.
 
Constructor Summary
GateIMDescriptor()
          Default constructor.
 
Method Summary
 java.awt.im.spi.InputMethod createInputMethod()
          Creates a new GateIM object and returns a handle.
 java.util.Locale[] getAvailableLocales()
          Gets an Array with the locales supported by the Gate input method.
 java.lang.String getInputMethodDisplayName(java.util.Locale inputLocale, java.util.Locale displayLanguage)
          Returns the display name for the input method for a given locale.
 java.awt.Image getInputMethodIcon(java.util.Locale inputLocale)
          Provides an icon for the gate input method.
 boolean hasDynamicLocaleList()
          Is the available locales list dynamic.
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

supportedLocales

java.util.Map supportedLocales
The available locales. Maps from locale to filename.
Constructor Detail

GateIMDescriptor

public GateIMDescriptor()
Default constructor.
Method Detail

getAvailableLocales

public java.util.Locale[] getAvailableLocales()
                                       throws java.awt.AWTException
Gets an Array with the locales supported by the Gate input method.
Specified by:
getAvailableLocales in interface java.awt.im.spi.InputMethodDescriptor
Throws:
java.awt.AWTException -  

hasDynamicLocaleList

public boolean hasDynamicLocaleList()
Is the available locales list dynamic. Always returns false;
Specified by:
hasDynamicLocaleList in interface java.awt.im.spi.InputMethodDescriptor

getInputMethodDisplayName

public java.lang.String getInputMethodDisplayName(java.util.Locale inputLocale,
                                                  java.util.Locale displayLanguage)
Returns the display name for the input method for a given locale.
Specified by:
getInputMethodDisplayName in interface java.awt.im.spi.InputMethodDescriptor
Parameters:
inputLocale - the locale for which the display name is sought
displayLanguage - the current locale to be used for displaying the name

getInputMethodIcon

public java.awt.Image getInputMethodIcon(java.util.Locale inputLocale)
Provides an icon for the gate input method.
Specified by:
getInputMethodIcon in interface java.awt.im.spi.InputMethodDescriptor
Parameters:
inputLocale -  

createInputMethod

public java.awt.im.spi.InputMethod createInputMethod()
                                              throws java.lang.Exception
Creates a new GateIM object and returns a handle.
Specified by:
createInputMethod in interface java.awt.im.spi.InputMethodDescriptor
Throws:
java.lang.Exception -