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

Class SwingGuiDriver

java.lang.Object

com.goldencode.p2j.ui.client.driver.AbstractDriver<GuiPrimitives,GuiOutputManager>

com.goldencode.p2j.ui.client.gui.driver.AbstractGuiDriver<java.awt.Font>

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

All Implemented Interfaces:

ScreenDriver<GuiOutputManager>, GuiDriver<java.awt.Font,java.awt.image.BufferedImage>

public class SwingGuiDriver
extends AbstractGuiDriver<java.awt.Font>

Swing-backed GUI driver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	SwingGuiDriver.BrowserHelper Parses the provided command line and returns the executable and its options.

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.gui.driver.AbstractGuiDriver

AbstractGuiDriver.TextMetrics, AbstractGuiDriver.Uri

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 MousePtrWrapper	globalCursor The application-wide cursor.
private java.awt.KeyboardFocusManager	keyboardFocusManager The driver's level keyboard focus manager.
private SwingKeyboardReader	keyReader The key reader.
private static CentralLogger	LOGGER The logger to log class events.
static java.lang.String	NAME Driver name.

Fields inherited from class com.goldencode.p2j.ui.client.gui.driver.AbstractGuiDriver

config, control, driverWidgets, ews, LOG, tmpDir, translatedOrigin, win32MousePosition

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

BEEP_FILE_PATH, direct, factory

Constructor Summary

Constructors

Constructor and Description
SwingGuiDriver(BootstrapConfig config) Create a new GUI screen driver.

Method Summary

Modifier and Type	Method and Description
void	addMessageListener(MsgBlasterPeer listener, int windowId, int widgetId) Add a low-level message listener for a specific window.
void	beep() Provide an audible feedback to user by generating a beep signal.
private java.net.URI	buildOpenResourcePage(java.lang.String mimeType, java.lang.String url) Builds the html document that embeds the target resource given by its url path and its mime type.
java.lang.String	clipboardContents() Get the current contents from the OS clipboard.
void	copyToClipboard(java.lang.String txt) Copy the given text to the system clipboard.
FontDetails<java.awt.Font>	createFont(FontDetails<java.awt.Font> specs) Create a font with the given details and register it with the driver.
MousePtrWrapper	createMousePointer(java.io.InputStream inputStream, java.lang.String ptrName) Load mouse pointer from the InputStream
<T extends DriverWidget> void	createWidget(java.lang.Class<T> widgetClass, int widgetId) Create a driver-implemented widget.
void	createWidget(java.lang.String type, int widgetId) Create a driver-implemented widget.
void	deliverDocumentOutput(java.util.function.Consumer<java.io.OutputStream> consumer, java.lang.Runnable finalizer, MediaType format, java.lang.String uuid, boolean promptUser) The method delivers document output to the client.
void	deregisterWidget(int wid) Deregister the specified widget for mouse events.
void	deriveFont(FontDetails<java.awt.Font> fd) Scale the given font to match the screen resolution.
protected Tuple<java.lang.String,java.awt.Rectangle>	getAdjustmentInfo(java.awt.Point p, java.awt.Dimension dim) Determines the type of overflow and the screen bounds.
MousePtrWrapper	getGlobalCursor() Returns the application-wide cursor.
NativePoint	getMousePosition() Returns current mouse cursor display position relative to the display origin.
java.lang.String	getName() Get the driver name.
private java.io.File	getPrintOutputDir() Returns the directory for print output.
int	getScreenResolution() Reports the screen resolution in dots per inch (DPI).
NativeDimension	getVirtualScreenSize() Returns the size of the virtual screen, i.e.
boolean	isFontInstalled(java.lang.String fontName, boolean boldFont) Tests if the target font is known to JRE.
boolean	isWindowDecorationSupported() Returns true if a window can be decorated in this graphics environment, otherwise false.
void	moveToBottom(int windowId) Move the specified window to the bottom of the z-order, at the OS level.
void	moveToTop(int windowId, boolean focus) Move the specified window to the top of the z-order, at the OS level.
EmulatedWindowState	newChildWindowEmulator(int windowId, EmulatedWindowState owner, java.lang.String windowTitle, boolean resizable, boolean isShareActivationWithOwner, boolean modal) Create a new child window emulator.
EmulatedWindowState	newEmulator(int windowId, boolean showInTaskbar) Create a new window emulator.
private static void	openDocument(java.net.URI uri) Open the target document given by its URI.
void	openMimeResource(boolean deleteContent, java.lang.String mimeType, java.lang.String uriString, boolean embedded) Opens the specified resource in a browser's window.
void	propagate(int windowId, int wid, MousePtrWrapper ptr) Push information about the loaded mouse pointer for widget
KeyCode	readKey() Read single keystroke from keyboard.
void	registerHoverableWidget(MouseHoverAction action) Register this widget as being editable, so that the mouse cursor will adjust properly when the widget is entered.
void	registerMoveableWidget(int wid) Register the specified widget as a moveable widget, via mouse.
void	registerResizeableWidget(int wid) Register the specified widget as a resizeable widget, via mouse.
void	removeGlobalCursor() Assign a cursor for the entire web application, simulating Win32.SetCursor functionality.
void	removeMessageListener(MsgBlasterPeer listener, int windowId, int widgetId) Removes a low-level message listener for a specific window.
void	restackWindows(int[] windowIds) Force the list of all GUI windows to be stacked as in the specified order.
void	setAlwaysOnTop(int windowId, boolean topOnly, boolean alwaysOnTop) Makes the supplied window to be on top of other windows.
void	setCurrentSelection(java.lang.String txt) Sets the current selection.
void	setCursor(java.awt.Cursor c) Set the mouse cursor to the given one.
void	setCursor(CursorType type) Set the mouse cursor to the given type.
void	setCursor(MousePtrWrapper ptr) Set the mouse cursor
void	setCursor(java.lang.String icon) Set the mouse cursor from a given resource.
void	setGlobalCursor(MousePtrWrapper ptr) Assign a cursor for the entire web application, simulating Win32.SetCursor functionality.
void	setResizeableWindow(boolean resize, int minWidth, int minHeight, int maxWidth, int maxHeight) Set the window details for resize; this includes the minimum and maximun dimensions, and also the window's resizeable state.

Methods inherited from class com.goldencode.p2j.ui.client.gui.driver.AbstractGuiDriver

cacheTextMetrics, captureMouseEvents, changeSensitivity, changeVisibility, clear, copyResource, copyResource, createGreyImage, createIcon, createImage, createMouseDirectManipulationInstance, createOutputManager, deiconifyWindow, deregisterTooltipWorkers, deregisterWindow, destroyWidget, doTextShift, draw, draw, draw3DRect, drawCursor, drawEdge, drawEllipse, drawFromOrigin, drawHighlight, drawIbeam, drawImage, drawImage, drawLine, drawParagraph, drawRect, drawRoundRect, drawSelection, drawString, drawStringCentered, drawStringCentered, drawStringScaled, drawStringWithinBox, drawStringWithinBoxScaled, drawStringWithinBoxWithMnemonic, drawStringWithMnemonic, drawTextSelection, enableEvents, endBatch, fill3DRect, fillEllipse, fillPolygon, fillRect, fillRectAroundText, fillRoundRect, fitStringWithEllipsis, getBgColor, getBgStdColor, getChildProcessFactory, getDisplayBounds, getDisplayWorkArea, getDriverWidget, getFgColor, getFgStdColor, getFontHeight, getFontMaxWidth, getFontWidth, getFontWidths, getParagraphHeight, getPrintOutputFile, getSubImage, getSysColor, getTextHeight, getTextMetrics, getTextWidth, getTextWidths, getTextWidths, getWindowDimension, getWindowLocation, handleMouseEvent, hasWindowEmulator, iconifyWindow, initDragAndDrop, invokeWidgetCommand, invokeWidgetCommand, isActualTextMetricsCached, isEmptyText, isWindowVisible, makeImage, moveResource, needsExplicitTextMetricsCaching, placeWidget, registerChildWindow, registerDirectManipulation, registerEmptySelector, registerInteractiveWidgets, registerPendingTooltipWorkers, registerTooltipWorker, registerWidgetPopup, registerWindow, releaseWindow, resetComposite, resetMode, resizeWindow, resolveTextMetrics, restoreDrawingState, resume, resume, saveDrawingState, scaleFont, selectWindow, setColor, setColor, setControl, setCursorStatus, setDesktopBgColor, setDisableRedraw, setDrawingArea, setDrawingAreas, setFontStyle, setGuiFont, setIcon, setLineStroke, setLineStroke, setTextMetrics, setTitle, setWidgetAttribute, setWidgetBounds, setWin32MousePosition, setWindowBounds, setWindowEnabled, setWindowLocation, setWindowLocation, setWindowVisible, setXORComposite, setXORMode, shutdown, squeeze, stackWindows, startBatch, suspend, suspend, translatePop, translatePush, 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, 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.gui.driver.GuiDriver

getBasicWebPalette, getClientFontHeight, getClientTextWidth, notifyWait, parseEditorContent, propagateWaitState, resetSelection, setUploadFileSizeLimits, withSelectedWindow

Methods inherited from interface com.goldencode.p2j.ui.client.driver.ScreenDriver

chooseFiles, clientReady, getFactory, getHostByName, getHostName, getPrimitives, getWindowSystem, inBackgroundMode, inBatchMode, init, isChui, isEmbeddedClient, isWeb, lockMousePointer, openMimeResource, setCurrentLanguage, setTerminalType, terminalType, widgetStateChanged

Field Detail

NAME

public static final java.lang.String NAME

Driver name.

See Also:

Constant Field Values

LOGGER

private static final CentralLogger LOGGER

The logger to log class events.

keyReader

private final SwingKeyboardReader keyReader

The key reader. This is global per the entire application, no matter how many frames are alive.

keyboardFocusManager

private final java.awt.KeyboardFocusManager keyboardFocusManager

The driver's level keyboard focus manager.

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.

globalCursor

private MousePtrWrapper globalCursor

The application-wide cursor.

Constructor Detail

SwingGuiDriver

public SwingGuiDriver(BootstrapConfig config)

Create a new GUI screen driver.

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.

registerMoveableWidget

public void registerMoveableWidget(int wid)

Register the specified widget as a moveable widget, via mouse.

Parameters:

wid - The widget ID.

registerHoverableWidget

public void registerHoverableWidget(MouseHoverAction action)

Register this widget as being editable, so that the mouse cursor will adjust properly when the widget is entered.

Parameters:

action - The widget mouse action.

registerResizeableWidget

public void registerResizeableWidget(int wid)

Register the specified widget as a resizeable widget, via mouse.

Parameters:

wid - The widget ID.

setResizeableWindow

public void setResizeableWindow(boolean resize,
                                int minWidth,
                                int minHeight,
                                int maxWidth,
                                int maxHeight)

Set the window details for resize; this includes the minimum and maximun dimensions, and also the window's resizeable state.

This is a no-op for Swing.

Parameters:

resize - Flag indicating if the window can be resized or not.

minWidth - The window's minimum width.

minHeight - The window's minimum height.

maxWidth - The window's maximum width.

maxHeight - The window's maximum height.

deregisterWidget

public void deregisterWidget(int wid)

Deregister the specified widget for mouse events.

Specified by:

deregisterWidget in interface ScreenDriver<GuiOutputManager>

Overrides:

deregisterWidget in class AbstractGuiDriver<java.awt.Font>

Parameters:

wid - The widget ID.

getScreenResolution

public int getScreenResolution()

Reports the screen resolution in dots per inch (DPI).

Returns:

The DPI of the screen.

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.

newEmulator

public EmulatedWindowState newEmulator(int windowId,
                                       boolean showInTaskbar)

Create a new window emulator.

Specified by:

newEmulator in class AbstractGuiDriver<java.awt.Font>

Parameters:

windowId - The window ID.

showInTaskbar - This flag is not supported by swing driver.

Returns:

The newly instantiated window emulator.

newChildWindowEmulator

public EmulatedWindowState newChildWindowEmulator(int windowId,
                                                  EmulatedWindowState owner,
                                                  java.lang.String windowTitle,
                                                  boolean resizable,
                                                  boolean isShareActivationWithOwner,
                                                  boolean modal)

Create a new child window emulator.

Specified by:

newChildWindowEmulator in class AbstractGuiDriver<java.awt.Font>

Parameters:

windowId - The window ID.

owner - The owning window.

windowTitle - Title of the window emulator.

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.

Returns:

The newly instantiated window emulator.

createFont

public FontDetails<java.awt.Font> createFont(FontDetails<java.awt.Font> specs)

Create a font with the given details and register it with the driver.

Parameters:

specs - The font specifications.

Returns:

A font instance.

deriveFont

public void deriveFont(FontDetails<java.awt.Font> fd)

Scale the given font to match the screen resolution.

Specified by:

deriveFont in class AbstractGuiDriver<java.awt.Font>

Parameters:

fd - Font to scale. This instance's contained font will be modified.

copyToClipboard

public void copyToClipboard(java.lang.String txt)

Copy the given text to the system clipboard.

Parameters:

txt - The text to be copied.

clipboardContents

public java.lang.String clipboardContents()

Get the current contents from the OS clipboard.

Returns:

The clipboard contents.

restackWindows

public void restackWindows(int[] windowIds)

Force the list of all GUI windows to be stacked as in the specified order.

This is a no-op. Swing handle this automatically.

Specified by:

restackWindows in class AbstractGuiDriver<java.awt.Font>

Parameters:

windowIds - The stack order to be enforced.

moveToTop

public void moveToTop(int windowId,
                      boolean focus)

Move the specified window to the top of the z-order, at the OS level.

This is a no-op. Swing handle this automatically.

Specified by:

moveToTop in interface GuiDriver<java.awt.Font,java.awt.image.BufferedImage>

Specified by:

moveToTop in class AbstractGuiDriver<java.awt.Font>

Parameters:

windowId - The window to be moved.

focus - If true, the window will become the focused window and its state changed to active.

moveToBottom

public void moveToBottom(int windowId)

Move the specified window to the bottom of the z-order, at the OS level.

This is a no-op. Swing handle this automatically.

Specified by:

moveToBottom in interface GuiDriver<java.awt.Font,java.awt.image.BufferedImage>

Specified by:

moveToBottom in class AbstractGuiDriver<java.awt.Font>

Parameters:

windowId - The window to be moved.

getVirtualScreenSize

public NativeDimension getVirtualScreenSize()

Returns the size of the virtual screen, i.e. in multi-display setup, all displays are accounted for.

Returns:

See above.

setCurrentSelection

public void setCurrentSelection(java.lang.String txt)

Sets the current selection.

Parameters:

txt - The current selection.

createMousePointer

public MousePtrWrapper createMousePointer(java.io.InputStream inputStream,
                                          java.lang.String ptrName)

Load mouse pointer from the InputStream

Parameters:

inputStream - cursor data

ptrName - pointer name

Returns:

mouse pointer or null

propagate

public void propagate(int windowId,
                      int wid,
                      MousePtrWrapper ptr)

Push information about the loaded mouse pointer for widget

Parameters:

windowId - to level window id

wid - widgetId

ptr - mouse pointer

setCursor

public void setCursor(MousePtrWrapper ptr)

Set the mouse cursor

Parameters:

ptr - mouse cursor

setCursor

public void setCursor(CursorType type)

Set the mouse cursor to the given type.

Parameters:

type - The cursor type.

setCursor

public void setCursor(java.awt.Cursor c)

Set the mouse cursor to the given one.

Parameters:

c - The custom cursor.

setCursor

public void setCursor(java.lang.String icon)

Set the mouse cursor from a given resource.

Parameters:

icon - The name of custom cursor.

isFontInstalled

public boolean isFontInstalled(java.lang.String fontName,
                               boolean boldFont)

Tests if the target font is known to JRE.

Parameters:

fontName - The target font name.

boldFont - Indicates that the bold font is queried.

Returns:

True if the target font is installed, otherwise false.

isWindowDecorationSupported

public boolean isWindowDecorationSupported()

Returns true if a window can be decorated in this graphics environment, otherwise false.

Returns:

true if a window can have its title, caption buttons and border, otherwise false.

getMousePosition

public NativePoint getMousePosition()

Returns current mouse cursor display position relative to the display origin.

Returns:

mouse cursor position, never null

deliverDocumentOutput

public void deliverDocumentOutput(java.util.function.Consumer<java.io.OutputStream> consumer,
                                  java.lang.Runnable finalizer,
                                  MediaType format,
                                  java.lang.String uuid,
                                  boolean promptUser)

The method delivers document output to the client. The supplied consumer is invoked by the driver providing a suitable output stream. The consumer implementation is responsible for sending the data to the provided stream. The consumer implementation must not close the provided stream. When the finalizer is supplied, it will be called by the driver when the document output is no longer needed. The finalizer should free up any additional resources the document output may need.

This implementation outputs the document data to a file. The output directory is given by getPrintOutputDir() and file name by AbstractGuiDriver.getPrintOutputFile(String, MediaType).

Parameters:

consumer - Output consumer, must not be null. See above.

finalizer - Finalizer callback, may be null. See above.

format - Report output format.

uuid - Unique id of the operation.

promptUser - if true the user is eventually prompted for a name for the output file, otherwise a name is picked automatically if needed.

openMimeResource

public void openMimeResource(boolean deleteContent,
                             java.lang.String mimeType,
                             java.lang.String uriString,
                             boolean embedded)
                      throws java.net.URISyntaxException

Opens the specified resource in a browser's window.

Parameters:

deleteContent - Indicates if the source content will be deleted after the document is loaded by the client.

mimeType - The resource mime type.

uriString - The string presentation of the target resource.

embedded - The document is embedded in the template document.

Throws:

java.net.URISyntaxException - If this string presentation of the target resource is not formatted strictly according to to RFC2396 and cannot be converted to a URI.

setAlwaysOnTop

public void setAlwaysOnTop(int windowId,
                           boolean topOnly,
                           boolean alwaysOnTop)

Makes the supplied window to be on top of other windows. This method is used to implement the top-only functionality directly in the driver when AbstractGuiDriver.stackWindows(int[]) is not fully supported by the driver.

Parameters:

windowId - The window to be changed.

topOnly - Corresponds to the WINDOW:TOP-ONLY attribute.

alwaysOnTop - Corresponds to the WINDOW:ALWAYS-ON-TOP attribute.

addMessageListener

public void addMessageListener(MsgBlasterPeer listener,
                               int windowId,
                               int widgetId)

Add a low-level message listener for a specific window.

Parameters:

listener - The listener to be added.

windowId - The windows id.

widgetId - The widget's id.

removeMessageListener

public void removeMessageListener(MsgBlasterPeer listener,
                                  int windowId,
                                  int widgetId)

Removes a low-level message listener for a specific window.

Parameters:

listener - The listener to be removed.

windowId - The windows id.

widgetId - The widget's id.

createWidget

public void createWidget(java.lang.String type,
                         int widgetId)

Create a driver-implemented widget.

Parameters:

type - The widget type, one of the LegacyResource widget names.

widgetId - The widget.

createWidget

public <T extends DriverWidget> void createWidget(java.lang.Class<T> widgetClass,
                                                  int widgetId)

Create a driver-implemented widget.

Parameters:

widgetClass - The widget class.

widgetId - The widget ID to be set.

setGlobalCursor

public void setGlobalCursor(MousePtrWrapper ptr)

Assign a cursor for the entire web application, simulating Win32.SetCursor functionality.

Parameters:

ptr - Wrapper for the cursor.

removeGlobalCursor

public void removeGlobalCursor()

Assign a cursor for the entire web application, simulating Win32.SetCursor functionality.

getGlobalCursor

public MousePtrWrapper getGlobalCursor()

Returns the application-wide cursor.

Returns:

wrapper for the cursor.

getPrintOutputDir

private java.io.File getPrintOutputDir()

Returns the directory for print output. This directory will store the files output from the internal printer. The directory path is read from client:driver:print_output bootstrap configuration item. If not specified or the configured path is no a valid directory the current work directory will be used.

Returns:

A File object representing the output directory.

buildOpenResourcePage

private java.net.URI buildOpenResourcePage(java.lang.String mimeType,
                                           java.lang.String url)
                                    throws java.io.IOException

Builds the html document that embeds the target resource given by its url path and its mime type.

Parameters:

mimeType - The resource mime type.

url - The url of the target resource.

Returns:

The absolute file system path to the new created html document given by file URI.

Throws:

java.io.IOException - Iff the target IO operation is failed.

openDocument

private static void openDocument(java.net.URI uri)
                          throws java.io.IOException

Open the target document given by its URI.

Parameters:

uri - The document URI

Throws:

java.io.IOException - Iff the target IO operation is failed

getAdjustmentInfo

protected Tuple<java.lang.String,java.awt.Rectangle> getAdjustmentInfo(java.awt.Point p,
                                                                       java.awt.Dimension dim)

Determines the type of overflow and the screen bounds.

Parameters:

p - The point representing the top-left corner of the window.

dim - The dimensions of the window.

Returns:

A tuple containing the overflow type as a string ("right", "bottom", "rightbottom", or empty if no overflow) and the bounds of the screen where the point is located.