org.gjt.sp.jedit.textarea
Class DefaultInputHandler

java.lang.Object
  java.awt.event.KeyAdapter
      org.gjt.sp.jedit.textarea.InputHandler
          org.gjt.sp.jedit.textarea.DefaultInputHandler

All Implemented Interfaces:

java.util.EventListener, java.awt.event.KeyListener

public class DefaultInputHandler

extends InputHandler

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

Version:

$Id: DefaultInputHandler.java,v 1.6 2002/08/09 14:16:38 orangeherbert Exp $

Author:

Slava Pestov

Nested Class Summary

Nested classes inherited from class org.gjt.sp.jedit.textarea.InputHandler

InputHandler.backspace, InputHandler.backspace_word, InputHandler.delete, InputHandler.delete_word, InputHandler.document_end, InputHandler.document_home, InputHandler.end, InputHandler.home, InputHandler.insert_break, InputHandler.insert_char, InputHandler.insert_tab, InputHandler.MacroRecorder, InputHandler.next_char, InputHandler.next_line, InputHandler.next_page, InputHandler.next_word, InputHandler.NonRecordable, InputHandler.NonRepeatable, InputHandler.overwrite, InputHandler.prev_char, InputHandler.prev_line, InputHandler.prev_page, InputHandler.prev_word, InputHandler.repeat, InputHandler.Wrapper

Field Summary

Fields inherited from class org.gjt.sp.jedit.textarea.InputHandler

BACKSPACE, BACKSPACE_WORD, DELETE, DELETE_WORD, DOCUMENT_END, DOCUMENT_HOME, END, grabAction, HOME, inputAction, INSERT_BREAK, INSERT_CHAR, INSERT_TAB, NEXT_CHAR, NEXT_LINE, NEXT_PAGE, NEXT_WORD, OVERWRITE, PREV_CHAR, PREV_LINE, PREV_PAGE, PREV_WORD, recorder, repeat, REPEAT, repeatCount, SELECT_DOC_END, SELECT_DOC_HOME, SELECT_END, SELECT_HOME, SELECT_NEXT_CHAR, SELECT_NEXT_LINE, SELECT_NEXT_PAGE, SELECT_NEXT_WORD, SELECT_PREV_CHAR, SELECT_PREV_LINE, SELECT_PREV_PAGE, SELECT_PREV_WORD, SMART_HOME_END_PROPERTY

Constructor Summary

DefaultInputHandler()
Creates a new input handler with no key bindings defined.

DefaultInputHandler(DefaultInputHandler copy)
Creates a new input handler with the same set of key bindings as the one specified.

Method Summary

void	addDefaultKeyBindings() Sets up the default key bindings.
void	addKeyBinding(java.lang.String keyBinding, java.awt.event.ActionListener action) Adds a key binding to this input handler.
void	keyPressed(java.awt.event.KeyEvent evt) Handle a key pressed event.
void	keyTyped(java.awt.event.KeyEvent evt) Handle a key typed event.
static javax.swing.KeyStroke	parseKeyStroke(java.lang.String keyStroke) Converts a string to a keystroke.
void	removeAllKeyBindings() Removes all key bindings from this input handler.
void	removeKeyBinding(java.lang.String keyBinding) Removes a key binding from this input handler.

Methods inherited from class org.gjt.sp.jedit.textarea.InputHandler

executeAction, executeOneClickAction, getAction, getActionName, getActions, getInputAction, getMacroRecorder, getRepeatCount, getTextArea, grabNextKeyStroke, handleGrabAction, isRepeatEnabled, setInputAction, setMacroRecorder, setRepeatCount, setRepeatEnabled

Methods inherited from class java.awt.event.KeyAdapter

keyReleased

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultInputHandler

public DefaultInputHandler()

Creates a new input handler with no key bindings defined.

DefaultInputHandler

public DefaultInputHandler(DefaultInputHandler copy)

Creates a new input handler with the same set of key bindings as the one specified. Note that both input handlers share a pointer to exactly the same key binding table; so adding a key binding in one will also add it to the other.

Parameters:

copy - The input handler to copy key bindings from

Method Detail

addDefaultKeyBindings

public void addDefaultKeyBindings()

Sets up the default key bindings.

Specified by:

addDefaultKeyBindings in class InputHandler

addKeyBinding

public void addKeyBinding(java.lang.String keyBinding,
                          java.awt.event.ActionListener action)

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)

Specified by:

addKeyBinding in class InputHandler

Parameters:

keyBinding - The key binding

action - The action

removeKeyBinding

public void removeKeyBinding(java.lang.String keyBinding)

Removes a key binding from this input handler. This is not yet implemented.

Specified by:

removeKeyBinding in class InputHandler

Parameters:

keyBinding - The key binding

removeAllKeyBindings

public void removeAllKeyBindings()

Removes all key bindings from this input handler.

Specified by:

removeAllKeyBindings in class InputHandler

keyPressed

public void keyPressed(java.awt.event.KeyEvent evt)

Handle a key pressed event. This will look up the binding for the key stroke and execute it.

keyTyped

public void keyTyped(java.awt.event.KeyEvent evt)

Handle a key typed event. This inserts the key into the text area.

parseKeyStroke

public static javax.swing.KeyStroke parseKeyStroke(java.lang.String keyStroke)

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 keycode name from the KeyEvent class, without the VK_ prefix.

Parameters:

keyStroke - A string description of the key stroke