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

Interface GuiPrimitives

All Superinterfaces:

OutputPrimitives

All Known Implementing Classes:

GuiPrimitivesImpl

public interface GuiPrimitives
extends OutputPrimitives

This is a low level GUI-specific window emulator management interface. 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.

Method Summary

Modifier and Type	Method and Description
void	deregisterWindow(int windowId) Deregister the given window from the driver.
EmulatedWindowState	getWindowEmulator() Get the currently selected window emulator.
EmulatedWindowState	getWindowEmulator(int windowId) Returns the window emulator registered for the supplied window id.
boolean	hasWindowEmulator(int windowId) Check if window has an emulator for the given window id.
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.
void	selectWindow(int windowId) On a GUI interface multiple windows can be created.
void	shutdown() Perform shutdown.

Methods inherited from interface com.goldencode.p2j.ui.client.OutputPrimitives

clearArea, getScreenBitmap, getWindowId, refresh, screenHeight, screenWidth, setScreenBitmap, sync

Method Detail

getWindowEmulator

EmulatedWindowState getWindowEmulator()

Get the currently selected window emulator.

Returns:

The current window emulator.

getWindowEmulator

EmulatedWindowState getWindowEmulator(int windowId)

Returns the window emulator registered for the supplied window id.

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

boolean hasWindowEmulator(int windowId)

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

Parameters:

windowId - Window ID.

Returns:

true if window has an associated emulator, true otherwise.

registerWindow

void registerWindow(int windowId,
                    EmulatedWindowState ews)

Register a new window with the driver.

Parameters:

windowId - The window ID.

ews - New emulated window state to register.

deregisterWindow

void deregisterWindow(int windowId)

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

Parameters:

windowId - The window ID.

selectWindow

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.

Parameters:

windowId - Window ID.

releaseWindow

void releaseWindow()

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

shutdown

void shutdown()

Perform shutdown.