Forge - Shell API 1.2.0.Final

org.jboss.forge.shell.integration
Interface KeyListener


public interface KeyListener

A priority key listener. KeyListeners are always called before the shell system processes the key strokes. This provides the key listener the ability to override control.

Note: KeyListeners should *not* be used for creating interactive prompts. Use Shell.scan() instead. This facility if for overriding the default behavior of the shell itself.

Author:
Mike Brock

Method Summary
 boolean keyPress(int key)
          Called for every keystroke in the shell.
 

Method Detail

keyPress

boolean keyPress(int key)
Called for every keystroke in the shell.

Parameters:
key - the character value
Returns:
boolean indicating whether control is overridden (true prevents propagation; false is default behavior)

Forge - Shell API 1.2.0.Final

Copyright © 2013 JBoss by Red Hat. All Rights Reserved.