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

Class ConsoleDriver

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

All Implemented Interfaces:

ScreenDriver<ChuiOutputManager>

Direct Known Subclasses:

BatchDriver

public class ConsoleDriver
extends AbstractChuiDriver

Text console-based driver. The underlying native implementation is used as backend to provide required features. The example is NCURSES package for Linux or console API wor Windows OS.

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 ConsoleHelper	helper Reference to console low-level driver.
private static int	KEY_MOUSE Special key code which denotes mouse event.
private static CentralLogger	LOG Logger.
static java.lang.String	NAME Driver name.
private KeyProcessor	processor Key processor.

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

BEEP_FILE_PATH, direct, factory

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	beep() Generate a beep signal.
void	clear() Clear screen.
ChildProcessFactory	getChildProcessFactory() Get driver-specific child process factory.
java.lang.String	getName() Get the driver name.
void	init() Initialize driver.
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	setTerminalType(java.lang.String name) Set terminal type according to passed string.
void	shutdown() Perform driver shutdown.
void	suspend() Suspend terminal and release it for use by other applications.
java.lang.String	terminalType() Get terminal type string.

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

Field Detail

NAME

public static final java.lang.String NAME

Driver name.

See Also:

Constant Field Values

KEY_MOUSE

private static final int KEY_MOUSE

Special key code which denotes mouse event.

See Also:

Constant Field Values

LOG

private static CentralLogger LOG

Logger.

processor

private KeyProcessor processor

Key processor.

helper

private ConsoleHelper helper

Reference to console low-level driver.

Constructor Detail

ConsoleDriver

public ConsoleDriver()

Constructor.

ConsoleDriver

public ConsoleDriver(ConsolePrimitives direct,
                     java.lang.String term)

Construct a new instance.

Parameters:

direct - The output primitives.

term - Terminal type string.

Method Detail

getName

public java.lang.String getName()

Get the driver name.

Returns:

See above.

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.

clear

public void clear()

Clear screen.

getChildProcessFactory

public ChildProcessFactory getChildProcessFactory()

Get driver-specific child process factory.

Returns:

The reference to the factory.

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.

Returns:

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

resetMode

public void resetMode()

Reset screen mode.

resume

public void resume()

Resume terminal after suspend() call.

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 AbstractChuiDriver

Parameters:

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

Returns:

Always false.

Throws:

java.lang.IllegalStateException

setTerminalType

public void setTerminalType(java.lang.String name)

Set terminal type according to passed string.

Specified by:

setTerminalType in interface ScreenDriver<ChuiOutputManager>

Overrides:

setTerminalType in class AbstractDriver<BasePrimitives,ChuiOutputManager>

Parameters:

name - The terminal type.

suspend

public void suspend()

Suspend terminal and release it for use by other applications.

terminalType

public java.lang.String terminalType()

Get terminal type string.

Specified by:

terminalType in interface ScreenDriver<ChuiOutputManager>

Overrides:

terminalType in class AbstractDriver<BasePrimitives,ChuiOutputManager>

Returns:

The current terminal type string.

init

public void init()

Initialize driver.

Specified by:

init in interface ScreenDriver<ChuiOutputManager>

Overrides:

init in class AbstractDriver<BasePrimitives,ChuiOutputManager>

shutdown

public void shutdown()

Perform driver shutdown.

Specified by:

shutdown in interface ScreenDriver<ChuiOutputManager>

Overrides:

shutdown in class AbstractDriver<BasePrimitives,ChuiOutputManager>