com.googlecode.lanterna.terminal.text

Class UnixTerminal

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

com.googlecode.lanterna.terminal.text.UnixTerminal

All Implemented Interfaces:

InputProvider, Terminal

public class UnixTerminal
extends ANSITerminal

A common ANSI terminal extention with support for Unix resize signals and the stty program to control cbreak and key echo

Author:

Martin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UnixTerminal.Behaviour This enum lets you control some more low-level behaviors of this terminal object.

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
UnixTerminal(InputStream terminalInput, OutputStream terminalOutput, Charset terminalCharset) Creates a UnixTerminal using a specified input stream, output stream and character set.
UnixTerminal(InputStream terminalInput, OutputStream terminalOutput, Charset terminalCharset, UnixTerminalSizeQuerier customSizeQuerier) Creates a UnixTerminal using a specified input stream, output stream and character set.
UnixTerminal(InputStream terminalInput, OutputStream terminalOutput, Charset terminalCharset, UnixTerminalSizeQuerier customSizeQuerier, UnixTerminal.Behaviour terminalBehaviour) Creates a UnixTerminal using a specified input stream, output stream and character set.

Method Summary

Methods

Modifier and Type	Method and Description
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.
TerminalSize	queryTerminalSize() Deprecated.
Key	readInput() Returns the next Key off the input queue or null if there is none more input events available
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	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.ANSITerminal

applyBackgroundColor, applyBackgroundColor, applyBackgroundColor, applyForegroundColor, applyForegroundColor, applyForegroundColor, applySGR, clearScreen, moveCursor, reportPosition, restoreCursorPosition, saveCursorPosition, setCursorVisible

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

flush, putCharacter, translateCharacter, writeToTerminal

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

addInputProfile, 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

UnixTerminal

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

Creates a UnixTerminal using a specified input stream, output stream and character set.

Parameters:

terminalInput - Input stream to read terminal input from

terminalOutput - Output stream to write terminal output to

terminalCharset - Character set to use when converting characters to bytes

UnixTerminal

public UnixTerminal(InputStream terminalInput,
            OutputStream terminalOutput,
            Charset terminalCharset,
            UnixTerminalSizeQuerier customSizeQuerier)

Creates a UnixTerminal using a specified input stream, output stream and character set.

Parameters:

terminalInput - Input stream to read terminal input from

terminalOutput - Output stream to write terminal output to

terminalCharset - Character set to use when converting characters to bytes

customSizeQuerier - Object to use for looking up the size of the terminal, or null to use the built-in method

UnixTerminal

public UnixTerminal(InputStream terminalInput,
            OutputStream terminalOutput,
            Charset terminalCharset,
            UnixTerminalSizeQuerier customSizeQuerier,
            UnixTerminal.Behaviour terminalBehaviour)

Creates a UnixTerminal using a specified input stream, output stream and character set.

Parameters:

terminalInput - Input stream to read terminal input from

terminalOutput - Output stream to write terminal output to

terminalCharset - Character set to use when converting characters to bytes

customSizeQuerier - Object to use for looking up the size of the terminal, or null to use the built-in method

terminalBehaviour - Special settings on how the terminal will behave, see UnixTerminalMode for more details

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.

Specified by:

queryTerminalSize in interface Terminal

Overrides:

queryTerminalSize in class ANSITerminal

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.

Specified by:

getTerminalSize in interface Terminal

Overrides:

getTerminalSize in class ANSITerminal

Returns:

Size of the terminal

readInput

public Key readInput()

Description copied from interface: InputProvider

Returns the next Key off the input queue or null if there is none more input events available

Specified by:

readInput in interface InputProvider

Overrides:

readInput in class InputEnabledAbstractTerminal

Returns:

Next Key off the input queue or null if there is none

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.

Specified by:

enterPrivateMode in interface Terminal

Overrides:

enterPrivateMode in class ANSITerminal

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.

Specified by:

exitPrivateMode in interface Terminal

Overrides:

exitPrivateMode in class ANSITerminal

setCBreak

public void setCBreak(boolean cbreakOn)

Description copied from class: ANSITerminal

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.

Specified by:

setCBreak in class ANSITerminal

See Also:

POSIX terminal interface

setEcho

public void setEcho(boolean echoOn)

Description copied from class: ANSITerminal

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.

Specified by:

setEcho in class ANSITerminal

Parameters:

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