com.googlecode.lanterna.terminal.text

Class ANSITerminal

java.lang.Object

com.googlecode.lanterna.terminal.AbstractTerminal

com.googlecode.lanterna.terminal.InputEnabledAbstractTerminal

com.googlecode.lanterna.terminal.text.StreamBasedTerminal

com.googlecode.lanterna.terminal.text.ANSITerminal

All Implemented Interfaces:

InputProvider, Terminal

Direct Known Subclasses:

CygwinTerminal, UnixTerminal

public abstract class ANSITerminal
extends StreamBasedTerminal

A common ANSI text terminal implementation

Author:

Martin

See Also:

Wikipedia

Nested Class Summary

Nested classes/interfaces inherited from interface com.googlecode.lanterna.terminal.Terminal

Terminal.Color, Terminal.ResizeListener, Terminal.SGR

Field Summary

Fields inherited from class com.googlecode.lanterna.terminal.text.StreamBasedTerminal

writerMutex

Constructor Summary

Constructors

Constructor and Description
ANSITerminal(InputStream terminalInput, OutputStream terminalOutput, Charset terminalCharset)

Method Summary

Methods

Modifier and Type	Method and Description
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.
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
TerminalSize	queryTerminalSize() Deprecated.
protected void	reportPosition() Synchronize with writerMutex externally!!!
protected void	restoreCursorPosition() Synchronize with writerMutex externally!!!
protected void	saveCursorPosition() Synchronize with writerMutex externally!!!
abstract void	setCBreak(boolean cbreakOn) Enabling cbreak mode will allow you to read user input immediately as the user enters the characters, as opposed to reading the data in lines as the user presses enter.
void	setCursorVisible(boolean visible) Hides or shows the text cursor
abstract void	setEcho(boolean echoOn) Enables or disables keyboard echo, meaning the immediate output of the characters you type on your keyboard.

Methods inherited from class com.googlecode.lanterna.terminal.text.StreamBasedTerminal

flush, putCharacter, translateCharacter, writeToTerminal

Methods inherited from class com.googlecode.lanterna.terminal.InputEnabledAbstractTerminal

addInputProfile, readInput, waitForTerminalSizeReport

Methods inherited from class com.googlecode.lanterna.terminal.AbstractTerminal

addResizeListener, getLastKnownSize, onResized, removeResizeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ANSITerminal

public ANSITerminal(InputStream terminalInput,
            OutputStream terminalOutput,
            Charset terminalCharset)

Method Detail

queryTerminalSize

@Deprecated
public TerminalSize queryTerminalSize()

Deprecated.

Description copied from interface: Terminal

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

See Also:

TerminalSize

getTerminalSize

public TerminalSize getTerminalSize()

Description copied from interface: Terminal

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

applyBackgroundColor

public void applyBackgroundColor(Terminal.Color color)

Description copied from interface: Terminal

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

applyBackgroundColor

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

Description copied from interface: Terminal

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

public void applyBackgroundColor(int index)

Description copied from interface: Terminal

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

applyForegroundColor

public void applyForegroundColor(Terminal.Color color)

Description copied from interface: Terminal

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

applyForegroundColor

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

Description copied from interface: Terminal

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

public void applyForegroundColor(int index)

Description copied from interface: Terminal

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

applySGR

public void applySGR(Terminal.SGR... options)

Description copied from interface: Terminal

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

Parameters:

options - List of SGR codes

See Also:

Terminal.SGR

clearScreen

public void clearScreen()

Description copied from interface: Terminal

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.

enterPrivateMode

public void enterPrivateMode()

Description copied from interface: Terminal

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.

exitPrivateMode

public void exitPrivateMode()

Description copied from interface: Terminal

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.

setEcho

public abstract void setEcho(boolean echoOn)

Enables or disables keyboard echo, meaning the immediate output of the characters you type on your keyboard. If your users are going to interact with this application through the keyboard, you probably want to disable echo mode.

Parameters:

echoOn - true if keyboard input will immediately echo, false if it's hidden

Throws:

LanternaException

setCBreak

public abstract void setCBreak(boolean cbreakOn)

Enabling cbreak mode will allow you to read user input immediately as the user enters the characters, as opposed to reading the data in lines as the user presses enter. If you want your program to respond to user input by the keyboard, you probably want to enable cbreak mode.

Parameters:

cbreakOn -

Throws:

LanternaException

See Also:

POSIX terminal interface

moveCursor

public void moveCursor(int x,
              int y)

Description copied from interface: Terminal

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

setCursorVisible

public void setCursorVisible(boolean visible)

Description copied from interface: Terminal

Hides or shows the text cursor

Parameters:

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

reportPosition

protected void reportPosition()

Synchronize with writerMutex externally!!!

restoreCursorPosition

protected void restoreCursorPosition()

Synchronize with writerMutex externally!!!

saveCursorPosition

protected void saveCursorPosition()

Synchronize with writerMutex externally!!!