Class KeyMap

java.lang.Object

jline.console.KeyMap

public class KeyMap
extends Object

The KeyMap class contains all bindings from keys to operations.

Since:

2.6

Field Summary

Fields

Modifier and Type	Field	Description
private Object	anotherKey
static final char	CTRL_CB
static final char	CTRL_D
static final char	CTRL_G
static final char	CTRL_H
static final char	CTRL_I
static final char	CTRL_J
static final char	CTRL_M
static final char	CTRL_OB
static final char	CTRL_R
static final char	CTRL_S
static final char	CTRL_U
static final char	CTRL_X
static final char	CTRL_Y
static final int	DELETE
static final String	EMACS
static final String	EMACS_CTLX
static final String	EMACS_META
static final String	EMACS_STANDARD
static final char	ESCAPE
private static final int	KEYMAP_LENGTH
private Object[]	mapping
private String	name
private static final Object	NULL_FUNCTION
static final String	VI_INSERT
static final String	VI_MOVE

Constructor Summary

Constructors

Modifier	Constructor	Description
	KeyMap(String name)
	KeyMap(String name, boolean unused)	Deprecated.
protected	KeyMap(String name, Object[] mapping)

Method Summary

Modifier and Type	Method	Description
void	bind(CharSequence keySeq, Object function)
private static void	bind(KeyMap map, CharSequence keySeq, Object function)
private static void	bind(KeyMap map, CharSequence keySeq, Object function, boolean onlyIfNotBound)
private static void	bindArrowKeys(KeyMap map)
void	bindIfNotBound(CharSequence keySeq, Object function)
static KeyMap	emacs()
static KeyMap	emacsCtrlX()
static KeyMap	emacsMeta()
void	from(KeyMap other)
Object	getAnotherKey()
Object	getBound(CharSequence keySeq)
String	getName()
static boolean	isMeta(char c)
static Map<String,KeyMap>	keyMaps()
static char	meta(char c)
void	setBlinkMatchingParen(boolean on)
static char	unMeta(char c)
static KeyMap	viInsertion()
static KeyMap	viMovement()

Methods inherited from class Object

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

Field Details

VI_MOVE

public static final String VI_MOVE

See Also:

• Constant Field Values

VI_INSERT

public static final String VI_INSERT

See Also:

• Constant Field Values

EMACS

public static final String EMACS

See Also:

• Constant Field Values

EMACS_STANDARD

public static final String EMACS_STANDARD

See Also:

• Constant Field Values

EMACS_CTLX

public static final String EMACS_CTLX

See Also:

• Constant Field Values

EMACS_META

public static final String EMACS_META

See Also:

• Constant Field Values

KEYMAP_LENGTH

private static final int KEYMAP_LENGTH

See Also:

• Constant Field Values

NULL_FUNCTION

private static final Object NULL_FUNCTION

mapping

private Object[] mapping

anotherKey

private Object anotherKey

name

private String name

CTRL_D

public static final char CTRL_D

See Also:

• Constant Field Values

CTRL_G

public static final char CTRL_G

See Also:

• Constant Field Values

CTRL_H

public static final char CTRL_H

See Also:

• Constant Field Values

CTRL_I

public static final char CTRL_I

See Also:

• Constant Field Values

CTRL_J

public static final char CTRL_J

See Also:

• Constant Field Values

CTRL_M

public static final char CTRL_M

See Also:

• Constant Field Values

CTRL_R

public static final char CTRL_R

See Also:

• Constant Field Values

CTRL_S

public static final char CTRL_S

See Also:

• Constant Field Values

CTRL_U

public static final char CTRL_U

See Also:

• Constant Field Values

CTRL_X

public static final char CTRL_X

See Also:

• Constant Field Values

CTRL_Y

public static final char CTRL_Y

See Also:

• Constant Field Values

ESCAPE

public static final char ESCAPE

See Also:

• Constant Field Values

CTRL_OB

public static final char CTRL_OB

See Also:

• Constant Field Values

CTRL_CB

public static final char CTRL_CB

See Also:

• Constant Field Values

DELETE

public static final int DELETE

See Also:

• Constant Field Values

Constructor Details

KeyMap

public KeyMap(String name)

KeyMap

@Deprecated
public KeyMap(String name,
 boolean unused)

Deprecated.

KeyMap

protected KeyMap(String name,
 Object[] mapping)

Method Details

getName

public String getName()

getAnotherKey

public Object getAnotherKey()

from

public void from(KeyMap other)

getBound

public Object getBound(CharSequence keySeq)

bindIfNotBound

public void bindIfNotBound(CharSequence keySeq,
 Object function)

bind

public void bind(CharSequence keySeq,
 Object function)

bind

private static void bind(KeyMap map,
 CharSequence keySeq,
 Object function)

bind

private static void bind(KeyMap map,
 CharSequence keySeq,
 Object function,
 boolean onlyIfNotBound)

setBlinkMatchingParen

public void setBlinkMatchingParen(boolean on)

bindArrowKeys

private static void bindArrowKeys(KeyMap map)

isMeta

public static boolean isMeta(char c)

unMeta

public static char unMeta(char c)

meta

public static char meta(char c)

keyMaps

public static Map<String,KeyMap> keyMaps()

emacs

public static KeyMap emacs()

emacsCtrlX

public static KeyMap emacsCtrlX()

emacsMeta

public static KeyMap emacsMeta()

viInsertion

public static KeyMap viInsertion()

viMovement

public static KeyMap viMovement()