org.jboss.aesh.terminal

Class AbstractTerminal

java.lang.Object

org.jboss.aesh.terminal.AbstractTerminal

All Implemented Interfaces:

Closeable, AutoCloseable, Shell, Terminal

Direct Known Subclasses:

POSIXTerminal, WindowsTerminal

public abstract class AbstractTerminal
extends Object
implements Terminal, Shell

Author:

Ståle W. Pedersen

Field Summary

Fields

Modifier and Type	Field and Description
protected Settings	settings

Method Summary

Modifier and Type	Method and Description
void	clear() clears the screen
void	enableAlternateBuffer() If not alternate buffer is enabled this will enable it
void	enableMainBuffer() If not main buffer is enabled this will enable it.
CursorPosition	getCursor() Return the row position if we use a ansi terminal Send a terminal: '[6n' and we receive the position as: '[n;mR' where n = current row and m = current column
Shell	getShell()
AeshStandardStream	in() Get the possible input stream
boolean	isMainBuffer()
void	moveCursor(int rows, int columns) Move the cursor relative to the current position Will not move outside of TerminalSize boundaries
void	setCursor(CursorPosition position) Set cursor position

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.aesh.terminal.Terminal

changeOutputStream, hasInput, init, isEchoEnabled, read, reset, writeToInputStream

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.jboss.aesh.terminal.Shell

err, getSize, out

Field Detail

settings

protected Settings settings

Method Detail

getCursor

public CursorPosition getCursor()

Return the row position if we use a ansi terminal Send a terminal: '[6n' and we receive the position as: '[n;mR' where n = current row and m = current column

Specified by:

getCursor in interface Shell

Returns:

get the cursor position

setCursor

public void setCursor(CursorPosition position)

Description copied from interface: Shell

Set cursor position

Specified by:

setCursor in interface Shell

moveCursor

public void moveCursor(int rows,
                       int columns)

Description copied from interface: Shell

Move the cursor relative to the current position Will not move outside of TerminalSize boundaries

Specified by:

moveCursor in interface Shell

clear

public void clear()

Description copied from interface: Shell

clears the screen

Specified by:

clear in interface Shell

isMainBuffer

public boolean isMainBuffer()

Specified by:

isMainBuffer in interface Shell

Returns:

true if current buffer is main

enableAlternateBuffer

public void enableAlternateBuffer()

Description copied from interface: Shell

If not alternate buffer is enabled this will enable it

Specified by:

enableAlternateBuffer in interface Shell

enableMainBuffer

public void enableMainBuffer()

Description copied from interface: Shell

If not main buffer is enabled this will enable it.

Specified by:

enableMainBuffer in interface Shell

getShell

public Shell getShell()

Specified by:

getShell in interface Terminal

in

public AeshStandardStream in()

Description copied from interface: Shell

Get the possible input stream

Specified by:

in in interface Shell