com.goldencode.p2j.ui.client.chui.driver

Class EmulatedTerminalState

java.lang.Object

com.goldencode.p2j.ui.client.chui.driver.EmulatedTerminalState

Direct Known Subclasses:

ChuiSimulator, ChuiWebSimulator

public abstract class EmulatedTerminalState
extends java.lang.Object

This class provides shared emulated terminal simulator logic. It manages the state for a rectangular component that appears to look and act like a character terminal (TTY). However, this class itself is not that component because it must be shared by different UI modalities. For example, it will be used for both Swing and Web terminal emulators.

All output is stored in a 2-dimensional buffer of of cells, which store the character to be drawn and the attributes/color of that character.

The current cursor position is remembered and can be manipulated by the application. The cursor visibility state can be externally controlled as well.

Input is read using key events and that is kept in a FIFO buffer as if they had been sent by the remote terminal hardware.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	cfgLock Lock object for synchronizing configuration usage and changes.
protected int	cursorX Current X coordinate of the cursor.
protected int	cursorY Current Y coordinate of the cursor.
protected Cell[][]	data Screen contents.
protected java.lang.Object	dataLock Lock object for synchronizing data and cursor usage and changes.
protected TerminalOptions	options Terminal configuration storage.
protected java.lang.Object	selLock Lock object for synchronizing selection processing.
protected boolean	showCursor Flag that controls if the cursor is visible or not.

Constructor Summary

Constructors

Constructor and Description
EmulatedTerminalState() Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	append(Cell[] output) Copy the given cells into the 2-dimensional output buffer starting at the current cursor position and writing to the "right", incrementing the cursor X position for each cell.
void	clear() Overwrite the entire 2-dimensional output buffer with the space character to be rendered with the Color.NORMAL color.
void	configure(TerminalOptions terminalOptions) Initialize the instance using the given configuration.
int	getColumns() Gets the number of columns on the screen.
int	getCursorX() Get the cursor's current X coordinate.
int	getCursorY() Get the cursor's current Y coordinate.
int	getRows() Gets the number of rows on the screen.
Cell[][]	getScreenData() Get screen memory array.
TerminalOptions	getTerminalOptions() Get terminal options used by client.
void	replace(Cell[][] screen, int newX, int newY) Completely replace the current 2-dimensional output buffer with the content on the given screen parameter and then set the the cursor position to the given values.
boolean	setCursor(int x, int y) Position the cursor.
boolean	setCursorStatus(boolean on) Set the cursor visibility.
private boolean	setCursorWorker(int x, int y, int w, int h) Position the cursor.
abstract void	triggerRepaint(boolean full) Cause a partial or full repaint to occur.

Methods inherited from class java.lang.Object

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

Field Detail

options

protected TerminalOptions options

Terminal configuration storage.

cfgLock

protected java.lang.Object cfgLock

Lock object for synchronizing configuration usage and changes.

selLock

protected java.lang.Object selLock

Lock object for synchronizing selection processing.

dataLock

protected java.lang.Object dataLock

Lock object for synchronizing data and cursor usage and changes.

showCursor

protected boolean showCursor

Flag that controls if the cursor is visible or not.

data

protected Cell[][] data

Screen contents.

cursorX

protected int cursorX

Current X coordinate of the cursor.

cursorY

protected int cursorY

Current Y coordinate of the cursor.

Constructor Detail

EmulatedTerminalState

public EmulatedTerminalState()

Create a new instance.

Method Detail

append

public void append(Cell[] output)

Copy the given cells into the 2-dimensional output buffer starting at the current cursor position and writing to the "right", incrementing the cursor X position for each cell. When the last column is reached, the cursor X will wrap back to 0 and the cursor Y will increment to the next row. When the last column of the last row is written, both the cursor X and Y positions will wrap back to 0.

This write operation does not cause a repaint to occur, but the next repaint that does occur will do so with the updated content.

Parameters:

output - List of cells to write into the buffer.

replace

public void replace(Cell[][] screen,
                    int newX,
                    int newY)

Completely replace the current 2-dimensional output buffer with the content on the given screen parameter and then set the the cursor position to the given values. Only non-null cells are copied. Any cells that are null are ignored and left alone in the target buffer.

This write operation DOES cause a repaint to occur.

Parameters:

screen - 2-dimensional array of cells to write into the buffer. This must have the same dimensions as the output buffer and all rows must have column arrays of the same size.

newX - Cursor X position after the method call.

newY - Cursor Y position after the method call.

clear

public void clear()

Overwrite the entire 2-dimensional output buffer with the space character to be rendered with the Color.NORMAL color. Sets the cursor Y and X positions to 0.

setCursor

public boolean setCursor(int x,
                         int y)

Position the cursor.

Parameters:

x - New X cursor position.

y - New Y cursor position.

Returns:

true if cursor positioning succeeded.

setCursorStatus

public boolean setCursorStatus(boolean on)
                        throws java.lang.IllegalStateException

Set the cursor visibility.

Parameters:

on - true to make the cursor visible (subsequen repaint operations will then cause the cursor to be drawn).

Returns:

The previous cursor visiblity state.

Throws:

java.lang.IllegalStateException

getCursorX

public int getCursorX()

Get the cursor's current X coordinate.

Returns:

The current X coordinate.

getCursorY

public int getCursorY()

Get the cursor's current Y coordinate.

Returns:

The current Y coordinate.

getRows

public int getRows()

Gets the number of rows on the screen.

Returns:

The number of rows (lines of characters).

getColumns

public int getColumns()

Gets the number of columns on the screen.

Returns:

The number of columns (in characters).

configure

public void configure(TerminalOptions terminalOptions)

Initialize the instance using the given configuration. This will obtain and initialize its fonts (and the color mapper). It will use the font metrics to calculate the size of the component (based on the number of rows and columns). If this is the first initialization, the 2-dimensional output buffer will be created and cleared.

Parameters:

terminalOptions - The configuration for the terminal simulator.

triggerRepaint

public abstract void triggerRepaint(boolean full)

Cause a partial or full repaint to occur. If full is true or if there is no current selection operation occurring, a repaint of the entire component ("screen") will occur. Otherwise, a repaint of only the selection area will occur.

Parameters:

full - Flag to force a the entire screen to repaint.

getScreenData

public Cell[][] getScreenData()

Get screen memory array.

Returns:

The screen memory array.

getTerminalOptions

public TerminalOptions getTerminalOptions()

Get terminal options used by client.

Returns:

Terminal options.

setCursorWorker

private boolean setCursorWorker(int x,
                                int y,
                                int w,
                                int h)

Position the cursor.

Parameters:

x - New X cursor position.

y - New Y cursor position.

w - Screen width.

h - Screen height.

Returns:

true if cursor positioning succeeded.