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

Class GuiOutputManager

java.lang.Object

com.goldencode.p2j.ui.client.OutputManager<GuiPrimitives>

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

public class GuiOutputManager
extends OutputManager<GuiPrimitives>

Provides a generic interface to low level graphic user interface primitives.

Field Summary

Fields

Modifier and Type	Field and Description
private BootstrapConfig	cfg The initial configuration of this manager.
private WidgetRegistry<GuiOutputManager>	registry Widget registry.
private OutputManager<?>	streamableMgr The StreamableManager instance used in redirected mode.

Fields inherited from class com.goldencode.p2j.ui.client.OutputManager

CHUI_DRIVER_BATCH, CHUI_DRIVER_CONSOLE, CHUI_DRIVER_SWING, CHUI_DRIVER_WEB, defaultOutput, defaultTerminal, drawing, driver, GUI_DRIVER_SWING, GUI_DRIVER_WEB, invalidate, output

Constructor Summary

Constructors

Constructor and Description
GuiOutputManager(GuiDriver driver, BootstrapConfig cfg) Create a new output manager instance, with the specified driver.

Method Summary

Modifier and Type	Method and Description
void	addEditableFrameForWidget(Widget<?> widget) Register editable frame related widget resources.
void	clear(Widget<?> widget) Clear area occupied by specified widget.
GuiWidgetFactory	getFactory() Access driver-specific widget factory.
WidgetRegistry<GuiOutputManager>	getRegistry() Get the widget registry for this output manager.
StreamableManager	getStreamableManager() Get the ChUI manager for this manager instance, used for redirected terminal support.
boolean	hasWindowEmulator(int windowId) Check if window has an emulator for the given window id.
static GuiOutputManager	instance() Get the context-specific instance, if it exists.
boolean	isRedirected() Reports if the terminal is currently redirected to a stream.
OutputManager	managerInstance() Get the manager instance, depending if the mode is redirected or not.
protected TitledWindow<?>	overrideWindow(TopLevelWindow<?> window) Check if the window being drawn needs to be overridden.
protected boolean	raiseStopCondition(int key) Check if the given key can raise the STOP condition.
void	realizeChildWindow(int ownerId, int windowId, java.lang.String windowTitle, boolean resizable, boolean isShareActivationWithOwner) Realize new child window.
void	realizeChildWindow(int ownerId, int windowId, java.lang.String windowTitle, boolean resizable, boolean isShareActivationWithOwner, boolean modal) Realize new child window.
void	registerWindow(int windowId, boolean showInTaskbar) Registers new window with the UI driver.
void	registerWindow(TopLevelWindow<?> window) Registers new window with the UI driver.
void	releaseWidgetResources(Widget<?> widget) GUI Implementation specific method of removing widget from registry
void	releaseWindow() On a device which allows multiple windows to be created, this allows releasing the window to allow drawing from other threads.
void	releaseWindow(boolean redirected) On a device which allows multiple windows to be created, this allows releasing the window to allow drawing from other threads.
void	removeEditableFrameForWidget(Widget<?> widget) Release editable frame related widget resources.
protected ScreenBitmap	screenBitmap(int windowId) Determine the screen bitmap associated with the given window.
void	selectWindow(int windowId) On a device which allows multiple windows to be created, this allows selecting an explicit window before using the primitives or before drawing a widget.
void	setDisableRedraw(boolean value) Sets the global SESSION:DISABLE-REDRAW attribute.
void	setDrawingArea(Rectangle bounds) Limit the available drawing area to the specified boundaries.
void	setInvalidate(Widget<?> widget, boolean mode, boolean flush) Sets the invalidation mode.
OutputPrimitives	switchOutput(OutputPrimitives newOps) Redirect terminal output to the drawing worker represented by newOps (or back to the interactive terminal if newOps is null) and return the instance representing the current output destination.

Methods inherited from class com.goldencode.p2j.ui.client.OutputManager

activateBatch, beep, clear, clear, clipWith, coordinates, drawNeeded, fixCoordinates, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getClippings, getClippings, getDriver, getInstanceDriver, getInteractiveOutput, getInvalidChars, inBatchMode, init, init, initErrorWriter, initErrorWriter, isBatchInBackground, isBatchModeOverride, isChui, isInvalidate, markArea, newInstance, readKey, refresh, resetBitmap, resetInvalidate, resetMode, resolveWidget, restoreInvalidate, resume, saveInvalidate, saveInvalidate, screenDimension, screenHeight, screenWidth, setBitmap, setCursorStatus, setInvalidate, setInvalidate, setTerminalType, startScreenSearch, suspend, sync, terminalType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

registry

private WidgetRegistry<GuiOutputManager> registry

Widget registry.

cfg

private final BootstrapConfig cfg

The initial configuration of this manager.

streamableMgr

private final OutputManager<?> streamableMgr

The StreamableManager instance used in redirected mode.

Constructor Detail

GuiOutputManager

public GuiOutputManager(GuiDriver driver,
                        BootstrapConfig cfg)

Create a new output manager instance, with the specified driver.

Parameters:

driver - Implements low level input/output primitives. Must NOT be null.

cfg - The initial configuration.

Method Detail

instance

public static GuiOutputManager instance()

Get the context-specific instance, if it exists. In a single-client JVM environment, this is equivalent to a singleton.

Returns:

The instance or null if none exists.

getStreamableManager

public StreamableManager getStreamableManager()

Get the ChUI manager for this manager instance, used for redirected terminal support.

Specified by:

getStreamableManager in class OutputManager<GuiPrimitives>

Returns:

The ChUI streamableMgr instance.

isRedirected

public boolean isRedirected()

Reports if the terminal is currently redirected to a stream.

Specified by:

isRedirected in class OutputManager<GuiPrimitives>

Returns:

true if the terminal is redirected to a stream, false if the terminal is interactive.

setInvalidate

public void setInvalidate(Widget<?> widget,
                          boolean mode,
                          boolean flush)

Sets the invalidation mode.

When invalidation mode is set to true, all PaintEvents are processed differently. Instead of causing immediate drawing, they contribute their respective rectangles to the invalidation rectangle. The moment the invalidation mode is being set to false, the cumulative invalidation rectangle triggers selective redrawing of the affected area.

Overrides:

setInvalidate in class OutputManager<GuiPrimitives>

Parameters:

mode - true is an opening bracket for the invalidation mode false is a closing bracket which conditionally flushes the accumulated paint requests

widget - The widget which triggered this drawing. If is null, the window as returned by WindowManager.findWindow(int) will be used; otherwise, the widget's window will be used.

flush - only meaningful for mode false. requests unconditional flushing of all accumulated paint requests

switchOutput

public OutputPrimitives switchOutput(OutputPrimitives newOps)

Redirect terminal output to the drawing worker represented by newOps (or back to the interactive terminal if newOps is null) and return the instance representing the current output destination. This may be another null if the interactive terminal is in use.

Specified by:

switchOutput in class OutputManager<GuiPrimitives>

Parameters:

newOps - The drawing worker or null to remove redirections and activate the interactive terminal.

Returns:

The previous drawing worker instance.

screenBitmap

protected ScreenBitmap screenBitmap(int windowId)

Determine the screen bitmap associated with the given window.

After this call, the OutputManager.output will have selected the specified window.

WARNING! If the ScreenBitmap reference is saved and a code is called which in turn ends up changing the ScreenBitmap reference (via the OutputManager.setBitmap(int, com.goldencode.p2j.ui.client.ScreenBitmap) API), then ensure the proper reference is used!

Overrides:

screenBitmap in class OutputManager<GuiPrimitives>

Parameters:

windowId - The window ID.

Returns:

The ScreenBitmap associated with this window.

registerWindow

public void registerWindow(TopLevelWindow<?> window)

Registers new window with the UI driver.

Overrides:

registerWindow in class OutputManager<GuiPrimitives>

Parameters:

window - A window.

registerWindow

public void registerWindow(int windowId,
                           boolean showInTaskbar)

Registers new window with the UI driver.

Overrides:

registerWindow in class OutputManager<GuiPrimitives>

Parameters:

windowId - A window ID to be realized.

showInTaskbar - If set to true the registered window will be shown in the system taskbar.

realizeChildWindow

public void realizeChildWindow(int ownerId,
                               int windowId,
                               java.lang.String windowTitle,
                               boolean resizable,
                               boolean isShareActivationWithOwner)

Realize new child window.

Parameters:

ownerId - The owning window ID.

windowId - A window ID to be realized.

windowTitle - Title of the realized window.

resizable - true if the window is resizable.

isShareActivationWithOwner - Indicates whether the window shares activation state with its owner.

realizeChildWindow

public void realizeChildWindow(int ownerId,
                               int windowId,
                               java.lang.String windowTitle,
                               boolean resizable,
                               boolean isShareActivationWithOwner,
                               boolean modal)

Realize new child window.

Parameters:

ownerId - The owning window ID.

windowId - A window ID to be realized.

windowTitle - Title of the realized window.

resizable - true if the window is resizable.

isShareActivationWithOwner - Indicates whether the window shares activation state with its owner.

modal - true if this is a modal window.

setDrawingArea

public void setDrawingArea(Rectangle bounds)

Limit the available drawing area to the specified boundaries.

Overrides:

setDrawingArea in class OutputManager<GuiPrimitives>

Parameters:

bounds - The bounds for the drawing area.

setDisableRedraw

public void setDisableRedraw(boolean value)

Sets the global SESSION:DISABLE-REDRAW attribute. When this mode is active, all output is disabled.

Overrides:

setDisableRedraw in class OutputManager<GuiPrimitives>

Parameters:

value - Value to set to DISABLE-REDRAW attribute.

clear

public void clear(Widget<?> widget)

Clear area occupied by specified widget.

Specified by:

clear in class OutputManager<GuiPrimitives>

Parameters:

widget - Reference widget.

getFactory

public GuiWidgetFactory getFactory()

Access driver-specific widget factory.

Specified by:

getFactory in class OutputManager<GuiPrimitives>

Returns:

reference to widget factory.

getRegistry

public WidgetRegistry<GuiOutputManager> getRegistry()

Get the widget registry for this output manager.

Specified by:

getRegistry in class OutputManager<GuiPrimitives>

Returns:

See above.

managerInstance

public OutputManager managerInstance()

Get the manager instance, depending if the mode is redirected or not.

Overrides:

managerInstance in class OutputManager<GuiPrimitives>

Returns:

The manager instance.

selectWindow

public void selectWindow(int windowId)

On a device which allows multiple windows to be created, this allows selecting an explicit window before using the primitives or before drawing a widget.

Overrides:

selectWindow in class OutputManager<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.

Overrides:

releaseWindow in class OutputManager<GuiPrimitives>

releaseWindow

public void releaseWindow(boolean redirected)

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

The method allows to explicitly direct the window release to the interactive or the redirected output.

Overrides:

releaseWindow in class OutputManager<GuiPrimitives>

Parameters:

redirected - The parameter directs the window release either to the interactive or the redirected output.

hasWindowEmulator

public boolean hasWindowEmulator(int windowId)

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

Overrides:

hasWindowEmulator in class OutputManager<GuiPrimitives>

Parameters:

windowId - Window ID.

Returns:

true if window has an associated emulator, false otherwise.

raiseStopCondition

protected boolean raiseStopCondition(int key)

Check if the given key can raise the STOP condition.

Specified by:

raiseStopCondition in class OutputManager<GuiPrimitives>

Parameters:

key - The key code to be checked.

Returns:

true if the key is the Key.VK_CTRL_BREAK key.

overrideWindow

protected TitledWindow<?> overrideWindow(TopLevelWindow<?> window)

Check if the window being drawn needs to be overridden.

In GUI, the window parameter is returned.

Specified by:

overrideWindow in class OutputManager<GuiPrimitives>

Parameters:

window - The currently active window.

Returns:

See above.

releaseWidgetResources

public void releaseWidgetResources(Widget<?> widget)

GUI Implementation specific method of removing widget from registry

Specified by:

releaseWidgetResources in class OutputManager<GuiPrimitives>

Parameters:

widget - Widget to have resources released

removeEditableFrameForWidget

public void removeEditableFrameForWidget(Widget<?> widget)

Release editable frame related widget resources.

Specified by:

removeEditableFrameForWidget in class OutputManager<GuiPrimitives>

Parameters:

widget - Widget to have resources released

addEditableFrameForWidget

public void addEditableFrameForWidget(Widget<?> widget)

Register editable frame related widget resources.

Specified by:

addEditableFrameForWidget in class OutputManager<GuiPrimitives>

Parameters:

widget - Widget to have resources released