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

All Superinterfaces:

ScreenDriver<GuiOutputManager>

All Known Implementing Classes:

AbstractGuiDriver, GuiWebDriver, SwingGuiDriver
```
public interface GuiDriver<F,I>
extends ScreenDriver<GuiOutputManager>
```
GUI screen driver contract.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addMessageListener(MsgBlasterPeer listener, int windowId, int widgetId)` Add a low-level message listener for a specific window.
`void`	`cacheTextMetrics(java.util.Map<FontDetails<F>,java.util.Set<java.lang.String>> texts, java.lang.Integer windowId)` Get and cache metrics for the given texts.
`void`	`changeSensitivity(int widgetId, boolean sensitive)` Change the sensitivity of a driver-implemented widget.
`void`	`changeVisibility(int widgetId, boolean visible)` Change the visibility of a driver-implemented widget.
`java.lang.String`	`clipboardContents()` Get the current contents from the OS clipboard.
`void`	`copyToClipboard(java.lang.String txt)` Copy the given text to the system clipboard.
`FontDetails<F>`	`createFont(FontDetails<F> details)` Create a font with the given details and register it with the driver.
`ImageWrapper<I>`	`createGreyImage(I imageIni)` Create a native grey image from the original initial image to be used for disabled control states.
`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`	`deiconifyWindow(int windowId)` De-iconify the window.
`void`	`deliverDocumentOutput(java.util.function.Consumer<java.io.OutputStream> consumer, java.lang.Runnable finalizer, MediaType format, java.lang.String uuid, boolean promptUser)` The method delivers document output to the client.
`void`	`deregisterTooltipWorkers(int wid)` Deregister the tooltip workers already registered with mouse handler.
`void`	`deregisterWidget(int wid)` Deregister the specified widget for mouse events.
`void`	`deregisterWindow(int windowId)` Deregister a given window from the driver.
`void`	`destroyWidget(int widgetId)` Destroy the driver-specific widget.
`void`	`draw(NativePoint origin, NativeRectangle clip, java.lang.Runnable core)` Execute a widget drawing bracket.
`void`	`draw(WidgetId id, NativePoint origin, NativeRectangle clip, java.lang.Runnable core)` Execute a widget drawing bracket.
`void`	`draw3DRect(int x, int y, int width, int height, boolean raised)` Draws a 3-D highlighted outline of the specified rectangle.
`void`	`drawCursor(LightweightTextWidget widget)` Draws the cursor for the given text widget.
`void`	`drawEdge(int left, int top, int width, int height, int edgeType, int flags)` Draw one or more edges of rectangle.
`void`	`drawEllipse(int x, int y, int width, int height)` Draws an ellipse.
`void`	`drawFromOrigin(NativePoint origin, NativeRectangle clip, java.lang.Runnable core)` Execute a widget drawing bracket.
`void`	`drawHighlight(int x, int y, int width, int height, ColorRgb color)` Draws a highlighted rectangular area of the specified color and bounds.
`void`	`drawIbeam(int x1, int y1, int x2, int y2)` Draws a text fields caret, using the current color, between the points `(x1, y1)` and `(x2, y2)` in this graphics context's coordinate system.
`void`	`drawImage(ImageWrapper<I> img, int x, int y, int w, int h, int xoff, int yoff, boolean transparent, boolean stretch, boolean retain, boolean convert3D)` Draw an image at the specified location.
`void`	`drawLine(int x1, int y1, int x2, int y2)` Draws a line, using the current color, between the points `(x1, y1)` and `(x2, y2)` in this graphics context's coordinate system.
`void`	`drawParagraph(java.lang.String text, FontDetails<F> font, int x, int y, int maxWidth)` Draws a multiline text (paragraph) at the supplied position and with the specified font.
`void`	`drawRect(int x, int y, int width, int height)` Draw a rectangle.
`void`	`drawRoundRect(int x, int y, int width, int height, int arcDiameter)` Draw a rounded rectangle.
`void`	`drawSelection(int x, int y, int width, int height, boolean clear)` Draw a selection box rectangular area with current color.
`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`	`drawStringCentered(java.lang.String text, int legacyWidth, int legacyHeight, int x, int height)` Draw a string using the current font, which will be scaled so that the final string will have the specified legacy width and height.
`void`	`drawStringScaled(java.lang.String text, int legacyWidth, int legacyHeight, int x, int y)` Draw a string using the current font, which will be scaled so that the final string will have the specified legacy width and height.
`void`	`drawStringWithinBox(int xPosition, int yPosition, int boxWidth, int boxHeight, java.lang.String text, int[] indices, boolean centered)` Draw a given text within a box given by its relative coordinates.
`void`	`drawStringWithinBoxScaled(int xPosition, int yPosition, int boxWidth, int boxHeight, java.lang.String text, int[] indices, boolean centered)` Draw a given text within a box given by its relative coordinates.
`void`	`drawStringWithinBoxWithMnemonic(java.lang.String text, int xPosition, int yPosition, int boxWidth, int boxHeight, MnemonicInfo info, GuiFontResolver gf, AbstractWidget<GuiOutputManager> widget, boolean centered)` Draw a string with a mnemonic within the given box.
`void`	`drawStringWithMnemonic(java.lang.String text, NativePoint tp, MnemonicInfo info, GuiFontResolver gf, AbstractWidget<GuiOutputManager> widget, boolean centered)` Draw a string with a mnemonic.
`void`	`drawTextSelection(LightweightTextWidget.TextLineSelection textLine, Theme.TextLookAndFeel textLookAndFeel, int x, int y, int lineHeight, int fontDescent)` Draw a text selection.
`void`	`enableEvents(int[] windowIds, boolean process)` Enable or Disable OS-level events for the specified windows.
`void`	`endBatch()` End a batch drawing routine.
`void`	`fill3DRect(int x, int y, int width, int height, boolean raised)` Paints a 3-D highlighted rectangle filled with the current color.
`void`	`fillEllipse(int x, int y, int width, int height)` Fills an ellipse.
`void`	`fillPolygon(int[] xPoints, int[] yPoints)` Fill polygon.
`void`	`fillRect(int x, int y, int width, int height)` Fill a rectangle.
`void`	`fillRectAroundText(int x, int y, int textWidthHint, int textHeightHint, java.lang.String text)` Fill a rectangle around the given text.
`void`	`fillRoundRect(int x, int y, int width, int height, int arcDiameter)` Fill a rounded rectangle.
`java.lang.String`	`fitStringWithEllipsis(java.lang.String text, FontDetails<F> font, int maxWidth)` Shortens the input string so that it fits the specified width.
`default int[]`	`getBasicWebPalette()` Queries the web driver for a basic palette.
`ColorRgb`	`getBgColor(int index)` Get BGCOLOR color.
`ColorRgb`	`getBgStdColor(java.lang.String stdColor)` Get background color for a standard color like NORMAL, INPUT or MESSAGES.
`NativeRectangle`	`getDisplayBounds(int windowId)` Returns bounds of a physical screen the passed in window is positioned on.
`NativeRectangle`	`getDisplayWorkArea(int windowId)` Returns an application-usable display area.
`DriverWidget`	`getDriverWidget(int widgetId)` Returns driver widget from the supplied id.
`ColorRgb`	`getFgColor(int index)` Get FGCOLOR color.
`ColorRgb`	`getFgStdColor(java.lang.String stdColor)` Get foreground color for a standard color like NORMAL, INPUT or MESSAGES.
`int`	`getFontHeight(FontDetails<F> font)` Get the height of the specified font.
`int`	`getFontMaxWidth(FontDetails<F> font)` Get the maximum font width, for the given font.
`int`	`getFontWidth(FontDetails<F> font)` Get the width of the specified font.
`int[]`	`getFontWidths(FontDetails<F> fd)` Report the advance widths of the first 256 characters in the font.
`NativePoint`	`getMousePosition()` Returns current mouse cursor display position relative to the display origin.
`int`	`getParagraphHeight(java.lang.String text, FontDetails<F> font, int maxWidth)` The method performs a layout operation on the supplied text and returns the resulting paragraph height while maintaining the supplied maximum width.
`int`	`getScreenResolution()` Reports the screen resolution in dots per inch (DPI).
`ImageWrapper<I>`	`getSubImage(ImageWrapper<I> img, int x, int y, int width, int height)` Creates a sub image from the supplied source image, offset coordinates and size.
`ColorRgb`	`getSysColor(int index)` Get a system color.
`int`	`getTextHeight(java.lang.String text, FontDetails<F> font)` Get the height of the specified text, using the given font.
`int`	`getTextWidth(java.lang.String text, FontDetails<F> font)` Get the width of the specified text, using the given font.
`int[][]`	`getTextWidths(java.lang.String[] texts, FontDetails<F> font)` Get the widths of the specified texts, using the given font.
`int[]`	`getTextWidths(java.lang.String text, FontDetails<F> font)` Get the widths of the specified text, using the given font.
`NativeDimension`	`getVirtualScreenSize()` Returns the size of the virtual screen, i.e.
`NativeDimension`	`getWindowDimension()` Get the physical window dimension, in pixel units.
`NativePoint`	`getWindowLocation()` Get the window location on screen.
`boolean`	`hasWindowEmulator(int windowId)` Check if window has an emulator for the given window id.
`void`	`iconifyWindow(int windowId)` Iconify the window.
`default void`	`initDragAndDrop(ServerExports srv)` Initializes several client specific internal variables used with drag-n-drop.
`java.lang.Object`	`invokeWidgetCommand(int widgetId, java.lang.Enum command, java.lang.Object[] args)` Invokes command on a widget implemented at the driver level.
`java.lang.Object`	`invokeWidgetCommand(int widgetId, java.lang.String command, java.lang.Object[] args)` Invokes command on a widget implemented at the driver level.
`boolean`	`isFontInstalled(java.lang.String fontName, boolean boldFont, boolean webScale)` Queries if the target font is installed.
`boolean`	`isWindowDecorationSupported()` Returns true if a window can be decorated in this graphics environment, otherwise false.
`boolean`	`isWindowVisible()` Check if the currently selected window is visible.
`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 `cacheTextMetrics(Map, Integer)`.
`default 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.
`default int[][]`	`parseEditorContent(int widgetId, int windowId, int maxWidth, java.lang.String text, int delta, FontDetails<F> font)` Split the text for a editor widget, so that it fits the specified maximum width.
`void`	`placeWidget(int widgetId, NativeRectangle bounds)` Place the driver-specific widget at the specified bounds, using the currently selected window.
`default void`	`propagateWaitState(boolean isWaitState)` Propagate wait state
`void`	`registerChildWindow(int ownerId, int windowId, java.lang.String windowTitle, boolean resizable, boolean isShareActivationWithOwner, boolean modal)` Register new child window with the driver.
`void`	`registerDirectManipulation(Widget<GuiOutputManager> widget)` Register the specified widget as a container able to use direct manipulation via mouse.
`void`	`registerEmptySelector(Widget<GuiOutputManager> widget)` Register the specified widget as a container able to deselect all widgets from the window.
`void`	`registerHoverableWidget(MouseHoverAction action)` Register this widget as being editable, so that the mouse cursor will adjust properly when the widget is entered.
`void`	`registerMouseWidgets()` Register all the mouse-aware widgets (in all Windows) with the driver.
`void`	`registerMoveableWidget(int wid)` Register the specified widget as a moveable widget, via mouse.
`void`	`registerPendingTooltipWorkers(int wid)` Register the tooltip workers if this process was dalayed with regular registration.
`void`	`registerResizeableWidget(int wid)` Register the specified widget as a resizeable widget, via mouse.
`void`	`registerTooltipWorker(Widget<GuiOutputManager> widget, int font, boolean now)` Register this widget as having tooltip functionality reacting on mouse entering and exiting events.
`void`	`registerWidgetPopup(int wid, int btn, int pid)` Register the specified widget for popup events, via mouse.
`void`	`registerWindow(int windowId, boolean showInTaskbar)` Register a new window with the driver.
`void`	`releaseWindow()` Release the last window used by the current thread.
`void`	`removeMessageListener(MsgBlasterPeer listener, int windowId, int widgetId)` Removes a low-level message listener for a specific window.
`void`	`resetComposite()` Reset composite mode and return to normal drawing mode.
`default void`	`resetSelection()` Reset selection boxes painting mode and return to normal drawing mode.
`void`	`resizeWindow(int width, int height)` Resize window.
`void`	`restoreDrawingState(java.lang.Object state)` Restore the drawing state to the specified state.
`java.lang.Object`	`saveDrawingState()` Save the current drawing state and release the drawing lock, so that other threads can acquire it.
`void`	`scaleFont(FontDetails<F> font)` Scale the font so its width and height match the legacy values.
`void`	`selectWindow(int windowId)` On a GUI interface multiple windows could be created.
`default void`	`setAlwaysOnTop(int windowId, boolean topOnly, boolean alwaysOnTop)` Makes the supplied window to be on top of other windows.
`void`	`setColor(java.awt.Color color)` Set current color used on draw operations.
`void`	`setColor(ColorRgb color)` Set current color used on draw operations.
`void`	`setCurrentSelection(java.lang.String txt)` Sets the current selection.
`default void`	`setCursor(MousePtrWrapper ptr)` Set the mouse cursor
`default void`	`setCursor(java.lang.String image)` Set the mouse cursor from resource
`void`	`setDesktopBgColor(ColorRgb color)` Set the desktop background color.
`void`	`setDisableRedraw(boolean value)` Sets the global SESSION:DISABLE-REDRAW attribute.
`void`	`setDrawingArea(NativeRectangle bounds)` Limit the available drawing area to the specified boundaries.
`void`	`setDrawingAreas(java.util.Set<NativeRectangle> bounds)` Limit the available drawing area to the specified boundaries provided in the `bounds` parameter.
`void`	`setFontStyle(FontStyle style)` Set the style of the current font used on draw operations.
`void`	`setGuiFont(FontDetails<F> font)` Set current font used on draw operations.
`void`	`setIcon(ImageWrapper<I> icon, int x, int y, int width, int height, int xoff, int yoff, boolean transparent, boolean stretch, boolean retain, boolean convert3D)` Sets the image to the window to be displayed as the window icon representation for the system task bar, the title window panel or the system tray icons panel.
`void`	`setLineStroke(LineStroke stroke)` Set the style of the current line drawing primitives.
`void`	`setLineStroke(LineStroke stroke, float width)` Set the style of the current line drawing primitives.
`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`	`setTitle(java.lang.String title)` Set the window title at the OS level.
`default 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.
`boolean`	`setWidgetAttribute(int widgetId, java.lang.String attr, java.lang.String val)` Set an attribute for a widget implemented at the driver level.
`void`	`setWindowBounds(int x, int y, int width, int height)` Set window bounds.
`void`	`setWindowEnabled(boolean enable)` Set the window's sensitive state, depending on the `enable` flag.
`void`	`setWindowLocation(int left, int top)` Set window location.
`void`	`setWindowVisible(boolean visible)` Hide or show the window, depending on the `visible` flag.
`void`	`setXORComposite()` Set "XOR composite" mode: color of the drawn elements is calculated as XOR (for each RGB component) of their color with color of underlying pixels.
`void`	`setXORMode(ColorRgb color)` Set XOR mode painting allowing to invert the destination color with current drawing primitive color.
`void`	`stackWindows(int[] windowIds)` Force the list of all GUI windows to be stacked as in the specified order.
`void`	`startBatch()` Start a batch drawing routine.
`void`	`translatePop()` Reverses the translation at the top of the stack.
`void`	`translatePush(int x, int y)` Translates the origin of the graphics context to the point (x, y) in the current coordinate system.
`default void`	`withSelectedWindow(int windowId, java.lang.Runnable run)` The method works as an envelope for `selectWindow(int)` and `releaseWindow()` methods.

Methods inherited from interface com.goldencode.p2j.ui.client.driver.ScreenDriver
beep, captureMouseEvents, chooseFiles, clear, clientReady, createOutputManager, getChildProcessFactory, getClientStorage, getFactory, getHostByName, getHostName, getPrimitives, getWindowSystem, handleMouseEvent, inBackgroundMode, inBatchMode, init, isChui, isWeb, lockMousePointer, openMimeResource, propagate, readKey, resetMode, resume, resume, setControl, setCursorStatus, setTerminalType, shutdown, suspend, suspend, terminalType, updateClientMetrics, widgetStateChanged

- Method Detail
 - translatePush
```
void translatePush(int x,
 int y)
```
 Translates the origin of the graphics context to the point (x, y) in the current coordinate system. The modified context will have its new origin corresponding to the point (x, y) in the context's former coordinate system. All coordinates used in subsequent rendering operations on this graphics context are relative to this new origin.
 All usage of this method MUST be paired with a subsequent translatePop(). A stack of translations is maintained, so that translate calls can be nested.
 Warning: unbalanced translate push/pop will cause an infinite loop in web driver, as it will keep waiting for the translate to reach 0. In Swing driver, it will not flush until all batch, translate and clip brackets reach 0.
 
 Parameters:
 
 x - the specified x coordinate
 
 y - the specified y coordinate
 - translatePop
```
void translatePop()
```
 Reverses the translation at the top of the stack.
 Warning: unbalanced translate push/pop will cause an infinite loop in web driver, as it will keep waiting for the translate to reach 0. In Swing driver, it will not flush until all batch, translate and clip brackets reach 0.
 - drawStringWithMnemonic
```
void drawStringWithMnemonic(java.lang.String text,
 NativePoint tp,
 MnemonicInfo info,
 GuiFontResolver gf,
 AbstractWidget<GuiOutputManager> widget,
 boolean centered)
```
 Draw a string with a mnemonic.
 
 Parameters:
 
 text - The full text, which needs to be drawn.
 
 tp - The text's coordinates. If centered parameter is set to true, then the NativePoint.y will represent the height on which centerin will be done.
 
 info - The mnemonic details.
 
 gf - The widget's font details.
 
 widget - The widget instance to which the text belongs.
 
 centered - Flag indicating if the text needs to be centered vertically.
 - fitStringWithEllipsis
```
java.lang.String fitStringWithEllipsis(java.lang.String text,
 FontDetails<F> font,
 int maxWidth)
```
 Shortens the input string so that it fits the specified width. If the input string fits fully, it is returned as is, otherwise it is shortened with ellipsis appended. If the shortest form of the input string (first character plus ellipsis) doesn't fit the specified max width, null is returned.
 
 Parameters:
 
 text - The full text, which needs to be drawn.
 
 font - The font details to use for text measuring.
 
 maxWidth - The maximum width the input string may occupy.
 
 Returns:
 
 the input string, shortened and appended with ellipsis if required
 - drawStringWithinBoxWithMnemonic
```
void drawStringWithinBoxWithMnemonic(java.lang.String text,
 int xPosition,
 int yPosition,
 int boxWidth,
 int boxHeight,
 MnemonicInfo info,
 GuiFontResolver gf,
 AbstractWidget<GuiOutputManager> widget,
 boolean centered)
```
 Draw a string with a mnemonic within the given box.
 
 Parameters:
 
 text - The full text, which needs to be drawn.
 
 xPosition - The box horizontal position
 
 yPosition - The box vertical position
 
 boxWidth - The box width
 
 boxHeight - The box height
 
 info - The mnemonic details.
 
 gf - The widget's font details.
 
 widget - The widget instance to which the text belongs.
 
 centered - Flag indicating if the text needs to be centered vertically.
 - drawStringWithinBox
```
void drawStringWithinBox(int xPosition,
 int yPosition,
 int boxWidth,
 int boxHeight,
 java.lang.String text,
 int[] indices,
 boolean centered)
```
 Draw a given text within a box given by its relative coordinates.
 
 Parameters:
 
 xPosition - The box horizontal position
 
 yPosition - The box vertical position
 
 boxWidth - The box width
 
 boxHeight - The box height
 
 text - The given text
 
 indices - Represents a text segment within the given text that should be drawn; if it isn't given, then all given text should be drawn
 
 centered - Flag indicating if the text needs to be centered vertically.
 - drawStringWithinBoxScaled
```
void drawStringWithinBoxScaled(int xPosition,
 int yPosition,
 int boxWidth,
 int boxHeight,
 java.lang.String text,
 int[] indices,
 boolean centered)
```
 Draw a given text within a box given by its relative coordinates.
 
 Parameters:
 
 xPosition - The box horizontal position
 
 yPosition - The box vertical position
 
 boxWidth - The box width
 
 boxHeight - The box height
 
 text - The given text
 
 indices - Represents a text segment within the given text that should be drawn; if it isn't given, then all given text should be drawn
 
 centered - Flag indicating if the text needs to be centered vertically.
 - drawString
```
void drawString(java.lang.String text,
 int x,
 int y)
```
 Draw a string at the specified location.
 
 Parameters:
 
 text - text string to draw.
 
 x - left position.
 
 y - top position.
 - drawStringCentered
```
void drawStringCentered(java.lang.String text,
 int x,
 int height)
```
 Draw a string at the specified location.
 
 Parameters:
 
 text - text string to draw.
 
 x - left position.
 
 height - the height to center on.
 - drawStringScaled
```
void drawStringScaled(java.lang.String text,
 int legacyWidth,
 int legacyHeight,
 int x,
 int y)
```
 Draw a string using the current font, which will be scaled so that the final string will have the specified legacy width and height.
 The string will be drawn at the specified location.
 
 Parameters:
 
 text - text string to draw.
 
 legacyWidth - The legacy width, which needs to be matched when drawing.
 
 legacyHeight - The legacy width, which needs to be matched when drawing.
 
 x - left position.
 
 y - top position.
 - drawStringCentered
```
void drawStringCentered(java.lang.String text,
 int legacyWidth,
 int legacyHeight,
 int x,
 int height)
```
 Draw a string using the current font, which will be scaled so that the final string will have the specified legacy width and height.
 The string will be drawn at the specified location.
 
 Parameters:
 
 text - text string to draw.
 
 legacyWidth - The legacy width, which needs to be matched when drawing.
 
 legacyHeight - The legacy width, which needs to be matched when drawing.
 
 x - left position.
 
 height - the height to center on.
 - getParagraphHeight
```
int getParagraphHeight(java.lang.String text,
 FontDetails<F> font,
 int maxWidth)
```
 The method performs a layout operation on the supplied text and returns the resulting paragraph height while maintaining the supplied maximum width.
 Note that the algorithm for text layout is compatible with drawParagraph(String, FontDetails, int, int, int) and so can be used in conjunction with this method.
 
 Parameters:
 
 text - The text to measure.
 
 font - The font to use during layout.
 
 maxWidth - The maximum paragraph width.
 
 Returns:
 
 The calculated height.
 - drawParagraph
```
void drawParagraph(java.lang.String text,
 FontDetails<F> font,
 int x,
 int y,
 int maxWidth)
```
 Draws a multiline text (paragraph) at the supplied position and with the specified font. The paragraph width will not exceed the supplied maximum width. The text will be properly broken into multiple lines.
 Note that the algorithm for text layout is compatible with getParagraphHeight(String, FontDetails, int) and so can be used in conjunction with this method.
 
 Parameters:
 
 text - The text to draw.
 
 font - The drawing font.
 
 x - The x position.
 
 y - The y position.
 
 maxWidth - The maximum paragraph width.
 - drawLine
```
void drawLine(int x1,
 int y1,
 int x2,
 int y2)
```
 Draws a line, using the current color, between the points (x1, y1) and (x2, y2) in this graphics context's coordinate system.
 
 Parameters:
 
 x1 - the first point's x coordinate.
 
 y1 - the first point's y coordinate.
 
 x2 - the second point's x coordinate.
 
 y2 - the second point's y coordinate.
 - drawIbeam
```
void drawIbeam(int x1,
 int y1,
 int x2,
 int y2)
```
 Draws a text fields caret, using the current color, between the points (x1, y1) and (x2, y2) in this graphics context's coordinate system.
 
 Parameters:
 
 x1 - the first point's x coordinate.
 
 y1 - the first point's y coordinate.
 
 x2 - the second point's x coordinate.
 
 y2 - the second point's y coordinate.
 - drawRect
```
void drawRect(int x,
 int y,
 int width,
 int height)
```
 Draw a rectangle.
 
 Parameters:
 
 x - left position
 
 y - top position
 
 width - rectangle width.
 
 height - rectangle height.
 - drawRoundRect
```
void drawRoundRect(int x,
 int y,
 int width,
 int height,
 int arcDiameter)
```
 Draw a rounded rectangle.
 
 Parameters:
 
 x - left position
 
 y - top position
 
 width - rectangle width.
 
 height - rectangle height.
 
 arcDiameter - diameter of the arc at corners.
 - fillRect
```
void fillRect(int x,
 int y,
 int width,
 int height)
```
 Fill a rectangle.
 
 Parameters:
 
 x - left position
 
 y - top position
 
 width - rectangle width.
 
 height - rectangle height.
 - fillRectAroundText
```
void fillRectAroundText(int x,
 int y,
 int textWidthHint,
 int textHeightHint,
 java.lang.String text)
```
 Fill a rectangle around the given text.
 
 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
 - fillRoundRect
```
void fillRoundRect(int x,
 int y,
 int width,
 int height,
 int arcDiameter)
```
 Fill a rounded rectangle.
 
 Parameters:
 
 x - left position
 
 y - top position
 
 width - rectangle width.
 
 height - rectangle height.
 
 arcDiameter - diameter of the arc at corners.
 - drawEllipse
```
void drawEllipse(int x,
 int y,
 int width,
 int height)
```
 Draws an ellipse.
 
 Parameters:
 
 x - Left position.
 
 y - Top position.
 
 width - Ellipse width.
 
 height - Ellipse height.
 - fillEllipse
```
void fillEllipse(int x,
 int y,
 int width,
 int height)
```
 Fills an ellipse.
 
 Parameters:
 
 x - Left position.
 
 y - Top position.
 
 width - Ellipse width.
 
 height - Ellipse height.
 - drawSelection
```
void drawSelection(int x,
 int y,
 int width,
 int height,
 boolean clear)
```
 Draw a selection box rectangular area with current color.
 
 Parameters:
 
 x - left position
 
 y - top position
 
 width - rectangle width.
 
 height - rectangle height.
 
 clear - TRUE means clean up area instead of drawing selections.
 - drawTextSelection
```
void drawTextSelection(LightweightTextWidget.TextLineSelection textLine,
 Theme.TextLookAndFeel textLookAndFeel,
 int x,
 int y,
 int lineHeight,
 int fontDescent)
```
 Draw a text selection.
 
 Parameters:
 
 textLine - The text selection object
 
 textLookAndFeel - The text look and feel
 
 x - The left position
 
 y - The top position
 
 lineHeight - The line height
 
 fontDescent - The font descent
 - drawEdge
```
void drawEdge(int left,
 int top,
 int width,
 int height,
 int edgeType,
 int flags)
```
 Draw one or more edges of rectangle.
 The edgeType parameter is a bit mask, defining which edges of the rectangle must be drawn and some other features:
 - BF_LEFT (0x0001): draw the left edge;
 - BF_TOP (0x0002): draw the top edge;
 - BF_RIGHT (0x0004): draw the right edge;
 - BF_BOTTOM (0x0008): draw the bottom edge.
 - BF_FLAT (0x4000): flat border (only two colors are used: one to draw entire inner border, another for the entire outer border)
 The edgeFlags parameter is a bit mask, the types of inner and outer edges:
 - BDR_RAISEDOUTER (0x0001): raise the outer edge;
 - BDR_SUNKENOUTER (0x0002): sunk the outer edge;
 - BDR_RAISEDINNER (0x0004): raise the inner edge;
 - BDR_SUNKENINNER (0x0008): sunk the inner edge.
 See https://docs.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-drawedge.
 Not all the features of the original MS-Windows function are implemented in FWD.

Parameters:: left - the rectangle left side coordinate; top - the rectangle top side coordinate; width - the rectangle width; height - the rectangle height; edgeType - Flags defining the edge type (flat, bevelled etc.); flags - Flags defining which rectangle edges to draw (left, top, right, bottom)

resetSelection
```
default void resetSelection()
```
Reset selection boxes painting mode and return to normal drawing mode.

initDragAndDrop
```
default void initDragAndDrop(ServerExports srv)
```
Initializes several client specific internal variables used with drag-n-drop.

Parameters:

srv - Server to make config related calls.

setUploadFileSizeLimits
```
default 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.

Parameters:

single - Single file size limit.

total - Total file size limit for single operation.

fillPolygon
```
void fillPolygon(int[] xPoints,
                 int[] yPoints)
```
Fill polygon.

Parameters:

xPoints - X coordinates.

yPoints - Y coordinates.

fill3DRect
```
void fill3DRect(int x,
                int y,
                int width,
                int height,
                boolean raised)
```
Paints a 3-D highlighted rectangle filled with the current color. The edges of the rectangle are highlighted so that it appears as if the edges were beveled and lit from the upper left corner. The colors used for the highlighting effect and for filling are determined from the current ColorRgb. This method uses the current ColorRgb exclusively and ignores the current Paint.

Parameters:

x - the x coordinate of the rectangle to be filled.

y - the y coordinate of the rectangle to be filled.

width - the width of the rectangle to be filled.

height - the height of the rectangle to be filled.

raised - a boolean value that determines whether the rectangle appears to be raised above the surface or etched into the surface.

draw3DRect
```
void draw3DRect(int x,
                int y,
                int width,
                int height,
                boolean raised)
```
Draws a 3-D highlighted outline of the specified rectangle. The edges of the rectangle are highlighted so that they appear to be beveled and lit from the upper left corner.
The colors used for the highlighting effect are determined based on the current color. The resulting rectangle covers an area that is width + 1 pixels wide by height + 1 pixels tall. This method uses the current ColorRgb exclusively and ignores the current Paint.

Parameters:

x - the x coordinate of the rectangle to be drawn.

y - the y coordinate of the rectangle to be drawn.

width - the width of the rectangle to be drawn.

height - the height of the rectangle to be drawn.

raised - A boolean that determines whether the rectangle appears to be raised above the surface or sunk into the surface.

drawImage
```
void drawImage(ImageWrapper img,
 int x,
 int y,
 int w,
 int h,
 int xoff,
 int yoff,
 boolean transparent,
 boolean stretch,
 boolean retain,
 boolean convert3D)
```
Draw an image at the specified location.

Parameters:

img - Image to draw.

x - left location.

y - top location.

w - the image width.

h - the image height.

xoff - x offset inside image to start drawing.

yoff - y offset inside image to start drawing.

transparent - Flag indicating to use lower-left pixel as color marker to draw part of image as transparent.

stretch - Flag indicating stretch or shrink the image to fit display area.

retain - Flag indicating keep original image aspect ratio when stretching the image.

convert3D - Flag indicating autoconvert some image colors to the corresponding system wide 3D colors.

getSubImage
```
ImageWrapper getSubImage(ImageWrapper img,
 int x,
 int y,
 int width,
 int height)
```
Creates a sub image from the supplied source image, offset coordinates and size. The method will throw a runtime exception when the offset or size is outside of the image bounds.

Parameters:

img - The source image to cut, the instance is not modified, instead new image wrapper is returned.

x - The offset x.

y - The offset y.

width - The width relative to the offset.

height - The height relative to the offset/.

Returns:

New image wrapper instance representing the sub image.

drawHighlight
```
void drawHighlight(int x,
                   int y,
                   int width,
                   int height,
                   ColorRgb color)
```
Draws a highlighted rectangular area of the specified color and bounds. The color is alpha-blended with the content of the screen buffer.

Parameters:

x - left position

y - top position

width - area width

height - area height

color - the highlight color

setColor
```
void setColor(ColorRgb color)
```
Set current color used on draw operations.

Parameters:

color - Drawing color.

setColor
```
void setColor(java.awt.Color color)
```
Set current color used on draw operations.

Parameters:

color - Drawing color.

setDesktopBgColor
```
void setDesktopBgColor(ColorRgb color)
```
Set the desktop background color.

Parameters:

color - The new desktop background color.

setXORComposite
```
void setXORComposite()
```
Set "XOR composite" mode: color of the drawn elements is calculated as XOR (for each RGB component) of their color with color of underlying pixels.

setXORMode
```
void setXORMode(ColorRgb color)
```
Set XOR mode painting allowing to invert the destination color with current drawing primitive color. Double painting of the same figure at the same location should restore original picture.

Parameters:

color - XOR alternation color.

resetComposite
```
void resetComposite()
```
Reset composite mode and return to normal drawing mode.

setTitle
```
void setTitle(java.lang.String title)
```
Set the window title at the OS level.

Parameters:

title - The window's title.

setGuiFont
```
void setGuiFont(FontDetails<F> font)
```
Set current font used on draw operations.

Parameters:

font - Drawing font.

scaleFont
```
void scaleFont(FontDetails<F> font)
```
Scale the font so its width and height match the legacy values.

Parameters:

font - The font to be scaled. This will be modified on return.

setFontStyle
```
void setFontStyle(FontStyle style)
```
Set the style of the current font used on draw operations.

Parameters:

style - Font style.

setLineStroke
```
void setLineStroke(LineStroke stroke)
```
Set the style of the current line drawing primitives.

Parameters:

stroke - Line style.

setLineStroke
```
void setLineStroke(LineStroke stroke,
                   float width)
```
Set the style of the current line drawing primitives.

Parameters:

stroke - Line style.

width - Width value for the line.

resizeWindow
```
void resizeWindow(int width,
                  int height)
```
Resize window.

Parameters:

width - new width.

height - new height

setWindowBounds

void setWindowBounds(int x,
                     int y,
                     int width,
                     int height)

Set window bounds.

Parameters:: x - new x; y - new y; width - new width.; height - new height

hasWindowEmulator
```
boolean hasWindowEmulator(int windowId)
```
Check if window has an emulator for the given window id.

Parameters:

windowId - Window ID.

Returns:

true if window has an associated emulator, false otherwise.

registerWindow
```
void registerWindow(int windowId,
                    boolean showInTaskbar)
```
Register a new window with the driver.

Parameters:

windowId - The window ID.

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

registerChildWindow
```
void registerChildWindow(int ownerId,
                         int windowId,
                         java.lang.String windowTitle,
                         boolean resizable,
                         boolean isShareActivationWithOwner,
                         boolean modal)
```
Register new child window with the driver.

Parameters:

ownerId - The owning window ID.

windowId - The window ID.

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.

deregisterWindow
```
void deregisterWindow(int windowId)
```
Deregister a given window from the driver. This needs to be called only when the window widget is being destroyed.

Parameters:

windowId - The window ID.

selectWindow
```
void selectWindow(int windowId)
```
On a GUI interface multiple windows could be created. Each window has it own renderer. When a window is draw first the window must call this method to setup it renderer as the current graphical canvas.
The GUI driver primitives can be accessed by only a single thread at a time. This requires all GUI driver API calls to be bracketed in selectWindow(int) and releaseWindow() calls.
If the thread drawing owner is null, the current thread will gain exclusive access immediately and will hold it until has finished work.

Parameters:

windowId - Window ID.

withSelectedWindow
```
default void withSelectedWindow(int windowId,
                                java.lang.Runnable run)
```
The method works as an envelope for selectWindow(int) and releaseWindow() methods.

Parameters:

windowId - Window ID.

run - The code to run after the window is selected in the driver.

releaseWindow
```
void releaseWindow()
```
Release the last window used by the current thread. This can be called only by the same thread as the drawing owner thread which acquired the exclusive drawing access.
If no more windows are in use by the current thread, then the exclusive drawing access is released and other other threads waiting in selectWindow(int) can acquire it.

saveDrawingState
```
java.lang.Object saveDrawingState()
```
Save the current drawing state and release the drawing lock, so that other threads can acquire it. This is useful in cases when the current thread needs to wait an indefinite amount of time (i.e. for keyboard/mouse events).

Returns:

An object encoding the drawing state.

restoreDrawingState
```
void restoreDrawingState(java.lang.Object state)
```
Restore the drawing state to the specified state. If the current thread is not currently the drawing oOwner, then wait for it to relinquish the exclusive lock, before restoring the state.

Parameters:

state - The drawing state.

setWindowLocation
```
void setWindowLocation(int left,
                       int top)
```
Set window location.

Parameters:

left - left coordinate

top - top coordinate

setResizeableWindow
```
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.

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.

getWindowLocation
```
NativePoint getWindowLocation()
```
Get the window location on screen.

Returns:

See above.

createGreyImage
```
ImageWrapper createGreyImage(I imageIni)
```
Create a native grey image from the original initial image to be used for disabled control states.

Parameters:

imageIni - The image to be used as source for grey transformation.

Returns:

The generic wrapper representing the given image or null if the image cannot be created (e.g. if the bytes are not a valid image type).

createFont
```
FontDetails<F> createFont(FontDetails<F> details)
```
Create a font with the given details and register it with the driver.

Parameters:

details - The font specifications.

Returns:

A font instance.

isFontInstalled
```
boolean isFontInstalled(java.lang.String fontName,
                        boolean boldFont,
                        boolean webScale)
```
Queries if the target font is installed.

Parameters:

fontName - The target font name.

boldFont - Indicates that the bold font is queried.

webScale - Check if the font is installed such that it can be web scaled.

Returns:

True if the target font is installed, otherwise false.

getFontWidth
```
int getFontWidth(FontDetails<F> font)
```
Get the width of the specified font.

Parameters:

font - The font.

Returns:

The fonts's width.

getFontMaxWidth
```
int getFontMaxWidth(FontDetails<F> font)
```
Get the maximum font width, for the given font.

Parameters:

font - The font to calculate.

Returns:

The font's maximum width.

getFontWidths
```
int[] getFontWidths(FontDetails<F> fd)
```
Report the advance widths of the first 256 characters in the font. Advance width measures the length of the character's baseline.

Parameters:

fd - The font details.

Returns:

The font widths.

getFontHeight
```
int getFontHeight(FontDetails<F> font)
```
Get the height of the specified font.

Parameters:

font - The font.

Returns:

The fonts's height.

getTextWidth
```
int getTextWidth(java.lang.String text,
 FontDetails<F> font)
```
Get the width of the specified text, using the given font.

Parameters:

text - The text.

font - The font used to draw and measure the text.

Returns:

The text's width.

cacheTextMetrics
```
void cacheTextMetrics(java.util.Map<FontDetails<F>,java.util.Set<java.lang.String>> texts,
 java.lang.Integer windowId)
```
Get and cache metrics for the given texts.

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
```
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 cacheTextMetrics(Map, Integer).

Returns:

see above.

getTextHeight
```
int getTextHeight(java.lang.String text,
 FontDetails<F> font)
```
Get the height of the specified text, using the given font.

Parameters:

text - The text.

font - The font used to draw and measure the text.

Returns:

The text's height.

setWindowVisible
```
void setWindowVisible(boolean visible)
```
Hide or show the window, depending on the visible flag.

Parameters:

visible - The window visibility state.

setWindowEnabled
```
void setWindowEnabled(boolean enable)
```
Set the window's sensitive state, depending on the enable flag.

Parameters:

enable - The window sensitive state.

iconifyWindow
```
void iconifyWindow(int windowId)
```
Iconify the window.

Parameters:

windowId - Target window.

deiconifyWindow
```
void deiconifyWindow(int windowId)
```
De-iconify the window.

Parameters:

windowId - Target window.

getWindowDimension
```
NativeDimension getWindowDimension()
```
Get the physical window dimension, in pixel units.

Returns:

See above.

draw
```
void draw(WidgetId id,
          NativePoint origin,
          NativeRectangle clip,
          java.lang.Runnable core)
```
Execute a widget drawing bracket. This includes translating the origin of the graphics context to the specified point, execute the drawing and restore the origin of the graphics context.

Parameters:

id - When not-null, it caches the drawing result of this widget.

origin - The drawing origin.

clip - Clip rectangle.

core - The drawing worker.

draw
```
void draw(NativePoint origin,
          NativeRectangle clip,
          java.lang.Runnable core)
```
Execute a widget drawing bracket. This includes translating the origin of the graphics context to the specified point, execute the drawing and restore the origin of the graphics context.
The method intersects the supplied clip with the screen bitmap rectangles retrieved by ScreenBitmap.getClippings(NativeRectangle).

Parameters:

origin - The drawing origin.

clip - Clip rectangle.

core - The drawing worker.

drawFromOrigin
```
void drawFromOrigin(NativePoint origin,
                    NativeRectangle clip,
                    java.lang.Runnable core)
```
Execute a widget drawing bracket. This includes translating the origin of the graphics context to the window's real (0,0) origin (top-left corner) and then translating to the specified location, before executing the drawing.
The translated origin (as before this was called) needs to be restored, before this call ends.

Parameters:

origin - The drawing origin (relative to window's real origin).

clip - Clip rectangle.

core - The drawing worker.

setDrawingAreas
```
void setDrawingAreas(java.util.Set<NativeRectangle> bounds)
```
Limit the available drawing area to the specified boundaries provided in the bounds parameter. The individual rectangular areas may or may not overlap.
Warning: unbalanced CLIP/NO_CLIP will cause an infinite loop in web driver, as it will keep waiting for the clip brackets to reach 0. In Swing driver, it will not flush until all batch, translate and clip brackets reach 0.

Parameters:

bounds - The bounds for the drawing area.

setDrawingArea
```
void setDrawingArea(NativeRectangle bounds)
```
Limit the available drawing area to the specified boundaries.
Warning: unbalanced CLIP/NO_CLIP will cause an infinite loop in web driver, as it will keep waiting for the clip brackets to reach 0. In Swing driver, it will not flush until all batch, translate and clip brackets reach 0.

Parameters:

bounds - The bounds for the drawing area.

setDisableRedraw
```
void setDisableRedraw(boolean value)
```
Sets the global SESSION:DISABLE-REDRAW attribute. When this mode is active, all output is disabled.

Parameters:

value - Value to set to DISABLE-REDRAW attribute.

registerMoveableWidget
```
void registerMoveableWidget(int wid)
```
Register the specified widget as a moveable widget, via mouse.

Parameters:

wid - The widget ID.

registerResizeableWidget
```
void registerResizeableWidget(int wid)
```
Register the specified widget as a resizeable widget, via mouse.

Parameters:

wid - The widget ID.

deregisterWidget
```
void deregisterWidget(int wid)
```
Deregister the specified widget for mouse events.

Parameters:

wid - The widget ID.

registerWidgetPopup
```
void registerWidgetPopup(int wid,
                         int btn,
                         int pid)
```
Register the specified widget for popup events, via mouse.
The popup with the given ID will be shown when the specified mouse button is pressed inside the specified widget.

Parameters:

wid - The widget id.

btn - The button to be pressed, when showing the popup.

pid - The popup widget ID.

registerHoverableWidget
```
void registerHoverableWidget(MouseHoverAction action)
```
Register this widget as being editable, so that the mouse cursor will adjust properly when the widget is entered.

Parameters:

action - The widget mouse action.

registerTooltipWorker
```
void registerTooltipWorker(Widget<GuiOutputManager> widget,
 int font,
 boolean now)
```
Register this widget as having tooltip functionality reacting on mouse entering and exiting events. The registration is pending if tooltip engine is not available for session or tooltip text is empty.

Parameters:

widget - The widget object to register.

font - The font to draw tooltip text.

now - The flag indicating whether the action be registered immediately or later.

registerPendingTooltipWorkers
```
void registerPendingTooltipWorkers(int wid)
```
Register the tooltip workers if this process was dalayed with regular registration.

Parameters:

wid - The widget id. 0 means register all pending workers.

deregisterTooltipWorkers
```
void deregisterTooltipWorkers(int wid)
```
Deregister the tooltip workers already registered with mouse handler.

Parameters:

wid - The widget id. 0 means deregister all registered workers.

registerEmptySelector
```
void registerEmptySelector(Widget<GuiOutputManager> widget)
```
Register the specified widget as a container able to deselect all widgets from the window.

Parameters:

widget - The widget object to register.

registerDirectManipulation
```
void registerDirectManipulation(Widget<GuiOutputManager> widget)
```
Register the specified widget as a container able to use direct manipulation via mouse.

Parameters:

widget - The widget object to register.

getBgColor
```
ColorRgb getBgColor(int index)
```
Get BGCOLOR color. Get a RGB value from COLOR-TABLE at the specified index.

Parameters:

index - Color number.

Returns:

instance of ColorRgb

getFgColor
```
ColorRgb getFgColor(int index)
```
Get FGCOLOR color. Get a RGB value from COLOR-TABLE at the specified index.

Parameters:

index - Color number.

Returns:

instance of ColorRgb

getSysColor
```
ColorRgb getSysColor(int index)
```
Get a system color.

Parameters:

index - Color index.

Returns:

see above.

getFgStdColor
```
ColorRgb getFgStdColor(java.lang.String stdColor)
```
Get foreground color for a standard color like NORMAL, INPUT or MESSAGES.

Parameters:

stdColor - Color name.

Returns:

see above.

getBgStdColor
```
ColorRgb getBgStdColor(java.lang.String stdColor)
```
Get background color for a standard color like NORMAL, INPUT or MESSAGES.

Parameters:

stdColor - Color name.

Returns:

see above.

startBatch
```
void startBatch()
```
Start a batch drawing routine.

endBatch
```
void endBatch()
```
End a batch drawing routine.

isWindowVisible
```
boolean isWindowVisible()
```
Check if the currently selected window is visible.

Returns:

See above.

stackWindows
```
void stackWindows(int[] windowIds)
```
Force the list of all GUI windows to be stacked as in the specified order.

Parameters:

windowIds - The stack order to be enforced.

moveToTop
```
void moveToTop(int windowId,
               boolean focus)
```
Move the specified window to the top of the z-order, at the OS level.

Parameters:

windowId - The window to be moved.

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

moveToBottom
```
void moveToBottom(int windowId)
```
Move the specified window to the bottom of the z-order, at the OS level.

Parameters:

windowId - The window to be moved.

enableEvents
```
void enableEvents(int[] windowIds,
                  boolean process)
```
Enable or Disable OS-level events for the specified windows.

Parameters:

windowIds - The window IDs which need to be processed.

process - Flag indicating OS level events are captured (when true).

getDisplayBounds
```
NativeRectangle getDisplayBounds(int windowId)
```
Returns bounds of a physical screen the passed in window is positioned on. The bounds are in virtual device coordinate system. For more information about the virtual device coordinate system see TopLevelWindow.
For single-display setups the top-left corner of the returned rectangle is always 0,0. For multiple-display setups it can be 0,0 or positive.

Parameters:

windowId - A valid window id.

Returns:

The physical screen bounds.

getDisplayWorkArea
```
NativeRectangle getDisplayWorkArea(int windowId)
```
Returns an application-usable display area. For example the task bar is not counted as the usable area.

Parameters:

windowId - A valid window id.

Returns:

The dimensions in pixels.

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

Returns:

See above.

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

Returns:

The DPI of the screen.

copyToClipboard
```
void copyToClipboard(java.lang.String txt)
```
Copy the given text to the system clipboard.

Parameters:

txt - The text to be copied.

clipboardContents
```
java.lang.String clipboardContents()
```
Get the current contents from the OS clipboard.

Returns:

See above.

setCurrentSelection
```
void setCurrentSelection(java.lang.String txt)
```
Sets the current selection.

Parameters:

txt - The current selection.

registerMouseWidgets
```
void registerMouseWidgets()
```
Register all the mouse-aware widgets (in all Windows) with the driver.

setIcon
```
void setIcon(ImageWrapper icon,
 int x,
 int y,
 int width,
 int height,
 int xoff,
 int yoff,
 boolean transparent,
 boolean stretch,
 boolean retain,
 boolean convert3D)
```
Sets the image to the window to be displayed as the window icon representation for the system task bar, the title window panel or the system tray icons panel.

Parameters:

icon - The wrapped icon.

x - The icon left location.

y - The icon top location.

width - The icon width.

height - The icon height.

xoff - x offset inside image of the icon to select drawing region.

yoff - y offset inside image of the icon to select drawing region.

transparent - Flag indicating to use lower-left pixel as color marker to draw part of image as transparent.

stretch - Flag indicating stretch or shrink the image to fit display area.

retain - Flag indicating keep original image aspect ratio when stretching the image.

convert3D - Flag indicating autoconvert some image colors to the corresponding system wide 3D colors.

createMousePointer
```
MousePtrWrapper createMousePointer(java.io.InputStream data,
                                   java.lang.String ptrName)
```
Load mouse pointer from the InputStream

Parameters:

data - cursor data

ptrName - pointer name

Returns:

mouse pointer or null

propagateWaitState
```
default void propagateWaitState(boolean isWaitState)
```
Propagate wait state

Parameters:

isWaitState - wait state

setCursor
```
default void setCursor(MousePtrWrapper ptr)
```
Set the mouse cursor

Parameters:

ptr - mouse cursor

setCursor
```
default void setCursor(java.lang.String image)
```
Set the mouse cursor from resource

Parameters:

image - resource name

isWindowDecorationSupported
```
boolean isWindowDecorationSupported()
```
Returns true if a window can be decorated in this graphics environment, otherwise false.

Returns:

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

parseEditorContent
```
default int[][] parseEditorContent(int widgetId,
 int windowId,
 int maxWidth,
 java.lang.String text,
 int delta,
 FontDetails<F> 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.

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.

getTextWidths
```
int[] getTextWidths(java.lang.String text,
 FontDetails<F> font)
```
Get the widths of the specified text, using the given font.

Parameters:

text - The text.

font - The font details used to draw and measure the text.

Returns:

The text's widths.

getTextWidths
```
int[][] getTextWidths(java.lang.String[] texts,
 FontDetails<F> font)
```
Get the widths of the specified texts, using the given font.

Parameters:

texts - The texts.

font - The font details used to draw and measure the text.

Returns:

The texts' widths.

getMousePosition
```
NativePoint getMousePosition()
```
Returns current mouse cursor display position relative to the display origin.

Returns:

mouse cursor position, never null

deliverDocumentOutput
```
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 print output may need.

Parameters:

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

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

format - Document 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.

drawCursor
```
void drawCursor(LightweightTextWidget widget)
```
Draws the cursor for the given text widget.

Parameters:

widget - The text widget

addMessageListener
```
void addMessageListener(MsgBlasterPeer listener,
                        int windowId,
                        int widgetId)
```
Add a low-level message listener for a specific window.

Parameters:

listener - The listener to be added.

windowId - The windows id.

widgetId - The widget's id.

removeMessageListener
```
void removeMessageListener(MsgBlasterPeer listener,
                           int windowId,
                           int widgetId)
```
Removes a low-level message listener for a specific window.

Parameters:

listener - The listener to be removed.

windowId - The windows id.

widgetId - The widget's id.

setAlwaysOnTop
```
default void setAlwaysOnTop(int windowId,
                            boolean topOnly,
                            boolean alwaysOnTop)
```
Makes the supplied window to be on top of other windows. This method is used to implement the top-only functionality directly in the driver when stackWindows(int[]) is not fully supported by the driver.

Parameters:

windowId - The window to be changed.

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

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

notifyWait
```
default 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.

getBasicWebPalette
```
default 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.

Returns:

the set of RGB values as integers for the entries to be overwritten.

setWidgetAttribute
```
boolean setWidgetAttribute(int widgetId,
                           java.lang.String attr,
                           java.lang.String val)
```
Set an attribute for a widget implemented at the driver level. These are custom attributes which have no counterpart at the FWD client side.
This works only for GUI drivers.

Parameters:

widgetId - The widget ID.

attr - The attribute name.

val - The attribute's value.

Returns:

true if setting this attribute completed.

invokeWidgetCommand
```
java.lang.Object invokeWidgetCommand(int widgetId,
                                     java.lang.String command,
                                     java.lang.Object[] args)
```
Invokes command on a widget implemented at the driver level.

Parameters:

widgetId - Widget id.

command - The command to invoke.

args - Optional event arguments.

Returns:

the event return value.

invokeWidgetCommand
```
java.lang.Object invokeWidgetCommand(int widgetId,
                                     java.lang.Enum command,
                                     java.lang.Object[] args)
```
Invokes command on a widget implemented at the driver level.

Parameters:

widgetId - Widget id.

command - The command to invoke.

args - Optional event arguments.

Returns:

the event return value.

createWidget
```
void createWidget(java.lang.String type,
                  int widgetId)
```
Create a driver-implemented widget.

Parameters:

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

widgetId - The widget ID to be set.

createWidget

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

Create a driver-implemented widget.

Parameters:: widgetClass - The widget class.; widgetId - The widget ID to be set.

destroyWidget
```
void destroyWidget(int widgetId)
```
Destroy the driver-specific widget.

Parameters:

widgetId - The widget ID.

placeWidget
```
void placeWidget(int widgetId,
                 NativeRectangle bounds)
```
Place the driver-specific widget at the specified bounds, using the currently selected window.

Parameters:

widgetId - The widget ID.

bounds - The widget's boundaries.

changeVisibility
```
void changeVisibility(int widgetId,
                      boolean visible)
```
Change the visibility of a driver-implemented widget.

Parameters:

widgetId - The widget ID.

visible - The visibility state.

changeSensitivity
```
void changeSensitivity(int widgetId,
                       boolean sensitive)
```
Change the sensitivity of a driver-implemented widget.

Parameters:

widgetId - The widget ID.

sensitive - The enabled state.

getDriverWidget
```
DriverWidget getDriverWidget(int widgetId)
```
Returns driver widget from the supplied id.

Parameters:

widgetId - Widget id.

Returns:

driver widget instance or null.

Interface GuiDriver<F,I>

Method Summary

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

Method Detail

translatePush

translatePop

drawStringWithMnemonic

fitStringWithEllipsis

drawStringWithinBoxWithMnemonic

drawStringWithinBox

drawStringWithinBoxScaled

drawString

drawStringCentered

drawStringScaled

drawStringCentered

getParagraphHeight

drawParagraph

drawLine

drawIbeam

drawRect

drawRoundRect

fillRect

fillRectAroundText

fillRoundRect

drawEllipse

fillEllipse

drawSelection

drawTextSelection

drawEdge

resetSelection

initDragAndDrop

setUploadFileSizeLimits

fillPolygon

fill3DRect

draw3DRect

drawImage

getSubImage

drawHighlight

setColor

setColor

setDesktopBgColor

setXORComposite

setXORMode

resetComposite

setTitle

setGuiFont

scaleFont

setFontStyle

setLineStroke

setLineStroke

resizeWindow

setWindowBounds

hasWindowEmulator

registerWindow

registerChildWindow

deregisterWindow

selectWindow

withSelectedWindow

releaseWindow

saveDrawingState

restoreDrawingState

setWindowLocation

setResizeableWindow

getWindowLocation

createGreyImage

createFont

isFontInstalled

getFontWidth

getFontMaxWidth

getFontWidths

getFontHeight

getTextWidth

cacheTextMetrics

needsExplicitTextMetricsCaching

getTextHeight

setWindowVisible

setWindowEnabled

iconifyWindow

deiconifyWindow

getWindowDimension