com.goldencode.p2j.ui.chui

Class TraceableTerminal

java.lang.Object

com.goldencode.p2j.ui.chui.BasePrimitives

com.goldencode.p2j.ui.chui.TraceableTerminal

All Implemented Interfaces:

OutputPrimitives

public class TraceableTerminal
extends BasePrimitives

This implementation can be used to trace all output calls for testing and/or debugging purposes.

Field Summary

Fields

Modifier and Type	Field and Description
private static CentralLogger	LOG Logger
(package private) BasePrimitives	std default plugin

Fields inherited from class com.goldencode.p2j.ui.chui.BasePrimitives

cursorInvalid, EMPTY_CELL

Constructor Summary

Constructors

Constructor and Description
TraceableTerminal() Creates an instance.

Method Summary

Modifier and Type	Method and Description
void	append(int chr, Color color) Add a character to the virtual terminal at the current cursor position.
void	append(java.lang.String str, Color color) Add a string to the virtual terminal at the current cursor position.
void	box(int left, int top, int right, int bottom, Color color) Draw a box using the specified dimensions and color pair.
Cell	cellAt(int row, int col) Get character at specified position.
void	clearArea(int left, int top, int right, int bottom, Color color) Blank out a box using the specified attributes and color pair.
private void	cp() Prints cursor position.
boolean	cursorAt(int x, int y) Position the virtual cursor during the drawing.
boolean	cursorStay(int x, int y) Position the real cursor.
void	drawHBorder(int col, int row, int width, Color color) Draw the upper or lower border.
void	drawLLCorner(int col, int row, Color color) Draw the lower-left border corner.
void	drawLRCorner(int col, int row, Color color) Draw the lower-right border corner.
void	drawULCorner(int col, int row, Color color) Draw the upper-left border corner.
void	drawURCorner(int col, int row, Color color) Draw the upper-right border corner.
void	drawVBorder(int col, int row, int height, Color color) Draw the left or right border.
ScreenBitmap	getScreenBitmap() Get the screen bitmap for this output primitives implementation.
int	getX() Get absolute X position of the cursor.
int	getY() Get absolute Y position of the cursor.
boolean	hasBoxBorderCorners() Check if this output primitives implementation requires border corners when drawing a box.
void	hLine(int length, Color color) Draw a horizontal line of the specified length starting at the current cursor position.
void	refresh(NativeRectangle rect) Mark a rectangle as needing repainting.
int	screenHeight() Gets the number of rows on the screen.
int	screenWidth() Gets the number of columns on the screen.
void	setScreenBitmap(ScreenBitmap bitmap) Replace the current bitmap instance with this one.
void	sync() Synchronize the state of the physical terminal with the state of the virtual terminal.
private void	tn(java.lang.String s) Prints a string with new line.
void	trace(boolean tracing) Controls the tracing of the primitives.
void	updateScreen(ScreenData screen) Perform a bulk output operation for the whole screen at once with output masking when desired.
void	vLine(int length, Color color) Draw a vertical line of the specified length starting at the current cursor position.

Methods inherited from class com.goldencode.p2j.ui.chui.BasePrimitives

borderColor, getWindowId, isCursorInvalid, setCursorInvalid, widgetColor

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final CentralLogger LOG

Logger

std

BasePrimitives std

default plugin

Constructor Detail

TraceableTerminal

public TraceableTerminal()

Creates an instance.

Method Detail

trace

public void trace(boolean tracing)

Controls the tracing of the primitives.

Parameters:

tracing - true turns tracing on

append

public void append(int chr,
                   Color color)

Add a character to the virtual terminal at the current cursor position.

Specified by:

append in class BasePrimitives

Parameters:

chr - The character to output.

color - Color.

append

public void append(java.lang.String str,
                   Color color)

Add a string to the virtual terminal at the current cursor position.

Specified by:

append in class BasePrimitives

Parameters:

str - The text to output.

color - Color.

hLine

public void hLine(int length,
                  Color color)

Draw a horizontal line of the specified length starting at the current cursor position. Always uses a '-' to draw.

Specified by:

hLine in class BasePrimitives

Parameters:

length - The length of the line to draw in columns.

color - Color.

vLine

public void vLine(int length,
                  Color color)

Draw a vertical line of the specified length starting at the current cursor position. Always uses a ' ' (space character) to draw.

Specified by:

vLine in class BasePrimitives

Parameters:

length - The length of the line to draw in rows.

color - Color.

clearArea

public void clearArea(int left,
                      int top,
                      int right,
                      int bottom,
                      Color color)

Blank out a box using the specified attributes and color pair.

Parameters:

left - The left column of the rectangle.

top - The top row of the rectangle.

right - The right column of the rectangle.

bottom - The bottom row of the rectangle.

color - Color.

box

public void box(int left,
                int top,
                int right,
                int bottom,
                Color color)

Draw a box using the specified dimensions and color pair.

Specified by:

box in class BasePrimitives

Parameters:

left - The left column of the rectangle.

top - The top row of the rectangle.

right - The right column of the rectangle.

bottom - The bottom row of the rectangle.

color - Color.

getX

public int getX()

Get absolute X position of the cursor.

Specified by:

getX in class BasePrimitives

Returns:

The X position of the cursor.

getY

public int getY()

Get absolute Y position of the cursor.

Specified by:

getY in class BasePrimitives

Returns:

The Y position of the cursor.

cursorAt

public boolean cursorAt(int x,
                        int y)

Position the virtual cursor during the drawing.

Specified by:

cursorAt in class BasePrimitives

Parameters:

x - Cursor X coordinate.

y - Cursor Y coordinate.

Returns:

true if cursor positioning succeeded.

cursorStay

public boolean cursorStay(int x,
                          int y)

Position the real cursor.

Specified by:

cursorStay in class BasePrimitives

Parameters:

x - Cursor X coordinate.

y - Cursor Y coordinate.

Returns:

true if cursor positioning succeeded.

refresh

public void refresh(NativeRectangle rect)

Mark a rectangle as needing repainting. Makes sense with the double buffered output only; ignored here.

Parameters:

rect - rectangle to mark for repainting

screenWidth

public int screenWidth()

Gets the number of columns on the screen.

Returns:

The number of columns (in characters).

screenHeight

public int screenHeight()

Gets the number of rows on the screen.

Returns:

The number of rows (lines of characters).

sync

public void sync()

Synchronize the state of the physical terminal with the state of the virtual terminal.

tn

private void tn(java.lang.String s)

Prints a string with new line.

Parameters:

s - string to print

cp

private void cp()

Prints cursor position.

getScreenBitmap

public ScreenBitmap getScreenBitmap()

Get the screen bitmap for this output primitives implementation.

Returns:

The screen bitmap.

setScreenBitmap

public void setScreenBitmap(ScreenBitmap bitmap)

Replace the current bitmap instance with this one.

Parameters:

bitmap - The new bitmap instance.

drawULCorner

public void drawULCorner(int col,
                         int row,
                         Color color)

Draw the upper-left border corner.

Specified by:

drawULCorner in class BasePrimitives

Parameters:

col - The column number where to draw.

row - The row number where to draw.

color - The number of the color-pair (foreground+background) to use for blanking the rectangle.

drawURCorner

public void drawURCorner(int col,
                         int row,
                         Color color)

Draw the upper-right border corner.

Specified by:

drawURCorner in class BasePrimitives

Parameters:

col - The column number where to draw.

row - The row number where to draw.

color - The number of the color-pair (foreground+background) to use for blanking the rectangle.

drawLLCorner

public void drawLLCorner(int col,
                         int row,
                         Color color)

Draw the lower-left border corner.

Specified by:

drawLLCorner in class BasePrimitives

Parameters:

col - The column number where to draw.

row - The row number where to draw.

color - The number of the color-pair (foreground+background) to use for blanking the rectangle.

drawLRCorner

public void drawLRCorner(int col,
                         int row,
                         Color color)

Draw the lower-right border corner.

Specified by:

drawLRCorner in class BasePrimitives

Parameters:

col - The column number where to draw.

row - The row number where to draw.

color - The number of the color-pair (foreground+background) to use for blanking the rectangle.

drawHBorder

public void drawHBorder(int col,
                        int row,
                        int width,
                        Color color)

Draw the upper or lower border.

Specified by:

drawHBorder in class BasePrimitives

Parameters:

col - The column number where to draw.

row - The row number where to draw.

width - The border width.

color - The number of the color-pair (foreground+background)

drawVBorder

public void drawVBorder(int col,
                        int row,
                        int height,
                        Color color)

Draw the left or right border.

Specified by:

drawVBorder in class BasePrimitives

Parameters:

col - The column number where to draw.

row - The row number where to draw.

height - The border height.

color - The number of the color-pair (foreground+background)

hasBoxBorderCorners

public boolean hasBoxBorderCorners()

Check if this output primitives implementation requires border corners when drawing a box.

Overrides:

hasBoxBorderCorners in class BasePrimitives

Returns:

true if the box should be drawn with border corners.

cellAt

public Cell cellAt(int row,
                   int col)

Get character at specified position.

Overrides:

cellAt in class BasePrimitives

Parameters:

row - Character row.

col - Character column.

Returns:

character from specified position or space if operation is not supported.

updateScreen

public void updateScreen(ScreenData screen)

Perform a bulk output operation for the whole screen at once with output masking when desired. Set the cursor afterwards.

Overrides:

updateScreen in class BasePrimitives

Parameters:

screen - Container for whole screen content and cursor position.