Package de.lessvoid.nifty.controls

Interface Console

All Superinterfaces:

NiftyControl

All Known Implementing Classes:

ConsoleControl

public interface Console
extends NiftyControl

The Console interface is the Nifty control API view of a Nifty Console control.

Author:

void

Method Summary

Modifier and Type	Method	Description
void	changeColors(Color standardColor, Color errorColor)	Change the output colors.
void	clear()	Clear the console.
java.lang.String[]	getConsoleContent()	Get the complete content of the console as an array of Strings.
TextField	getTextField()	This gives you access to the Textfield that the Console uses for text input.
void	output(java.lang.String line)	output a line of text (or multiple lines separated by \n) to the console.
void	output(java.lang.String line, Color color)	output a line of text (or multiple lines separated by \n) to the console.
void	outputError(java.lang.String line)	output a line of text (or multiple lines separated by \n) with the error color

Methods inherited from interface de.lessvoid.nifty.controls.NiftyControl

disable, enable, getElement, getHeight, getId, getStyle, getWidth, hasFocus, isBound, isEnabled, layoutCallback, setEnabled, setFocus, setFocusable, setHeight, setId, setStyle, setWidth

Method Detail

output

void output(@Nonnull
            java.lang.String line)

output a line of text (or multiple lines separated by \n) to the console.

Parameters:

line - the line of text to output to the console

output

void output(@Nonnull
            java.lang.String line,
            @Nullable
            Color color)

output a line of text (or multiple lines separated by \n) to the console.

Parameters:

line - the line of text to output to the console

outputError

void outputError(@Nonnull
                 java.lang.String line)

output a line of text (or multiple lines separated by \n) with the error color

Parameters:

line - the line of text to output to the console

getConsoleContent

@Nonnull
java.lang.String[] getConsoleContent()

Get the complete content of the console as an array of Strings.

Returns:

console content

clear

void clear()

Clear the console.

getTextField

@Nullable
TextField getTextField()

This gives you access to the Textfield that the Console uses for text input.

Returns:

the Nifty TextField control

changeColors

void changeColors(@Nullable
                  Color standardColor,
                  @Nonnull
                  Color errorColor)

Change the output colors. A color can be null in which case the default color of the console is being used.

Parameters:

standardColor - the output color for the normal output

errorColor - the output color for the error output