com.goldencode.p2j.ui.client.driver

Class AbstractDriver<P extends OutputPrimitives,O extends OutputManager<P>>

java.lang.Object

com.goldencode.p2j.ui.client.driver.AbstractDriver<P,O>

All Implemented Interfaces:

ScreenDriver<O>

Direct Known Subclasses:

AbstractChuiDriver, AbstractGuiDriver

public abstract class AbstractDriver<P extends OutputPrimitives,O extends OutputManager<P>>
extends java.lang.Object
implements ScreenDriver<O>

Simple base class for common screen driver implementation features. This should not have any features that are specific to ChUI or GUI. Instead, all features must be independent of any UI modality. In addition, 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

Modifier and Type	Field and Description
private boolean	background Background flag (signifies if the client is in the foreground session).
private boolean	batch Batch mode flag.
protected static java.lang.String	BEEP_FILE_PATH Path to the file containing error beep sound.
protected P	direct Direct to screen output primitives.
protected WidgetFactory<O>	factory This driver-specific widget factory
private boolean	isChui UI modality flag: true for ChUI, false for GUI.
private static CentralLogger	LOG Logger.
private java.lang.String	term Terminal type name.

Constructor Summary

Constructors

Constructor and Description
AbstractDriver(WidgetFactory<O> factory, P direct, boolean isChui, java.lang.String term) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
WidgetFactory<O>	getFactory() Get driver-specific widget factory.
long	getHostByName(java.lang.String name) Returns the currently connected client's machine name for session.
java.lang.String	getHostName() Returns the currently connected client's machine name for session.
P	getPrimitives() Get driver-specific direct output primitives implementation.
java.lang.String	getWindowSystem() Get the default WINDOW-SYSTEM used by this driver.
boolean	inBackgroundMode() Checks if the current driver is running in background mode.
boolean	inBatchMode() Checks if the current driver is running in batch mode.
void	init() Initialize driver.
boolean	isChui() Get screen interface type.
protected java.io.ByteArrayInputStream	playBeep(java.io.ByteArrayInputStream beepAudioData) Load and play beep sound.
protected void	setBackgroundMode(boolean background) Assigns the flag determining if the current driver is running in background mode.
protected void	setBatchMode(boolean batch) Assigns the flag determining if the current driver is running in batch mode.
void	setTerminalType(java.lang.String term) Change terminal type to specified one.
void	shutdown() Perform driver shutdown.
java.lang.String	terminalType() Obtain system/implementation specific terminal type string.

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, captureMouseEvents, chooseFiles, clear, clientReady, createOutputManager, deregisterWidget, getChildProcessFactory, getName, handleMouseEvent, isEmbeddedClient, isWeb, lockMousePointer, openMimeResource, openMimeResource, propagate, readKey, resetMode, resume, resume, setControl, setCurrentLanguage, setCursorStatus, suspend, suspend, updateClientMetrics, widgetStateChanged

Field Detail

BEEP_FILE_PATH

protected static java.lang.String BEEP_FILE_PATH

Path to the file containing error beep sound.

LOG

private static final CentralLogger LOG

Logger.

factory

protected WidgetFactory<O extends OutputManager<P>> factory

This driver-specific widget factory

direct

protected P extends OutputPrimitives direct

Direct to screen output primitives.

isChui

private boolean isChui

UI modality flag: true for ChUI, false for GUI.

batch

private boolean batch

Batch mode flag.

background

private boolean background

Background flag (signifies if the client is in the foreground session).

term

private java.lang.String term

Terminal type name.

Constructor Detail

AbstractDriver

public AbstractDriver(WidgetFactory<O> factory,
                      P direct,
                      boolean isChui,
                      java.lang.String term)

Construct a new instance.

Parameters:

factory - The widget factory to use for this driver.

direct - The output primitives.

isChui - true for ChUI, false for GUI.

term - Terminal type string.

Method Detail

inBatchMode

public boolean inBatchMode()

Checks if the current driver is running in batch mode.

Specified by:

inBatchMode in interface ScreenDriver<O extends OutputManager<P>>

Returns:

Always false.

inBackgroundMode

public boolean inBackgroundMode()

Checks if the current driver is running in background mode.

Specified by:

inBackgroundMode in interface ScreenDriver<O extends OutputManager<P>>

Returns:

Always false.

terminalType

public java.lang.String terminalType()

Obtain system/implementation specific terminal type string.

At present this is used to implement 4GL TERMINAL function and do some terminal-specific workarounds. At present workarounds exist for "vt320" terminal type. If implementation requires no special workarounds, then it should avoid returning "vt320" as terminal type string.

Specified by:

terminalType in interface ScreenDriver<O extends OutputManager<P>>

Returns:

The current terminal type string.

setTerminalType

public void setTerminalType(java.lang.String term)

Change terminal type to specified one. The terminal-based implementation should try to change terminal type to specified one. It is assumed that passed terminal string is specific to particular driver implementation and recognized by it.

Specified by:

setTerminalType in interface ScreenDriver<O extends OutputManager<P>>

Parameters:

term - The terminal type.

getPrimitives

public P getPrimitives()

Get driver-specific direct output primitives implementation.

Specified by:

getPrimitives in interface ScreenDriver<O extends OutputManager<P>>

Returns:

driver-specific instance of direct screen output primitives.

getFactory

public WidgetFactory<O> getFactory()

Get driver-specific widget factory.

Specified by:

getFactory in interface ScreenDriver<O extends OutputManager<P>>

Returns:

reference to widget factory.

init

public void init()

Initialize driver.

Specified by:

init in interface ScreenDriver<O extends OutputManager<P>>

getWindowSystem

public java.lang.String getWindowSystem()

Get the default WINDOW-SYSTEM used by this driver. See ClientParameters for the list of possible values.

Specified by:

getWindowSystem in interface ScreenDriver<O extends OutputManager<P>>

Returns:

See above.

isChui

public boolean isChui()

Get screen interface type.

Specified by:

isChui in interface ScreenDriver<O extends OutputManager<P>>

Returns:

true is ChUI false is GUI

shutdown

public void shutdown()

Perform driver shutdown.

Specified by:

shutdown in interface ScreenDriver<O extends OutputManager<P>>

getHostName

public java.lang.String getHostName()

Returns the currently connected client's machine name for session.

Specified by:

getHostName in interface ScreenDriver<O extends OutputManager<P>>

Returns:

The current system logged in for the given session.

getHostByName

public long getHostByName(java.lang.String name)

Returns the currently connected client's machine name for session.

Specified by:

getHostByName in interface ScreenDriver<O extends OutputManager<P>>

Parameters:

name - The name of the host to get IP.

Returns:

The current system logged in for the given session.

setBatchMode

protected void setBatchMode(boolean batch)

Assigns the flag determining if the current driver is running in batch mode.

Parameters:

batch - The new state of the batch mode flag.

setBackgroundMode

protected void setBackgroundMode(boolean background)

Assigns the flag determining if the current driver is running in background mode.

Parameters:

background - The new state of the background mode flag.

playBeep

protected java.io.ByteArrayInputStream playBeep(java.io.ByteArrayInputStream beepAudioData)

Load and play beep sound.

Parameters:

beepAudioData - Cached audio data to play. null to make this function load it.

Returns:

loaded audio data.