uk.ac.essex.common.keymapper
Interface KeyMapService

All Superinterfaces:

Service

All Known Implementing Classes:

KeyMapServiceImpl

public interface KeyMapService
extends Service

Date: 15-Jul-2002

Field Summary

static java.lang.String

DEFAULT_KEY_MAP_NAME The default key map should always be available so this is its name

Method Summary

void	add(java.io.File xmlFile) Load the keymap from the file given
void	add(java.io.Reader reader) Load the keymap from the stream given
void	addAll(java.io.File directoryToLoadFrom) Loads all xml files from the given directory
KeyMap	getKeyMap(java.lang.String keyMapId) Get the keymap with the given id
java.lang.String[]	getKeyMapNames() Get an array of the key map names that are available

Methods inherited from interface uk.ac.essex.common.Service

destroy, initialise

Field Detail

DEFAULT_KEY_MAP_NAME

static final java.lang.String DEFAULT_KEY_MAP_NAME

The default key map should always be available so this is its name

See Also:

Constant Field Values

Method Detail

add

void add(java.io.File xmlFile)

Load the keymap from the file given

Parameters:

xmlFile -

add

void add(java.io.Reader reader)

Load the keymap from the stream given

Parameters:

reader - - The stream

addAll

void addAll(java.io.File directoryToLoadFrom)

Loads all xml files from the given directory

Parameters:

directoryToLoadFrom -

getKeyMap

KeyMap getKeyMap(java.lang.String keyMapId)

Get the keymap with the given id

Parameters:

keyMapId -

Returns:

getKeyMapNames

java.lang.String[] getKeyMapNames()

Get an array of the key map names that are available

Returns: