com.googlecode.lanterna.terminal

Interface Terminal

All Superinterfaces:

InputProvider

All Known Implementing Classes:

AbstractTerminal, ANSITerminal, CygwinTerminal, InputEnabledAbstractTerminal, StreamBasedTerminal, SwingTerminal, UnixTerminal

public interface Terminal
extends InputProvider

This is the main terminal interface, at the lowest level supported by Lanterna. You can implement your own implementation of this if you want to target an exotic text terminal specification or another graphical environment (like SWT).

Author:

Martin

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Terminal.Color
static interface	Terminal.ResizeListener Listener interface that can be used to be alerted on terminal resizing
static class	Terminal.SGR SGR - Select Graphic Rendition, changes the state of the terminal as to what kind of text to print after this command.

Method Summary

Methods

Modifier and Type	Method and Description
void	addResizeListener(Terminal.ResizeListener listener) Adds a ResizeListener to be called when the terminal has changed size.
void	applyBackgroundColor(int index) Changes the background color for all the following characters put to the terminal.
void	applyBackgroundColor(int r, int g, int b) Changes the background color for all the following characters put to the terminal.
void	applyBackgroundColor(Terminal.Color color) Changes the background color for all the following characters put to the terminal.
void	applyForegroundColor(int index) Changes the foreground color for all the following characters put to the terminal.
void	applyForegroundColor(int r, int g, int b) Changes the foreground color for all the following characters put to the terminal.
void	applyForegroundColor(Terminal.Color color) Changes the foreground color for all the following characters put to the terminal.
void	applySGR(Terminal.SGR... options) Activates an SGR code for all the following characters put to the terminal.
void	clearScreen() Removes all the characters, colors and graphics from the screep and leaves you with a big empty space.
void	enterPrivateMode() Calling this method will, where supported, give your terminal a private area to use, separate from what was there before.
void	exitPrivateMode() If you have previously entered private mode, this method will exit this and, depending on implementation, maybe restore what the terminal looked like before private mode was entered.
void	flush() Calls flush() on the underlying OutputStream object, or whatever other implementation this terminal is built around.
TerminalSize	getTerminalSize() Returns the size of the terminal, expressed as a TerminalSize object.
void	moveCursor(int x, int y) Moves the text cursor to a new location
void	putCharacter(char c) Prints one character to the terminal at the current cursor location.
TerminalSize	queryTerminalSize() Deprecated. Being deprecated since 2.0.1 in favor of getTerminalSize()
void	removeResizeListener(Terminal.ResizeListener listener) Removes a ResizeListener from the list of listeners to be notified when the terminal has changed size
void	setCursorVisible(boolean visible) Hides or shows the text cursor

Methods inherited from interface com.googlecode.lanterna.input.InputProvider

addInputProfile, readInput

Method Detail

enterPrivateMode

void enterPrivateMode()

Calling this method will, where supported, give your terminal a private area to use, separate from what was there before. Some terminal emulators will preserve the terminal history and restore it when you exit private mode.

Throws:

LanternaException

exitPrivateMode

void exitPrivateMode()

If you have previously entered private mode, this method will exit this and, depending on implementation, maybe restore what the terminal looked like before private mode was entered.

Throws:

LanternaException

clearScreen

void clearScreen()

Removes all the characters, colors and graphics from the screep and leaves you with a big empty space. Text cursor position is undefined after this call (depends on platform and terminal) so you should always call moveCursor next.

Throws:

LanternaException

moveCursor

void moveCursor(int x,
              int y)

Moves the text cursor to a new location

Parameters:

x - The 0-indexed column to place the cursor at

y - The 0-indexed row to place the cursor at

Throws:

LanternaException

setCursorVisible

void setCursorVisible(boolean visible)

Hides or shows the text cursor

Parameters:

visible - Hides the text cursor if false and shows it if true

putCharacter

void putCharacter(char c)

Prints one character to the terminal at the current cursor location. Please note that the cursor will then move one column to the right but if reached the end of the line may move to the beginning of the next line.

Parameters:

c -

Throws:

LanternaException

applySGR

void applySGR(Terminal.SGR... options)

Activates an SGR code for all the following characters put to the terminal.

Parameters:

options - List of SGR codes

Throws:

LanternaException

See Also:

Terminal.SGR

applyForegroundColor

void applyForegroundColor(Terminal.Color color)

Changes the foreground color for all the following characters put to the terminal. The foreground color is what color to draw the text in.

Parameters:

color - Color to use for foreground

Throws:

LanternaException

applyForegroundColor

void applyForegroundColor(int r,
                        int g,
                        int b)

Changes the foreground color for all the following characters put to the terminal. The foreground color is what color to draw the text in.
Warning: Only a few terminal support 24-bit color control codes, please avoid using this unless you know all users will have compatible terminals. For details, please see this commit log.

Parameters:

r - Red intensity, from 0 to 255

g - Green intensity, from 0 to 255

b - Blue intensity, from 0 to 255

applyForegroundColor

void applyForegroundColor(int index)

Changes the foreground color for all the following characters put to the terminal. The foreground color is what color to draw the text in.
Warning: This method will use the XTerm 256 color extension, it may not be supported on all terminal emulators! The index values are resolved as this:
0 .. 15 - System color, these are taken from the schema. 16 .. 231 - Forms a 6x6x6 RGB color cube.
232 .. 255 - A gray scale ramp without black and white.

For more details on this, please see this commit message to Konsole.

Parameters:

index - Color index from the XTerm 256 color space

applyBackgroundColor

void applyBackgroundColor(Terminal.Color color)

Changes the background color for all the following characters put to the terminal. The background color is the color surrounding the text being printed.

Parameters:

color - Color to use for the background

Throws:

LanternaException

applyBackgroundColor

void applyBackgroundColor(int r,
                        int g,
                        int b)

Changes the background color for all the following characters put to the terminal. The background color is the color surrounding the text being printed.
Warning: Only a few terminal support 24-bit color control codes, please avoid using this unless you know all users will have compatible terminals. For details, please see this commit log.

Parameters:

r - Red intensity, from 0 to 255

g - Green intensity, from 0 to 255

b - Blue intensity, from 0 to 255

applyBackgroundColor

void applyBackgroundColor(int index)

Changes the background color for all the following characters put to the terminal. The background color is the color surrounding the text being printed.
Warning: This method will use the XTerm 256 color extension, it may not be supported on all terminal emulators! The index values are resolved as this:
0 .. 15 - System color, these are taken from the schema. 16 .. 231 - Forms a 6x6x6 RGB color cube.
232 .. 255 - A gray scale ramp without black and white.

For more details on this, please see this commit message to Konsole.

Parameters:

index - Index of the color to use, from the XTerm 256 color extension

addResizeListener

void addResizeListener(Terminal.ResizeListener listener)

Adds a ResizeListener to be called when the terminal has changed size.

Parameters:

listener - Listener object to be called when the terminal has been changed

See Also:

Terminal.ResizeListener

removeResizeListener

void removeResizeListener(Terminal.ResizeListener listener)

Removes a ResizeListener from the list of listeners to be notified when the terminal has changed size

Parameters:

listener - Listener object to remove

See Also:

Terminal.ResizeListener

queryTerminalSize

@Deprecated
TerminalSize queryTerminalSize()

Deprecated. Being deprecated since 2.0.1 in favor of getTerminalSize()

Will ask the terminal of its current size dimensions, represented by a TerminalSize object. Please note that the default way of figuring this information out is asynchorous and so you will be given the last known dimensions. With proper resize listeners set up, this will only be a problem for figuring out the initial size of the terminal.

Returns:

a TerminalSize object representing the size of the terminal

Throws:

LanternaException

See Also:

TerminalSize

getTerminalSize

TerminalSize getTerminalSize()

Returns the size of the terminal, expressed as a TerminalSize object. Please bear in mind that depending on the Terminal implementation, this may or may not be accurate. See the implementing classes for more information.

Returns:

Size of the terminal

flush

void flush()

Calls flush() on the underlying OutputStream object, or whatever other implementation this terminal is built around.

Throws:

LanternaException