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

Class SwingChuiDriver

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.swing.SwingChuiDriver

All Implemented Interfaces:

ScreenDriver<ChuiOutputManager>

public class SwingChuiDriver
extends AbstractChuiDriver

Swing-based ChUI driver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	SwingChuiDriver.VT100SwingEmulator Swing-specific implementation of the VT100 emulator child process.
private class	SwingChuiDriver.VT100SwingRenderer Swing-specific implementation of the VT100 emulator renderer.

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 java.io.ByteArrayInputStream	beepAudioData Cached beep sound audio data.
private boolean	isWin OS platform flag
static java.lang.String	NAME Driver name.
private ContentPane	pane Content pane of the containing swing window.
private ChuiSimulator	sim Core Swing component that simulates the terminal.

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

BEEP_FILE_PATH, direct, factory

Constructor Summary

Constructors

Constructor and Description
SwingChuiDriver(BootstrapConfig config) Constructor.

Method Summary

Modifier and Type	Method and Description
void	beep() Provide an audible feedback to user by generating a beep signal.
void	clear() Clear screen.
ChildProcessFactory	getChildProcessFactory() Get driver-specific child process factory.
java.lang.String	getName() Get the driver name.
KeyCode	readKey() Read single keystroke from keyboard.
void	resetMode() Reset current screen mode.
void	resume() Resume normal driver operation.
boolean	setCursorStatus(boolean on) Set cursor status (ON/OFF).
void	suspend() Suspend all screen I/O operations.

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, 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

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

sim

private ChuiSimulator sim

Core Swing component that simulates the terminal.

pane

private ContentPane pane

Content pane of the containing swing window.

isWin

private boolean isWin

OS platform flag

beepAudioData

private java.io.ByteArrayInputStream beepAudioData

Cached beep sound audio data. Normally it would be good to cache an audio Clip, but in JDK 8 with PulseAudio enabled (default JDK settings), a clip cannot be properly replayed.

Constructor Detail

SwingChuiDriver

public SwingChuiDriver(BootstrapConfig config)

Constructor.

Parameters:

config - The BootstrapConfig configuration.

Method Detail

getName

public java.lang.String getName()

Get the driver name.

Returns:

See above.

beep

public void beep()

Provide an audible feedback to user by generating a beep signal.

There is no specific requirements to this method and actual implementation may do nothing if there is no way to perform audible notification to the user.

clear

public void clear()

Clear screen.

This method should clear the screen and perform necessary flushing of the system-specific buffers if necessary. Users of this method assume that actual screen appearance as it is visible to the user is properly changed upon exit from this method.

getChildProcessFactory

public ChildProcessFactory getChildProcessFactory()

Get driver-specific child process factory.

Returns:

The reference to the factory.

readKey

public KeyCode readKey()

Read single keystroke from keyboard. Returned code should be either proper Progress 4GL/P2J key code or -1 if environment-specific input cannot be properly translated.

Returns:

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

resetMode

public void resetMode()

Reset current screen mode.

Upon exit from this method P2J assumes that screen is in correct state and can be used for interaction with the user.

resume

public void resume()

Resume normal driver operation. If implementation is terminal-based, they terminal should be acquired again and driver should be ready to perform regular screen I/O operations.

suspend

public void suspend()

Suspend all screen I/O operations. If implementation is terminal-based, then terminal should be released to allow other application executed from P2J access terminal.

setCursorStatus

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

Set cursor status (ON/OFF).

The implementation of this method should show/hide actual screen cursor visible to user. Remaining code assumes that actual cursor status visible to user is properly changed upon exit from this method.

Specified by:

setCursorStatus in interface ScreenDriver<ChuiOutputManager>

Overrides:

setCursorStatus in class AbstractChuiDriver

Parameters:

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

Returns:

true if operation was successful.

Throws:

java.lang.IllegalStateException