com.goldencode.terminal

Class VT100AbstractRenderer<T>

java.lang.Object

com.goldencode.terminal.VT100AbstractRenderer<T>

All Implemented Interfaces:

VT100Renderer

Direct Known Subclasses:

VT100RendererImpl

public abstract class VT100AbstractRenderer<T>
extends java.lang.Object
implements VT100Renderer

Implements a generic abstract VT-100 renderer.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	autoWrap Auto wrap mode
protected int	begScroll Scroll window, starting position.
protected int	col Cursor column position.
protected int	cols Number of columns in the screen.
protected T[][]	data Screen contents.
protected int	endScroll Scroll window, ending position.
protected int	row Cursor row position.
protected int	rows Number of rows in the screen.

Constructor Summary

Constructors

Constructor and Description
VT100AbstractRenderer(T[][] data, int rows, int cols, int begScroll, int endScroll) Constructor.

Method Summary

Modifier and Type	Method and Description
abstract int	attributeMask(int id) Get attribute mask.
abstract void	beep() Play a message beep.
private void	clearRow(int rowIndex, int begCol, int endCol)
private void	clearScreen(int begRow, int endRow) Clear screen.
protected abstract T	emptyCell() Create an empty cell.
void	eraseInDisplay(int mode) Clear lines on screen.
void	eraseInLine(int mode) Clear characters in current line.
int	getColumns() Get number of columns.
int	getCursorCol() Get cursor current column position.
int	getCursorRow() Get cursor current row position.
void	index() IND -- Index ESC D This sequence causes the active position to move downward one line without changing the column position.
protected abstract T	makeCell(char text, int attribute, int color) Build a new video memory cell.
private void	moveCursorNext() Move cursor to the next position.
void	moveCursorPos(int nRows, int nCols) Move cursor position with the amount of rows and columns.
void	nextLine() NEL -- Next Line ESC E This sequence causes the active position to move to the first position on the next line downward.
void	reverseIndex() RI -- Reverse Index ESC M Move the active position to the same horizontal position on the preceding line.
private void	scrollDown() Scroll DOWN one line in scroll window.
private void	scrollUp() Scroll UP one line in scroll window.
void	setAutoWrap(boolean autoWrap) Set auto wrap mode.
void	setCellText(char text, int attribute, int color) Set cell text attributes and color.
void	setCursorCol(int column) Set cursor at column.
void	setCursorPos(int row, int col) Set cursor position.
abstract void	setCursorVisible(boolean showCursor) Set cursor visibility.
void	setScrollRegion(int begLine, int endLine) Set scroll window.
protected abstract void	updateScreen() Update screen.

Methods inherited from class java.lang.Object

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

Field Detail

rows

protected int rows

Number of rows in the screen.

cols

protected int cols

Number of columns in the screen.

begScroll

protected int begScroll

Scroll window, starting position.

endScroll

protected int endScroll

Scroll window, ending position.

row

protected int row

Cursor row position.

col

protected int col

Cursor column position.

data

protected T[][] data

Screen contents.

autoWrap

private boolean autoWrap

Auto wrap mode

Constructor Detail

VT100AbstractRenderer

public VT100AbstractRenderer(T[][] data,
                             int rows,
                             int cols,
                             int begScroll,
                             int endScroll)

Constructor.

Parameters:

data - Video buffer.

rows - Number of rows on the screen.

cols - Number of columns on the screen.

begScroll - Scroll window, starting position.

endScroll - Scroll window, ending position.

Method Detail

setCursorPos

public void setCursorPos(int row,
                         int col)

Set cursor position.

Specified by:

setCursorPos in interface VT100Renderer

Parameters:

row - Line number.

col - Column number.

moveCursorPos

public void moveCursorPos(int nRows,
                          int nCols)

Move cursor position with the amount of rows and columns.

Specified by:

moveCursorPos in interface VT100Renderer

Parameters:

nRows - Number of rows.

nCols - Number of columns.

eraseInDisplay

public void eraseInDisplay(int mode)

Clear lines on screen.

Specified by:

eraseInDisplay in interface VT100Renderer

Parameters:

mode - An integer value representing a screen region: 0 - Erase from the active position to the end of the screen, inclusive (default) 1 - Erase from start of the screen to the active position, inclusive 2 - Erase all of the display -- all lines are erased, changed to single-width, and the cursor does not move.

eraseInLine

public void eraseInLine(int mode)

Clear characters in current line.

Specified by:

eraseInLine in interface VT100Renderer

Parameters:

mode - An integer value representing a line region: 0 - Erase from the active position to the end of the line, inclusive (default) 1 - Erase from the start of the line to the active position, inclusive 2 - Erase all of the line, inclusive

setCellText

public void setCellText(char text,
                        int attribute,
                        int color)

Set cell text attributes and color.

Specified by:

setCellText in interface VT100Renderer

Parameters:

text - Character that should be displayed.

attribute - Cell attributes.

color - Call color FG/BG

beep

public abstract void beep()

Play a message beep.

Specified by:

beep in interface VT100Renderer

setCursorCol

public void setCursorCol(int column)

Set cursor at column.

Specified by:

setCursorCol in interface VT100Renderer

Parameters:

column - Column number.

nextLine

public void nextLine()

NEL -- Next Line ESC E This sequence causes the active position to move to the first position on the next line downward. If the active position is at the bottom margin, a scroll up is performed.

Specified by:

nextLine in interface VT100Renderer

index

public void index()

IND -- Index ESC D This sequence causes the active position to move downward one line without changing the column position. If the active position is at the bottom margin, a scroll up is performed.

Specified by:

index in interface VT100Renderer

reverseIndex

public void reverseIndex()

RI -- Reverse Index ESC M Move the active position to the same horizontal position on the preceding line. If the active position is at the top margin, a scroll down is performed.

Specified by:

reverseIndex in interface VT100Renderer

setScrollRegion

public void setScrollRegion(int begLine,
                            int endLine)

Set scroll window.

Specified by:

setScrollRegion in interface VT100Renderer

Parameters:

begLine - Start line.

endLine - End line.

setCursorVisible

public abstract void setCursorVisible(boolean showCursor)

Set cursor visibility.

Specified by:

setCursorVisible in interface VT100Renderer

Parameters:

showCursor -

setAutoWrap

public void setAutoWrap(boolean autoWrap)

Set auto wrap mode.

Specified by:

setAutoWrap in interface VT100Renderer

Parameters:

autoWrap -

getCursorRow

public int getCursorRow()

Get cursor current row position.

Specified by:

getCursorRow in interface VT100Renderer

Returns:

row number

getCursorCol

public int getCursorCol()

Get cursor current column position.

Specified by:

getCursorCol in interface VT100Renderer

Returns:

column number

getColumns

public int getColumns()

Get number of columns.

Specified by:

getColumns in interface VT100Renderer

Returns:

Number of columns

attributeMask

public abstract int attributeMask(int id)

Get attribute mask.

Specified by:

attributeMask in interface VT100Renderer

Parameters:

id - Attribute id.

0 - NORMAL 1 - BLINK 2 - BOLD 3 - UNDERLINE 4 - REVERSE

Returns:

attribute mask.

emptyCell

protected abstract T emptyCell()

Create an empty cell.

Returns:

An empty video memory cell.

makeCell

protected abstract T makeCell(char text,
                              int attribute,
                              int color)

Build a new video memory cell.

Parameters:

text - Cell character.

attribute - Color attributes

color - Color pair FG/BG

Returns:

A new video memory cell.

updateScreen

protected abstract void updateScreen()

Update screen.

moveCursorNext

private void moveCursorNext()

Move cursor to the next position.

clearRow

private void clearRow(int rowIndex,
                      int begCol,
                      int endCol)

Parameters:

rowIndex - Row number.

begCol - Start column position.

endCol - End column position.

scrollUp

private void scrollUp()

Scroll UP one line in scroll window.

scrollDown

private void scrollDown()

Scroll DOWN one line in scroll window.

clearScreen

private void clearScreen(int begRow,
                         int endRow)

Clear screen.

Parameters:

begRow - Start row number.

endRow - End row number.