com.goldencode.p2j.ui.client.gui.driver

Class GuiPrimitivesImpl

java.lang.Object

com.goldencode.p2j.ui.client.gui.driver.GuiPrimitivesImpl

All Implemented Interfaces:

GuiPrimitives, OutputPrimitives

public abstract class GuiPrimitivesImpl
extends java.lang.Object
implements GuiPrimitives

This is a low level GUI-specific window emulator management implementation. Real drawing does not occur in this class. This is a kind of router that keeps the list of emulated window instances and a current instance which can be swapped.

This interface is for GUI-specific features. It is intended to be specific to a given UI-modality (GUI in this case). No driver-specific implementation classes or features should be present. For example, no Swing-specific feature usage is allowed.

The actual GUI processing does not heavily utilize the pluggable OutputPrimitives interface. In other words, the interactive UI processing GUI is not switched in and out like in ChUI. For this reason, the core output processing in ChUI is driven using the primitives approach, but in GUI we simply honor the minimum implementation in this class. The majority of this class is really about providing access to and management of the core window structure. The primitives implementation is secondary, but the functionality is best implemented here.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.Integer,EmulatedWindowState>	emulators Registry of window emulators.
protected EmulatedWindowState	ews Current GUI emulator.

Constructor Summary

Constructors

Constructor and Description
GuiPrimitivesImpl() Constructor.

Method Summary

Modifier and Type	Method and Description
void	clearArea(int left, int top, int right, int bottom, Color color) Clear specified area at the screen.
void	deregisterWindow(int windowId) Deregister this window from the driver.
ScreenBitmap	getScreenBitmap() Get the screen bitmap for the current window.
EmulatedWindowState	getWindowEmulator() Get the currently selected window emulator.
EmulatedWindowState	getWindowEmulatorSafe(int windowId) Returns the window emulator registered for the supplied window id.
int	getWindowId() Get the ID of the window currently selected.
boolean	hasWindowEmulator(int windowId) Check if window has an emulator for the given window id.
void	refresh(NativeRectangle rect) Refresh specified area.
void	registerWindow(int windowId, EmulatedWindowState ews) Register a new window with the driver.
void	releaseWindow() On a device which allows multiple windows to be created, this allows releasing the window to allow drawing from other threads.
int	screenHeight() Get the screen height, in character units.
int	screenWidth() Get the screen width, in character units.
void	selectWindow(int windowId) On a GUI interface multiple windows can be created.
void	setScreenBitmap(ScreenBitmap bitmap) Set the active screen bitmap for the current window.
void	shutdown() Perform shutdown.
abstract void	sync() Synchronize screen.

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.gui.driver.GuiPrimitives

getWindowEmulator

Field Detail

ews

protected EmulatedWindowState ews

Current GUI emulator.

emulators

private java.util.Map<java.lang.Integer,EmulatedWindowState> emulators

Registry of window emulators.

Constructor Detail

GuiPrimitivesImpl

public GuiPrimitivesImpl()

Constructor.

Method Detail

clearArea

public void clearArea(int left,
                      int top,
                      int right,
                      int bottom,
                      Color color)

Clear specified area at the screen.

Specified by:

clearArea in interface OutputPrimitives

Parameters:

left - Left coordinate of the area.

top - Top coordinate of the area.

right - Right coordinate of the area.

bottom - Bottom coordinate of the area.

color - Color.

refresh

public void refresh(NativeRectangle rect)

Refresh specified area.

This is a no-op.

Specified by:

refresh in interface OutputPrimitives

Parameters:

rect - Area to refresh.

screenWidth

public int screenWidth()

Get the screen width, in character units.

Specified by:

screenWidth in interface OutputPrimitives

Returns:

See above.

screenHeight

public int screenHeight()

Get the screen height, in character units.

Specified by:

screenHeight in interface OutputPrimitives

Returns:

See above.

sync

public abstract void sync()

Synchronize screen.

Driver level implementation of this method should force flushing internal low-level buffers to screen. This method requires implementation only if operating system or hardware uses internal buffering for the terminal output. Otherwise this method can do nothing.

Specified by:

sync in interface OutputPrimitives

setScreenBitmap

public void setScreenBitmap(ScreenBitmap bitmap)

Set the active screen bitmap for the current window.

Specified by:

setScreenBitmap in interface OutputPrimitives

Parameters:

bitmap - The screen bitmap.

getScreenBitmap

public ScreenBitmap getScreenBitmap()

Get the screen bitmap for the current window.

Specified by:

getScreenBitmap in interface OutputPrimitives

Returns:

The current window's screen bitmap.

getWindowId

public int getWindowId()

Get the ID of the window currently selected. If no window is currently selected -1 is returned.

Specified by:

getWindowId in interface OutputPrimitives

Returns:

See above.

getWindowEmulator

public EmulatedWindowState getWindowEmulator()

Get the currently selected window emulator.

Specified by:

getWindowEmulator in interface GuiPrimitives

Returns:

See above.

getWindowEmulatorSafe

public EmulatedWindowState getWindowEmulatorSafe(int windowId)

Returns the window emulator registered for the supplied window id.

Specified by:

getWindowEmulatorSafe in interface GuiPrimitives

Parameters:

windowId - A valid window id.

Returns:

The identified window emulator.

Throws:

java.lang.RuntimeException - When no window emulator is registered for the supplied window id.

hasWindowEmulator

public boolean hasWindowEmulator(int windowId)

Check if window has an emulator for the given window id.

Specified by:

hasWindowEmulator in interface GuiPrimitives

Parameters:

windowId - Window ID.

Returns:

true if window has an associated emulator, true otherwise.

registerWindow

public void registerWindow(int windowId,
                           EmulatedWindowState ews)

Register a new window with the driver.

Specified by:

registerWindow in interface GuiPrimitives

Parameters:

windowId - The window ID.

ews - New emulated window state to register.

deregisterWindow

public void deregisterWindow(int windowId)

Deregister this window from the driver. This needs to be called only when the window widget is being destroyed.

Specified by:

deregisterWindow in interface GuiPrimitives

Parameters:

windowId - The window ID.

selectWindow

public void selectWindow(int windowId)

On a GUI interface multiple windows can be created. Each window has it own emulator. When a window is first drawn, this method is used to set it's emulator as the current target for output operations.

Specified by:

selectWindow in interface GuiPrimitives

Parameters:

windowId - Window ID.

releaseWindow

public void releaseWindow()

On a device which allows multiple windows to be created, this allows releasing the window to allow drawing from other threads.

Specified by:

releaseWindow in interface GuiPrimitives

shutdown

public void shutdown()

Perform shutdown.

Specified by:

shutdown in interface GuiPrimitives