org.jboss.aesh.terminal

Interface Shell

All Known Implementing Classes:

AbstractTerminal, POSIXTerminal, TestTerminal, WindowsTerminal

public interface Shell

A Shell is an abstraction of the Terminal that provides easy to use methods to manipulate text/cursor/buffers.

Author:

Ståle W. Pedersen

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.
PrintStream	err() Returns the PrintStream associated with the std err
CursorPosition	getCursor()
TerminalSize	getSize()
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
PrintStream	out() Returns the PrintStream associated with the std out
void	setCursor(CursorPosition position) Set cursor position

Method Detail

clear

void clear()
    throws IOException

clears the screen

Throws:

IOException

out

PrintStream out()

Returns the PrintStream associated with the std out

err

PrintStream err()

Returns the PrintStream associated with the std err

in

AeshStandardStream in()

Get the possible input stream

getSize

TerminalSize getSize()

Returns:

terminal size

getCursor

CursorPosition getCursor()

Returns:

get the cursor position

setCursor

void setCursor(CursorPosition position)

Set cursor position

moveCursor

void moveCursor(int rows,
                int columns)

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

isMainBuffer

boolean isMainBuffer()

Returns:

true if current buffer is main

enableAlternateBuffer

void enableAlternateBuffer()

If not alternate buffer is enabled this will enable it

Throws:

IOException

enableMainBuffer

void enableMainBuffer()

If not main buffer is enabled this will enable it.

Throws:

IOException