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

Class BatchPrimitives

java.lang.Object

com.goldencode.p2j.ui.chui.BasePrimitives

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

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

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

All Implemented Interfaces:

OutputPrimitives

public class BatchPrimitives
extends ConsolePrimitives

Implementation of the primitives for batch mode screen driver.

This implementation uses console-based null driver for terminal access. This means all i/o requests will produce the error messages and immediate stop for client application. There are two modes of functionality. If batch mode is active the primitives generate error otherwise the control is passing to the underlying console primitive handlers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchPrimitives.OutputWriter Interface to define how BatchPrimitives writes output.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isActive Flag indicating whether we need to do special processing or just ignore calls.
private BatchPrimitives.OutputWriter	outputWriter Defines the writer for displaying messages.

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

cursorInvalid, EMPTY_CELL

Constructor Summary

Constructors

Constructor and Description
BatchPrimitives() Constructor.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates special processing for batch mode.
void	append(java.lang.String str, Color color) Add a string to the virtual terminal at the current cursor position.
boolean	cursorAt(int x, int y) Position the virtual cursor during the drawing.
void	deActivate() Deactivates special processing for batch mode.
boolean	isActive() Check if the special internal processing for batch mode is active.
int	screenHeight() Gets the number of rows on the screen.
int	screenWidth() Gets the number of columns on the screen.
void	setOutputWriter(BatchPrimitives.OutputWriter outputWriter) Sets the writer for output.
void	sync() Synchronize the state of the physical terminal with the state of the virtual terminal.
void	updateScreen(ScreenData screen) Perform a bulk output operation for the whole screen at once with output masking when desired.

Methods inherited from class com.goldencode.p2j.ui.client.chui.driver.console.ConsolePrimitives

cursorStay, getX, getY, init

Methods inherited from class com.goldencode.p2j.ui.client.chui.driver.DriverPrimitives

append, borderColor, box, clearArea, drawHBorder, drawLLCorner, drawLRCorner, drawULCorner, drawURCorner, drawVBorder, getScreenBitmap, hLine, refresh, setScreenBitmap, vLine, widgetColor

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

cellAt, getWindowId, hasBoxBorderCorners, isCursorInvalid, setCursorInvalid

Methods inherited from class java.lang.Object

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

Field Detail

isActive

private boolean isActive

Flag indicating whether we need to do special processing or just ignore calls.

outputWriter

private BatchPrimitives.OutputWriter outputWriter

Defines the writer for displaying messages.

Constructor Detail

BatchPrimitives

public BatchPrimitives()

Constructor.

Method Detail

activate

public void activate()

Activates special processing for batch mode. This means all i/o terminal requests produce error writing and immediate application stop.

deActivate

public void deActivate()

Deactivates special processing for batch mode. This means all i/o terminal requests will be ignored and application will contimue.

isActive

public boolean isActive()

Check if the special internal processing for batch mode is active.

Returns:

true if batch mode is active, false otherwise.

cursorAt

public boolean cursorAt(int x,
                        int y)

Position the virtual cursor during the drawing.

Overrides:

cursorAt in class ConsolePrimitives

Parameters:

x - New cursor X.

y - New cursor Y.

Returns:

true if cursor positioning succeeded.

append

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

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

Overrides:

append in class ConsolePrimitives

Parameters:

str - The text to output.

color - The Color instance used to draw characters. Mapping into native colors is performed internally.

screenHeight

public int screenHeight()

Gets the number of rows on the screen. This is artificial value for batch mode. Windows HEIGHT attribute returns the value that looks like desktop height in chracter units, Linux version returns unknown value(?). However we need the reasonable value to corectly allocate internal character cell bitmaps.

Specified by:

screenHeight in interface OutputPrimitives

Overrides:

screenHeight in class ConsolePrimitives

Returns:

The number of rows (lines of characters) - 24 for batch mode.

screenWidth

public int screenWidth()

Gets the number of columns on the screen. This is artificial value for batch mode. Windows WIDTH attribute returns the value that looks like desktop height in chracter units, Linux version returns unknown value(?). However we need the reasonable value to corectly allocate internal character cell bitmaps.

Specified by:

screenWidth in interface OutputPrimitives

Overrides:

screenWidth in class ConsolePrimitives

Returns:

The number of columns (in characters).

sync

public void sync()

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

Specified by:

sync in interface OutputPrimitives

Overrides:

sync in class ConsolePrimitives

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.

The screen container is safe for use with characters that are UNICODE encoded which are also outside of the 7-bit ASCII range. Such characters are passed through to the native layer directly and are not converted to a natively encoded form. This could be provided but since one of the primary uses of this method is for drawing characters (e.g. ACS_HLINE) which are encoded using the full 32-bits, any attempt to convert these into a single byte native encoding would lose data.

Because of the above limitation, DO NOT USE THIS FOR OUTPUT OF USER DATA THAT COULD CONTAIN DATA OUTSIDE OF THE 7-bit ASCII RANGE.

Overrides:

updateScreen in class ConsolePrimitives

Parameters:

screen - Container for whole screen content and cursor position.

setOutputWriter

public void setOutputWriter(BatchPrimitives.OutputWriter outputWriter)

Sets the writer for output.

Parameters:

outputWriter - Writer for output that implements BatchPrimitives.OutputWriter interface.