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

Class BatchDriver

java.lang.Object

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

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

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

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

All Implemented Interfaces:

ScreenDriver<ChuiOutputManager>

public class BatchDriver
extends ConsoleDriver

The dummy console pseudo batch driver. The underlying implementation is used to provide I/O handling for batch mode.

During initialization, the Progress 4GL client in batch mode outputs a Progress logo, copyright notice and version when run in the foreground (and just the version when run in the background). This implementation is deliberately NOT duplicating these outputs for these reasons:

1. The output has no value for application/user processing or functionality.
2. Generating that output would confuse people as to who owns this technology.
3. The output content changes from version to version anyway, so it is very unlikely that an application would depend upon the output.

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.chui.driver.console.ConsoleDriver

NAME

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

BEEP_FILE_PATH, direct, factory

Constructor Summary

Constructors

Constructor and Description
BatchDriver(BootstrapConfig cfg) Constructor.

Method Summary

Modifier and Type	Method and Description
void	beep() Generate a beep signal.
void	clear() Clear screen.
KeyCode	readKey() Read the key from terminal and translate it into P2J internal representation.
void	resetMode() Reset screen mode.
void	resume() Resume terminal after suspend() call.
boolean	setCursorStatus(boolean on) Set cursor status (ON/OFF).
void	suspend() Suspend terminal and release it for use by other applications.

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

getChildProcessFactory, getName, init, setTerminalType, shutdown, terminalType

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

captureMouseEvents, convertToOptions, createOutputManager, handleMouseEvent, updateClientMetrics

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

getFactory, getHostByName, getHostName, getPrimitives, getWindowSystem, inBackgroundMode, inBatchMode, isChui, playBeep, setBackgroundMode, setBatchMode

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

chooseFiles, clientReady, deregisterWidget, isEmbeddedClient, isWeb, lockMousePointer, openMimeResource, openMimeResource, propagate, resume, setControl, setCurrentLanguage, suspend, widgetStateChanged

Constructor Detail

BatchDriver

public BatchDriver(BootstrapConfig cfg)

Constructor.

Parameters:

cfg - The BootstrapConfig configuration.

Method Detail

beep

public void beep()

Generate a beep signal.

Implementation deoends on native layer and (in turn) from particular terminal. If terminal does not support this feature or sound in terminal is turned off, there will be no audible feedback to user.

Specified by:

beep in interface ScreenDriver<ChuiOutputManager>

Overrides:

beep in class ConsoleDriver

clear

public void clear()

Clear screen.

Specified by:

clear in interface ScreenDriver<ChuiOutputManager>

Overrides:

clear in class ConsoleDriver

readKey

public KeyCode readKey()

Read the key from terminal and translate it into P2J internal representation. Translation details are in KeyProcessor class. Mouse events (which also returned from native layer) are filtered out because mouse is not supported.

Specified by:

readKey in interface ScreenDriver<ChuiOutputManager>

Overrides:

readKey in class ConsoleDriver

Returns:

key code or null if no keys were pressed since last call.

resetMode

public void resetMode()

Reset screen mode.

Specified by:

resetMode in interface ScreenDriver<ChuiOutputManager>

Overrides:

resetMode in class ConsoleDriver

resume

public void resume()

Resume terminal after suspend() call.

Specified by:

resume in interface ScreenDriver<ChuiOutputManager>

Overrides:

resume in class ConsoleDriver

suspend

public void suspend()

Suspend terminal and release it for use by other applications.

Specified by:

suspend in interface ScreenDriver<ChuiOutputManager>

Overrides:

suspend in class ConsoleDriver

setCursorStatus

public boolean setCursorStatus(boolean on)
                        throws java.lang.IllegalStateException

Set cursor status (ON/OFF).

Specified by:

setCursorStatus in interface ScreenDriver<ChuiOutputManager>

Overrides:

setCursorStatus in class ConsoleDriver

Parameters:

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

Returns:

Always false.

Throws:

java.lang.IllegalStateException