GuiWebDriver (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.ui.client.driver.AbstractDriver<GuiPrimitives,GuiOutputManager>
- - com.goldencode.p2j.ui.client.gui.driver.AbstractGuiDriver<java.lang.Integer>
  - - com.goldencode.p2j.ui.client.gui.driver.web.GuiWebDriver

All Implemented Interfaces:

ScreenDriver<GuiOutputManager>, ScreenWebDriver, ClientProtocolHooks, EmbeddedWebServer, EmbeddedClient, GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>, DocumentOutputStorage, FileUploadStorage, WebConfigurationConstants
```
public class GuiWebDriver
extends AbstractGuiDriver<java.lang.Integer>
implements EmbeddedWebServer, ScreenWebDriver, ClientProtocolHooks, EmbeddedClient, DocumentOutputStorage, FileUploadStorage, WebConfigurationConstants
```
GUI driver using WebSockets to communicate with a very thin javascript client hosted in a browser. This class creates and uses an embedded web server to accomplish this.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class GuiWebDriver.RepaintThread
Dedicated thread responsible of processing repaint requests.
- 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

Nested Classes
Modifier and Type	Class and Description
`private class`	`GuiWebDriver.RepaintThread` Dedicated thread responsible of processing repaint requests.

Field Summary

Fields
Modifier and Type	Field and Description
`private int`	`activeWindowId` The active window.
`private java.util.Map<java.lang.Integer,java.util.List<MsgBlasterPeer>>`	`blasterListeners` The set of listened widgetId.
`private static java.awt.Component`	`BOGUS_AWT_COMPONENT` A bogus AWT component used to raise mouse events, on notification from the JS code.
`private java.util.function.Supplier<java.lang.Integer>`	`browserTimeoutSupplier` The number of milliseconds to wait a page to be loaded in a HTML browser
`private NativeDimension`	`desktop` Desktop bounds.
`private int`	`directUploadsModcount` The cached modification count of the effective list of direct upload definitions
`private java.util.Map<java.util.UUID,DocumentOutput>`	`documentOutputs` Map of document outputs pending to be sent to the Javascript part of the client.
`private boolean`	`embedded` Indicates if the web client embedded mode is on or off.
`private double[]`	`fontScaleX` A cache of font scaling factors, by their remote font ID.
`private MousePtrWrapper`	`globalCursor` The global cursor.
`private java.util.function.Supplier<java.util.Map<java.lang.String,java.util.List<java.lang.String>>>`	`helperApplicationsSupplier` The provider of the supported helper applications.
`private static int[]`	`HOVER_ACTIONS` Actions for hoverable widgets
`private java.util.Map<java.util.List<java.lang.Integer>,java.lang.Integer>`	`imageSeals` Maps the image seal to the unique image identity.
`private java.util.Map<java.util.List<java.lang.Integer>,org.roaringbitmap.RoaringBitmap>`	`imageUsages` Image usages is a mapping of an image loaded by a client to its owner windows.
`private SupplierWithMemo<KeyboardLayoutsSettings>`	`keyboardSupplier` The provider of keyboard layouts settings
`private java.util.Set<java.lang.String>`	`langCache` Language Ids cache
`private int`	`lastFocusedWidget` The focused widget saved during the last processing of interactive widgets
`private java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,org.roaringbitmap.RoaringBitmap>>`	`lastMouseWidgets` A map with the last widgets sent to the JS side in [ windowid : [widgetId : actions] ] form.
`private FontDetails<java.lang.Integer>`	`lastUsedFont` The last font set.
`private LocalStorageAccessor`	`localStorageAccessor` Accessor for localStorage
`private java.lang.Object`	`lock` Lock object for shared syncrhonization of the web socket.
`private static CentralLogger`	`LOG` Logger.
`private static java.lang.String`	`MAIN_TARGET` Main page root target.
`private static long`	`MAX_PRINT_OUTPUT_AGE` Max age of print outputs in milliseconds.
`static java.lang.String`	`NAME` Driver name.
`private boolean`	`needsNotificationOnWait` The notify-user-input state.
`private int`	`nextFontId` A counter for font IDs to be mapped on the js-side.
`private java.net.URL`	`originUrl` The origin URL of the embedded web server's index page
`private java.util.Map<java.lang.Integer,java.util.Set<java.util.List<java.lang.Integer>>>`	`ownedImages` Owned images is a mapping of a window to its owned images seals.
`private boolean`	`registerMouseWidgets` Flag indicating if `registerInteractiveWidgets()` must be executed.
`private java.util.LinkedList<GuiWebEmulatedWindow>`	`repaints` A queue of pending repaint requests which needs to be processed by the `GuiWebDriver.RepaintThread` thread.
`private org.roaringbitmap.RoaringBitmap`	`stateChanged` Set of widget IDs for which their state has changed.
`private boolean`	`taskbar` Flag indicating if the virtual desktop taskbar is shown.
`static int`	`TASKBAR_HEIGHT` Taskbar height in pixels when it exists.
`private TaskBarStyle`	`taskBarStyle` The task bar style on the virtual desktop
`private static java.lang.String`	`TEXT_SAMPLE` Text sample to calculate scaling factor for variable size fonts.
`private static java.lang.String`	`TEXT_SAMPLE_MONO` Text sample to calculate scaling factor for monospace fonts.
`private java.util.HashMap<java.lang.Integer,FileUploadInfo>`	`uploads` Active uploads
`private VirtualScreen`	`virtualScreen` Virtual screen for drawing in a memory
`private GuiWebSocket`	`websock` Web-Socket which provides a GUI-specific protocol for communication with the browser.
`private EmbeddedWebServerImpl`	`websrv` Delgated implementation for the embedded web server.
`private static java.lang.String`	`WELCOME_PAGE` Welcome page.
`private java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,NativeRectangle>>`	`widgetsRegions` Collects the mouse widgets belonging to a window.
`private NativeDimension`	`workarea` Work-Area bounds.

Fields inherited from class com.goldencode.p2j.ui.client.gui.driver.AbstractGuiDriver
config, control, driverWidgets, ews, 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

GuiWebDriver(BootstrapConfig config)
Constructor.

Constructors
Constructor and Description
`GuiWebDriver(BootstrapConfig config)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHandler(org.eclipse.jetty.server.Handler handler)` Adds a custom handler.
`boolean`	`addImageUsage(java.util.List<java.lang.Integer> imageHash, int windowId)` Register a usage of the given image by the given window.
`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.
`void`	`cacheTextMetrics(java.util.Map<FontDetails<java.lang.Integer>,java.util.Set<java.lang.String>> texts, java.lang.Integer windowId)` Get and cache metrics for the given texts.
`boolean`	`captureMouseEvents(boolean state)` Enable or disable capture of mouse events.
`ChooseFileResult`	`chooseFiles(java.lang.String title, boolean multiple, boolean upload, java.lang.String uploadDir, java.lang.String[] filters)` Supported by web-based drivers.
`void`	`clearMessages(int windowId)` Clear all message texts of specified window.
`void`	`clientReady()` Notify the driver that the client is ready (useful for embedded mode, to notify the embedded app the client can handle messages).
`java.lang.String`	`clipboardContents()` Get the current contents from the OS clipboard.
`private void`	`collectWidgets(Widget w, java.util.function.Predicate<Widget> filter, java.util.function.Consumer<Widget> actionsCollector)` Add the widget (and all its possible children) in the specified set, maintaining z-order in a left-to-right (topmost to bottommost) order.
`void`	`copyToClipboard(java.lang.String txt)` Copy the given text to the system clipboard.
`FontDetails<java.lang.Integer>`	`createFont(FontDetails<java.lang.Integer> details)` Create a font with the given details and register it with the driver.
`MousePtrWrapper`	`createMousePointer(java.io.InputStream data, 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.
`DocumentOutput`	`dequeueDocumentOutput(java.util.UUID uuid)` Returns the document outputs previously enqueued with `enqueueDocumentOutput(DocumentOutput)`.
`void`	`deregisterWidget(int wid)` Deregister the specified widget for mouse events.
`void`	`deriveFont(FontDetails<java.lang.Integer> fd)` Scale the given font to match the screen resolution.
`void`	`desktopResized(int width, int height, TaskBarStyle taskBarStyle)` Called when the desktop on the client has changed its dimensions.
`void`	`doTextShift(java.lang.String text, int widthHint)` Draws the cursor for the given text widget.
`void`	`drawCursor(LightweightTextWidget widget)` Draws the cursor for the given text widget.
`void`	`drawString(java.lang.String text, int x, int y)` Draw a string at the specified location.
`void`	`drawStringCentered(java.lang.String text, int x, int height)` Draw a string at the specified location.
`void`	`enableEvents(int[] windowIds, boolean capture)` Enable or Disable OS-level events for the specified windows.
`void`	`enqueueDocumentOutput(DocumentOutput docOutput)` The method stores document outputs pending to be sent to the Javascript part of FWD client.
`void`	`fillRectAroundText(int x, int y, int textWidthHint, int textHeightHint, java.lang.String text)` Fill a rectangle around the given text.
`boolean`	`findAnyIdInChannel(java.lang.String channelName, java.util.List<java.lang.String> channelIds)` Searches for the specified channel instances and returns `true` if any found, `false` otherwise.
`int[]`	`getBasicWebPalette()` Queries the web driver for a basic palette.
`BrowserDetails`	`getBrowserDetails()` Returns the browser details for web drivers.
`int`	`getClientFontHeight(FontDetails<java.lang.Integer> fd)` Get the height of the font from the client native environment.
`int`	`getClientTextWidth(java.lang.String text, FontDetails<java.lang.Integer> fd)` Get the width of the specified text for the given font from the client native environment, the browser or swing environments.
`private java.util.Map<java.lang.Integer,java.util.List<ClientDirectUploadDef>>`	`getDirectUploadDefinitions()` Retrieves the effective direct upload definitions.
`NativeRectangle`	`getDisplayBounds()` Since web interface is inherently a single-display setup the method effectively returns a rectangle with top-level corner equal to 0,0.
`NativeRectangle`	`getDisplayWorkArea()` Returns an application-usable display area.
`FileUploadInfo`	`getFileUpload(int id)` Returns file upload metadata.
`MousePtrWrapper`	`getGlobalCursor()` Retrieves the globally assigned cursor.
`long`	`getHostByName(java.lang.String name)` Returns the currently connected client's machine name for session.
`java.lang.String`	`getHostName()` Returns the currently connected client's machine name for session.
`KeyValueStorage`	`getLocalStorageAccessor(java.lang.String storageId, java.lang.String fwdUser)` Returns accessor for localStorage for web drivers.
`private static int`	`getMouseModifiers(int button, int modifiersMask)` Gets the mouse modifiers mask for this event.
`NativePoint`	`getMousePosition()` Returns current mouse cursor display position relative to the display origin.
`java.lang.String`	`getName()` Get the driver name.
`java.net.URL`	`getOriginUrl()` Returns the origin URL of the embedded web server's index page.
`int`	`getScreenResolution()` Reports the screen resolution in dots per inch (DPI).
`java.lang.String`	`getServerURI()` Get the embedded web server's URI.
`int`	`getTextWidth(java.lang.String text, FontDetails<java.lang.Integer> fd)` Get the width of the specified text, using the given font.
`int[]`	`getTextWidths(java.lang.String text, FontDetails<java.lang.Integer> fd)` Get the widths of the specified text, using the given font.
`java.lang.Integer`	`getUniqueIdForSeal(java.util.List<java.lang.Integer> imageSeal)` Gets the unique image id by its identity array.
`VirtualScreen`	`getVirtualScreen()` Returns its virtual screen that represents the physical screen in a memory using a sRGB pixel model.
`NativeDimension`	`getVirtualScreenSize()` Returns the size of the virtual screen, i.e.
`private static org.roaringbitmap.RoaringBitmap`	`getWebActions(Widget widget)` Returns the set of mouse actions handled by this widget.
`void`	`init()` Initialize driver.
`void`	`initClipboardSoftPaste()` Init widget generated PASTE command from the OS clipboard.
`void`	`initRemoteClient()` Called each time a connect occurs, this allows caller-controlled initialization of the remote client.
`void`	`injectVT100Key(int keyCode, char charCode)` Input key events when in VT100 mode.
`boolean`	`isEmbeddedClient()` Returns true if this client runs in embedded mode.
`boolean`	`isFontInstalled(java.lang.String fontName, boolean boldFont)` Returns the boolean value if the target font is installed or not.
`private boolean`	`isInLastMouseWidgets(java.lang.Integer widgetId, java.lang.Integer windowId)` Tests if the given mouse widget is in the last mouse widgets map.
`private static boolean`	`isInsideVisibleFrameOrStandalone(Widget wid)` Checks if the given widget is belonging to visible frame or not inside any frame, like window decorations.
`boolean`	`isWeb()` All web-based drivers return `true`.
`boolean`	`isWindowDecorationSupported()` Returns true if a window can be decorated in this graphics environment, otherwise false.
`void`	`lockMousePointer(int widgetId, MousePtrWrapper ptr)` Lock the mouse pointer (suppress widget-specific changes) or unlock it
`void`	`lowLevelEvent(int widgetId, int winId, int messageId, int p1, int p2, int p3)` Sends a notification of a low-level event for a listening widget.
`void`	`lowLevelMouseEvent(java.awt.event.MouseEvent evt, MouseOps mop, int windowId)` Sends a notification of a low-level mouse event for a listening widget.
`void`	`mapSealToUniqueId(java.util.List<java.lang.Integer> imageSeal, java.lang.Integer uniqueId)` Maps the image identity array to the unique image id.
`private static java.lang.String`	`mimeType(java.lang.String icon)` Detect MIME type of image.
`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.
`boolean`	`needsExplicitTextMetricsCaching()` Returns `true` if getting actual text metrics is an expensive operation for this driver and you want to manually manage metrics cache using `GuiDriver.cacheTextMetrics(Map, Integer)`.
`EmulatedWindowState`	`newChildWindowEmulator(int windowId, EmulatedWindowState parentWindow, 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.
`void`	`notifyWait()` The method is called when the 4GL program execution enters a modal or wait-for event loop, in other words when user input is expected.
`void`	`openMimeResource(boolean deleteContent, java.lang.String mimeType, java.lang.String uriString, boolean embedded)` Opens the specified resource in a browser's window.
`void`	`openMimeResource(java.lang.String mimeType, java.lang.String resourcePath, ScreenDriver.UriPathAnchor uriPathAnchor)` Opens the specified resource in a browser's window.
`int[][]`	`parseEditorContent(int widgetId, int windowId, int maxWidth, java.lang.String text, int delta, FontDetails<java.lang.Integer> font)` Split the text for a editor widget, so that it fits the specified maximum width.
`boolean`	`pingBroadcastChannel(java.lang.String channelName, java.lang.String targetChannelId)` Returns if the target broadcast channel responds with pong.
`boolean`	`pingOnWebSocket()` Check if the WebSocket connection is alive.
`protected void`	`postRepaint(GuiWebEmulatedWindow ews)` Post a new repaint for the specified window to the `repaints` queue.
`void`	`propagate(int windowId, int wid, MousePtrWrapper ptr)` Push information about the loaded mouse pointer for widget
`void`	`propagateWaitState(boolean isWaitState)` Propagate wait state
`void`	`publish(long subId, java.lang.String event, java.lang.String[] param)` Send a PUBLISH notification to a remote application.
`void`	`putFileUpload(int id, FileUploadInfo uploadInfo)` The method stores an instance with file upload metadata.
`void`	`raiseMouseEvent(int windowId, int mouseOp, long tstamp, int mouseX, int mouseY, int button, int clickCount, int modifiersMask, int[] wheelParameters, int widgetId)` Raise a mouse event.
`KeyCode`	`readKey()` Read single keystroke from keyboard.
`void`	`registerBroadcastChannel(java.lang.String channelName, java.lang.String channelId)` Opens a broadcast channel in the client's front-end.
`void`	`registerHoverableWidget(MouseHoverAction action)` Register this widget as being editable, so that the mouse cursor will adjust properly when the widget is entered.
`void`	`registerInteractiveWidgets()` Register all the mouse-aware widgets (in all Windows) with the JS side.
`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.
`UnformattedPayload`	`remoteCall(UnformattedPayload request)` This is a special API which is used to delegate a call from converted 4GL code (via _P2J_REMOTE_CALL_ functions) to the remote side.
`void`	`removeDocuments(java.util.Set<java.util.UUID> documents)` Remove the given documents from the storage
`void`	`removeFileUpload(int id)` Removes metadata for a particular upload.
`void`	`removeGlobalCursor()` Removes the assigned global cursor.
`void`	`removeHandler(org.eclipse.jetty.server.Handler handler)` Removes the handler from the list of handlers.
`void`	`removeMessageListener(MsgBlasterPeer listener, int windowId, int widgetId)` Removes a low-level message listener for a specific window.
`int[]`	`removeUnusedImages(int windowId)` Returns all unused images.
`void`	`resetSelection()` Reset selection boxes painting mode and return to normal drawing mode.
`(package private) DocumentOutput`	`resolveResource(boolean deleteContent, java.lang.String mimeType, ContentDisposition contentDisposition, java.io.File originalFile)` Resolve the document output used to retrieve the content of the original file.
`(package private) DocumentOutput`	`resolveResource(boolean deleteContent, java.lang.String mimeType, ContentDisposition contentDisposition, java.io.File originalFile, java.util.function.BiConsumer<java.io.File,java.io.File> customCopy, boolean cached)` Resolve the document output used to retrieve the content of the original file.
`void`	`restackWindows(int[] windowIds)` Force the list of all GUI windows to be stacked as in the specified order.
`OsPassChangeInput`	`retryPassChangeOnError(java.lang.String osUserName, java.lang.String errMsg)` Shows an error message in the OS pass change process.
`void`	`saveDropTargetFile(java.lang.String name, byte[] data, int size)` Stores the given byte array date as file in Java temporary directory with the given name.
`void`	`saveDropTargetFile(java.lang.String name, java.nio.channels.FileChannel channel, int length)` Reads the data from the given file channel starting from its current position and stores the retrieved data into the file in Java temporary directory with the given name.
`void`	`setControl(boolean control)` Notify the driver which side has control (client-side (when `true`) or server, otherwise).
`void`	`setCurrentLanguage(java.lang.String language)` Set new current session language for the client.
`void`	`setCurrentSelection(java.lang.String txt)` Sets the current editors selection.
`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.
`void`	`setGuiFont(FontDetails<java.lang.Integer> font)` Set current font used on draw operations.
`void`	`setMessageText(int windowId, java.lang.String[] message)` Add message texts of specified window.
`void`	`setNeedsNotificationOnWait(boolean newState)` The method is executed by the JS client when it requires to be notified when 4GL program execution enters modal or wait-for event loop, in other words when user input is expected.
`void`	`setOriginUrl(java.net.URL originUrl)` Assigns the origin URL of the embedded web server's index page.
`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.
`void`	`setStatusText(int windowId, java.lang.String message)` Set status text message of specified window.
`void`	`setUploadFileSizeLimits(int single, int total)` Setting up file size limits for cases when drag and drop needs file uploads from web client to Java side.
`void`	`setWindowDimension(int windowId, int width, int height)` Set the dimension for the specified window.
`void`	`setWindowLocation(int windowId, int x, int y)` Set the location for the specified window.
`OsPassChangeInput`	`showChangePasswordDialog(java.lang.String osUserName, boolean isModal)` Shows a dialog to allow the change of the OS account password.
`void`	`showSuccessfulPassChange()` Shows that the OS pass has been changed successfully on the front-end and hide the dialog.
`void`	`shutdown()` Perform driver shutdown.
`void`	`shutdownServer()` Shutdown the embedded web server.
`void`	`startDirectManipulation(int opType, boolean gridSnapOn, int resizeDir, NativeRectangle maxBounds, NativeRectangle[] nr)` Uses websocket to notify the JS side the direct manipulation has started to draw the selection box(es).
`void`	`startDropTarget(int windowId, int widgetId, java.util.List<java.lang.String> fileNameList)` Initiates the process of the file list dropping for web clients.
`java.lang.String`	`startupServer(ServerKeyStore keyStore, BootstrapConfig config, java.lang.String host, int port)` Startup the embedded server using the server's key store to build the web server SSL context.
`private void`	`syncDesktopDimensions()` Fetches the desktop dimension from the client and calls `updateDesktopDimensions(int, int)` with the result.
`private boolean`	`updateCachedWidgetBounds(int windowId, Widget widget, NativeRectangle[] widgetBounds)` Updates the cached widgets bounds and returns true iff the cached widgets bounds has been updated.
`private void`	`updateDesktopDimensions(int width, int height)` Updates the class state that relies on the client desktop dimensions.
`void`	`waitInitialization()` Wait for the page to notify that it has fully initialized its JS code.
`void`	`widgetStateChanged(int widgetId)` Notification that this widget's state has changed (visibility, sensitivity, z-order).
`void`	`windowActivated(int deactivatingWindowId, int activatingWindowId)` Raise an event indicating that the target window has been activated or deactivated.
`void`	`windowIconified(int windowId, boolean state)` Raise an event as the window was (de)iconified.
`private static java.lang.String`	`writeLauncherWrapper(java.lang.String uriString)` Create the wrapper for the launcher resource.

Methods inherited from class com.goldencode.p2j.ui.client.gui.driver.AbstractGuiDriver
changeSensitivity, changeVisibility, clear, copyResource, copyResource, createGreyImage, createIcon, createImage, createMouseDirectManipulationInstance, createOutputManager, deiconifyWindow, deregisterTooltipWorkers, deregisterWindow, destroyWidget, draw, draw, draw3DRect, drawEdge, drawEllipse, drawFromOrigin, drawHighlight, drawIbeam, drawImage, drawImage, drawLine, drawParagraph, drawRect, drawRoundRect, drawSelection, drawStringCentered, drawStringScaled, drawStringWithinBox, drawStringWithinBoxScaled, drawStringWithinBoxWithMnemonic, drawStringWithMnemonic, drawTextSelection, endBatch, fill3DRect, fillEllipse, fillPolygon, fillRect, fillRoundRect, fitStringWithEllipsis, getBgColor, getBgStdColor, getChildProcessFactory, getDisplayBounds, getDisplayWorkArea, getDriverWidget, getFgColor, getFgStdColor, getFontHeight, getFontMaxWidth, getFontWidth, getFontWidths, getParagraphHeight, getPrintOutputFile, getSubImage, getSysColor, getTextHeight, getTextMetrics, getTextWidths, getWindowDimension, getWindowLocation, handleMouseEvent, hasWindowEmulator, iconifyWindow, initDragAndDrop, invokeWidgetCommand, invokeWidgetCommand, isActualTextMetricsCached, isEmptyText, isWindowVisible, makeImage, moveResource, placeWidget, registerChildWindow, registerDirectManipulation, registerEmptySelector, registerPendingTooltipWorkers, registerTooltipWorker, registerWidgetPopup, registerWindow, releaseWindow, resetComposite, resetMode, resizeWindow, resolveTextMetrics, restoreDrawingState, resume, resume, saveDrawingState, scaleFont, selectWindow, setColor, setColor, setCursorStatus, setDesktopBgColor, setDisableRedraw, setDrawingArea, setDrawingAreas, setFontStyle, setIcon, setLineStroke, setLineStroke, setTextMetrics, setTitle, setWidgetAttribute, setWidgetBounds, setWin32MousePosition, setWindowBounds, setWindowEnabled, setWindowLocation, setWindowLocation, setWindowVisible, setXORComposite, setXORMode, squeeze, stackWindows, startBatch, suspend, suspend, translatePop, translatePush, updateClientMetrics

Methods inherited from class com.goldencode.p2j.ui.client.driver.AbstractDriver
getFactory, getPrimitives, getWindowSystem, inBackgroundMode, inBatchMode, 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
setAlwaysOnTop, withSelectedWindow

Methods inherited from interface com.goldencode.p2j.ui.client.driver.ScreenDriver
getFactory, getPrimitives, getWindowSystem, inBackgroundMode, inBatchMode, isChui, setTerminalType, terminalType

- Field Detail
  - NAME
```
public static final java.lang.String NAME
```
    Driver name.
    
    See Also:
    
    Constant Field Values
  - TASKBAR_HEIGHT
```
public static final int TASKBAR_HEIGHT
```
    Taskbar height in pixels when it exists. This is in sync with p2j.virtual_desktop.js:TASKBAR_HEIGHT.
    
    See Also:
    
    Constant Field Values
  - LOG
```
private static final CentralLogger LOG
```
    Logger.
  - MAIN_TARGET
```
private static final java.lang.String MAIN_TARGET
```
    Main page root target.
    
    See Also:
    
    Constant Field Values
  - WELCOME_PAGE
```
private static final java.lang.String WELCOME_PAGE
```
    Welcome page.
    
    See Also:
    
    Constant Field Values
  - BOGUS_AWT_COMPONENT
```
private static final java.awt.Component BOGUS_AWT_COMPONENT
```
    A bogus AWT component used to raise mouse events, on notification from the JS code.
  - HOVER_ACTIONS
```
private static final int[] HOVER_ACTIONS
```
    Actions for hoverable widgets
  - MAX_PRINT_OUTPUT_AGE
```
private static final long MAX_PRINT_OUTPUT_AGE
```
    Max age of print outputs in milliseconds. When a PDF print output is delivered to the driver it is stored in documentOutputs form where it is later served to JS client. Print outputs are removed from the map either upon successful delivery to the JS client or when the age extends over this value.
    
    See Also:
    
    Constant Field Values
  - TEXT_SAMPLE
```
private static final java.lang.String TEXT_SAMPLE
```
    Text sample to calculate scaling factor for variable size fonts.
    
    See Also:
    
    Constant Field Values
  - TEXT_SAMPLE_MONO
```
private static final java.lang.String TEXT_SAMPLE_MONO
```
    Text sample to calculate scaling factor for monospace fonts.
    
    See Also:
    
    Constant Field Values
  - websrv
```
private EmbeddedWebServerImpl websrv
```
    Delgated implementation for the embedded web server.
  - websock
```
private GuiWebSocket websock
```
    Web-Socket which provides a GUI-specific protocol for communication with the browser.
  - lock
```
private java.lang.Object lock
```
    Lock object for shared syncrhonization of the web socket.
  - desktop
```
private NativeDimension desktop
```
    Desktop bounds.
  - workarea
```
private NativeDimension workarea
```
    Work-Area bounds.
  - virtualScreen
```
private VirtualScreen virtualScreen
```
    Virtual screen for drawing in a memory
  - imageSeals
```
private final java.util.Map<java.util.List<java.lang.Integer>,java.lang.Integer> imageSeals
```
    Maps the image seal to the unique image identity.
  - imageUsages
```
private final java.util.Map<java.util.List<java.lang.Integer>,org.roaringbitmap.RoaringBitmap> imageUsages
```
    Image usages is a mapping of an image loaded by a client to its owner windows. The loaded image is represented by its image seal 6-tuple integer array.
  - ownedImages
```
private final java.util.Map<java.lang.Integer,java.util.Set<java.util.List<java.lang.Integer>>> ownedImages
```
    Owned images is a mapping of a window to its owned images seals.
  - nextFontId
```
private int nextFontId
```
    A counter for font IDs to be mapped on the js-side.
  - lastMouseWidgets
```
private java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,org.roaringbitmap.RoaringBitmap>> lastMouseWidgets
```
    A map with the last widgets sent to the JS side in [ windowid : [widgetId : actions] ] form.
  - widgetsRegions
```
private java.util.Map<java.lang.Integer,java.util.Map<java.lang.Integer,NativeRectangle>> widgetsRegions
```
    Collects the mouse widgets belonging to a window.
  - repaints
```
private java.util.LinkedList<GuiWebEmulatedWindow> repaints
```
    A queue of pending repaint requests which needs to be processed by the GuiWebDriver.RepaintThread thread.
  - activeWindowId
```
private int activeWindowId
```
    The active window.
  - embedded
```
private final boolean embedded
```
    Indicates if the web client embedded mode is on or off.
  - taskbar
```
private boolean taskbar
```
    Flag indicating if the virtual desktop taskbar is shown.
  - taskBarStyle
```
private TaskBarStyle taskBarStyle
```
    The task bar style on the virtual desktop
  - documentOutputs
```
private java.util.Map<java.util.UUID,DocumentOutput> documentOutputs
```
    Map of document outputs pending to be sent to the Javascript part of the client.
  - needsNotificationOnWait
```
private volatile boolean needsNotificationOnWait
```
    The notify-user-input state.
  - registerMouseWidgets
```
private boolean registerMouseWidgets
```
    Flag indicating if registerInteractiveWidgets() must be executed. This is to minimize the amount of calls, and is performed only when client-side receives control.
  - fontScaleX
```
private double[] fontScaleX
```
    A cache of font scaling factors, by their remote font ID. 32 items initial slots.
  - stateChanged
```
private org.roaringbitmap.RoaringBitmap stateChanged
```
    Set of widget IDs for which their state has changed.
  - uploads
```
private java.util.HashMap<java.lang.Integer,FileUploadInfo> uploads
```
    Active uploads
  - keyboardSupplier
```
private SupplierWithMemo<KeyboardLayoutsSettings> keyboardSupplier
```
    The provider of keyboard layouts settings
  - browserTimeoutSupplier
```
private java.util.function.Supplier<java.lang.Integer> browserTimeoutSupplier
```
    The number of milliseconds to wait a page to be loaded in a HTML browser
  - helperApplicationsSupplier
```
private java.util.function.Supplier<java.util.Map<java.lang.String,java.util.List<java.lang.String>>> helperApplicationsSupplier
```
    The provider of the supported helper applications.
  - lastUsedFont
```
private FontDetails<java.lang.Integer> lastUsedFont
```
    The last font set. This is used when a special webScale font is used.
  - langCache
```
private java.util.Set<java.lang.String> langCache
```
    Language Ids cache
  - originUrl
```
private java.net.URL originUrl
```
    The origin URL of the embedded web server's index page
  - localStorageAccessor
```
private LocalStorageAccessor localStorageAccessor
```
    Accessor for localStorage
  - directUploadsModcount
```
private int directUploadsModcount
```
    The cached modification count of the effective list of direct upload definitions
  - lastFocusedWidget
```
private int lastFocusedWidget
```
    The focused widget saved during the last processing of interactive widgets
  - globalCursor
```
private MousePtrWrapper globalCursor
```
    The global cursor.
  - blasterListeners
```
private final java.util.Map<java.lang.Integer,java.util.List<MsgBlasterPeer>> blasterListeners
```
    The set of listened widgetId. Each widgetId may have multiple listeners waiting for notification. Each incoming message is dispatched to all listeners.
- Constructor Detail
  - GuiWebDriver
```
public GuiWebDriver(BootstrapConfig config)
```
    Constructor.
    
    Parameters:
    
    config - The BootstrapConfig configuration.
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Get the driver name.
    
    Specified by:
    
    getName in interface ScreenDriver<GuiOutputManager>
    
    Returns:
    
    See above.
  - init
```
public void init()
```
    Initialize driver.
    
    Specified by:
    
    init in interface ScreenDriver<GuiOutputManager>
    
    Overrides:
    
    init in class AbstractDriver<GuiPrimitives,GuiOutputManager>
  - getLocalStorageAccessor
```
public KeyValueStorage getLocalStorageAccessor(java.lang.String storageId,
                                               java.lang.String fwdUser)
```
    Returns accessor for localStorage for web drivers.
    
    Specified by:
    
    getLocalStorageAccessor in interface ScreenWebDriver
    
    Parameters:
    
    storageId - Unique id for the storage.
    
    fwdUser - The FWD user name.
    
    Returns:
    
    KeyValueStorage instance.
  - getBrowserDetails
```
public BrowserDetails getBrowserDetails()
```
    Returns the browser details for web drivers.
    
    Specified by:
    
    getBrowserDetails in interface ScreenWebDriver
    
    Returns:
    
    See above.
  - showChangePasswordDialog
```
public OsPassChangeInput showChangePasswordDialog(java.lang.String osUserName,
                                                  boolean isModal)
```
    Shows a dialog to allow the change of the OS account password. If the password is expired, the dialog is modal and can't be dismissed.
    
    Specified by:
    
    showChangePasswordDialog in interface ScreenWebDriver
    
    Parameters:
    
    osUserName - The OS account name.
    
    isModal - Flag to indicate if the dialog should be modal (non-dismissible).
    
    Returns:
    
    The OS account pass change input.
  - showSuccessfulPassChange
```
public void showSuccessfulPassChange()
```
    Shows that the OS pass has been changed successfully on the front-end and hide the dialog.
    
    Specified by:
    
    showSuccessfulPassChange in interface ScreenWebDriver
  - retryPassChangeOnError
```
public OsPassChangeInput retryPassChangeOnError(java.lang.String osUserName,
                                                java.lang.String errMsg)
```
    Shows an error message in the OS pass change process.
    
    Specified by:
    
    retryPassChangeOnError in interface ScreenWebDriver
    
    Parameters:
    
    osUserName - The OS account name.
    
    errMsg - The error message.
    
    Returns:
    
    The OS account pass change input.
  - registerBroadcastChannel
```
public void registerBroadcastChannel(java.lang.String channelName,
                                     java.lang.String channelId)
```
    Opens a broadcast channel in the client's front-end.
    
    Specified by:
    
    registerBroadcastChannel in interface ScreenWebDriver
    
    Parameters:
    
    channelName - The name of the channel. The same for all instances of the app. Usually package root.
    
    channelId - The ID of the channel. Unique for this instance of the app. Usually session ID.
  - pingBroadcastChannel
```
public boolean pingBroadcastChannel(java.lang.String channelName,
                                    java.lang.String targetChannelId)
```
    Returns if the target broadcast channel responds with pong.
    
    Specified by:
    
    pingBroadcastChannel in interface ScreenWebDriver
    
    Parameters:
    
    channelName - The name of the channel. The same for all instances of the app. Usually package root.
    
    targetChannelId - The id of the target channel. Unique for this instance of the app. Usually session ID.
    
    Returns:
    
    true if the target broadcast channel responds with pong, false otherwise.
  - findAnyIdInChannel
```
public boolean findAnyIdInChannel(java.lang.String channelName,
                                  java.util.List<java.lang.String> channelIds)
```
    Searches for the specified channel instances and returns true if any found, false otherwise.
    
    Specified by:
    
    findAnyIdInChannel in interface ScreenWebDriver
    
    Parameters:
    
    channelName - The broadcast channel name.
    
    channelIds - A list of channel ids to check for.
    
    Returns:
    
    true if any of the channel instances found, false otherwise.
  - pingOnWebSocket
```
public boolean pingOnWebSocket()
```
    Check if the WebSocket connection is alive.
    
    Specified by:
    
    pingOnWebSocket in interface ScreenWebDriver
    
    Returns:
    
    true if the websocket connection is alive, false otherwise.
  - getOriginUrl
```
public java.net.URL getOriginUrl()
```
    Returns the origin URL of the embedded web server's index page.
    
    Returns:
    
    see above.
  - setOriginUrl
```
public void setOriginUrl(java.net.URL originUrl)
```
    Assigns the origin URL of the embedded web server's index page. The external assignment is needed as the driver is not aware of a potential reverse proxy.
    
    Parameters:
    
    originUrl - The URL to be assigned.
  - clientReady
```
public void clientReady()
```
    Notify the driver that the client is ready (useful for embedded mode, to notify the embedded app the client can handle messages).
    
    Specified by:
    
    clientReady in interface ScreenDriver<GuiOutputManager>
  - initRemoteClient
```
public void initRemoteClient()
```
    Called each time a connect occurs, this allows caller-controlled initialization of the remote client. There can only be 1 connection open at a time, but it is possible for the connection to be opened, closed and then re-opened.
    Whenever the main page is loaded or re-loaded, the WebSocket will connect and we must put the virtual terminal into a known state.
    
    Specified by:
    
    initRemoteClient in interface ClientProtocolHooks
  - waitInitialization
```
public void waitInitialization()
```
    Wait for the page to notify that it has fully initialized its JS code.
    
    Specified by:
    
    waitInitialization in interface EmbeddedWebServer
  - addHandler
```
public void addHandler(org.eclipse.jetty.server.Handler handler)
```
    Adds a custom handler.
    
    Specified by:
    
    addHandler in interface EmbeddedWebServer
    
    Parameters:
    
    handler - The handler to add.
  - removeHandler
```
public void removeHandler(org.eclipse.jetty.server.Handler handler)
```
    Removes the handler from the list of handlers.
    
    Specified by:
    
    removeHandler in interface EmbeddedWebServer
    
    Parameters:
    
    handler - The handler to remove.
  - remoteCall
```
public UnformattedPayload remoteCall(UnformattedPayload request)
```
    This is a special API which is used to delegate a call from converted 4GL code (via _P2J_REMOTE_CALL_ functions) to the remote side. Usually, this is used when P2J client runs in embedded mode, i.e. the P2J screens are embedded in another customer-specific application. The call will be remoted into the customer-specific application.
    This API is expected to block waiting for a response.
    
    Specified by:
    
    remoteCall in interface EmbeddedClient
    
    Parameters:
    
    request - The request data incoming from 4GL.
    
    Returns:
    
    The response from the customer-specific application, which will be sent back to the converted 4GL code.
  - publish
```
public void publish(long subId,
                    java.lang.String event,
                    java.lang.String[] param)
```
    Send a PUBLISH notification to a remote application.
    
    Specified by:
    
    publish in interface EmbeddedClient
    
    Parameters:
    
    subId - The subscriber's ID, known by the remote application.
    
    event - The published event name.
    
    param - The parameters for this event.
  - setStatusText
```
public void setStatusText(int windowId,
                          java.lang.String message)
```
    Set status text message of specified window.
    
    Specified by:
    
    setStatusText in interface EmbeddedClient
    
    Parameters:
    
    windowId - Window ID.
    
    message - Text message.
  - setMessageText
```
public void setMessageText(int windowId,
                           java.lang.String[] message)
```
    Add message texts of specified window.
    
    Specified by:
    
    setMessageText in interface EmbeddedClient
    
    Parameters:
    
    windowId - Window ID.
    
    message - Text message.
  - clearMessages
```
public void clearMessages(int windowId)
```
    Clear all message texts of specified window.
    
    Specified by:
    
    clearMessages in interface EmbeddedClient
    
    Parameters:
    
    windowId - Window ID.
  - injectVT100Key
```
public void injectVT100Key(int keyCode,
                           char charCode)
```
    Input key events when in VT100 mode.
    
    Specified by:
    
    injectVT100Key in interface ClientProtocolHooks
    
    Parameters:
    
    keyCode - The key code from the input event.
    
    charCode - The character code from the input event.
  - getDisplayBounds
```
public NativeRectangle getDisplayBounds()
```
    Since web interface is inherently a single-display setup the method effectively returns a rectangle with top-level corner equal to 0,0.
    
    Returns:
    
    The physical screen bounds.
  - getVirtualScreen
```
public VirtualScreen getVirtualScreen()
```
    Returns its virtual screen that represents the physical screen in a memory using a sRGB pixel model.
    
    Returns:
    
    The virtual screen to draw images in a memory.
  - addImageUsage
```
public boolean addImageUsage(java.util.List<java.lang.Integer> imageHash,
                             int windowId)
```
    Register a usage of the given image by the given window.
    
    Parameters:
    
    imageHash - The image hash id.
    
    windowId - The window id.
    
    Returns:
    
    True iff it is the first usage of the given image.
  - removeUnusedImages
```
public int[] removeUnusedImages(int windowId)
```
    Returns all unused images. Removes the given window from all image usages.
    
    Parameters:
    
    windowId - The window id.
    
    Returns:
    
    The set of all unused images.
  - mapSealToUniqueId
```
public void mapSealToUniqueId(java.util.List<java.lang.Integer> imageSeal,
                              java.lang.Integer uniqueId)
```
    Maps the image identity array to the unique image id.
    
    Parameters:
    
    imageSeal - The image identity array.
    
    uniqueId - The image unique id.
  - getUniqueIdForSeal
```
public java.lang.Integer getUniqueIdForSeal(java.util.List<java.lang.Integer> imageSeal)
```
    Gets the unique image id by its identity array.
    
    Parameters:
    
    imageSeal - The image identity array.
    
    Returns:
    
    The image unique id.
  - getDisplayWorkArea
```
public NativeRectangle getDisplayWorkArea()
```
    Returns an application-usable display area. For example, a task bar is not counted as the usable area and it is always at the bottom of the virtual screen (when present).
    
    Returns:
    
    The area in pixels.
  - beep
```
public void beep()
```
    Provide an audible feedback to user by generating a beep signal.
    
    Specified by:
    
    beep in interface ScreenDriver<GuiOutputManager>
  - 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.
    
    Specified by:
    
    readKey in interface ScreenDriver<GuiOutputManager>
    
    Returns:
    
    key code or null if no keys were pressed since last call.
  - getHostName
```
public java.lang.String getHostName()
```
    Returns the currently connected client's machine name for session.
    
    Specified by:
    
    getHostName in interface ScreenDriver<GuiOutputManager>
    
    Overrides:
    
    getHostName in class AbstractDriver<GuiPrimitives,GuiOutputManager>
    
    Returns:
    
    The current system logged in for the given session.
  - getHostByName
```
public long getHostByName(java.lang.String name)
```
    Returns the currently connected client's machine name for session.
    
    Specified by:
    
    getHostByName in interface ScreenDriver<GuiOutputManager>
    
    Overrides:
    
    getHostByName in class AbstractDriver<GuiPrimitives,GuiOutputManager>
    
    Parameters:
    
    name - The name of the host to get IP.
    
    Returns:
    
    The current system logged in for the given session.
  - newEmulator
```
public EmulatedWindowState newEmulator(int windowId,
                                       boolean showInTaskbar)
```
    Create a new window emulator.
    The method ignores the alwaysOnTop flag.
    
    Specified by:
    
    newEmulator in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    windowId - The window ID.
    
    showInTaskbar - If set to true the window will be shown in the virtual desktop's taskbar.
    
    Returns:
    
    The newly instantiated window emulator.
  - newChildWindowEmulator
```
public EmulatedWindowState newChildWindowEmulator(int windowId,
                                                  EmulatedWindowState parentWindow,
                                                  java.lang.String windowTitle,
                                                  boolean resizable,
                                                  boolean isShareActivationWithOwner,
                                                  boolean modal)
```
    Create a new child window emulator.
    
    Specified by:
    
    newChildWindowEmulator in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    windowId - The window ID.
    
    parentWindow - The parent 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.lang.Integer> createFont(FontDetails<java.lang.Integer> details)
```
    Create a font with the given details and register it with the driver.
    
    Specified by:
    
    createFont in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    details - The font specifications.
    
    Returns:
    
    A font instance.
  - deriveFont
```
public void deriveFont(FontDetails<java.lang.Integer> fd)
```
    Scale the given font to match the screen resolution.
    
    Specified by:
    
    deriveFont in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    fd - Font to scale. This instance's contained font will be modified.
  - getScreenResolution
```
public int getScreenResolution()
```
    Reports the screen resolution in dots per inch (DPI).
    
    Specified by:
    
    getScreenResolution in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Returns:
    
    The DPI of the screen.
  - copyToClipboard
```
public void copyToClipboard(java.lang.String txt)
```
    Copy the given text to the system clipboard.
    
    Specified by:
    
    copyToClipboard in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    txt - The text to be copied.
  - clipboardContents
```
public java.lang.String clipboardContents()
```
    Get the current contents from the OS clipboard.
    
    Specified by:
    
    clipboardContents in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Returns:
    
    The clipboard contents.
  - initClipboardSoftPaste
```
public void initClipboardSoftPaste()
```
    Init widget generated PASTE command from the OS clipboard.
  - restackWindows
```
public void restackWindows(int[] windowIds)
```
    Force the list of all GUI windows to be stacked as in the specified order.
    
    Specified by:
    
    restackWindows in class AbstractGuiDriver<java.lang.Integer>
    
    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.
    
    Specified by:
    
    moveToTop in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Specified by:
    
    moveToTop in class AbstractGuiDriver<java.lang.Integer>
    
    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.
    
    Specified by:
    
    moveToBottom in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Specified by:
    
    moveToBottom in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    windowId - The window to be moved.
  - shutdown
```
public void shutdown()
```
    Perform driver shutdown.
    
    Specified by:
    
    shutdown in interface ScreenDriver<GuiOutputManager>
    
    Overrides:
    
    shutdown in class AbstractGuiDriver<java.lang.Integer>
  - startupServer
```
public java.lang.String startupServer(ServerKeyStore keyStore,
                                      BootstrapConfig config,
                                      java.lang.String host,
                                      int port)
```
    Startup the embedded server using the server's key store to build the web server SSL context.
    There are two page handlers. One is for the root ("/") target and the other is for the index ("/index.html") target. Both load the same page index.html.
    When the user is first redirected the URL is https://server:port/ and the target is "/". The index.html page is loaded for this target.
    After redirection and the main page is loaded, the URL in the browser address bar will become https://server:port/index.html and the corresponding target is now "/index.html".
    When the user reloads the main page within the browser environment the "/index.html" target is sent to the web server and the same main page index.html is loaded.
    
    Specified by:
    
    startupServer in interface EmbeddedWebServer
    
    Parameters:
    
    keyStore - The exported server KeyStore.
    
    config - Client configuration.
    
    port - An explicit port to start the web server or 0 to let the OS assign one.
    
    host - An explicit host to start the web server or null to use the server's host.
    
    Returns:
    
    The embedded web server's URI.
  - shutdownServer
```
public void shutdownServer()
```
    Shutdown the embedded web server.
    
    Specified by:
    
    shutdownServer in interface EmbeddedWebServer
  - getServerURI
```
public java.lang.String getServerURI()
```
    Get the embedded web server's URI.
    
    Specified by:
    
    getServerURI in interface EmbeddedWebServer
    
    Returns:
    
    A string representing the server's URI.
  - captureMouseEvents
```
public boolean captureMouseEvents(boolean state)
```
    Enable or disable capture of mouse events.
    It also notifies the JS side to enable/disable mouse events.
    
    Specified by:
    
    captureMouseEvents in interface ScreenDriver<GuiOutputManager>
    
    Overrides:
    
    captureMouseEvents in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    state - true to capture mouse events, false to ignore them.
    
    Returns:
    
    The previous state.
  - raiseMouseEvent
```
public void raiseMouseEvent(int windowId,
                            int mouseOp,
                            long tstamp,
                            int mouseX,
                            int mouseY,
                            int button,
                            int clickCount,
                            int modifiersMask,
                            int[] wheelParameters,
                            int widgetId)
```
    Raise a mouse event.
    
    Specified by:
    
    raiseMouseEvent in interface ClientProtocolHooks
    
    Parameters:
    
    windowId - The window ID.
    
    mouseOp - The mouse event code.
    
    tstamp - The event timestamp.
    
    mouseX - The absolute mouse X for this event.
    
    mouseY - The absolute mouse Y for this event.
    
    button - The button which was pressed.
    
    clickCount - The click count.
    
    modifiersMask - The bit mask that represents the modifiers keys are pressed. The 0-bit corresponds to the shift key, the 1-bit to the ctrl key, the 2-bit to the meta key and the 3-bit to the alt key.
    
    wheelParameters - The array that represents the wheel rotation amount and its unit.
    
    widgetId - The explicit widget ID to which this event needs to be posted.
  - startDropTarget
```
public void startDropTarget(int windowId,
                            int widgetId,
                            java.util.List<java.lang.String> fileNameList)
```
    Initiates the process of the file list dropping for web clients.
    
    Specified by:
    
    startDropTarget in interface ClientProtocolHooks
    
    Parameters:
    
    windowId - The window ID.
    
    widgetId - The widget ID.
    
    fileNameList - The oredered file name list to be dropped.
  - saveDropTargetFile
```
public void saveDropTargetFile(java.lang.String name,
                               byte[] data,
                               int size)
```
    Stores the given byte array date as file in Java temporary directory with the given name.
    
    Specified by:
    
    saveDropTargetFile in interface ClientProtocolHooks
    
    Parameters:
    
    name - The file name to create.
    
    data - The data to store in the file.
    
    size - The size of the to create, used to check the input array.
  - saveDropTargetFile
```
public void saveDropTargetFile(java.lang.String name,
                               java.nio.channels.FileChannel channel,
                               int length)
```
    Reads the data from the given file channel starting from its current position and stores the retrieved data into the file in Java temporary directory with the given name.
    
    Specified by:
    
    saveDropTargetFile in interface ClientProtocolHooks
    
    Parameters:
    
    name - The file name to create
    
    channel - The file channel
    
    length - The length of the content
  - startDirectManipulation
```
public void startDirectManipulation(int opType,
                                    boolean gridSnapOn,
                                    int resizeDir,
                                    NativeRectangle maxBounds,
                                    NativeRectangle[] nr)
```
    Uses websocket to notify the JS side the direct manipulation has started to draw the selection box(es). The real painting work will be performed in JS until the end event happens.
    
    Parameters:
    
    opType - The operation type.
    
    gridSnapOn - The flag indicating the grid snap is turned on.
    
    resizeDir - The widget resize direction for respective operation or -1 if not used.
    
    maxBounds - The bounds that must not be exceeded when direct manipulating the widgets.
    
    nr - The array of the rectangle coordinates.
  - putFileUpload
```
public void putFileUpload(int id,
                          FileUploadInfo uploadInfo)
```
    The method stores an instance with file upload metadata.
    
    Specified by:
    
    putFileUpload in interface FileUploadStorage
    
    Parameters:
    
    id - Upload id.
    
    uploadInfo - The object that encapsulates the upload metadata.
  - getFileUpload
```
public FileUploadInfo getFileUpload(int id)
```
    Returns file upload metadata.
    
    Specified by:
    
    getFileUpload in interface FileUploadStorage
    
    Parameters:
    
    id - Upload id.
    
    Returns:
    
    File upload metadata.
  - removeFileUpload
```
public void removeFileUpload(int id)
```
    Removes metadata for a particular upload.
    
    Specified by:
    
    removeFileUpload in interface FileUploadStorage
    
    Parameters:
    
    id - Id of the upload metadata to remove.
  - setCurrentLanguage
```
public void setCurrentLanguage(java.lang.String language)
```
    Set new current session language for the client.
    
    Specified by:
    
    setCurrentLanguage in interface ScreenDriver<GuiOutputManager>
    
    Specified by:
    
    setCurrentLanguage in interface ScreenWebDriver
    
    Parameters:
    
    language - The language identifier
  - getMouseModifiers
```
private static int getMouseModifiers(int button,
                                     int modifiersMask)
```
    Gets the mouse modifiers mask for this event.
    
    Parameters:
    
    button - The mouse button that is currently pressed
    
    modifiersMask - The bit mask that represents the modifiers keys are pressed. The 0-bit corresponds to the shift key, the 1-bit to the ctrl key, the 2-bit to the meta key and the 3-bit to the alt key.
    
    Returns:
    
    The key's modifiers bit mask for this mouse event.
  - setWindowLocation
```
public void setWindowLocation(int windowId,
                              int x,
                              int y)
```
    Set the location for the specified window.
    
    Specified by:
    
    setWindowLocation in interface ClientProtocolHooks
    
    Parameters:
    
    windowId - The window ID.
    
    x - The X coordinate of the top-left corner.
    
    y - The Y coordinate of the top-left corner.
  - setWindowDimension
```
public void setWindowDimension(int windowId,
                               int width,
                               int height)
```
    Set the dimension for the specified window.
    
    Specified by:
    
    setWindowDimension in interface ClientProtocolHooks
    
    Parameters:
    
    windowId - The window ID.
    
    width - The window width.
    
    height - The window height.
  - windowActivated
```
public void windowActivated(int deactivatingWindowId,
                            int activatingWindowId)
```
    Raise an event indicating that the target window has been activated or deactivated.
    
    Specified by:
    
    windowActivated in interface ClientProtocolHooks
    
    Parameters:
    
    deactivatingWindowId - Id of the window being deactivated, may be negative.
    
    activatingWindowId - Id of the window being activated, always valid.
  - windowIconified
```
public void windowIconified(int windowId,
                            boolean state)
```
    Raise an event as the window was (de)iconified.
    
    Specified by:
    
    windowIconified in interface ClientProtocolHooks
    
    Parameters:
    
    windowId - The window ID.
    
    state - true if the window was iconified.
  - desktopResized
```
public void desktopResized(int width,
                           int height,
                           TaskBarStyle taskBarStyle)
```
    Called when the desktop on the client has changed its dimensions.
    
    Specified by:
    
    desktopResized in interface ClientProtocolHooks
    
    Parameters:
    
    width - New desktop width.
    
    height - New desktop height.
    
    taskBarStyle - Updated task bar style.
  - setControl
```
public void setControl(boolean control)
```
    Notify the driver which side has control (client-side (when true) or server, otherwise).
    When control is received, registerInteractiveWidgets() is enabled.
    
    Specified by:
    
    setControl in interface ScreenDriver<GuiOutputManager>
    
    Overrides:
    
    setControl in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    control - Flag indicating (when true) that the client-side has control.
  - widgetStateChanged
```
public void widgetStateChanged(int widgetId)
```
    Notification that this widget's state has changed (visibility, sensitivity, z-order).
    
    Specified by:
    
    widgetStateChanged in interface ScreenDriver<GuiOutputManager>
  - registerInteractiveWidgets
```
public void registerInteractiveWidgets()
```
    Register all the mouse-aware widgets (in all Windows) with the JS side.
    To register a widget, it must be visible, displayed and enabled, and part of a visible window.
    This method is executed only when registerMouseWidgets flag is set (via setControl(boolean)). Once executed, it disables this flag.
    
    Specified by:
    
    registerInteractiveWidgets in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    registerInteractiveWidgets in class AbstractGuiDriver<java.lang.Integer>
  - parseEditorContent
```
public int[][] parseEditorContent(int widgetId,
                                  int windowId,
                                  int maxWidth,
                                  java.lang.String text,
                                  int delta,
                                  FontDetails<java.lang.Integer> font)
```
    Split the text for a editor widget, so that it fits the specified maximum width. The delta parameter represents the start position of this text, in the editor's content; when the full content is parsed, this will be zero.
    
    Specified by:
    
    parseEditorContent in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    widgetId - The editor's ID.
    
    windowId - The editor's window ID.
    
    maxWidth - The width for the content to fit (the editor's editable area).
    
    text - The text to split into lines.
    
    delta - The start position of this text in the editor's full content.
    
    font - The editor's font.
    
    Returns:
    
    Two arrays: one with the split indexes and one with the split indexes which were determined to be caused by a new line.
  - resetSelection
```
public void resetSelection()
```
    Reset selection boxes painting mode and return to normal drawing mode.
    
    Specified by:
    
    resetSelection in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
  - setUploadFileSizeLimits
```
public void setUploadFileSizeLimits(int single,
                                    int total)
```
    Setting up file size limits for cases when drag and drop needs file uploads from web client to Java side.
    
    Specified by:
    
    setUploadFileSizeLimits in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    single - Single file size limit.
    
    total - Total file size limit for single operation.
  - updateCachedWidgetBounds
```
private boolean updateCachedWidgetBounds(int windowId,
                                         Widget widget,
                                         NativeRectangle[] widgetBounds)
```
    Updates the cached widgets bounds and returns true iff the cached widgets bounds has been updated.
    
    Parameters:
    
    windowId - The target window id.
    
    widget - The target widget with its cached bounds.
    
    widgetBounds - On index 0, the computed bounds will be saved.
    
    Returns:
    
    true value indicates that the widget's bounds has been changed and must be sent to the JS client.
  - getWebActions
```
private static org.roaringbitmap.RoaringBitmap getWebActions(Widget widget)
```
    Returns the set of mouse actions handled by this widget.
    
    Parameters:
    
    widget - The collected mouse widget.
    
    Returns:
    
    The web actions that are handled by the given widget.
  - isInLastMouseWidgets
```
private boolean isInLastMouseWidgets(java.lang.Integer widgetId,
                                     java.lang.Integer windowId)
```
    Tests if the given mouse widget is in the last mouse widgets map.
    
    Parameters:
    
    widgetId - The widget id.
    
    windowId - The window id.
    
    Returns:
    
    Returns true iff the given widget is in the target map.
  - getDirectUploadDefinitions
```
private java.util.Map<java.lang.Integer,java.util.List<ClientDirectUploadDef>> getDirectUploadDefinitions()
```
    Retrieves the effective direct upload definitions.
    
    Returns:
    
    A map of widget IDs to lists of client direct upload definitions. Each client direct upload definition contains information such as widget ID, event codes, title, multiple file upload support, upload flag, upload directory, file filters, and widget bounds.
  - registerMoveableWidget
```
public void registerMoveableWidget(int wid)
```
    Register the specified widget as a moveable widget, via mouse.
    This is a no-op for the web client: the work is done by registerInteractiveWidgets().
    
    Specified by:
    
    registerMoveableWidget in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    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.
    This is a no-op for the web client: the work is done by registerInteractiveWidgets().
    
    Specified by:
    
    registerHoverableWidget in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    action - The widget mouse action.
  - propagateWaitState
```
public void propagateWaitState(boolean isWaitState)
```
    Propagate wait state
    
    Specified by:
    
    propagateWaitState in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    isWaitState - wait state
  - registerResizeableWidget
```
public void registerResizeableWidget(int wid)
```
    Register the specified widget as a resizeable widget, via mouse. Only WINDOW widgets are supported.
    This is a no-op for the web client: the work is done by registerInteractiveWidgets().
    
    Specified by:
    
    registerResizeableWidget in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    wid - The widget ID.
  - 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.lang.Integer>
    
    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.
    
    Specified by:
    
    setResizeableWindow in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    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.
  - enqueueDocumentOutput
```
public void enqueueDocumentOutput(DocumentOutput docOutput)
```
    The method stores document outputs pending to be sent to the Javascript part of FWD client.
    Before the supplied print output is inserted into the storage, the method removes all outputs older than MAX_PRINT_OUTPUT_AGE. The actual age is calculated from the current time stamp and the time stamp of the document output when enqueued.
    
    Specified by:
    
    enqueueDocumentOutput in interface DocumentOutputStorage
    
    Parameters:
    
    docOutput - The object that encapsulates the document output being enqueued.
  - dequeueDocumentOutput
```
public DocumentOutput dequeueDocumentOutput(java.util.UUID uuid)
```
    Returns the document outputs previously enqueued with enqueueDocumentOutput(DocumentOutput). and removes the returned entry from the storage iff the document outputs should not be cached.
    
    Specified by:
    
    dequeueDocumentOutput in interface DocumentOutputStorage
    
    Parameters:
    
    uuid - The document output uuid.
    
    Returns:
    
    See above. The result may be null if the id doesn't represent a previously enqueued print output.
  - removeDocuments
```
public void removeDocuments(java.util.Set<java.util.UUID> documents)
```
    Remove the given documents from the storage
    
    Specified by:
    
    removeDocuments in interface DocumentOutputStorage
    
    Parameters:
    
    documents - The given documents to remove
  - postRepaint
```
protected void postRepaint(GuiWebEmulatedWindow ews)
```
    Post a new repaint for the specified window to the repaints queue. This will be processed by the GuiWebDriver.RepaintThread.
    
    Parameters:
    
    ews - The window requiring repaint.
  - collectWidgets
```
private void collectWidgets(Widget w,
                            java.util.function.Predicate<Widget> filter,
                            java.util.function.Consumer<Widget> actionsCollector)
```
    Add the widget (and all its possible children) in the specified set, maintaining z-order in a left-to-right (topmost to bottommost) order.
    
    Parameters:
    
    w - The parent widget.
    
    filter - The condition predicate that must be evaluated for collected widgets.
    
    actionsCollector - Collects a widget's action if the target is selected by the filter condition.
  - isInsideVisibleFrameOrStandalone
```
private static boolean isInsideVisibleFrameOrStandalone(Widget wid)
```
    Checks if the given widget is belonging to visible frame or not inside any frame, like window decorations.
    
    Parameters:
    
    wid - Widget to check.
    
    Returns:
    
    TRUE if the widget is inside visible frame or standalone, FALSE otherwise.
  - setCurrentSelection
```
public void setCurrentSelection(java.lang.String txt)
```
    Sets the current editors selection.
    
    Specified by:
    
    setCurrentSelection in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    txt - The current editors selection.
  - createMousePointer
```
public MousePtrWrapper createMousePointer(java.io.InputStream data,
                                          java.lang.String ptrName)
```
    Load mouse pointer from the InputStream
    
    Specified by:
    
    createMousePointer in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    data - cursor data
    
    ptrName - pointer name
    
    Returns:
    
    mouse pointer or null
  - setCursor
```
public void setCursor(MousePtrWrapper ptr)
```
    Set the mouse cursor
    
    Specified by:
    
    setCursor in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    ptr - mouse cursor
  - setGlobalCursor
```
public void setGlobalCursor(MousePtrWrapper ptr)
```
    Assign a cursor for the entire web application. The global cursor will later not be enforced, allowing widgets to override it. This is similar to how Win32.SetCursor behaves.
    
    Specified by:
    
    setGlobalCursor in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    ptr - Wrapper for the cursor.
  - removeGlobalCursor
```
public void removeGlobalCursor()
```
    Removes the assigned global cursor.
    
    Specified by:
    
    removeGlobalCursor in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
  - getGlobalCursor
```
public MousePtrWrapper getGlobalCursor()
```
    Retrieves the globally assigned cursor.
    
    Specified by:
    
    getGlobalCursor in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Returns:
    
    The wrapper for the cursor.
  - setCursor
```
public void setCursor(java.lang.String icon)
```
    Set the mouse cursor from a given resource.
    
    Specified by:
    
    setCursor in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    icon - The name of custom cursor.
  - lockMousePointer
```
public void lockMousePointer(int widgetId,
                             MousePtrWrapper ptr)
```
    Lock the mouse pointer (suppress widget-specific changes) or unlock it
    
    Specified by:
    
    lockMousePointer in interface ScreenDriver<GuiOutputManager>
    
    Parameters:
    
    widgetId - the id of the active DropDown which caused the pointer lock or -1
    
    ptr - the locked mouse pointer or null for unlock
  - propagate
```
public void propagate(int windowId,
                      int wid,
                      MousePtrWrapper ptr)
```
    Push information about the loaded mouse pointer for widget
    
    Specified by:
    
    propagate in interface ScreenDriver<GuiOutputManager>
    
    Parameters:
    
    windowId - to level window id
    
    wid - widgetId
    
    ptr - mouse pointer
  - isFontInstalled
```
public boolean isFontInstalled(java.lang.String fontName,
                               boolean boldFont)
```
    Returns the boolean value if the target font is installed or not.
    
    Specified by:
    
    isFontInstalled in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    fontName - The target font name.
    
    boldFont - Indicates that the bold font is queried.
    
    Returns:
    
    True if the target font is installed, otherwise false.
  - enableEvents
```
public void enableEvents(int[] windowIds,
                         boolean capture)
```
    Enable or Disable OS-level events for the specified windows.
    
    Specified by:
    
    enableEvents in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    enableEvents in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    windowIds - The window IDs which need to be processed.
    
    capture - Flag indicating OS level events are captured (when true).
  - getVirtualScreenSize
```
public NativeDimension getVirtualScreenSize()
```
    Returns the size of the virtual screen, i.e. in multi-display setup, all displays are accounted for.
    
    Specified by:
    
    getVirtualScreenSize in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Returns:
    
    See above.
  - isWindowDecorationSupported
```
public boolean isWindowDecorationSupported()
```
    Returns true if a window can be decorated in this graphics environment, otherwise false.
    
    Specified by:
    
    isWindowDecorationSupported in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Returns:
    
    true if a window can have its title, caption buttons and border, otherwise false.
  - isEmbeddedClient
```
public boolean isEmbeddedClient()
```
    Returns true if this client runs in embedded mode.
    
    Specified by:
    
    isEmbeddedClient in interface ScreenDriver<GuiOutputManager>
    
    Specified by:
    
    isEmbeddedClient in interface EmbeddedClient
    
    Returns:
    
    See above.
  - getMousePosition
```
public NativePoint getMousePosition()
```
    Returns current mouse cursor display position relative to the display origin.
    
    Specified by:
    
    getMousePosition in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Returns:
    
    mouse cursor position, never null
  - getTextWidths
```
public int[] getTextWidths(java.lang.String text,
                           FontDetails<java.lang.Integer> fd)
```
    Get the widths of the specified text, using the given font.
    
    Specified by:
    
    getTextWidths in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    getTextWidths in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    text - The text.
    
    fd - The font details used to draw and measure the text.
    
    Returns:
    
    The text's widths.
  - getClientTextWidth
```
public int getClientTextWidth(java.lang.String text,
                              FontDetails<java.lang.Integer> fd)
```
    Get the width of the specified text for the given font from the client native environment, the browser or swing environments.
    
    Specified by:
    
    getClientTextWidth in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    text - The text.
    
    fd - The font used to draw and measure the text.
    
    Returns:
    
    The text's width.
  - getClientFontHeight
```
public int getClientFontHeight(FontDetails<java.lang.Integer> fd)
```
    Get the height of the font from the client native environment.
    
    Specified by:
    
    getClientFontHeight in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    fd - The used font.
    
    Returns:
    
    The font's height.
  - getTextWidth
```
public int getTextWidth(java.lang.String text,
                        FontDetails<java.lang.Integer> fd)
```
    Get the width of the specified text, using the given font. Web client specific version.
    
    Specified by:
    
    getTextWidth in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    getTextWidth in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    text - The text.
    
    fd - The font details used to draw and measure the text.
    
    Returns:
    
    The text's width.
  - setGuiFont
```
public void setGuiFont(FontDetails<java.lang.Integer> font)
```
    Set current font used on draw operations.
    
    Specified by:
    
    setGuiFont in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    setGuiFont in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    font - Drawing font.
  - drawString
```
public void drawString(java.lang.String text,
                       int x,
                       int y)
```
    Draw a string at the specified location.
    
    Specified by:
    
    drawString in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    drawString in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    text - text string to draw.
    
    x - left position.
    
    y - top position.
  - drawStringCentered
```
public void drawStringCentered(java.lang.String text,
                               int x,
                               int height)
```
    Draw a string at the specified location.
    
    Specified by:
    
    drawStringCentered in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    drawStringCentered in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    text - text string to draw.
    
    x - left position.
    
    height - the height to center on.
  - drawCursor
```
public void drawCursor(LightweightTextWidget widget)
```
    Draws the cursor for the given text widget.
    
    Specified by:
    
    drawCursor in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    drawCursor in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    widget - The text widget
  - doTextShift
```
public void doTextShift(java.lang.String text,
                        int widthHint)
```
    Draws the cursor for the given text widget.
    
    Overrides:
    
    doTextShift in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    text - The text widget
    
    widthHint - The text hint width
  - fillRectAroundText
```
public void fillRectAroundText(int x,
                               int y,
                               int textWidthHint,
                               int textHeightHint,
                               java.lang.String text)
```
    Fill a rectangle around the given text.
    
    Specified by:
    
    fillRectAroundText in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    fillRectAroundText in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    x - The text left position
    
    y - The text top position
    
    textWidthHint - The text hint width
    
    textHeightHint - The text hint height
    
    text - The given text
  - 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 stores the provided consumer with enqueueDocumentOutput(DocumentOutput) and notifies the JavaScript part to download the document output. The document output is identified with a random UUID generated by this method.
    
    Specified by:
    
    deliverDocumentOutput in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    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.
    
    Specified by:
    
    openMimeResource in interface ScreenDriver<GuiOutputManager>
    
    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.
    
    java.lang.RuntimeException - For other IO errors during file operations.
  - openMimeResource
```
public void openMimeResource(java.lang.String mimeType,
                             java.lang.String resourcePath,
                             ScreenDriver.UriPathAnchor uriPathAnchor)
```
    Opens the specified resource in a browser's window.
    
    Specified by:
    
    openMimeResource in interface ScreenDriver<GuiOutputManager>
    
    Parameters:
    
    mimeType - The resource mime type.
    
    resourcePath - The relative path to the target resource.
    
    uriPathAnchor - Instructs how to resolve the given resource path.
  - resolveResource
```
DocumentOutput resolveResource(boolean deleteContent,
                               java.lang.String mimeType,
                               ContentDisposition contentDisposition,
                               java.io.File originalFile)
```
    Resolve the document output used to retrieve the content of the original file.
    
    Parameters:
    
    deleteContent - Indicates if the original file will be deleted after its content loaded by the client.
    
    mimeType - The mime type of the original file content
    
    contentDisposition - The value of content-disposition http header
    
    originalFile - The original file to be loaded by the client
    
    Returns:
    
    The document output
  - resolveResource
```
DocumentOutput resolveResource(boolean deleteContent,
                               java.lang.String mimeType,
                               ContentDisposition contentDisposition,
                               java.io.File originalFile,
                               java.util.function.BiConsumer<java.io.File,java.io.File> customCopy,
                               boolean cached)
```
    Resolve the document output used to retrieve the content of the original file.
    
    Parameters:
    
    deleteContent - Indicates if the original file will be deleted after its content loaded by the client.
    
    mimeType - The mime type of the original file content
    
    contentDisposition - The value of content-disposition http header
    
    originalFile - The original file to be loaded by the client
    
    customCopy - Do a custom copy process. If this is null, a simple byte-base copy is done.
    
    cached - Indicating that the document should be cached
    
    Returns:
    
    The document output.
  - addMessageListener
```
public void addMessageListener(MsgBlasterPeer listener,
                               int windowId,
                               int widgetId)
```
    Add a low-level message listener for a specific window.
    
    Specified by:
    
    addMessageListener in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    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.
    
    Specified by:
    
    removeMessageListener in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    listener - The listener to be removed.
    
    windowId - The windows id.
    
    widgetId - The widget's id.
  - lowLevelEvent
```
public void lowLevelEvent(int widgetId,
                          int winId,
                          int messageId,
                          int p1,
                          int p2,
                          int p3)
```
    Sends a notification of a low-level event for a listening widget. The notification carries 3 integer parameters whose value will be interpreted based on the messageId. ex: for mouse events: pressed buttons and the two coordinates.
    
    Specified by:
    
    lowLevelEvent in interface ClientProtocolHooks
    
    Parameters:
    
    widgetId - The id of the widget that generated the event.
    
    winId - The id of the parent window.
    
    messageId - The id of the event.
    
    p1 - The first parameter of the event.
    
    p2 - The first parameter of the event.
    
    p3 - The first parameter of the event.
  - lowLevelMouseEvent
```
public void lowLevelMouseEvent(java.awt.event.MouseEvent evt,
                               MouseOps mop,
                               int windowId)
```
    Sends a notification of a low-level mouse event for a listening widget.
    
    Parameters:
    
    evt - The mouse event to send.
    
    mop - The mouse operation type.
    
    windowId - The ID of the target window.
  - notifyWait
```
public void notifyWait()
```
    The method is called when the 4GL program execution enters a modal or wait-for event loop, in other words when user input is expected.
    
    Specified by:
    
    notifyWait in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
  - setNeedsNotificationOnWait
```
public void setNeedsNotificationOnWait(boolean newState)
```
    The method is executed by the JS client when it requires to be notified when 4GL program execution enters modal or wait-for event loop, in other words when user input is expected.
    
    Specified by:
    
    setNeedsNotificationOnWait in interface ClientProtocolHooks
    
    Parameters:
    
    newState - true turns ON the notification while false turns it OFF.
  - cacheTextMetrics
```
public void cacheTextMetrics(java.util.Map<FontDetails<java.lang.Integer>,java.util.Set<java.lang.String>> texts,
                             java.lang.Integer windowId)
```
    Get and cache metrics for the given texts.
    
    Specified by:
    
    cacheTextMetrics in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    cacheTextMetrics in class AbstractGuiDriver<java.lang.Integer>
    
    Parameters:
    
    texts - Map of texts for which metrics should be calculated, keyed by fonts which are used for drawing specific texts.
    
    windowId - ID of the parent window. Can be null if there is no need to select a window.
  - needsExplicitTextMetricsCaching
```
public boolean needsExplicitTextMetricsCaching()
```
    Returns true if getting actual text metrics is an expensive operation for this driver and you want to manually manage metrics cache using GuiDriver.cacheTextMetrics(Map, Integer).
    
    Specified by:
    
    needsExplicitTextMetricsCaching in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Overrides:
    
    needsExplicitTextMetricsCaching in class AbstractGuiDriver<java.lang.Integer>
    
    Returns:
    
    see above.
  - writeLauncherWrapper
```
private static java.lang.String writeLauncherWrapper(java.lang.String uriString)
```
    Create the wrapper for the launcher resource.
    
    Parameters:
    
    uriString - The target resource.
  - mimeType
```
private static java.lang.String mimeType(java.lang.String icon)
```
    Detect MIME type of image.
    
    Parameters:
    
    icon - Image file name
    
    Returns:
    
    MIME type if image null if not.
  - syncDesktopDimensions
```
private void syncDesktopDimensions()
```
    Fetches the desktop dimension from the client and calls updateDesktopDimensions(int, int) with the result.
  - updateDesktopDimensions
```
private void updateDesktopDimensions(int width,
                                     int height)
```
    Updates the class state that relies on the client desktop dimensions.
    
    Parameters:
    
    width - New desktop width.
    
    height - New desktop height.
  - getBasicWebPalette
```
public int[] getBasicWebPalette()
```
    Queries the web driver for a basic palette. A null or incomplete can be returned. The basic palette has five entries: BACKGROUND, FOREGROUND, NORMAL, HIGHLIGHTED and DISABLED in that order. The returned palette can contain null values that will not overwrite the default entries of the Theme. Additional entries will be ignored.
    
    Specified by:
    
    getBasicWebPalette in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Returns:
    
    the set of RGB values as integers for the entries to be overwritten.
  - createWidget
```
public void createWidget(java.lang.String type,
                         int widgetId)
```
    Create a driver-implemented widget.
    
    Specified by:
    
    createWidget in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    type - The widget type, one of the LegacyResource widget names.
    
    widgetId - The widget ID to be set.
  - createWidget
```
public <T extends DriverWidget> void createWidget(java.lang.Class<T> widgetClass,
                                                  int widgetId)
```
    Create a driver-implemented widget.
    
    Specified by:
    
    createWidget in interface GuiDriver<java.lang.Integer,java.awt.image.BufferedImage>
    
    Parameters:
    
    widgetClass - The widget class.
    
    widgetId - The widget ID to be set.
  - isWeb
```
public boolean isWeb()
```
    All web-based drivers return true.
    
    Specified by:
    
    isWeb in interface ScreenDriver<GuiOutputManager>
    
    Returns:
    
    see above.
  - chooseFiles
```
public ChooseFileResult chooseFiles(java.lang.String title,
                                    boolean multiple,
                                    boolean upload,
                                    java.lang.String uploadDir,
                                    java.lang.String[] filters)
```
    Supported by web-based drivers. Provides web-native UI for selecting or uploading files from the web-browser local files to the web server file system. The mthod blocks until the file upload UI is not dismissed.
    
    Specified by:
    
    chooseFiles in interface ScreenDriver<GuiOutputManager>
    
    Parameters:
    
    title - Upload title.
    
    multiple - true to allow upload or selection of multiple files.
    
    upload - When true the selected files will be uploaded to the web server, when false only the selected file names will be returned.
    
    uploadDir - The directory on the web server the files will be uploaded to.
    
    filters - Defines the file types the file input should accept. The first element denotes a filter name and the next element defines a file specification expression.
    
    Returns:
    
    ChooseFileResult instance.

Class GuiWebDriver

Nested Class Summary

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

Nested classes/interfaces inherited from interface com.goldencode.p2j.ui.client.driver.ScreenDriver

Field Summary

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

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

Fields inherited from interface com.goldencode.p2j.web.WebConfigurationConstants

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.ui.client.gui.driver.GuiDriver

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

Field Detail

NAME

TASKBAR_HEIGHT

LOG

MAIN_TARGET

WELCOME_PAGE

BOGUS_AWT_COMPONENT

HOVER_ACTIONS

MAX_PRINT_OUTPUT_AGE

TEXT_SAMPLE

TEXT_SAMPLE_MONO

websrv

websock

lock

desktop

workarea

virtualScreen

imageSeals

imageUsages

ownedImages

nextFontId

lastMouseWidgets

widgetsRegions

repaints

activeWindowId

embedded

taskbar

taskBarStyle

documentOutputs

needsNotificationOnWait

registerMouseWidgets

fontScaleX

stateChanged

uploads

keyboardSupplier

browserTimeoutSupplier

helperApplicationsSupplier

lastUsedFont

langCache

originUrl

localStorageAccessor

directUploadsModcount

lastFocusedWidget

globalCursor

blasterListeners

Constructor Detail

GuiWebDriver

Method Detail

getName

init

getLocalStorageAccessor

getBrowserDetails

showChangePasswordDialog

showSuccessfulPassChange

retryPassChangeOnError

registerBroadcastChannel

pingBroadcastChannel

findAnyIdInChannel

pingOnWebSocket

getOriginUrl

setOriginUrl

clientReady

initRemoteClient

waitInitialization

addHandler