uk.ac.gate.guk.im
Class GateIM

java.lang.Object
  |
  +--uk.ac.gate.guk.im.GateIM

All Implemented Interfaces:

java.awt.im.spi.InputMethod

public class GateIM

extends java.lang.Object

implements java.awt.im.spi.InputMethod

The Gate input method

Field Summary

(package private) java.util.Map	additionalKeymaps Not used
(package private) java.lang.String	composedText The composed text;
(package private) LocaleHandler	currentHandler The current locale handler.
(package private) java.util.Locale	currentLocale The active locale
(package private) State	currentState The current state of the current LocaleHandler.
(package private) java.util.Locale	defaultLocale The default locale to be used when this method is loaded and no locale is specified.
(package private) boolean	enabled Is this inpuit method enabled?
(package private) static boolean	GIMDEBUG enables or disables output of GimDPrintln
private static java.lang.String	imBase The resource path to the input methods director
private static java.awt.Font	keyboardFont
(package private) static KeyboardMap	keyboardMap The current virtual keyboard map.
(package private) java.util.Map	loadedLocales The locales that have been loaded already.
(package private) boolean	mapVisible Should the keyboard map be visible?
(package private) java.awt.im.spi.InputMethodContext	myContext The input context
(package private) java.util.Map	supportedLocales The available locales (the locales for which a definition file exists).

Constructor Summary

GateIM(java.util.Map supportedLocales)
Constructs a new Gate input method

Method Summary

void	activate() Activates this input method
void	deactivate(boolean isTemporary) Deactivates this input method
void	dispatchEvent(java.awt.AWTEvent event) Called by the system when an input event occures in a component that uses this input method.
void	dispose() Disposes this input method releasing all the memory.
void	endComposition() Ends the curent composition.
java.awt.im.spi.InputMethodContext	getContext() Returns the input context for this input method.
java.lang.Object	getControlObject() Gives the clients a chance to control the bevaviour of this input method by returning a handle to itself.
GateIMDescriptor	getDescriptor() gets the descriptor class for this input method
static java.lang.String	getIMBase() Gets the path inside the classpath where the input methods should be found
static java.awt.Font	getKeyboardFont() returns the current keyboard font, default Arial Unicode MS
java.util.Locale	getLocale() Gets the active locale
static void	GimDPrintln(java.lang.String s) print if debugging enabled...
void	hideWindows() Hides all the windows displayed by the input method.
boolean	isCompositionEnabled() Is this input method enabled?
protected void	loadLocale(java.util.Locale locale) Loads a new locale if it's not already loaded.
void	notifyClientWindowChange(java.awt.Rectangle bounds) Called by the system when the client window has changed size or position.
void	reconvert() Throws a UnsupportedOperationException as this input method does not support recnversion.
void	removeNotify() Called by the system when a client unregisters to this input method.
void	setCharacterSubsets(java.lang.Character.Subset[] subsets) Restricts the character ranges valid for this input method output.
void	setCompositionEnabled(boolean enable) Enables this input method for composition
static void	setIMBase(java.lang.String path) Sets the default path to be used when looking for input methods.
void	setInputMethodContext(java.awt.im.spi.InputMethodContext context) Provides the input method with a context.
static void	setKeyboardFont(java.awt.Font font) sets a new keyboard font
boolean	setLocale(java.util.Locale locale) Selects the active locale
void	setMapVisible(boolean mapvis) Should the virtual keyboard map be visible?

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

GIMDEBUG

static final boolean GIMDEBUG

enables or disables output of GimDPrintln

currentLocale

java.util.Locale currentLocale

The active locale

defaultLocale

java.util.Locale defaultLocale

The default locale to be used when this method is loaded and no locale is specified.

currentHandler

LocaleHandler currentHandler

The current locale handler.

myContext

java.awt.im.spi.InputMethodContext myContext

The input context

supportedLocales

java.util.Map supportedLocales

The available locales (the locales for which a definition file exists).

loadedLocales

java.util.Map loadedLocales

The locales that have been loaded already. Maps from Loacle to LocaleHandler.

enabled

boolean enabled

Is this inpuit method enabled?

composedText

java.lang.String composedText

The composed text;

currentState

State currentState

The current state of the current LocaleHandler.

additionalKeymaps

java.util.Map additionalKeymaps

Not used

keyboardMap

static KeyboardMap keyboardMap

The current virtual keyboard map.

mapVisible

boolean mapVisible

Should the keyboard map be visible?

imBase

private static java.lang.String imBase

The resource path to the input methods director

keyboardFont

private static java.awt.Font keyboardFont

Constructor Detail

GateIM

public GateIM(java.util.Map supportedLocales)

Constructs a new Gate input method

Parameters:

supportedLocales -

Method Detail

GimDPrintln

public static void GimDPrintln(java.lang.String s)

print if debugging enabled...

setInputMethodContext

public void setInputMethodContext(java.awt.im.spi.InputMethodContext context)

Provides the input method with a context. This method is called by the system after the input method is loaded and linked to a text component.

Specified by:

setInputMethodContext in interface java.awt.im.spi.InputMethod

Parameters:

context -

setLocale

public boolean setLocale(java.util.Locale locale)

Selects the active locale

Specified by:

setLocale in interface java.awt.im.spi.InputMethod

Parameters:

locale -

getLocale

public java.util.Locale getLocale()

Gets the active locale

Specified by:

getLocale in interface java.awt.im.spi.InputMethod

getDescriptor

public GateIMDescriptor getDescriptor()

gets the descriptor class for this input method

setCharacterSubsets

public void setCharacterSubsets(java.lang.Character.Subset[] subsets)

Restricts the character ranges valid for this input method output. This is currently ignored by the input method.

Specified by:

setCharacterSubsets in interface java.awt.im.spi.InputMethod

Parameters:

subsets -

setCompositionEnabled

public void setCompositionEnabled(boolean enable)

Enables this input method for composition

Specified by:

setCompositionEnabled in interface java.awt.im.spi.InputMethod

Parameters:

enable -

isCompositionEnabled

public boolean isCompositionEnabled()

Is this input method enabled?

Specified by:

isCompositionEnabled in interface java.awt.im.spi.InputMethod

reconvert

public void reconvert()

Throws a UnsupportedOperationException as this input method does not support recnversion.

Specified by:

reconvert in interface java.awt.im.spi.InputMethod

dispatchEvent

public void dispatchEvent(java.awt.AWTEvent event)

Called by the system when an input event occures in a component that uses this input method. The input method then analyses the input event and sends an input method event to the interested components using the input context provided by the system.

Specified by:

dispatchEvent in interface java.awt.im.spi.InputMethod

Parameters:

event -

notifyClientWindowChange

public void notifyClientWindowChange(java.awt.Rectangle bounds)

Called by the system when the client window has changed size or position. This event is ignored by the input method.

Specified by:

notifyClientWindowChange in interface java.awt.im.spi.InputMethod

Parameters:

bounds -

activate

public void activate()

Activates this input method

Specified by:

activate in interface java.awt.im.spi.InputMethod

deactivate

public void deactivate(boolean isTemporary)

Deactivates this input method

Specified by:

deactivate in interface java.awt.im.spi.InputMethod

Parameters:

isTemporary -

hideWindows

public void hideWindows()

Hides all the windows displayed by the input method. Currently this only includes the virtual keyboard map.

Specified by:

hideWindows in interface java.awt.im.spi.InputMethod

removeNotify

public void removeNotify()

Called by the system when a client unregisters to this input method. This event is currently ignored by the input method.

Specified by:

removeNotify in interface java.awt.im.spi.InputMethod

endComposition

public void endComposition()

Ends the curent composition.

Specified by:

endComposition in interface java.awt.im.spi.InputMethod

dispose

public void dispose()

Disposes this input method releasing all the memory.

Specified by:

dispose in interface java.awt.im.spi.InputMethod

getControlObject

public java.lang.Object getControlObject()

Gives the clients a chance to control the bevaviour of this input method by returning a handle to itself.

Specified by:

getControlObject in interface java.awt.im.spi.InputMethod

Returns:

a reference to this input method

setMapVisible

public void setMapVisible(boolean mapvis)

Should the virtual keyboard map be visible?

Parameters:

mapvis -

loadLocale

protected void loadLocale(java.util.Locale locale)

Loads a new locale if it's not already loaded.

Parameters:

locale -

getContext

public java.awt.im.spi.InputMethodContext getContext()

Returns the input context for this input method.

setIMBase

public static void setIMBase(java.lang.String path)

Sets the default path to be used when looking for input methods. This should be a resource path (a path inside the class path). By default the path is "/uk/ac/gate/guk/im/data/" (changed to be globally unique!)

Parameters:

path - The path where im.list and the *.gim files are.

getIMBase

public static java.lang.String getIMBase()

Gets the path inside the classpath where the input methods should be found

getKeyboardFont

public static java.awt.Font getKeyboardFont()

returns the current keyboard font, default Arial Unicode MS

setKeyboardFont

public static void setKeyboardFont(java.awt.Font font)

sets a new keyboard font