Module jEdit

Package org.jedit.keymap

Interface KeymapManager

All Known Implementing Classes:

KeymapManagerImpl

public interface KeymapManager

Since:

jEdit 5.0

Author:

Matthieu Casanova

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	KeymapManager.State	The states of the keymaps

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_KEYMAP_NAME

Method Summary

Modifier and Type	Method	Description
boolean	copyKeymap(String name, String newName)	Copy the keymap to another one
void	deleteUserKeymap(String name)	Delete a user keymap.
Keymap	getKeymap()	Returns the current keymap.
Keymap	getKeymap(String name)	Returns the keymap with that name.
Collection<String>	getKeymapNames()
KeymapManager.State	getKeymapState(String name)	Returns the state of the keymap
void	reload()
void	resetKeymap(String name)	Reset the keymap to it's original state if it was a modified system keymap

Field Details

DEFAULT_KEYMAP_NAME

static final String DEFAULT_KEYMAP_NAME

See Also:

• Constant Field Values

Method Details

getKeymap

Keymap getKeymap()

Returns the current keymap.

Returns:

the current keymap

reload

void reload()

getKeymapNames

Collection<String> getKeymapNames()

getKeymap

Keymap getKeymap(String name)

Returns the keymap with that name.

Parameters:

name - the keymap name

Returns:

the user keymap of that name, if it exists, or the system keymap if it doesn't. If none exists null is returned

getKeymapState

KeymapManager.State getKeymapState(String name)

Returns the state of the keymap

Parameters:

name - the name of the keymap

Returns:

a state.

resetKeymap

void resetKeymap(String name)

Reset the keymap to it's original state if it was a modified system keymap

Parameters:

name - the keymap name

deleteUserKeymap

void deleteUserKeymap(String name)

Delete a user keymap.

Parameters:

name - the keymap name

copyKeymap

boolean copyKeymap(String name,
 String newName)

Copy the keymap to another one

Parameters:

name - the original keymap

newName - the new keymap