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

Class AbstractChuiDriver

java.lang.Object

com.goldencode.p2j.ui.client.driver.AbstractDriver<BasePrimitives,ChuiOutputManager>

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

All Implemented Interfaces:

ScreenDriver<ChuiOutputManager>

Direct Known Subclasses:

ChuiWebDriver, ConsoleDriver, SwingChuiDriver

public abstract class AbstractChuiDriver
extends AbstractDriver<BasePrimitives,ChuiOutputManager>

Simple base class for ChUI-specific screen driver implementation features. GUI-specific features are not to be implemented here. This class is intended to be specific to a given UI-modality (ChUI in this case). However, no driver-specific implementation classes or features should be present. For example, no Swing-specific feature usage is allowed.

Nested Class Summary

Nested classes/interfaces inherited from interface com.goldencode.p2j.ui.client.driver.ScreenDriver

ScreenDriver.UriPathAnchor

Field Summary

Fields inherited from class com.goldencode.p2j.ui.client.driver.AbstractDriver

BEEP_FILE_PATH, direct, factory

Constructor Summary

Constructors

Constructor and Description
AbstractChuiDriver(BasePrimitives direct, java.lang.String term) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	captureMouseEvents(boolean state) Enable or disable capture of mouse events.
static TerminalOptions	convertToOptions(BootstrapConfig cfg) Read configuration values from the bootstrap configuration and convert these into an options instance.
ChuiOutputManager	createOutputManager(BootstrapConfig cfg) Get the OutputManager instance associated with this driver.
void	handleMouseEvent(int sourceID, java.awt.event.MouseEvent evt) Handle the specified event, in the context of the specified widget.
boolean	setCursorStatus(boolean on) Set cursor status (ON/OFF).
void	updateClientMetrics(ClientMetrics metrics) Updates the screen metrics.

Methods inherited from class com.goldencode.p2j.ui.client.driver.AbstractDriver

getFactory, getHostByName, getHostName, getPrimitives, getWindowSystem, inBackgroundMode, inBatchMode, init, isChui, playBeep, setBackgroundMode, setBatchMode, setTerminalType, shutdown, 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.driver.ScreenDriver

beep, chooseFiles, clear, clientReady, deregisterWidget, getChildProcessFactory, getName, isEmbeddedClient, isWeb, lockMousePointer, openMimeResource, openMimeResource, propagate, readKey, resetMode, resume, resume, setControl, setCurrentLanguage, suspend, suspend, widgetStateChanged

Constructor Detail

AbstractChuiDriver

public AbstractChuiDriver(BasePrimitives direct,
                          java.lang.String term)

Construct a new instance.

Parameters:

direct - The output primitives.

term - Terminal type string.

Method Detail

convertToOptions

public static TerminalOptions convertToOptions(BootstrapConfig cfg)

Read configuration values from the bootstrap configuration and convert these into an options instance.

The following parameters are supported:

 Category:Group:Key       Type
 -----------------------  ---------------------------
 client:chui:rows         integer
 client:chui:columns      integer
 client:chui:background   text which can be converted to a ColorRgb by ColorRgb.fromString()
 client:chui:foreground   text which can be converted to a ColorRgb by ColorRgb.fromString()
 client:chui:selection    text which can be converted to a ColorRgb by ColorRgb.fromString()
 client:chui:fontname     text containing a monospaced (fixed width) font family name
 client:chui:fontsize     integer
 

Parameters:

cfg - The bootstrap configuration.

Returns:

A new options instance with any defaults overridden as specified in the bootstrap configuration.

createOutputManager

public ChuiOutputManager createOutputManager(BootstrapConfig cfg)

Get the OutputManager instance associated with this driver.

Parameters:

cfg - The initial configuration for this driver.

Returns:

The instance.

setCursorStatus

public boolean setCursorStatus(boolean on)

Set cursor status (ON/OFF).

For GUI, this does nothing.

Parameters:

on - true - show cursor, false - hide cursor.

Returns:

Always false.

captureMouseEvents

public boolean captureMouseEvents(boolean state)

Enable or disable capture of mouse events.

This implementation is a no-op.

Parameters:

state - true to capture mouse events, false to ignore them.

Returns:

The previous state.

handleMouseEvent

public void handleMouseEvent(int sourceID,
                             java.awt.event.MouseEvent evt)

Handle the specified event, in the context of the specified widget.

This implementation is a no-op.

Parameters:

sourceID - The source widget ID.

evt - The mouse event.

updateClientMetrics

public void updateClientMetrics(ClientMetrics metrics)

Updates the screen metrics.

Parameters:

metrics - The instance to update.