com.sshtools.server.vshell.terminal

Class TerminalOutput

java.lang.Object

com.sshtools.server.vshell.terminal.TerminalOutput

public class TerminalOutput
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	BACKSPACE
static int	BCOLOR
static int	BEL
static int	BLACK
static int	BLINK
static int	BLINK_OFF
static int	BLUE
static int	BOLD
static int	BOLD_OFF
static int	BOX_BOTTOM
static int	BOX_BOTTOM_LEFT
static int	BOX_BOTTOM_MIDDLE
static int	BOX_BOTTOM_RIGHT
static int	BOX_CENTER
static int	BOX_LEFT
static int	BOX_MIDDLE
static int	BOX_MIDDLE_LEFT
static int	BOX_MIDDLE_MIDDLE
static int	BOX_MIDDLE_RIGHT
static int	BOX_RIGHT
static int	BOX_TOP
static int	BOX_TOP_LEFT
static int	BOX_TOP_MIDDLE
static int	BOX_TOP_RIGHT
static int	BS
static int	BYTEMISSING
static int	CharacterUpdate
static int	COLORINIT
static int	CR
static String	CRLF
static int	CYAN
static int	DEL
static int	DELETE
static int	DOWN
static int	EBOL
static int	EBOS
static int	EditBuffer
static int	EEL
static int	EEOL
static int	EEOS
static int	EES
static int	ENTER
static int	EOL_CR
static int	EOL_CRLF
static int	ESCAPE
static int	FCOLOR
static int	GRAPHICS_OFF
static int	GRAPHICS_ON
static int	GREEN
static int	HANDLED
static int[]	HOME
static int	IOERROR
static int	ITALIC
static int	ITALIC_OFF
static int	LEFT
static int	LF
static int	LineEditBuffer
static int	LineUpdate
static int	LOGOUTREQUEST
static int	MAGENTA
static int	RED
static int	RESET
static int	RESTORECURSOR
static int	RIGHT
static int	ScreenpartUpdate
static int	STORECURSOR
static int	STYLE
static int	TABULATOR
static int	UNDERLINED
static int	UNDERLINED_OFF
static int	UNRECOGNIZED
static int	UP
static int	WHITE
static int	YELLOW

Constructor Summary

Constructors

Constructor and Description
TerminalOutput(OutputStream out)
TerminalOutput(OutputStream out, String term, int cols, int rows, int width, int height, byte[] modes)

Method Summary

Modifier and Type	Method and Description
void	attachStream(OutputStream out)
void	bell()
void	boxCharacter(int specialSequence)
void	close()
void	closeOutput()
boolean	defineScrollRegion(int topmargin, int bottommargin)
void	detachStream()
void	disableGraphics()
void	enableGraphics()
void	eraseLine()
void	eraseScreen()
void	eraseToBeginOfLine()
void	eraseToBeginOfScreen()
void	eraseToEndOfLine()
void	eraseToEndOfScreen()
void	flush()
OutputStream	getAttachedOutputStream()
int	getCols()
int	getColumns()
int	getCursorCol()
int	getCursorRow()
byte[]	getEncodedTerminalModes()
int	getEOL()
String	getEOLString()
int	getHeight()
int	getRows()
String	getTerm()
Terminal	getTerminal()
int	getWidth()
void	homeCursor()
boolean	isAutoflushing()
boolean	isSignalling()
void	moveCursor(int direction, int times)
void	moveDown(int times)
void	moveLeft(int times)
void	moveRight(int times)
void	moveUp(int times)
void	resetAttributes()
void	restoreCursor()
void	setAutoflushing(boolean b)
void	setBackgroundColor(int color)
void	setBlink(boolean b)
void	setBold(boolean b)
void	setCols(int cols)
void	setCursor(int row, int col)
void	setDefaultTerminal()
void	setDisplay(boolean display)
void	setEOL(int eol)
void	setForegroundColor(int color)
void	setHeight(int height)
void	setItalic(boolean b)
void	setModes(byte[] modes)
void	setRows(int rows)
void	setSignalling(boolean bool)
void	setTerminal(String terminalName)
void	setUnderlined(boolean b)
void	setWidth(int width)
void	storeCursor()

Methods inherited from class java.lang.Object

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

Field Detail

EOL_CRLF

public static final int EOL_CRLF

See Also:

Constant Field Values

EOL_CR

public static final int EOL_CR

See Also:

Constant Field Values

HOME

public static final int[] HOME

IOERROR

public static final int IOERROR

See Also:

Constant Field Values

UP

public static final int UP

See Also:

Constant Field Values

DOWN

public static final int DOWN

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

See Also:

Constant Field Values

LEFT

public static final int LEFT

See Also:

Constant Field Values

STORECURSOR

public static final int STORECURSOR

See Also:

Constant Field Values

RESTORECURSOR

public static final int RESTORECURSOR

See Also:

Constant Field Values

GRAPHICS_ON

public static final int GRAPHICS_ON

See Also:

Constant Field Values

GRAPHICS_OFF

public static final int GRAPHICS_OFF

See Also:

Constant Field Values

BOX_TOP_LEFT

public static final int BOX_TOP_LEFT

See Also:

Constant Field Values

BOX_TOP

public static final int BOX_TOP

See Also:

Constant Field Values

BOX_TOP_MIDDLE

public static final int BOX_TOP_MIDDLE

See Also:

Constant Field Values

BOX_TOP_RIGHT

public static final int BOX_TOP_RIGHT

See Also:

Constant Field Values

BOX_MIDDLE_LEFT

public static final int BOX_MIDDLE_LEFT

See Also:

Constant Field Values

BOX_MIDDLE

public static final int BOX_MIDDLE

See Also:

Constant Field Values

BOX_MIDDLE_MIDDLE

public static final int BOX_MIDDLE_MIDDLE

See Also:

Constant Field Values

BOX_MIDDLE_RIGHT

public static final int BOX_MIDDLE_RIGHT

See Also:

Constant Field Values

BOX_BOTTOM_LEFT

public static final int BOX_BOTTOM_LEFT

See Also:

Constant Field Values

BOX_BOTTOM

public static final int BOX_BOTTOM

See Also:

Constant Field Values

BOX_BOTTOM_MIDDLE

public static final int BOX_BOTTOM_MIDDLE

See Also:

Constant Field Values

BOX_BOTTOM_RIGHT

public static final int BOX_BOTTOM_RIGHT

See Also:

Constant Field Values

BOX_LEFT

public static final int BOX_LEFT

See Also:

Constant Field Values

BOX_RIGHT

public static final int BOX_RIGHT

See Also:

Constant Field Values

BOX_CENTER

public static final int BOX_CENTER

See Also:

Constant Field Values

EEOL

public static final int EEOL

See Also:

Constant Field Values

EBOL

public static final int EBOL

See Also:

Constant Field Values

EEL

public static final int EEL

See Also:

Constant Field Values

EEOS

public static final int EEOS

See Also:

Constant Field Values

EBOS

public static final int EBOS

See Also:

Constant Field Values

EES

public static final int EES

See Also:

Constant Field Values

ESCAPE

public static final int ESCAPE

See Also:

Constant Field Values

BYTEMISSING

public static final int BYTEMISSING

See Also:

Constant Field Values

UNRECOGNIZED

public static final int UNRECOGNIZED

See Also:

Constant Field Values

ENTER

public static final int ENTER

See Also:

Constant Field Values

TABULATOR

public static final int TABULATOR

See Also:

Constant Field Values

DELETE

public static final int DELETE

See Also:

Constant Field Values

BACKSPACE

public static final int BACKSPACE

See Also:

Constant Field Values

COLORINIT

public static final int COLORINIT

See Also:

Constant Field Values

HANDLED

public static final int HANDLED

See Also:

Constant Field Values

LOGOUTREQUEST

public static final int LOGOUTREQUEST

See Also:

Constant Field Values

LineUpdate

public static final int LineUpdate

See Also:

Constant Field Values

CharacterUpdate

public static final int CharacterUpdate

See Also:

Constant Field Values

ScreenpartUpdate

public static final int ScreenpartUpdate

See Also:

Constant Field Values

EditBuffer

public static final int EditBuffer

See Also:

Constant Field Values

LineEditBuffer

public static final int LineEditBuffer

See Also:

Constant Field Values

BEL

public static final int BEL

See Also:

Constant Field Values

BS

public static final int BS

See Also:

Constant Field Values

DEL

public static final int DEL

See Also:

Constant Field Values

CR

public static final int CR

See Also:

Constant Field Values

LF

public static final int LF

See Also:

Constant Field Values

FCOLOR

public static final int FCOLOR

See Also:

Constant Field Values

BCOLOR

public static final int BCOLOR

See Also:

Constant Field Values

STYLE

public static final int STYLE

See Also:

Constant Field Values

RESET

public static final int RESET

See Also:

Constant Field Values

BOLD

public static final int BOLD

See Also:

Constant Field Values

BOLD_OFF

public static final int BOLD_OFF

See Also:

Constant Field Values

ITALIC

public static final int ITALIC

See Also:

Constant Field Values

ITALIC_OFF

public static final int ITALIC_OFF

See Also:

Constant Field Values

BLINK

public static final int BLINK

See Also:

Constant Field Values

BLINK_OFF

public static final int BLINK_OFF

See Also:

Constant Field Values

UNDERLINED

public static final int UNDERLINED

See Also:

Constant Field Values

UNDERLINED_OFF

public static final int UNDERLINED_OFF

See Also:

Constant Field Values

BLACK

public static final int BLACK

See Also:

Constant Field Values

RED

public static final int RED

See Also:

Constant Field Values

GREEN

public static final int GREEN

See Also:

Constant Field Values

YELLOW

public static final int YELLOW

See Also:

Constant Field Values

BLUE

public static final int BLUE

See Also:

Constant Field Values

MAGENTA

public static final int MAGENTA

See Also:

Constant Field Values

CYAN

public static final int CYAN

See Also:

Constant Field Values

WHITE

public static final int WHITE

See Also:

Constant Field Values

CRLF

public static final String CRLF

See Also:

Constant Field Values

Constructor Detail

TerminalOutput

public TerminalOutput(OutputStream out)
               throws IOException

Throws:

IOException

TerminalOutput

public TerminalOutput(OutputStream out,
                      String term,
                      int cols,
                      int rows,
                      int width,
                      int height,
                      byte[] modes)
               throws IOException

Throws:

IOException

Method Detail

setModes

public void setModes(byte[] modes)

getRows

public int getRows()

getColumns

public int getColumns()

getHeight

public int getHeight()

getWidth

public int getWidth()

getTerm

public String getTerm()

getEncodedTerminalModes

public byte[] getEncodedTerminalModes()

getAttachedOutputStream

public OutputStream getAttachedOutputStream()
                                     throws IOException

Throws:

IOException

detachStream

public void detachStream()

getEOL

public int getEOL()

getEOLString

public String getEOLString()

setEOL

public void setEOL(int eol)

attachStream

public void attachStream(OutputStream out)

getCols

public int getCols()

setCols

public void setCols(int cols)

setRows

public void setRows(int rows)

setWidth

public void setWidth(int width)

setHeight

public void setHeight(int height)

eraseToEndOfLine

public void eraseToEndOfLine()
                      throws IOException

Throws:

IOException

eraseToBeginOfLine

public void eraseToBeginOfLine()
                        throws IOException

Throws:

IOException

eraseLine

public void eraseLine()
               throws IOException

Throws:

IOException

eraseToEndOfScreen

public void eraseToEndOfScreen()
                        throws IOException

Throws:

IOException

eraseToBeginOfScreen

public void eraseToBeginOfScreen()
                          throws IOException

Throws:

IOException

eraseScreen

public void eraseScreen()
                 throws IOException

Throws:

IOException

getCursorRow

public int getCursorRow()

getCursorCol

public int getCursorCol()

moveCursor

public void moveCursor(int direction,
                       int times)
                throws IOException

Throws:

IOException

moveLeft

public void moveLeft(int times)
              throws IOException

Throws:

IOException

moveRight

public void moveRight(int times)
               throws IOException

Throws:

IOException

moveUp

public void moveUp(int times)
            throws IOException

Throws:

IOException

moveDown

public void moveDown(int times)
              throws IOException

Throws:

IOException

setCursor

public void setCursor(int row,
                      int col)
               throws IOException

Throws:

IOException

homeCursor

public void homeCursor()
                throws IOException

Throws:

IOException

boxCharacter

public void boxCharacter(int specialSequence)
                  throws IOException

Throws:

IOException

enableGraphics

public void enableGraphics()
                    throws IOException

Throws:

IOException

disableGraphics

public void disableGraphics()
                     throws IOException

Throws:

IOException

storeCursor

public void storeCursor()
                 throws IOException

Throws:

IOException

restoreCursor

public void restoreCursor()
                   throws IOException

Throws:

IOException

setDisplay

public void setDisplay(boolean display)

flush

public void flush()
           throws IOException

Throws:

IOException

closeOutput

public void closeOutput()
                 throws IOException

Throws:

IOException

setSignalling

public void setSignalling(boolean bool)

isSignalling

public boolean isSignalling()

bell

public void bell()
          throws IOException

Throws:

IOException

defineScrollRegion

public boolean defineScrollRegion(int topmargin,
                                  int bottommargin)
                           throws IOException

Throws:

IOException

setForegroundColor

public void setForegroundColor(int color)
                        throws IOException

Throws:

IOException

setBackgroundColor

public void setBackgroundColor(int color)
                        throws IOException

Throws:

IOException

setBold

public void setBold(boolean b)
             throws IOException

Throws:

IOException

setUnderlined

public void setUnderlined(boolean b)
                   throws IOException

Throws:

IOException

setItalic

public void setItalic(boolean b)
               throws IOException

Throws:

IOException

setBlink

public void setBlink(boolean b)
              throws IOException

Throws:

IOException

resetAttributes

public void resetAttributes()
                     throws IOException

Throws:

IOException

isAutoflushing

public boolean isAutoflushing()

setAutoflushing

public void setAutoflushing(boolean b)

close

public void close()
           throws IOException

Throws:

IOException

getTerminal

public Terminal getTerminal()

setDefaultTerminal

public void setDefaultTerminal()
                        throws IOException

Throws:

IOException

setTerminal

public void setTerminal(String terminalName)
                 throws IOException

Throws:

IOException