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

Class ChuiOutputManager

java.lang.Object

com.goldencode.p2j.ui.client.OutputManager<BasePrimitives>

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

All Implemented Interfaces:

StreamableManager

public class ChuiOutputManager
extends OutputManager<BasePrimitives>
implements StreamableManager

Provides a generic interface to low level character user interface primitives.

Field Summary

Fields

Modifier and Type	Field and Description
protected BasePrimitives	directOutput Direct drawing routines.
private static CentralLogger	LOG Logger
private WidgetRegistry<ChuiOutputManager>	registry Widget registry.
private Window<?>	streamableWindow The window to which streamable widgets are attached, in redirected mode.
static char	UACS_BTEE Bottom tee drawing char.
static char	UACS_CKBOARD Checker board char for scrollbars body.
static char	UACS_DARROW Down arrow char for vertical scrollbars.
static char	UACS_HLINE Horizontal line drawing char.
static char	UACS_LARROW Left arrow char for horizontal scrollbars.
static char	UACS_LLCORNER Lower left corner drawing char.
static char	UACS_LRCORNER Lower right corner drawing char.
static char	UACS_RARROW Right arrow char for horizontal scrollbars.
static char	UACS_SELECT Current selection char for selection lists.
static char	UACS_TTEE Top tee drawing char.
static char	UACS_UARROW Up arrow char for vertical scrollbars.
static char	UACS_ULCORNER Upper left corner drawing char.
static char	UACS_URCORNER Upper right corner drawing char.
static char	UACS_VLINE Vertical line drawing char.

Fields inherited from class com.goldencode.p2j.ui.client.OutputManager

CHUI_DRIVER_BATCH, CHUI_DRIVER_CONSOLE, CHUI_DRIVER_SWING, CHUI_DRIVER_WEB, defaultOutput, defaultTerminal, drawing, driver, GUI_DRIVER_SWING, GUI_DRIVER_WEB, invalidate, output

Constructor Summary

Constructors

Constructor and Description
ChuiOutputManager(ScreenDriver<ChuiOutputManager> driver) Create a new output manager instance, with the specified driver.

Method Summary

Modifier and Type	Method and Description
void	addEditableFrameForWidget(Widget<?> widget) Register editable frame related widget resources.
ChuiOutputManager	append(int chr, Color color) Append character with specified color at current cursor location and advance the cursor.
ChuiOutputManager	append(java.lang.String text, Color color) Append string with specified color at current cursor location and advance the cursor.
ChuiOutputManager	at(double x, double y) Set cursor position.
ChuiOutputManager	at(NativePoint p) Set cursor position.
ChuiOutputManager	at(Point p) Set cursor position.
Color	borderColor(Widget<ChuiOutputManager> widget) Obtain border color for specified widget.
ChuiOutputManager	box(Point origin, Dimension size, Color color) Draw box at specified location with provided size and color.
private ChuiOutputManager	box(Rectangle rect, Color color) Draw box at specified location with provided size and color.
void	boxToScreen(Point origin, Dimension size, Color color) Draw box at interactive terminal.
void	clear(Widget<?> widget) Clear area occupied by specified widget.
void	clearScreen() Clear screen.
NativePoint	cursor() Get current cursor position.
private void	drawHBorder(double col, double row, double width, Color color) Draw the upper or lower border.
private void	drawVBorder(double col, double row, double height, Color color) Draw the left or right border.
ScreenBitmap	getBitmapCopy() Get a copy of the current screen bitmap.
BasePrimitives	getDirectOutput() Obtain the direct output worker.
ChuiWidgetFactory	getFactory() Access driver-specific widget factory.
WidgetRegistry<ChuiOutputManager>	getRegistry() Get the widget registry for this output manager.
StreamableManager	getStreamableManager() Get the streamable manager for this manager instance, used for redirected terminal support.
Window<?>	getStreamableWindow() Get the Window instance which can be used in redirected mode.
boolean	hasWindowEmulator(int windowId) Check if window has an emulator for the given window id.
ChuiOutputManager	hLine(double len, Color color) Draw horizontal line.
void	init() Initialize this output manager.
boolean	isRedirected() Reports if the terminal is currently redirected to a stream.
protected TitledWindow<?>	overrideWindow(TopLevelWindow<?> window) Check if the window being drawn needs to be overridden.
protected boolean	raiseStopCondition(int key) Check if the given key can raise the STOP condition.
void	releaseWidgetResources(Widget<?> widget) ChUI Implementation specific method of removing widget from registry
void	removeEditableFrameForWidget(Widget<?> widget) Register editable frame related widget resources.
ScreenBitmap	screenBitmap() Determine the screen bitmap associated with the default window.
void	setBitmap(ScreenBitmap bitmap) Restore the bitmap to a previous state.
ChuiOutputManager	stayAt(NativePoint p) Set real cursor position.
ChuiOutputManager	stayAt(Point p) Set real cursor position.
BasePrimitives	switchOutput(OutputPrimitives newOps) Redirect terminal output to the drawing worker represented by newOps (or back to the interactive terminal if newOps is null) and return the instance representing the current output destination.
ChuiOutputManager	vLine(double len, Color color) Draw a vertical line of the specified length starting at the current cursor position.

Methods inherited from class com.goldencode.p2j.ui.client.OutputManager

activateBatch, beep, clear, clear, clipWith, coordinates, drawNeeded, fixCoordinates, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getClippings, getClippings, getDriver, getInstanceDriver, getInteractiveOutput, getInvalidChars, inBatchMode, init, initErrorWriter, initErrorWriter, instance, isBatchInBackground, isBatchModeOverride, isChui, isInvalidate, managerInstance, markArea, newInstance, readKey, refresh, registerWindow, registerWindow, releaseWindow, releaseWindow, resetBitmap, resetInvalidate, resetMode, resolveWidget, restoreInvalidate, resume, saveInvalidate, saveInvalidate, screenBitmap, screenDimension, screenHeight, screenWidth, selectWindow, setBitmap, setCursorStatus, setDisableRedraw, setDrawingArea, setInvalidate, setInvalidate, setInvalidate, setTerminalType, startScreenSearch, suspend, sync, terminalType

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.StreamableManager

newInstance

Field Detail

UACS_BTEE

public static final char UACS_BTEE

Bottom tee drawing char.

See Also:

Constant Field Values

UACS_TTEE

public static final char UACS_TTEE

Top tee drawing char.

See Also:

Constant Field Values

UACS_LLCORNER

public static final char UACS_LLCORNER

Lower left corner drawing char.

See Also:

Constant Field Values

UACS_LRCORNER

public static final char UACS_LRCORNER

Lower right corner drawing char.

See Also:

Constant Field Values

UACS_URCORNER

public static final char UACS_URCORNER

Upper right corner drawing char.

See Also:

Constant Field Values

UACS_ULCORNER

public static final char UACS_ULCORNER

Upper left corner drawing char.

See Also:

Constant Field Values

UACS_HLINE

public static final char UACS_HLINE

Horizontal line drawing char.

See Also:

Constant Field Values

UACS_VLINE

public static final char UACS_VLINE

Vertical line drawing char.

See Also:

Constant Field Values

UACS_UARROW

public static final char UACS_UARROW

Up arrow char for vertical scrollbars.

See Also:

Constant Field Values

UACS_DARROW

public static final char UACS_DARROW

Down arrow char for vertical scrollbars.

See Also:

Constant Field Values

UACS_LARROW

public static final char UACS_LARROW

Left arrow char for horizontal scrollbars.

See Also:

Constant Field Values

UACS_RARROW

public static final char UACS_RARROW

Right arrow char for horizontal scrollbars.

See Also:

Constant Field Values

UACS_CKBOARD

public static final char UACS_CKBOARD

Checker board char for scrollbars body.

See Also:

Constant Field Values

UACS_SELECT

public static final char UACS_SELECT

Current selection char for selection lists.

See Also:

Constant Field Values

LOG

private static final CentralLogger LOG

Logger

directOutput

protected BasePrimitives directOutput

Direct drawing routines.

registry

private final WidgetRegistry<ChuiOutputManager> registry

Widget registry.

streamableWindow

private Window<?> streamableWindow

The window to which streamable widgets are attached, in redirected mode.

Constructor Detail

ChuiOutputManager

public ChuiOutputManager(ScreenDriver<ChuiOutputManager> driver)

Create a new output manager instance, with the specified driver.

Parameters:

driver - Implements low level input/output primitives. Must NOT be null.

Method Detail

getStreamableWindow

public Window<?> getStreamableWindow()

Get the Window instance which can be used in redirected mode.

Specified by:

getStreamableWindow in interface StreamableManager

Returns:

See above.

getStreamableManager

public StreamableManager getStreamableManager()

Get the streamable manager for this manager instance, used for redirected terminal support.

Specified by:

getStreamableManager in class OutputManager<BasePrimitives>

Returns:

See above.

init

public void init()

Initialize this output manager.

Overrides:

init in class OutputManager<BasePrimitives>

switchOutput

public BasePrimitives switchOutput(OutputPrimitives newOps)

Redirect terminal output to the drawing worker represented by newOps (or back to the interactive terminal if newOps is null) and return the instance representing the current output destination. This may be another null if the interactive terminal is in use.

Specified by:

switchOutput in class OutputManager<BasePrimitives>

Parameters:

newOps - The drawing worker or null to remove redirections and activate the interactive terminal.

Returns:

The previous drawing worker instance.

isRedirected

public boolean isRedirected()

Reports if the terminal is currently redirected to a stream.

Specified by:

isRedirected in class OutputManager<BasePrimitives>

Returns:

true if the terminal is redirected to a stream, false if the terminal is interactive.

getFactory

public ChuiWidgetFactory getFactory()

Access driver-specific widget factory.

Specified by:

getFactory in class OutputManager<BasePrimitives>

Returns:

reference to widget factory.

getRegistry

public WidgetRegistry<ChuiOutputManager> getRegistry()

Get the widget registry for this output manager.

Specified by:

getRegistry in class OutputManager<BasePrimitives>

Returns:

See above.

clear

public void clear(Widget<?> widget)

Clear area occupied by specified widget.

Specified by:

clear in class OutputManager<BasePrimitives>

Parameters:

widget - Reference widget.

clearScreen

public void clearScreen()

Clear screen.

append

public ChuiOutputManager append(int chr,
                                Color color)

Append character with specified color at current cursor location and advance the cursor.

Parameters:

chr - Character to append.

color - Color and attribute.

Returns:

this to enable chaining.

append

public ChuiOutputManager append(java.lang.String text,
                                Color color)

Append string with specified color at current cursor location and advance the cursor.

Specified by:

append in interface StreamableManager

Parameters:

text - Character to append.

color - Color and attribute.

Returns:

this to enable chaining.

hLine

public ChuiOutputManager hLine(double len,
                               Color color)

Draw horizontal line.

Parameters:

len - Line length.

color - Line color.

Returns:

this to enable chaining.

vLine

public ChuiOutputManager vLine(double len,
                               Color color)

Draw a vertical line of the specified length starting at the current cursor position.

Parameters:

len - Vertical line length.

color - Line color.

Returns:

this to enable chaining.

box

public ChuiOutputManager box(Point origin,
                             Dimension size,
                             Color color)

Draw box at specified location with provided size and color.

Parameters:

origin - Upper left corner of the box.

size - Box dimensions.

color - Color and attribute of the box lines.

Returns:

this to enable chaining.

boxToScreen

public void boxToScreen(Point origin,
                        Dimension size,
                        Color color)

Draw box at interactive terminal.

Parameters:

origin - Upper left corner.

size - Box dimensions.

color - Box color.

borderColor

public Color borderColor(Widget<ChuiOutputManager> widget)

Obtain border color for specified widget.

Parameters:

widget - Widget for which border color should be obtained.

Returns:

Widget border color.

at

public ChuiOutputManager at(double x,
                            double y)

Set cursor position.

Parameters:

x - Cursor X.

y - Cursor Y.

Returns:

this to enable chaining.

at

public ChuiOutputManager at(Point p)

Set cursor position.

Parameters:

p - New cursor position.

Returns:

this to enable chaining.

at

public ChuiOutputManager at(NativePoint p)

Set cursor position.

Parameters:

p - New cursor position.

Returns:

this to enable chaining.

stayAt

public ChuiOutputManager stayAt(Point p)

Set real cursor position.

Parameters:

p - New cursor position.

Returns:

this to enable chaining.

stayAt

public ChuiOutputManager stayAt(NativePoint p)

Set real cursor position.

Parameters:

p - New cursor position.

Returns:

this to enable chaining.

getDirectOutput

public BasePrimitives getDirectOutput()

Obtain the direct output worker.

Returns:

The output worker used to draw directly to the screen with ncurses

hasWindowEmulator

public boolean hasWindowEmulator(int windowId)

Check if window has an emulator for the given window id.

Overrides:

hasWindowEmulator in class OutputManager<BasePrimitives>

Parameters:

windowId - Window ID.

Returns:

Always true.

cursor

public NativePoint cursor()

Get current cursor position.

Returns:

current cursor position.

box

private ChuiOutputManager box(Rectangle rect,
                              Color color)

Draw box at specified location with provided size and color.

Parameters:

rect - The box to draw.

color - Color and attribute of the box lines.

Returns:

this to enable chaining.

drawHBorder

private void drawHBorder(double col,
                         double row,
                         double width,
                         Color color)

Draw the upper or lower border.

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

private void drawVBorder(double col,
                         double row,
                         double height,
                         Color color)

Draw the left or right border.

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)

getBitmapCopy

public ScreenBitmap getBitmapCopy()

Get a copy of the current screen bitmap.

Returns:

a copy of the current screen bitmap.

setBitmap

public void setBitmap(ScreenBitmap bitmap)

Restore the bitmap to a previous state.

Parameters:

bitmap - The bitmap instance to set as the output primitive's bitmap.

raiseStopCondition

protected boolean raiseStopCondition(int key)

Check if the given key can raise the STOP condition.

Specified by:

raiseStopCondition in class OutputManager<BasePrimitives>

Parameters:

key - The key code to be checked.

Returns:

true if the key is the Key.VK_CTRL_C key.

screenBitmap

public ScreenBitmap screenBitmap()

Determine the screen bitmap associated with the default window.

Specified by:

screenBitmap in interface StreamableManager

Returns:

The ScreenBitmap associated with this window.

releaseWidgetResources

public void releaseWidgetResources(Widget<?> widget)

ChUI Implementation specific method of removing widget from registry

Specified by:

releaseWidgetResources in class OutputManager<BasePrimitives>

Parameters:

widget - Widget to have resources released

overrideWindow

protected TitledWindow<?> overrideWindow(TopLevelWindow<?> window)

Check if the window being drawn needs to be overridden.

In ChUI, the current top window will always be returned. This might be some other window than default-window.

Specified by:

overrideWindow in class OutputManager<BasePrimitives>

Parameters:

window - The currently active window.

Returns:

See above.

removeEditableFrameForWidget

public void removeEditableFrameForWidget(Widget<?> widget)

Register editable frame related widget resources.

Specified by:

removeEditableFrameForWidget in class OutputManager<BasePrimitives>

Parameters:

widget - Widget to have resources released

addEditableFrameForWidget

public void addEditableFrameForWidget(Widget<?> widget)

Register editable frame related widget resources.

Specified by:

addEditableFrameForWidget in class OutputManager<BasePrimitives>

Parameters:

widget - Widget to have resources released