The default input handler. More...

Inheritance diagram for net.sf.gridarta.textedit.textarea.DefaultInputHandler:

Collaboration diagram for net.sf.gridarta.textedit.textarea.DefaultInputHandler:

Public Member Functions
void	addDefaultKeyBindings ()
	Sets up the default key bindings. More...

InputHandler	copy ()
	Returns a copy of this input handler that shares the same key bindings. More...

	DefaultInputHandler (@NotNull final ScriptEditControl scriptEditControl, @NotNull final MenuEntries menuEntries)
	Creates a new input handler with no key bindings defined. More...

void	keyPressed (final KeyEvent e)
	Handle a key pressed event. More...

void	keyReleased (final KeyEvent e)

void	keyTyped (final KeyEvent e)
	Handle a key typed event. More...

Public Member Functions inherited from net.sf.gridarta.textedit.textarea.InputHandler
abstract void	addDefaultKeyBindings ()
	Adds the default key bindings to this input handler. More...

abstract InputHandler	copy ()
	Returns a copy of this input handler that shares the same key bindings. More...

void	executeAction (final ActionListener listener, final Object source, @Nullable final String actionCommand)
	Executes the specified action, repeating and recording it as necessary. More...

int	getRepeatCount ()
	Returns the number of times the next action will be repeated. More...

boolean	isRepeatEnabled ()
	Returns if repetition is enabled. More...

void	setRepeatCount (final int repeatCount)
	Sets the number of times the next action will be repeated. More...

void	setRepeatEnabled (final boolean repeat)
	Sets the enabled state of repetition. More...

Private Member Functions
void	addKeyBinding (final String keyBinding, final ActionListener action)
	Adds a key binding to this input handler. More...

	DefaultInputHandler (final DefaultInputHandler copy)

Static Private Member Functions
static KeyStroke	parseKeyStroke (final String keyStroke)
	Converts a string to a keystroke. More...

Private Attributes
final Map< KeyStroke, ActionListener >	bindings

final InputActions	inputActions

Static Private Attributes
static final Category	LOG = Logger.getLogger(DefaultInputHandler.class)
	The Logger for printing log messages. More...

Additional Inherited Members
Static Public Member Functions inherited from net.sf.gridarta.textedit.textarea.InputHandler
static JEditTextArea	getTextArea (final EventObject evt)
	Returns the text area that fired the specified event. More...

Protected Member Functions inherited from net.sf.gridarta.textedit.textarea.InputHandler
boolean	handleGrabAction (final KeyEvent evt)
	If a key is being grabbed, this method should be called with the appropriate key event. More...

Protected Attributes inherited from net.sf.gridarta.textedit.textarea.InputHandler
int	repeatCount

Detailed Description

The default input handler.

It maps sequences of keystrokes into actions and inserts key typed events into the text area.

Author: Slava Pestov; Andreas Vogl

Definition at line 33 of file DefaultInputHandler.java.

Constructor & Destructor Documentation

◆ DefaultInputHandler() [1/2]

net.sf.gridarta.textedit.textarea.DefaultInputHandler.DefaultInputHandler	(	@NotNull final ScriptEditControl	scriptEditControl,
		@NotNull final MenuEntries	menuEntries
	)

Creates a new input handler with no key bindings defined.

Parameters

scriptEditControl	the script edit control to affect
menuEntries	the menu entries to include in the function list popup

Definition at line 52 of file DefaultInputHandler.java.

Referenced by net.sf.gridarta.textedit.textarea.DefaultInputHandler.copy().

Here is the caller graph for this function:

◆ DefaultInputHandler() [2/2]

net.sf.gridarta.textedit.textarea.DefaultInputHandler.DefaultInputHandler ( final DefaultInputHandler copy )

private

Definition at line 262 of file DefaultInputHandler.java.

References net.sf.gridarta.textedit.textarea.DefaultInputHandler.bindings, and net.sf.gridarta.textedit.textarea.DefaultInputHandler.inputActions.

Member Function Documentation

◆ addDefaultKeyBindings()

void net.sf.gridarta.textedit.textarea.DefaultInputHandler.addDefaultKeyBindings ( )

Sets up the default key bindings.

Definition at line 61 of file DefaultInputHandler.java.

Here is the call graph for this function:

◆ addKeyBinding()

void net.sf.gridarta.textedit.textarea.DefaultInputHandler.addKeyBinding	(	final String	keyBinding,
		final ActionListener	action
	)

private

Adds a key binding to this input handler.

The key binding is a list of white space separated key strokes of the form [modifiers+]key where modifier is C for Control, A for Alt, or S for Shift, and key is either a character (a-z) or a field name in the KeyEvent class prefixed with VK_ (e.g., BACK_SPACE)

Parameters

keyBinding	the key binding
action	the action

Definition at line 114 of file DefaultInputHandler.java.

References net.sf.gridarta.textedit.textarea.DefaultInputHandler.parseKeyStroke().

Referenced by net.sf.gridarta.textedit.textarea.DefaultInputHandler.addDefaultKeyBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copy()

InputHandler net.sf.gridarta.textedit.textarea.DefaultInputHandler.copy ( )

Returns a copy of this input handler that shares the same key bindings.

Setting key bindings in the copy will also set them in the original.

Definition at line 126 of file DefaultInputHandler.java.

References net.sf.gridarta.textedit.textarea.DefaultInputHandler.DefaultInputHandler().

Here is the call graph for this function:

◆ keyPressed()

void net.sf.gridarta.textedit.textarea.DefaultInputHandler.keyPressed ( final KeyEvent e )

Handle a key pressed event.

This will look up the binding for the key stroke and execute it.

Definition at line 135 of file DefaultInputHandler.java.

References net.sf.gridarta.textedit.textarea.InputHandler.executeAction(), and net.sf.gridarta.textedit.textarea.InputHandler.handleGrabAction().

Here is the call graph for this function:

◆ keyReleased()

void net.sf.gridarta.textedit.textarea.DefaultInputHandler.keyReleased ( final KeyEvent e )

Definition at line 158 of file DefaultInputHandler.java.

◆ keyTyped()

void net.sf.gridarta.textedit.textarea.DefaultInputHandler.keyTyped ( final KeyEvent e )

Handle a key typed event.

This inserts the key into the text area.

Definition at line 165 of file DefaultInputHandler.java.

References net.sf.gridarta.textedit.textarea.InputHandler.executeAction(), net.sf.gridarta.textedit.textarea.InputHandler.handleGrabAction(), net.sf.gridarta.textedit.textarea.actions.InputActions.insertChar, net.sf.gridarta.textedit.textarea.InputHandler.isRepeatEnabled(), net.sf.gridarta.textedit.textarea.InputHandler.repeatCount, and net.sf.gridarta.textedit.textarea.InputHandler.setRepeatEnabled().

Here is the call graph for this function:

◆ parseKeyStroke()

static KeyStroke net.sf.gridarta.textedit.textarea.DefaultInputHandler.parseKeyStroke ( final String keyStroke )

staticprivate

Converts a string to a keystroke.

The string should be of the form modifiers+shortcut where modifiers is any combination of A for Alt, C for Control, S for Shift or M for Meta, and shortcut is either a single character, or a key code name from the

KeyEvent

class, without the

VK_

prefix.

Parameters

keyStroke a string description of the key stroke

Returns: the key stroke or
null
if invalid

Definition at line 208 of file DefaultInputHandler.java.

Referenced by net.sf.gridarta.textedit.textarea.DefaultInputHandler.addKeyBinding().

Here is the caller graph for this function:

Member Data Documentation

◆ bindings

final Map<KeyStroke, ActionListener> net.sf.gridarta.textedit.textarea.DefaultInputHandler.bindings

private

Definition at line 36 of file DefaultInputHandler.java.

Referenced by net.sf.gridarta.textedit.textarea.DefaultInputHandler.DefaultInputHandler().

◆ inputActions

final InputActions net.sf.gridarta.textedit.textarea.DefaultInputHandler.inputActions

private

Definition at line 44 of file DefaultInputHandler.java.

Referenced by net.sf.gridarta.textedit.textarea.DefaultInputHandler.DefaultInputHandler().

◆ LOG

final Category net.sf.gridarta.textedit.textarea.DefaultInputHandler.LOG = Logger.getLogger(DefaultInputHandler.class)

staticprivate

The Logger for printing log messages.

Definition at line 41 of file DefaultInputHandler.java.

The documentation for this class was generated from the following file:

gridarta-gridarta/src/textedit/src/main/java/net/sf/gridarta/textedit/textarea/DefaultInputHandler.java

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultInputHandler() [1/2]

◆ DefaultInputHandler() [2/2]

Member Function Documentation

◆ addDefaultKeyBindings()

◆ addKeyBinding()

◆ copy()

◆ keyPressed()

◆ keyReleased()

◆ keyTyped()

◆ parseKeyStroke()

Member Data Documentation

◆ bindings

◆ inputActions

◆ LOG