Package de.lessvoid.nifty.controls

Class ConsoleCommands

java.lang.Object

de.lessvoid.nifty.controls.ConsoleCommands

All Implemented Interfaces:

KeyInputHandler

public class ConsoleCommands
extends java.lang.Object
implements KeyInputHandler

This adds all the nifty command line features to the console control: - command line completion (for all registered commands) - command history - command processing which detects commands and directly calls your registered commands (via the ConsoleCommand interface)

Author:

void

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConsoleCommands.ConsoleCommand	You can implement this interface for individual commands and Nifty will call them when the registered command has been detected.

Constructor Summary

Constructors

Constructor	Description
ConsoleCommands(Nifty nifty, Console console)	Create and attach this to the given console.

Method Summary

Modifier and Type	Method	Description
void	enableCommandCompletion(boolean enabled)	When the command completion is enabled pressing TAB will check for all known commands.
ConsoleCommands.ConsoleCommand	findCommand(java.lang.String commandText)	Find a ConsoleCommand with the given commandText.
java.util.List<java.lang.String>	getRegisteredCommands()	Get all commands that are registered.
boolean	keyEvent(NiftyInputEvent inputEvent)
void	registerCommand(java.lang.String commandText, ConsoleCommands.ConsoleCommand command)	Register a command for the command completion feature.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleCommands

public ConsoleCommands(@Nonnull
                       Nifty nifty,
                       @Nonnull
                       Console console)

Create and attach this to the given console.

Method Detail

enableCommandCompletion

public void enableCommandCompletion(boolean enabled)

When the command completion is enabled pressing TAB will check for all known commands. Use registerCommand() to register commands for this feature to work. Please note that in this case you can't TAB away from the textfield.

Parameters:

enabled - true when command completion should be enabled and false if not

registerCommand

public void registerCommand(@Nonnull
                            java.lang.String commandText,
                            @Nonnull
                            ConsoleCommands.ConsoleCommand command)

Register a command for the command completion feature.

Parameters:

command - the command to make known

getRegisteredCommands

@Nonnull
public java.util.List<java.lang.String> getRegisteredCommands()

Get all commands that are registered.

Returns:

list of all commands that have been registered

keyEvent

public boolean keyEvent(@Nonnull
                        NiftyInputEvent inputEvent)

Specified by:

keyEvent in interface KeyInputHandler

findCommand

@Nullable
public ConsoleCommands.ConsoleCommand findCommand(@Nonnull
                                                  java.lang.String commandText)

Find a ConsoleCommand with the given commandText. This will find commands that begin with the given commandText as well.

Parameters:

commandText - the command to return

Returns:

the ConsoleCommand or null if command does not exist