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

java.lang.Object
- com.goldencode.p2j.ui.chui.ThinClient

All Implemented Interfaces:

StateSynchronizer, Watcher, ClientExports, ClientStorage, KeyValueStorage, ObjectStorage, AdvanceListener, CloseListener, FlushListener
```
public class ThinClient
extends java.lang.Object
implements ClientExports, StateSynchronizer, Watcher, CloseListener, AdvanceListener, FlushListener
```
Thin Client generic CHUI driver.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`ThinClient.HidingProcessor` Widget/frame hiding processor
`private static class`	`ThinClient.State` Stores the triggered widget and the events code.
`static class`	`ThinClient.TriggerResult` Container for the flags related to trigger processing.
`private static class`	`ThinClient.WaitForOp` Container for data related to wait-for loops.

Field Summary

Fields
Modifier and Type	Field and Description
`private ComboBox`	`activeComboBox` Combo-box with active drop-down.
`private boolean`	`afterChoose` Force automatic clearing.
`private boolean`	`authMode` Authentication mode flag.
`private boolean`	`batchMode` Flag indicating the UI client is in batch mode.
`private static boolean`	`bypassDefaultWindowShowInPauseNoMessage` Configurable flag to bypass default-window showing after pause x no-message
`private java.lang.Runnable`	`cleanupBlock` Pause cleanup block.
`private java.lang.Object`	`cleanupSynchronizer` Synchronization object for pause/Ctrl-C handling.
`private ClientParameters`	`clientParameters` The client parameters.
`private ClientStorage`	`clientStorage` Client storage.
`private static ValuesCounter`	`COM_EVENT_TIME_COUNTER` This variable represents an instance of the ValuesCounter class for measuring and tracking the time taken for COM event handlers to execute.
`private boolean`	`condExit` Set to `true` when condition exception may be thrown.
`private int`	`conditionalFrameId` Tracks the frame ID associated with the conditional up or down.
`private int`	`conditionalUpDown` Tracks any conditional up or down that must be applied.
`private boolean`	`consumeNextMouseClick` Flag indicating that the next mouse left click event must be ignored.
`private BlockingOperation`	`currentBlockingOp` Track the type of the current blocking operation.
`private EventList`	`currentEventList` Current active wait list.
`private int`	`currentStream` Tracks the id of the current output stream (-1 for interactive).
`private Widget`	`currentTarget` The target focus widget for the current BlockingOperation
`private int`	`currentWindowId` Id of the window as specified in the IN WINDOW option of the current blocking operation
`private boolean`	`cursorVisible` Cache of the cursor visibility.
`private java.lang.Thread`	`dedicatedThread` When running in the server process, this is the user's thread.
`private java.util.Set<java.lang.Integer>`	`deferredCleanup` Tracks pseudo-terminals which need deferred cleanup processing.
`private java.lang.String[]`	`directUploadFiles` Array of files just directly uploaded or selected
`private int`	`directUploadsModcount` Variable used to track modification count for the direct uploads list
`private boolean`	`directUploadStatus` Represents the status of the last direct upload process
`private boolean`	`disableRedraw` Holds the state of the SESSION:DISABLE-REDRAW attribute.
`private Widget<?>`	`downMouseButtonNewFocus` The new focused widget after the left button was pressed.
`private Widget<?>`	`downMouseButtonOldFocus` The old focused widget before the left button was pressed.
`private static boolean`	`dynamicLayoutEnabled` Flag indicating whether dynamic layout is enabled.
`private Stack<Widget>`	`editingFocus` Stack of prior focus before an editing block started.
`private java.util.Deque<Frame>`	`editingFrames` Stack of frames targeted by editing blocks.
`private java.util.LinkedList<DirectUploadDef>`	`effectiveDirectUploads` Represents a list of effective direct upload definitions
`private static java.lang.String`	`END_ERR_MSG` Exception message used in END-ERROR key processing.
`private java.util.Map<Widget,Widget>`	`entrySourceOnLeaveMap` Contains pairs of the ENTRY source widget and its next tab widget that obtains the focus on APPLY "LEAVE" to the ENTRY source widget with RETURN NO-APPLY.
`private java.lang.String`	`envVersion` Gets the current version string of the Progress compatible environment.
`private Stack<EventList>`	`eventLists` Stack of event lists saved between editing blocks.
`private FileSystem`	`fileSystem` Managed file system.
`private FocusManager`	`focusManager` `FocusManager` instance.
`private FillIn`	`focusToRestoreFillIn` Saving the last focused widget before choose()
`private static boolean`	`forceDialogsInCenter` Configurable flag to force dialog positioning in the center.
`private boolean`	`forceWipeScreen` Force wiping of the screen from PUT SCREEN artifacts on next frame hiding.
`private int`	`functionKey` Contains the action code of the last key input event.
`private boolean`	`hadPause` Flags if the current operation had an implicit or explicit pause.
`private boolean`	`hadReset` Track resetTerminal usage in editing blocks.
`private boolean`	`helpActive` Track HELP function activity
`private boolean`	`honorPBH` Flag that determines if pause before hide mode is active.
`private java.util.Stack<MouseHoverAction>`	`hovers` Active hovers stack
`private java.util.Map<java.lang.String,java.net.URI>`	`htmlBrowserWhitelist` Session-level cache of normalized urls of the HTML browser whitelist
`private boolean`	`ignoreNextStopEditing` Control editing mode processing.
`private ConditionException`	`immediateException` An exception which causes all trigger processing recursions to be terminated.
`private boolean`	`implicitApplyNoTrigger` Track APPLY with implicit target usage and there is no focus.
`private boolean`	`inEditingBlock` Track editing block usage.
`private boolean`	`inEnable` If `true` then `enable(..)` function is being run.
`private int`	`inputActive` Track input mode.
`private java.lang.String`	`inputDefaultText` Default status message displayed when input operation is active.
`private boolean`	`inRowDisplayTrigger` Flag indicating if a ROW-DISPLAY event is being executed.
`private int`	`interactions` Tracks the number of I/O interactions within the current block
`private boolean`	`is3D` THREE-D value for this session.
`private java.lang.Boolean`	`isDataEntryReturn` The state of SESSION:DATA-ENTRY-RETURN attribute
`private int`	`isGoPending` Number of times when we've found that the GO event is pending.
`private boolean`	`isImmediateDisplay` The state of SESSION:IMMEDIATE-DISPLAY attribute
`private boolean`	`isWaitState` wait-state flag
`private boolean`	`keep3DFillinBorder` The effective value of the keep3DFillinBorder environment variable.
`java.util.Set<java.lang.Integer>`	`keyboardState` Track currently pressed keys
`private int`	`lastActionCode` Contains the action code of the last key input event.
`private int`	`lastAppliedCode` The action code currently being applied by the apply() method.
`private Editor`	`lastEditorDisplayed` Track the last displayed and enabled editor widget.
`private Event`	`lastEvent` Last OS event received to be used as LAST-EVENT properties source.
`private Frame`	`lastExposedFrame` Last frame, which was made visible
`private int`	`lastKey` Last key received from the keyboard.
`private int`	`lastKeyState` Last extended key state received from the keyboard.
`private long`	`lastRepaintFlush` The last time the repaints were processed in `processRepaints()`.
`private Frame`	`lastViewed` Last frame which was displayed.
`private boolean`	`leaveSent` Tracks the LEAVE event sent status
`private static ContextLocal<ThinClient>`	`local` Context local instance of this class.
`private java.util.Optional<MousePtrWrapper>`	`lockedMousePointer` Locked mouse pointer
`private static CentralLogger`	`LOG` Logger.
`private java.lang.String`	`loginPageAddress` Login page address.
`private static LegacyLogManagerClientServiceImpl`	`logManagerService` Client LOG-MANAGER service
`private static java.lang.Object`	`logToken` Token used to authenticate with the dispatcher when registering APIs.
`private EmailDaemon`	`mailer` Email daemon.
`protected boolean`	`messageClearQuirk` Flag which controls behavior of message clear quirk simulation.
`private int`	`modalActive` Counter of nested modal UI elements (alert box, system file and print dialog, etc.).
`private static java.lang.Object`	`modToken` Token used to authenticate with the dispatcher when registering APIs.
`private java.util.Map<java.lang.String,MousePtrWrapper>`	`mousePointers` Custom mouse pointers by name
`private long`	`multitaskingInterval` The value of SESSION:MULTITASKING-INTERVAL attribute.
`private boolean`	`needPause` Pause before hide state flag.
`private int`	`nesting` External procedure call nesting.
`(package private) boolean`	`nextViewDisplay` `false` has no effect.
`(package private) boolean`	`nextViewRefresh` `false` has no effect.
`private Stack<java.lang.Boolean>`	`oldcursor` Stores the state of the cursor at the time input mode was activated.
`private java.lang.String`	`osUserName` Currently associated OS user name.
`private java.util.Map<java.lang.Integer,PageElement>`	`pageElements` Tracks all page elements which are active.
`private static java.lang.String`	`PBE_DEFAULT_TEXT` Default pause before end message text.
`private static java.lang.String`	`PBH_DEFAULT_TEXT` Default pause before hide message text.
`private ProcessDaemon`	`pd` Process daemon.
`private boolean`	`pendingCursorReset` Flag to notify server side for cursor resetting.
`private Widget`	`pendingFocus` Save pending focus (to which will be adjusted to on the next wait-for loop.
`private Widget`	`pendingFocusApply` Save pending focus, when focus is disabled or hidden.
`private java.util.Map<java.lang.Integer,java.util.List<InvocationEvent>>`	`pendingInvocationEvents` Postponed invocation events.
`private MouseHoverAction`	`recentlyHovered` Most recent hovers action
`private CoordinatesConversion`	`redirectedConversion` The coordinates conversion implementation used when the output is redirected.
`private java.util.Map<java.lang.Integer,RedirectedTerminal>`	`redirections` Tracks pseudo-terminals used for redirecting output to a stream.
`private boolean`	`refreshQuirk` Control behavior of some wipe-out quirks.
`private java.util.ArrayList<java.lang.Integer>`	`removedFrames` List of frames which should be deleted at server.
`private long`	`repaintInterval` The repaint flush interval, in milliseconds.
`private java.util.Map<WidgetId,java.util.Set<PaintEvent>>`	`repaints` A cache of `repaints`, per each generating window ID.
`private java.util.Map<java.lang.Integer,java.lang.Integer>`	`rowDisplayEvents` Current registered ROW-DISPLAY events.
`private Stack<java.lang.Integer>`	`savedInsStateInitials` The stack of saved insert indicator states.
`private Stack<java.lang.Integer>`	`savedInsStates` The stack of saved insert indicator states.
`private int`	`savedTermRedir` The ID of the saved redirected terminal stream.
`private StreamDaemon`	`sd` Stream daemon (provides access to streams by id).
`private ServerExports`	`server` Server exports
`private static java.lang.Object`	`sessToken` Token used to authenticate with the dispatcher when registering APIs.
`private SigintWaiter`	`sigintThread` Waiter thread for SIGINT incoming.
`private boolean`	`skipCaretDraw` Flag indicating if caret draw is skipped on next cursor positioning, after a wait-for loop iteration.
`private StartupParameters`	`startupParameters` Startup parameters.
`private static java.lang.String`	`storageId` The unique id for the client storage.
`private java.util.Map<PageElement,java.util.Set<Stream>>`	`streamMap` Tracks the streams in which a given page element is registered.
`private boolean`	`suppressWarnings` Flag to indicate if the warnings should be suppressed
`private java.lang.String`	`textPBH` Text displayed while processing pause before hide.
`private int`	`timePBH` Pause before hide time for automatic frame hiding (in milliseconds).
`private java.util.concurrent.ScheduledExecutorService`	`timer` Timer service for asynchronous execution on the OS queue
`private OutputManager`	`tk` Reference to `OutputManager` instance.
`private Stack<java.lang.Boolean>`	`triggerHadApplyEntry` Contains `true` if the last trigger (on this level) had `APPLY "entry"` call for an explicit target.
`private Stack<java.lang.Boolean>`	`triggerHadWaitFor` Contains true if the last trigger (on this level) did execute a nested wait-for loop.
`private int`	`triggerNesting` Level of nesting (recursion) that exists with trigger processing.
`private Stack<java.lang.Integer>`	`triggerNestingByWaitFor` Contains levels of trigger nesting relative to active WAIT-FOR cycles.
`private Stack<java.lang.Boolean>`	`triggerResultNoApply` Contains true if the last trigger result (on this level) returned no-apply.
`private Stack<ThinClient.State>`	`triggersContext` The stack of triggers context that holds information about the triggered widget and its event.
`private TypeAhead`	`typeAhead` Key reader and type ahead buffer processor.
`private boolean`	`underWindows` Flag indicating if the client is running in windows compatibility mode.
`private static boolean`	`useLocalStorage` Flag to indicate if localStorage needs to be used for client storage in web.
`private java.lang.String`	`validationError` Validation message from last failed validation operation.
`boolean`	`viewDisplay` This view displays frame data
`(package private) boolean`	`viewInProgress` This flag is on for the duration of view operation
`boolean`	`viewRefresh` This view refreshes the frame including decorations
`private java.util.Deque<ThinClient.WaitForOp>`	`waitForFrames` Stack of frames targeted by WAIT-FOR statements.
`private java.util.ArrayList<java.lang.Integer>`	`wrappedFrames` List of DOWN frames which were wrapped.
`private java.util.Map<MousePointer,MousePtrWrapper>`	`wrappers` Map pre-defined pointers to corresponding wrappers

Fields inherited from interface com.goldencode.p2j.ui.client.Watcher
CLEAR_AND_QUEUE, IGNORE, QUEUE

Constructor Summary

Constructors
Modifier Constructor and Description

private ThinClient()
Constructor.

Constructors
Modifier	Constructor and Description
`private`	`ThinClient()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activateBatchMode(boolean on)` Changes the activation flag for batch mode driver if loaded.
`void`	`activateConfigUpdates()` Inform the client-side that it can start sending the config updates.
`void`	`activatePopUpMenu(int menuId, int64 x, int64 y)` Deprecated.
`void`	`activateTooltipForWidget(int wId)` Activates tootip feature for particular widget.
`private void`	`activateWindow()` The method implements window activation when a blocking operation is executed.
`ComboBox<?>`	`activeComboBox()` Get the combo-box with active drop-down.
`void`	`addDroppedFileName(java.lang.String fileName)` Adds next file name to the list of the dropped files.
`void`	`addDroppedFileName(java.lang.String fileName, int index)` Adds file name to the list of the dropped files at specified index .
`int`	`addGlobalImage(int wId, java.lang.String imgFile, byte[] data)` Loads the supplied image from the file name if data `null`, and registers the image with `ImageHelper.addGlobalImage(int, ImageWrapper)`.
`private void`	`addGoPending()` Increments isGoPending.
`private boolean`	`adjustFocusBeforeProcessing(boolean explicit, Widget saveFocus, Widget focusFrame, int focusState, boolean frameChangeEvent)` Adjust focus before processing event.
`private void`	`adjustFocusForTriggerMode(Widget pending, boolean isPendingValid)` Adjust focus when processing nested triggers.
`void`	`adjustFontTableSize(int numEntries)` Set the number of entries in the font-table.
`private boolean`	`advanceCursor(int steps, boolean noPause, Frame frame)` Advance DOWN cursor.
`ScreenBuffer[]`	`apply(int widgetId, int eventCode, ScreenBuffer[] inbuf, EventList eventList, boolean explicit)` Applies the encoded event to the widget currently in focus in the given frame, or directly to the specified widget.
`void`	`apply(long resId, int eventCode, EventList eventList)` Apply this event to a non-widget resource.
`void`	`applyChanges(java.io.Externalizable changes)` Called by the protocol driver upon reading a message that contains state changes that need to be applied to this side of the connection.
`boolean`	`applyEnhancedConfig(int browseId, EnhancedBrowseConfig config)` Apply the given enhanced browse configuration to the given browse.
`void`	`applyEnhancedConfigClient(int browseId)` Run client-side part of the code which should be executed after an enhanced configuration is applied to the browse.
`void`	`applyMessageA(int hWnd, int msg, int wParam, int lParam, boolean sync)` Emulates `PostMessageA` and `SendMessageA` Win32 function by processing the message synchronous or asynchronous.
`private void`	`applyWidgetAttributes(int[] widgetAttrIds, java.lang.Object[] widgetAttrValues)` Applies widget attributes in the widget tree.
`private void`	`applyWorker(Event event)` Applies the encoded event to the widget currently in focus in the given frame, or directly to the specified widget.
`void`	`attachRuntimeWidget(int fid, int wid, WidgetConfig cfg)` Attach a widget to a frame, at runtime.
`void`	`bell()` Rings a bell on the terminal.
`boolean`	`cacheRepaint(WidgetId id, PaintEvent evt)` Cache the given `PaintEvent` so that it will be processed when the UI gets into a user-interactive state.
`int`	`calcBrowseDown(int browseId, int rowHeightPixels)` Calculate DOWN value for the browse basing on the given row height.
`Frame`	`callDialog(int windowId, java.util.function.Supplier<Frame> createDialog)` Create and display a dialog.
`private boolean`	`checkBreak(long resourceId, int evtCode)` Check active `EventList` instance for exit conditions for this event and resource pair.
`private boolean`	`checkBreak(Widget widget, int evtCode, boolean isKey)` Check active `EventList` instance for exit conditions for this event and widget pair.
`void`	`checkDeleteEntryRowIndex(int browseId)` Check that the current row can be deleted with DELETE-RESULT-LIST-ENTRY: the row should be existing and in the view.
`private boolean`	`checkForSystemEvent(KeyInput key)` Check if the given event can be treated by the focused widget on its own.
`private static void`	`checkHelpText(Widget focus)` Check help text and restore it if necessary.
`ChooseData`	`choose(int frameId, ChooseData c, EventList wl)` Performs CHOOSE processing.
`int`	`chooseColor(int rgbColor, int windowId)` Change the specified color, in the user's environment.
`java.lang.Integer`	`chooseColorIndex(java.lang.Integer colorIndex, int windowId)` Select a color from the color table of the target window.
`ChooseFileResult`	`chooseFile(int windowId, java.lang.String path, java.lang.String title, boolean findDirectories, boolean saveAs, boolean askOverwrite, boolean mustExist, boolean createTestFile, boolean returnToStartDir, boolean useFilename, java.lang.String defaultExtension, java.lang.String initialDir, java.lang.String[] filters, int initialFilter, boolean multiple, boolean atWebBrowser, boolean upload, java.lang.String uploadDir)` Displays the `File Selection` dialog box and prompt the user to select a file with configured constraints set by the options of the `SYSTEM-DIALOG PRINTER-SETUP` statement.
`FontDetails`	`chooseFont(FontDetails<?> font, java.lang.Integer fontNum, int windowId, boolean ansiOnly, boolean fixedOnly, int minSize, int maxSize)` Select font details using the font selection dialog.
`boolean`	`chooseFont(int fontNum, int windowId, boolean ansiOnly, boolean fixedOnly, int minSize, int maxSize)` Change the specified font, in the user's environment.
`private ChooseData`	`chooseWorker(ChooseData c, EventList wl, Frame frame, Widget[] comps, int toFocusId)` CHOOSE processor.
`private void`	`cleanUp(EventList save, int oldGoPending, boolean saveLeaveSent, boolean curvis)` Convenience function used inside `waitForWorker(EventList, int, int, ScreenBuffer[], boolean, boolean, boolean, BlockingOperation, int)`
`void`	`cleanupPseudoTerminal(int id)` Called when a stream is closed to ensure that any terminal resources associated with that id are cleaned up.
`private void`	`cleanupQueue()` Process events internally if there are no interactive requests from the server.
`ScreenBuffer[]`	`clear(int frameId, boolean noPause)` Clears the data and colors for all fill-in fields of the frame.
`ScreenBuffer[]`	`clearAll(int frameId, boolean noPause)` Clears all occurrences for the down frame and resets the current display position to the top of the frame.
`private ScreenBuffer`	`clearAll(int frameId, boolean noPause, boolean resolveBuffer)` Clears all occurrences for the down frame and resets the current display position to the top of the frame.
`void`	`clearDroppedFiles()` Remove all dropped file names.
`private void`	`clearFrame(int frameId, boolean conditional, Frame frame, boolean down)` Clear frame.
`void`	`clearSavedInsState()` Clears saved insert mode.
`private void`	`clearTerminal()` Clears all content from the terminal.
`(package private) ScreenBuffer`	`clearWorker(Frame frame, boolean noPause, boolean clearAll, boolean resolveBuffer)` Clear specified frame widgets.
`private Widget`	`computeFocus(boolean frameAsTarget)` Compute the next focus in a wait-for loop.
`void`	`conditionalLineRefresh(Rectangle rect)` Conditionally refresh specified horizontal lice described by provided rectangle.
`void`	`conditionalRefresh(Rectangle rect)` Conditionally refresh specified rectangle not occupied by frames.
`ContinueEditingResult`	`continueEditing(boolean hadNext)` Checks to see whether a pending GO event is about to end the editing block.
`private MousePtrWrapper`	`createMousePointer(java.io.InputStream data, java.lang.String ptrName)` Create mouse pointer from the binary data
`MousePtrWrapper`	`createPtrWrapper(MousePointer ptr)` Create wrapper for the pre-defined cursor
`void`	`deactivateTooltipForWidget(int wId)` Deactivates tootip feature for particular widget.
`void`	`debug(int id, java.lang.String message)` Utility method for debugging, can be used to include information from the server-side to the client-side log
`void`	`delete(java.lang.String key)` Deletes the given key and its value from the client storage.
`void`	`deleteDynamicWidget(int fid, int wid)` Delete and detach a widget from a frame, at runtime.
`java.lang.Boolean`	`deleteEditorLine(int id)` Delete the line of text in which the targeted editor's cursor currently resides.
`boolean`	`deleteFromControlSet(int widgetId, int idx)` Delete item from `ControlSetEntity`.
`void`	`deregisterMouseActions(java.util.Collection<MouseWidgetAction> toRemove)` Remove all registered mouse hover actions provided in the argument list.
`void`	`deregisterPageElement(int frameId, boolean header)` Deregister (remove) the frame as a header or footer from the stream that is the current redirected terminal output destination.
`void`	`deregisterPageElement(int frameId, boolean header, int streamId)` Deregister (remove) the frame as a header or footer from the given stream.
`void`	`deselectFocusedRow(int browseId)` Implements the DESELECT-FOCUSED-ROW() BROWSE widget method.
`void`	`deselectRows(int browseId)` Implements the DESELECT-ROWS() BROWSE widget method.
`boolean`	`deselectSelectedRow(int browseId, int rowIndex)` Implements the DESELECT-SELECTED-ROW() widget method.
`void`	`destroyFrame(int frameId)` Destroy the frame and free associated resources as needed.
`void`	`displayAndDown(int widgetId, ScreenBuffer[] frameBuf, int[] widgetIds, int streamId, boolean register, boolean pageTop, int windowId, int[] tabItemList)` Support for the DISPLAY followed by DOWN combination.
`void`	`displayError(java.lang.String errmsg, boolean noMessageBox, java.lang.String[] stack, boolean logCallStack)` Displays the error message via current client side error writer.
`void`	`displayError(java.lang.String errmsg, boolean noMessageBox, java.lang.String[] stack, boolean logCallStack, boolean isFromLogManager)` Displays the error message via current client side error writer.
`void`	`displayErrorMessage(java.lang.String text)` Displays an error message.
`void`	`displayErrorMessage(java.lang.String text, boolean noMessageBox)` Displays an error message.
`void`	`displayErrorMessage(java.lang.String text, boolean noMessageBox, java.lang.String[] stack, boolean logCallStack)` Displays an error message.
`void`	`displayErrorMessage(java.lang.String text, boolean noMessageBox, java.lang.String[] stack, boolean logCallStack, boolean isFromLogManager)` Displays an error message.
`void`	`displayErrorRedirected(java.lang.String errmsg)` Displays the error message via current client side error writer.
`void`	`displayWarning(java.lang.String wrnmsg)` Displays the warning message via current client side error writer.
`void`	`displayWarningMessage(java.lang.String text)` Displays a warning message.
`void`	`doInteractive(java.lang.Runnable run)` This is a helper method for wrapping the supplied code fragment between the calls to `forceInteractive()` and `restoreRedirection(int)`.
`<T> T`	`doInteractive(java.util.function.Supplier<T> run)` This is a helper method for wrapping the supplied code fragment between the calls to `forceInteractive()` and `restoreRedirection(int)`.
`WidgetConfig[]`	`down(int frameId, int lines, boolean cond, int sid)` Positions the cursor on a new line in a down frame.
`WidgetConfig[]`	`down(int frameId, int lines, int streamId, boolean cond, boolean endOut)` Positions the cursor on a new line in a down frame.
`private boolean`	`downWorker(int frameId, int steps, boolean conditional, boolean newStream, boolean noPause)` Positions the cursor on a new line in a down frame.
`boolean`	`editCopySelection(int id, boolean cut)` Copies the currently selected text from an Editor, Fill-In or ComboBox to Clibpoard.
`boolean`	`editorReadFile(int wId, java.lang.String name)` Loads the file from the client side filesystem.
`boolean`	`editorSaveFile(int wId, java.lang.String name)` Save the content in the widgets in the client side filesystem.
`boolean`	`editPaste(int id)` Paste the Clipboard content into an Editor, Fill-In or ComboBox starting with current cursor position.
`boolean`	`editUndo(int id)` Undo the last changes in text editable widget if possible.
`BaseDataType[]`	`emitComEvent(int widgetId, java.lang.String eventName, BaseDataType... args)` Emits the supplied COM event.
`ScreenBuffer[]`	`enable(int frameId, int[] widgetId, ScreenBuffer[] sb, boolean enabled, int windowId, boolean resolveBuffer, int[] tabItemList)` Enables/disables input for all specified field-level widgets of the frame.
`ScreenBuffer[]`	`enable(int frameId, int[] widgetId, ScreenBuffer[] sb, boolean enabled, int windowId, int[] tabItemList)` Enables/disables input for all specified field-level widgets of the frame.
`ScreenBuffer[]`	`enable(int frameId, int widgetId, ScreenBuffer[] sb, boolean enabled, int windowId, int[] tabItemList)` Enables/disables input for the specified field-level widget.
`private void`	`enableChooseWidgets(ChooseData c, Widget[] list)` Enable widgets involved in CHOOSE.
`private static void`	`enableFillInAutoZap(Widget widget)` Activate AUTO-ZAP mode for widget if it a FillIn instance in ChUI mode.
`private void`	`enableWorker(int[] widgetId, ScreenBuffer[] sb, boolean enabled, Widget focus, Frame frame, boolean preview, int windowId)` Widget enabling worker.
`boolean`	`endFileDrop()` Terminates file dropping operation and clean up resources.
`private void`	`endOutput(int sid)` Force the given stream to output any buffered PUT or EXPORT content, so long as the stream is not the terminal.
`(package private) void`	`endWidgetOutput()` Mark end of widget output.
`private void`	`enterChoose(ChooseData c, Frame frame, java.lang.Integer[] focusId, Widget[] comps)` Start CHOOSE processing.
`boolean`	`eventBracket(boolean discard, java.lang.Runnable code)` Execute the given code inside a new bracket of event processing which starts with a `push()` and ends with a `pop()` or `popTrash()` even if the executed code throws an exception.
`boolean`	`eventBracket(java.lang.Runnable code)` Execute the given code inside a new bracket of event processing which starts with a `push()` and ends with a `pop()` even if the executed code throws an exception.
`boolean`	`eventDrawingBracket(Widget<?> widget, boolean discard, boolean flush, java.lang.Runnable code)` Execute the given code inside a new bracket of event processing which starts the toolkit capturing invalidation rectangles, then starts a new event bracket with a `push()`, executes the code and then ends with a `pop()` (or `popTrash()`) and finally disables invalidation mode.
`(package private) boolean`	`eventDrawingBracket(Widget<?> widget, boolean discard, java.lang.Runnable code)` Execute the given code inside a new bracket of event processing which starts the toolkit capturing invalidation rectangles, then starts a new event bracket with a `push()`, executes the code and then ends with a `pop()` (or `popTrash()`) and finally disables invalidation mode.
`boolean`	`eventDrawingBracket(Widget<?> widget, java.lang.Runnable code)` Execute the given code inside a new bracket of event processing which starts the toolkit capturing invalidation rectangles, then starts a new event bracket with a `push()`, executes the code and then ends with a `pop()` and finally disables invalidation mode.
`void`	`executePendingRefresh(int browseId, boolean queryReopened, boolean repositionBeforeReopen, int repositionedRow)` Execute pending refresh when REFRESHABLE is turned on.
`private static java.util.List<Frame>`	`extractFrames(java.util.Deque<ThinClient.WaitForOp> waitForOps)` Extract the frames from the stack of wait-for event loops.
`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.
`java.lang.Integer`	`findTreeNodeByRelativeCoordinates(int treeId, int x, int y)` Find a node id in the given tree under the mouse pointer given by coordinates relative to the container itself.
`java.lang.Integer`	`findWidgetByCoordinates(int containerId, int x, int y)` Find a widget in the given container under the mouse pointer given by coordinates relative to the owner window.
`void`	`finishDirectUpload(int uploadId, java.lang.String[] files, boolean result)` Finishes a direct upload for a given upload ID, updating the provided files and result.
`private void`	`fixFocusedFrameZOrder()` Fix possible Z-ordering issues.
`private void`	`fixWaitForFocus(int cop, Widget<?> saveFocus, Widget<?> savePending, int focusState, int pendingState)` Fix the focus after a event loop has finished, regradless if a condition was raised or not.
`void`	`flushEnqueuedWidgetAttrs()` This method is called when widget attribute changes must be sent to the client.
`private int`	`flushNow(int steps, Stream stream)` Perform immediate stream flush.
`private int`	`flushRedirected(Stream stream, boolean bypass)` Flushes all buffered output to the redirected output stream (does nothing if output is not redirected).
`void`	`flushRepaints(boolean force)` Flush the repaints, considering the state of the `repaintInterval`, `isImmediateDisplay` and `multitaskingInterval` values.
`void`	`flushStream(Stream out)` Push any pending output from the redirected terminal to the stream and then flush the stream.
`void`	`focusAndSelect(int widgetId)` Sets focus to widget and selects all current content.
`int`	`fontTableSize()` Get the number of entries in the font-table.
`void`	`forceDeregisterPageElement(int frameId)` Deregister (remove) the frame either as a header or footer from all streams in which it is registered.
`void`	`forceDeregisterPageElement(int frameId, boolean header)` Deregister (remove) the frame as a header or footer from all streams in which it is registered.
`private void`	`forceFrameDraw(RedirectedTerminal rt, int frameId, int streamId)` Force the given frame to output to the given stream in redirected mode.
`int`	`forceInteractive()` Switch the terminal into interactive mode if it is redirected.
`static int`	`frameIdFromWidgetId(int widgetId)` Retrieve the ID of the frame containing the widget with a given ID.
`int`	`getActiveFrame()` Returns the ID of the currently active frame.
`Frame`	`getActiveFrameInt()` Get reference to active frame.
`java.lang.Boolean`	`getBoolean(java.lang.String key)` Retrieves the boolean value of the given key from the client storage.
`int`	`getBrowseCacheSize(int browseId)` Get the number of entries visible in the browse.
`int`	`getBrowseColumnY(int browseId)` Get value of `column.Y` attribute for the columns of this browse: vertical offset of the current row from the top of the browse, in pixels for GUI or in chars for ChUI.
`int`	`getBrowsePageRowCount(int browseId)` Get number of rows in the browse viewport set either by DOWN or SIZE options.
`java.io.Externalizable`	`getChanges()` Called by the protocol driver to obtain the latest state that should be sent to the other side of the connection.
`EnhancedBrowseConfig[]`	`getClientEnhancedConfigs(EhBrowseConfigKey[] keys)` Get enhanced browse configurations stored on the client side.
`static ClientParameters`	`getClientParameters()` Get the `clientParameters`.
`ClientStorage`	`getClientStorage()` Gets the client storage.
`character`	`getClipboardValue()` Exposes the client's system clipboard to the server.
`java.lang.String[]`	`getColumnFiltersMappedDataTypes(int browseId)` For enhanced filtering: get data types of the fields mapped using `DB-FILTER-FIELD-MAPPING`.
`EventList`	`getCurrentEventList()` Gets the current event list.
`Stream`	`getCurrentRedirection()` Get the stream to which the terminal is redirected or `null` if no redirection is currently in effect.
`int`	`getCurrentRow(int browseId)` Get current row in the query.
`int`	`getDialogExtraHeight()` Get the theme specific extra pixels difference value for fialog frame height.
`int`	`getDialogExtraWidth()` Get the theme specific extra pixels difference value for fialog frame width.
`int`	`getDirectUploadsModcount()` Retrieves the modification count of the list of effective direct upload definitions.
`NativeRectangle`	`getDisplayBounds(int windowId)` Returns display size.
`int`	`getDisplayHeight(int windowId)` Returns display height in native.
`int`	`getDisplayWidth(int windowId)` Returns display width in native units.
`NativeRectangle`	`getDisplayWorkArea(int windowId)` Returns an application-usable display area.
`int`	`getDisplayWorkAreaHeight(int windowId)` Returns the height of the application-usable display area.
`int`	`getDisplayWorkAreaWidth(int windowId)` Returns the width of the application-usable display area.
`int`	`getDisplayWorkAreaX(int windowId)` Returns the X coordinate of the application-usable display area.
`int`	`getDisplayWorkAreaY(int windowId)` Returns the Y coordinate of the application-usable display area.
`java.lang.String`	`getDroppedFile(int index)` Gets the name of the dropped file from internal 1-based list list.
`private ScreenBuffer[]`	`getEditableClientScreenBuffers()` Retrieves the editable screen buffers.
`private ScreenBuffer[]`	`getEditableClientScreenBuffers(ScreenBuffer sbDefault)` Prepares the array of the screen buffers to pass to the server when calling the server export methods to be able the screen buffer synchronization.
`private ScreenBuffer[]`	`getEditableClientScreenBuffers(ScreenBuffer sbDefault, boolean onlyChildren)` Prepares the array of the screen buffers to pass to the server when calling the server export methods to be able the screen buffer synchronization.
`ScreenBuffer[]`	`getEditableClientScreenBuffers(Widget widget)` Prepares the array of the screen buffers to pass to the server when calling the server export methods to be able the screen buffer synchronization.
`WidgetConfig[]`	`getEditorsConfigs(int browseId)` Get configurations of widgets used for in-browse editing (fill-ins, toggle-boxes or combo-boxes).
`DirectUploadDef`	`getEffectiveDirectUpload(int widgetId)` Retrieves the effective direct upload definition for the specified widget ID.
`java.util.List<DirectUploadDef>`	`getEffectiveDirectUploads()` Returns a list of effective direct uploads.
`private Widget`	`getEnablePendingFocus(Widget focus, int[] widgetId, boolean enabled)` Get widget which may receive focus after ENABLE.
`EnhancedBrowseSaveTarget[]`	`getEnhancedBrowseResetTargets(int browseId)` Get enhanced browse configuration reset targets available for the target browse and the current user.
`EnhancedBrowseSaveTarget[]`	`getEnhancedBrowseSaveTargets(int browseId)` Get save targets for an enhanced browse configuration, which are available for the current user.
`java.lang.String`	`getEnvVersion()` Getter for `envVersion`.
`FileSystem`	`getFileSystem()` Returns the client-managed file system.
`int`	`getFirstTabItem(int frameId, java.util.List<java.lang.Integer> widgetIDs)` Gets the first widget in the tab order from the widgets of specified list.
`int`	`getFocus()` Get ID of the widget which has the input focus.
`integer`	`getFocusedRow(int browseId)` Implements the FOCUSED-ROW attribute getter.
`FocusManager`	`getFocusManager()` Get the focus manager.
`int`	`getFontHeightPixels(int fontNum)` Get the height in pixels, of the specified font.
`java.lang.String`	`getFontKey(int fontNum)` Resolve the font key associated with the given font, in the current window's font-table.
`Frame`	`getFrame(int frameId)` Get frame widget from the given frame ID.
`double`	`getFrameCol(int frameId)` Returns the column position of the upper-left corner of the frame within its window (in coordinates that are relative to the containing window).
`int`	`getFrameDown(int frameId)` Returns the number of iterations in a down frame.
`static int`	`getFrameLine(Frame frame, int pendingUpDown)` Returns the current logical line number in a frame.
`int`	`getFrameLine(int frameId, int pendingUpDown)` Returns the current logical line number in a frame.
`double`	`getFrameRow(int frameId)` Returns the row position of the upper-left corner of the frame within its window (in coordinates that are relative to the containing window).
`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.
`java.lang.Integer`	`getHTMLBrowserLoadTimeout()` Retrieve the number of milliseconds to wait when loading a HTML web page.
`java.lang.String`	`getImageFileName(java.lang.String imageName)` Find the name of the image file in PROPATH appending possible exensions, if needed.
`int`	`getInputActive()` Get input active counter.
`java.lang.String`	`getInputDefaultText()` Resolve the input default text (if not already resolved) and return it.
`static ThinClient`	`getInstance()` Get the context-local instance of this class.
`KeyboardLayoutsSettings`	`getKeyboardLayoutsSettings()` Gets the supported keyboard layouts defined by the directory.
`int`	`getLastActionCode()` Returns the action code of the last key input event.
`int`	`getLastKey()` Get the last key, received form keyboard.
`Frame`	`getLastViewed()` Get the last viewed frame.
`static java.lang.String`	`getLocalFileName(java.lang.String name)` Locates a file name to load from local file system.
`java.lang.String`	`getLoginPageAddress()` Returns the web client login page address.
`int`	`getMessageLines()` Returns the number of screen lines available for message display.
`NativePoint`	`getMousePosition()` Returns current mouse cursor position relative to the screen origin.
`int[]`	`getMousePosition(int widgetId)` Returns current mouse cursor position relative to the provided widget id.
`int`	`getNextTabItem(int frameId, int widgetId)` Gets the widget that is the next from specified in the tab order.
`java.lang.Number`	`getNumber(java.lang.String key)` Retrieves the number value of the given key from the client storage.
`int`	`getNumDroppedFiles()` Gets the number of the dropped files.
`int`	`getNumSelectedRows(int browseId)` Getter for the NUM-SELECTED-ROWS attribute.
`<T> T`	`getObject(java.lang.String key, java.lang.Class<T> clazz)` Retrieves the object value of the given key from the client storage.
`OutputManager`	`getOutputManager()` Get input active counter.
`Widget`	`getPendingFocus()` Get `pendingFocus` widget.
`int`	`getPixelsPerColumn()` Get the PIXELS-PER-COLUMN value for this client session.
`int`	`getPixelsPerRow()` Get the PIXELS-PER-ROW value for this client session.
`int`	`getRowCount(int browseId)` Get the number of rows iterated by the query (for preselect queries - matches result size, for adaptive queries - matches the size of the part of the result set the query has already iterated over).
`int`	`getRowCount(int browseId, int startRow)` Get number of available rows starting from the given one.
`int`	`getRowDisplayTriggerId(int browseId)` Get ID of the ROW-DISPLAY trigger for the target browse.
`BrowseRow[]`	`getRows(int browseId, char searchChar, int searchColumn, int viewportTopRow, int viewportBottomRow, int rowDisplayTriggerId, ScreenBuffer[] sb)` This function is used when search by key is performed in a browse.
`BrowseRow[]`	`getRows(int browseId, int startRowIndex, int count, boolean forward, int rowDisplayTriggerId, ScreenBuffer[] sb, RowDisplayStrategy displayStrategy)` Retrieves several subsequent rows from the database.
`int`	`getSavedInsState()` Returns saved insert indicator state that should be applied to the next focused fill-in, or `-1` if there is no state to apply.
`private ScreenBuffer`	`getScreenBuffer(int frameId, boolean force)` Generate a copy of the `ScreenBuffer` instance for the given frame.
`private ScreenBuffer`	`getScreenBuffer(int frameId, boolean force, java.util.Set<WidgetId> widgets)` Generate a copy of the `ScreenBuffer` instance for the given frame.
`private ScreenBuffer`	`getScreenBuffer(Widget widget)` Generate a copy of the `ScreenBuffer` instance for the given frame or for the frame in which the given widget is contained.
`private ScreenBuffer`	`getScreenBuffer(Widget widget, java.util.function.Predicate<Frame> filter)` Generate a copy of the `ScreenBuffer` instance for the given frame or for the frame in which the given widget is contained.
`double`	`getScreenLines()` Returns the number of screen lines available for frame display (does not include the message or status lines).
`int`	`getSelectedRowIndex(int browseId, int n)` Retrieve the 0-based row index of the nth selected row in the given browse widget.
`int[]`	`getSelectedRowIndexes(int browseId)` Retrieve the row indexes of the selected rows in the given browse widget.
`int[]`	`getSelection(int widgetId)` Request indexes of selected items in RadioSet, ComboBox or SelectionList widgets.
`ServerExports`	`getServer()` Get the `ServerExports` instance.
`StartupParameters`	`getStartupParameters()` Startup parameters getter.
`java.lang.String`	`getStorageId()` Returns the storage id.
`java.lang.String`	`getString(java.lang.String key)` Retrieves the string value of the given key from the client storage.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getSupportedHelperApplications()` Gets the supported helper applications with their mime types.
`java.lang.String`	`getTerminalType()` Returns the terminal type.
`java.lang.String`	`getTextPBH()` Returns text displayed while processing pbh.
`int`	`getTextWidthPixels(java.lang.String txt, int fontNum)` Get the width of the specified text, in pixels, using the specified font.
`java.util.Map<java.lang.Integer,ColorRgb>`	`getThemeSystemPalette()` Obtain the default system palette for current theme from client.
`int`	`getTimePBH()` Returns pause before hide time for automatic frame hiding.
`int`	`getTriggerNesting()` Get trigger nesting.
`boolean`	`getUnderWindows()` Getter for `underWindows`.
`int[]`	`getUploadFileSizeLimits()` Gets the values for uploaded file size limits from server.
`java.lang.String`	`getUserName()` Returns the current user name for session.
`java.lang.String`	`getValidationError()` Returns the last validation error message.
`Widget`	`getWidget(int componentId)` Get `Component` instance for a given ID.
`Widget`	`getWidget(WidgetId componentId)` Get `Component` instance for a given ID.
`private void`	`handleFillInEntry(int eventCode, Widget inFocus)` Process event for `FillIn` widgets.
`void`	`handleNextPrevFrameEvents(Frame frame, boolean nextFrame)` Execute the NEXT-FRAME or PREV-FRAME event, depending on flag.
`private int`	`handleOutstandingNextPrompt(int toFocusId, int[] widgetIds)` Handle outstanding NEXT-PROMPT clause.
`boolean`	`hasRows(int browseId)` Gets a value that indicates whether the browse contains one or more rows (including new rows).
`boolean`	`hide(int widgetId, boolean noPause, boolean hidden)` Makes the specified frame or widget invisible.
`void`	`hideAll(boolean noPause, int windowId)` Hides all widgets and messages displayed in the message area.
`private boolean`	`hideFramesInt(Frame frame)` Internal method which hides frames if necessary and maintains global flag.
`void`	`hideMessage(boolean noPause, int windowId)` Hides all messages displayed in the message area.
`void`	`highlight(Widget widget, boolean state)` Changes the highlighted state of the widget and repaints it.
`java.lang.Integer`	`hitTest(int widgetId, int x, int y)` Get the TreeView node under mouse cursor.
`private void`	`honorConditionalUpDown()` Honor the deferred processing for a conditional up or down.
`private boolean`	`honorConditionalUpDown(boolean noPause)` Honor the deferred processing for a conditional up or down.
`int`	`idFromStream(Stream s)` Returns the stream ID associated with a given stream.
`boolean`	`independentEventDrawingBracket(Widget<?> widget, java.lang.Runnable code)` Execute the given code inside a new bracket of event processing which starts the toolkit capturing invalidation rectangles, then starts a new event bracket with a `push()`, executes the code and then ends with a `pop()` and finally disables invalidation mode.
`static void`	`initializePost(BootstrapConfig cfg, Session session, java.lang.Object context, StartupParameters startupParameters, java.lang.String iniFileName)` Initialize network services (must only be called after the user has been authenticated AND after `initializePrep(com.goldencode.p2j.cfg.BootstrapConfig)` has been called).
`static void`	`initializePrep(BootstrapConfig cfg)` Initialize core UI services and create or re-create the singleton instance of this class.
`void`	`initLogging(CentralLoggerClientConfig loggingConfig)` Indicates the server is ready to receive and handle logs and sends all logger levels.
`void`	`initOSResources()` Initializes the system resources.
`void`	`inputClear()` Clears the type-ahead buffer if the input source is the keyboard.
`java.lang.Boolean`	`insertEditorFile(int id, java.lang.String filePath)` Inserts the content of a file at the current cursor position of the targeted editor.
`java.lang.Boolean`	`insertEditorString(int id, java.lang.String txt)` Inserts string at the current cursor position of the targeted editor.
`boolean`	`insertRow(int browseId, boolean after)` Inserts a blank row in an updateable browse before or after the last selected row.
`void`	`invalidateLoggerLevels(CentralLoggerClientConfig loggerLevels)` Indicates a server change to logger levels.
`static void`	`invokeLater(java.lang.Runnable runnable)` Asynchronously executes the supplied runnable reference on the event thread.
`void`	`invokeLaterOS(boolean priority, java.lang.Runnable runnable)` Asynchronously executes the supplied runnable reference on the event thread.
`void`	`invokeLaterOS(java.lang.Runnable runnable)` Asynchronously executes the supplied runnable reference on the event thread.
`java.util.concurrent.ScheduledFuture<?>`	`invokeLaterOS(java.lang.Runnable runnable, long delay, java.util.concurrent.TimeUnit unit)` Asynchronously executes the supplied runnable reference on the event thread after the specified delay.
`void`	`invokeLaterOS(Widget source, java.lang.Runnable runnable, boolean pending)` Asynchronously executes the supplied runnable reference on the event thread after the caller's trigger has been completed if the "pending" flag is set on, otherwise it works according to `invokeLaterOS(Runnable)` without "pending" flag.
`java.lang.Object`	`invokeOnServer(java.util.function.Supplier<ServerReturnValue> code)` Invoke the specified server-side code, while maintaining any changes in the trigger registry.
`ThinClient.TriggerResult`	`invokeRowDisplayTrigger(int widgetId)` Check the `rowDisplayEvents` map for a ROW-DISPLAY trigger associated with this widget.
`ThinClient.TriggerResult`	`invokeTriggers(Widget widget, int evtCode, boolean isKey)` Check active `EventList` instance for triggers defined for this event and widget pair and activate the first one found.
`private ThinClient.TriggerResult`	`invokeTriggers(Widget widget, long resourceId, int evtCode, boolean isKey)` Check active `EventList` instance for triggers defined for this event and widget pair and activate the first one found.
`ThinClient.TriggerResult`	`invokeTriggers(Widget widget, Widget other, int evtCode, boolean isKey)` Check active `EventList` instance for triggers defined for this event and widget pair and activate the first one found.
`private ThinClient.TriggerResult`	`invokeTriggers(Widget widget, Widget other, long resourceId, int evtCode, boolean isKey)` Check active `EventList` instance for triggers defined for this event and widget pair and activate the first one found.
`ThinClient.TriggerResult`	`invokeTriggers(Widget widget, Widget other, long resourceId, int evtCode, boolean isKey, boolean specificWidget, Widget rowSourceWidget)` Check active `EventList` instance for triggers defined for this event and widget pair and activate the first one found.
`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.
`private java.lang.Object`	`invokeWidgetCommandImpl(int widgetId, GuiDriver gd, java.util.function.Supplier<java.lang.Object> driverInvocation)` Invokes a command on a widget implemented at the driver level.
`boolean`	`is3D()` Get the THREE-D value for this client session.
`boolean`	`isAfterChoose()` Is to force automatic clearing.
`boolean`	`isBatchInBackground()` Checks if the client is running in batch background mode.
`static boolean`	`isBypassDefaultWindowShowInPauseNoMessage()` Returns `true` when bypass-default-window-show-in-pause-no-message is enabled.
`boolean`	`isChui()` Checks whether the CHUI is up and running on the client.
`boolean`	`isCurrentRowModified(int browseId)` Returns `true` if the current browse row is modified.
`static boolean`	`isDataEntryReturn()` Get the state of SESSION:DATA-ENTRY-RETURN attribute.
`boolean`	`isDisableRedraw()` Getter for SESSION:DISABLE-REDRAW attribute.
`static boolean`	`isDynamicLayoutEnabled()` Returns `true` when dynamic layout is enabled.
`boolean`	`isEditCanPaste(int id)` Checks if the Clipboard has data to paste from.
`boolean`	`isEditCanUndo(int id)` Checks if the widget can handle text undo request.
`boolean`	`isEmbedded()` Check the client type: embedded or not.
`private static boolean`	`isEmpty(int[] widgetId)` Check if array of widget IDs is empty.
`boolean`	`isFocusedRowSelected(int browseId)` Return `true` if the row that has focus is selected.
`static boolean`	`isForceDialogsInCenterEnabled()` Returns `true` when force-dialogs-in-center is enabled.
`boolean`	`isGoPending()` Checks whether a GO event is pending for this editing operation (either an `editing` block or a `wait-for`).
`boolean`	`isHonorPBH()` Returns true if pause before hide mode is active.
`boolean`	`isInBatchMode()` Checks if the client is running in batch mode.
`boolean`	`isInEditingBlock()` Returns if processing is in editing block.
`boolean`	`isInEnable()` Returns `true` if `enable(..)` function is being run.
`boolean`	`isKeep3DFillinBorder()` Get the Keep3DFillinBorder environment value for this client session.
`boolean`	`isKeepMessages()` Determines if the current stream is redirected and has KEEP-MESSAGES option
`private static boolean`	`isKeyVariation(int key, int variableKey)` Returns `true` if the given `key` equals `variableKey`, `CTRL-variableKey`, `SHIFT-variableKey` or `CTRL-SHIFT-variableKey`
`boolean`	`isModalBoxActive()` Checks whether there are any modal boxes active.
`static boolean`	`isMousePointerLocked()` Check if mouse pointer is locked
`(package private) boolean`	`isNeedPause()` Get current value of the `needPause` flag.
`boolean`	`isNewRow(int browseId)` Returns `true` if the current row is a new row and is not present in the database.
`boolean`	`isRedirected()` Reports if the terminal is currently redirected to a stream.
`boolean`	`isRedirected(Stream s)` Reports if the terminal is currently redirected to the specified stream.
`private boolean`	`isReducedDown(boolean newStream, Frame frame, boolean down, Stream stream)` Determine if DOWN is a reduced one.
`static boolean`	`isRefreshQuirkActive()` Get status of refresh quirk (odd refreshing behavior in some terminal types).
`boolean`	`isRowAvailable(int browseId, int rowIndex)` Determines if the specified browse row is "available", i.e.
`boolean`	`isRowSelected(int browseId, int rowIndex)` Implements the IS-ROW-SELECTED() BROWSE widget method.
`java.lang.Boolean`	`isTriggerHadApplyEntry()` Check if the last trigger executed `APPLY "entry"` call for an explicit target.
`java.lang.Boolean`	`isTriggerResultNoApply()` Check if outermost trigger processing result was 'NO-APPLY'.
`boolean`	`isTriggerWasAppliedWithoutWaitFor()` Check if trigger processing was finished with NO-APPLY and there was no WAIT-FOR during trigger processing.
`boolean`	`isUnderWindows()` Check if the client is running in windows compatibility mode.
`private static boolean`	`isValidFocusTarget(Widget inFocus, Frame inFocusFrame)` Determines if the given widget in focus is a valid focus target.
`static boolean`	`isWaitState()` Check if wait state is active
`private void`	`iterateEditingBlock()` This method is called on each start of an EDITING block iteration.
`private void`	`lastEventToClientState(ClientState cs)` Update client state with last event info.
`static void`	`loadEnvironment(BootstrapConfig cfg)` The method is called when the environment has been fully initialized.
`boolean`	`loadImage(int wId, int type, java.lang.String name)` Loads the new image for given button or image widgets from the client side filesystem.
`boolean`	`loadMousePointer(int id, java.lang.String fileName)` Load custom mouse pointer from a file
`private MousePtrWrapper`	`loadMousePointer(java.lang.String fileName)` Load custom mouse pointer from a file
`boolean`	`loadWindowIcon(int windowId, boolean small, java.lang.String name)` Loads the new application icon for given window from the client side filesystem.
`private Widget`	`locateInFocus(int widgetId)` Locate widget in focus.
`static java.util.Optional<MousePtrWrapper>`	`lockedMousePointer()` Get locked mouse pointer if it is locked
`void`	`lockMousePointer(int widgetId, MousePtrWrapper ptr)` Lock mouse pointer
`TriggerMatch`	`lookupEvent(EventList eventList, int eventId, int frameId, int widgetId, boolean trigger, boolean isKey)` Checks whether this event matches any event defined in the current event list (see `getCurrentEventList()`).
`private static java.lang.String`	`makePauseText(int millis)` Prepare message text for specified time to wait.
`void`	`markFrames(MarkEntry me)` Perform operation on array of frames or widgets.
`static void`	`message(java.lang.String message)` Renders the specified message into the message line.
`MessageReturnValue`	`message(java.lang.String text, boolean set, BaseDataType var, boolean auto, java.lang.String format, Color cs, int windowId, java.lang.String[] stack)` Displays a message and sets or updates a character variable using a specified format for the temporary FillIn widget.
`void`	`messageBlasterAddMessage(long id, int index, int message, int pass)` Dispatches a add-propery message to client-side peer of a `MsgBlaster`.
`void`	`messageBlasterClearMessages(long id, boolean delete)` Request to clear the client-side peer of a `MsgBlaster`.
`void`	`messageBlasterEvent(long id, int msgVal, int wParam, int lParam, int lplRetVal)` Sends a `MessageBlaster` notification back to server.
`void`	`messageBlasterSetTarget(long id, int hWndTarget)` Dispatches a set-target message to client-side peer of a `MsgBlaster`.
`logical`	`messageBox(java.lang.Object[] list, logical var, int alertType, int buttons, java.lang.String title, Color color, int windowId, java.lang.String[] stack)` Displays a list of text items and empty lines in an alert box and sets/updates a `logical` variable as a result of the action taken.
`logical`	`messageBox(java.lang.Object[] list, logical var, int alertType, int buttons, java.lang.String title, Color color, int windowId, java.lang.String[] stack, boolean asInBatch, boolean logCallStack)` Displays a list of text items and empty lines in an alert box and sets/updates a `logical` variable as a result of the action taken.
`private logical`	`messageBox(java.lang.Object[] list, logical var, int alertType, int buttons, java.lang.String title, Color color, int windowId, java.lang.String[] stack, boolean asInBatch, boolean logCallStack, boolean isFromLogManager)` Displays a list of text items and empty lines in an alert box and sets/updates a `logical` variable as a result of the action taken.
`private void`	`modalEventLoop(IsModal modal, int savedFocusState, Widget savedFocus, TopLevelWindow owner)` Event worker for modal UI elements (alert box, system file and print dialogs, etc.).
`private void`	`modalEventLoopWorker(IsModal modal)` Event worker for modal UI elements (alert box, system file and print dialogs, etc.).
`logical`	`moveAfterTabItem(int frameId, int widget, int after)` Move specified widget after the widget "after".
`logical`	`moveBeforeTabItem(int frameId, int widget, int before)` Move specified widget before the widget "before" in the tab order.
`void`	`moveColumnClient(int browseId, int srcIndex, int destIndex)` Implements the client side of the MOVE-COLUMN() widget method.
`void`	`moveColumnServer(int browseId, int src, int dest)` Implements the server-side MOVE-COLUMN() widget method.
`java.lang.Boolean`	`moveToBottom(int id)` Move the widget to the bottom in z-order
`java.lang.Boolean`	`moveToTop(int id)` Move the widget to the top in z-order
`static boolean`	`needPause()` Get current state of the needPause flag.
`static boolean`	`nextFocus(Widget widget)` Performs conditional focus change procedure to the next widget.
`private static Frame`	`nextFrame(Frame frame)` Get next frame.
`void`	`nextPrompt(int frameId, int widgetId)` Specifies the field to be put in focus during the next input operation which involves this field of the frame.
`int`	`nextTabItem(int frameId, int widgetId)` Obtains the next widget in the frame's tab order from the client.
`static boolean`	`nextTabStop(Widget widget)` Performs conditional focus change procedure to the next tab stop widget.
`void`	`notifyAdvance(Stream out)` Notify the registered object that the given stream is advancing page.
`void`	`notifyBrowseLayoutPerformed(int browseId)` Notify server that browse layout has been performed on the client side.
`void`	`notifyClose(Stream out)` Notify the registered object that the given stream is being closed.
`void`	`notifyColumnsUpdated(int browseId, boolean refreshData)` Notify the client that columns have been added to the browse.
`void`	`notifyFlush(Stream out)` Notify the registered object that the given stream is flushing.
`void`	`notifyUnbind(Stream out)` Notify registered object that given stream reached end of life cycle and all references to it can be safely discarded.
`void`	`oleClear()` Remove all objects from clipboard.
`void`	`oleDrag(int widgetId)` Start an OLE drag/drop event with the given control as the source.
`byte[]`	`oleGetData(int format, int id)` Get object of specified format.
`boolean`	`oleGetFormat(int format)` Check if specified format is supported.
`void`	`oleSetData(byte[] value, int format)` Put object of specified format.
`void`	`openHyperlink(BrowseColumnGuiImpl column, java.lang.String hyperlinkText)` Open the hyperlink in the browse column by raising the event previously set for this column using the HYPERLINK attribute (FWD extension).
`void`	`openMimeResource(boolean deleteContent, java.lang.String filePath, boolean embedded, java.util.List<java.lang.String> preferredMimeTypes)` Opens the specified file resource in a browser's window.
`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 path, ScreenDriver.UriPathAnchor uriPathAnchor)` Opens the specified resource given by its relative path in respect to the service host.
`void`	`openPopup(int widgetId)` Opens the popup menu set on the specified widget.
`int`	`pause(int millis, java.lang.String text, boolean noMessage, int windowId)` Suspends processing for the specified number of milliseconds or until the user presses any key, whichever comes first.
`int`	`pause(int millis, java.lang.String text, boolean noMessage, TopLevelWindow wnd)` Suspends processing for the specified number of milliseconds or until the user presses any key, whichever comes first.
`void`	`pauseAfterPage()` Process pause after page for terminal stream.
`void`	`pauseBeforeEnd()` Perform pause before end of application.
`void`	`pauseBeforeHide()` Process pause before hide as requested.
`void`	`pauseBeforeHide(int millis, java.lang.String text, int windowId)` Specifies the pause action the user must take whenever frames are hidden automatically.
`private void`	`pauseCleanup()` Run pause cleanup block if any.
`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.
`void`	`placeFrame(int frameId)` Place the frame.
`private void`	`placeFrameInt(Frame frame, boolean force)` Hide frames if necessary to prepare space for specified frame and then place and realize current frame.
`private boolean`	`pop()` Process events and restore previous event queue.
`MouseHoverAction`	`popHover()` Pop action of the recently hovered widget off the stack
`private static void`	`popTrash()` Trash all events and restore previous event queue.
`private void`	`positionCursor()` Positions the real cursor before pausing according to the focused widget "directions".
`static void`	`postKeyboardStateEvent(int keyCode, boolean isReleased)` Post system key pressed/released event.
`void`	`postKeyEvent(int widgetId, int id, int key)` This method posts a key event to a specific widget identified by its widget ID.
`void`	`postMouseEvent(java.awt.event.MouseEvent event, int windowId)` Post the specified mouse event to the `EventManager`, which will save it in a dedicated queue.
`void`	`postMouseEvent(java.awt.event.MouseEvent event, int windowId, int sourceId)` Post the specified mouse event to the `EventManager`, which will save it in a dedicated queue.
`void`	`postOSEvent(Event event)` Post an OS event (which needs to be processed by the 4GL drawing layer, but not necessarily as a legacy 4GL event) to the event queue.
`void`	`postServerEvent(ServerEvent event)` Post the server event to the client side.
`private Widget[]`	`prepareChooseWidgetList(ChooseData c, Frame frame, java.lang.Integer[] focusId)` Prepare list of widgets involved in CHOOSE.
`private void`	`preprocessFrameDef(Frame frame, WidgetConfig cc)` Process frame definition.
`private void`	`preprocessView(ScreenBuffer[] frameBuf, Widget widget, int[] widgetIds)` If this is a nested frame, when performing a VIEW FRAME, in some cases all the ancestors need to be displayed, if not already visible.
`private static Frame`	`prevFrame(Frame frame)` Get previous frame.
`static boolean`	`previousFocus(Widget widget)` Performs conditional focus change procedure to the previous widget.
`static boolean`	`previousTabStop(Widget widget)` Performs conditional focus change procedure to the previous tab stop widget.
`private static boolean`	`processBrowseEvent(KeyInput evt)` Give a browse widget, if it is in this event's component hierarchy, a chance to process and consume the END-ERROR event.
`private void`	`processCondition(int action, int opcode, boolean inPause)` Handles processing of ENDKEY, END-ERROR and STOP conditions in a uniform manner.
`private void`	`processDirectUploadDefs(java.util.List<DirectUploadDef> registerDirectUploads, java.util.List<DirectUploadDef> deregisterDirectUploads)` Processes the direct upload registrations and deregistrations and produces a list of effective direct upload definitions to be synchronized with web gui driver.
`private Widget[]`	`processEnable(Frame frame, boolean enabled, int[] widgetId, ScreenBuffer[] sb, Widget focus)` Process enable.
`ScreenBuffer[]`	`processEvents(ScreenBuffer[] inbuf)` Processes all outstanding events without blocking for user input.
`private boolean`	`processEventsWorker()` Processes all outstanding events without blocking for user input.
`boolean`	`processMnemonic(KeyInput evt, int key, Widget<?> src)` Worker to process the given key as a mnemonic (ALT or simple key), for normal widgets (not menus).
`void`	`processProgressEvent(Event event)` Handle event as Progress event.
`void`	`processRepaints()` Process the delayed repaints so that the changes are drawn on the UI.
`private static void`	`processSideLabel(ScreenBuffer buffer, Widget<?> comp)` Process the side-label associated with the given widget.
`ScreenBuffer[]`	`promptFor(int frameId, int[] widgetIds, ScreenBuffer[] sb, int millis, EventList el, boolean doIO, int windowId, int[] tabItemList)` Provides a composite helper to implement a single call to the client which does an enable, wait-for, disable and hide message (in that order).
`static void`	`propagate(int windowId, int wid, MousePtrWrapper ptr)` Push information about the loaded mouse pointer for widget
`void`	`publish(long subId, java.lang.String event, java.lang.String[] param, boolean delayed)` Send a PUBLISH notification to a remote application.
`private static void`	`push()` Save current event queue.
`void`	`pushHover(MouseHoverAction action)` Push action of the currently hovered widget on the stack
`void`	`pushIntermediateRows(int browseId, BrowseRow[] rows)` Push "intermediate" rows (i.e.
`void`	`pushMenuDescription(MenuDescription[] md)` Send array of menu element descriptions to the client.
`private void`	`pushOneDef(ScreenDefinition definition)` Push one screen definition.
`void`	`pushScreenBuffers(ScreenBuffer[] sb)` Process array of frame/widget buffers provided by server.
`WidgetConfig[]`	`pushScreenDefinition(ScreenDefinition[] sd)` Process array of frame/widget definitions provided by server.
`void`	`pushWidgetAttr(boolean frameVisible, int id, java.lang.String[] fnames, java.lang.Object[] values)` Push the specified widget attribute changes to the client-side.
`void`	`pushWidgetAttr(boolean frameVisible, int id, java.lang.String fname, java.lang.Object value)` Push the specified widget attribute changes to the client-side.
`private void`	`pushWidgetAttr(ConfigManager mgr, boolean frameVisible, int id, java.lang.Runnable code)` Apply the specified widget attribute changes to the client-side.
`void`	`pushWidgetAttrInBatch(boolean frameVisible, int id, java.lang.Integer[] fids, java.lang.Object[] values)` Push the specified widget attribute changes to the client-side.
`void`	`pushWindow(WindowConfig config)` Process window configuration provided by server.
`ScreenBuffer`	`putBrowseColumnValues(Browse browse, ScreenBuffer buffer)` Put the values of the column widgets of the given browse into the given screen buffer.
`void`	`putCursor(boolean onOff)` Turns cursor visibility on or off.
`void`	`putCursor(double row, double column)` Puts cursor to the specified screen position.
`void`	`putScreen(java.lang.String text, double row, double column, Color color)` Puts text on the screen at the specified position and with the given text attributes.
`private void`	`putScreenDirect(java.lang.String text, double row, double column, Color color)` Outputs text as the result of PUT SCREEN operation.
`private static void`	`putWidgetValue(Widget widget, ScreenBuffer sb)` Put widget value into the screen buffer.
`void`	`queryClosed(int browseId)` Notify browse widget at client side that query was closed.
`void`	`queryRepositioned(int browseId, boolean repositionError, int targetRepositionRow)` Notify the browse that the underlying query has been repositioned..
`java.util.Map<java.lang.String,java.net.URI>`	`readHtmlBrowserWhitelist()` Look-up for the whitelisted HTML resource-base entries.
`ReadKeyResult`	`readKey(int millis)` Reads and returns one keystroke from the keyboard type-ahead buffer.
`static RedirectedTerminal`	`redirectedTerminalForStream(Stream out)` Looks up the redirected terminal instance for a given stream.
`void`	`redirectOutput(int oldId, int newId)` Redirect terminal output to the stream represented by `newId` (or to the interactive terminal if `newId` is -1) and close/ cleanup resources for the redirected terminal associated with `oldId` (unless `oldId` is -1 in which case nothing needs to be closed).
`private void`	`redrawEnabled(Frame frame, Widget[] affw)` Redraw enabled widgets.
`private void`	`refocusTarget(int widgetId, Widget inFocus)` Set focus to target.
`void`	`refresh(int browseId, boolean deleteCurrentRowMode)` Refresh the browse cache and redisplay the browse.
`void`	`refreshAfterDeletion(int browseId, int rowIndex)` Refresh the browse after some of its rows were deleted.
`void`	`refreshBrowseColumnBuffers(Browse browse)` Refresh server-side screen buffers of the columns of the given browse.
`void`	`refreshCurrentRow(int browseId, BrowseRow row)` Refresh the current browse row using the provided data.
`java.lang.String`	`refreshFrameWidget(int fid, int wid, BaseDataType value)` Refreshes the specified frame and widget with a new screen value.
`java.lang.String`	`refreshFrameWidgets(int fid, int[] wids, BaseDataType[] values)` Refreshes the specified frame and widget with a new screen value.
`private java.lang.String`	`refreshFrameWidgets(int fid, int[] wids, BaseDataType[] values, boolean asFrameField)` Refreshes the specified frame and widget with a new screen value.
`void`	`refreshHover()` Refresh mouse cursor shape for ACTIVE-WINDOW
`void`	`refreshHover(int widgetId)` Refresh mouse cursor shape for window
`void`	`refreshHoverImpl(Window<?> wnd)` Refresh mouse cursor shape for currently hovered widget
`void`	`refreshScreen()` Redraw everything after suspending terminal or after use of terminal stream.
`void`	`refreshScrollRow(int browseId, boolean leaveOnRowInView, boolean preserveViewportRow, boolean repositioned, boolean repositionError, int targetRepositionRow)` Refresh scroll row in the browse and redisplay.
`void`	`refreshWidget(int widgetId)` Refresh widget.
`void`	`registerBroadcastChannel(java.lang.String channelName, java.lang.String channelId)` Opens a broadcast channel in the client's front-end.
`void`	`registerPageElement(int frameId, boolean header)` Register the frame as a header or footer from the stream that is the current redirected terminal output destination.
`void`	`registerPageElement(int frameId, boolean header, boolean pulse)` Register the frame as a header or footer from the stream that is the current redirected terminal output destination.
`void`	`registerPageElement(int frameId, boolean header, int streamId)` Register the frame as a header or footer with the given stream as the redirected terminal output destination.
`void`	`registerPageElement(int frameId, boolean header, int streamId, boolean endOut)` Register the frame as a header or footer with the given stream as the redirected terminal output destination.
`void`	`registerPageElement(int frameId, boolean header, int streamId, boolean endOut, boolean pulse)` Register the frame as a header or footer with the given stream as the redirected terminal output destination.
`void`	`registerRowDisplayEvents(int[] wids, int[] triggerIds)` Register the specified ROW-DISPLAY events.
`WidgetRegistry`	`registry()` Resolve the widget registry being in use.
`void`	`remapKey(java.lang.String keyLabel, java.lang.String keyFunction)` Defines a specific action for the key.
`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`	`removeDroppedFile(int index)` Remove dropped file name at specified position.
`void`	`removeEditSelection(int id)` Removes the currently selected text from an Editor, Fill-In or ComboBox.
`static void`	`removeFrame(Frame frame)` Remove frame from the registry().
`void`	`removeGlobalImages(int wId)` Removes all previously registered global images for a specific widget.
`void`	`removeGlobalImages(int wId, java.util.Collection<java.lang.Integer> uniqueIds)` Removes selected global images for a specific widget.
`void`	`removeRowDisplayEvents(int[] triggers)` Remove the ROW-DISPLAY triggers from the specified list.
`void`	`removeServerEvents(int[] eventIds)` Remove from the server event queue all the events in the given list, identified by their id.
`static void`	`removeWidget(Widget<?> widget)` Remove the specified widget from the registry, and from its parent frame.
`void`	`removeWindow(int window)` Remove the window instance from the client.
`private static void`	`repaintAffectedWidgets(Frame[] frames, java.lang.Iterable<Widget> widgets)` Repaint widgets affected during ENABLE/DISABLE processing.
`void`	`repaintWidget(int widgetId)` Repaints the widget with the specified ID.
`java.lang.Boolean`	`replaceEditorSelectionText(int id, java.lang.String txt)` Replace selection of the targeted editor with a given string.
`java.lang.Boolean`	`replaceEditorString(int id, java.lang.String from, java.lang.String to, int flag)` Replace given substring of the targeted editor with a given string
`void`	`requestEndCurrentWaitForEventLoop()` Requests the current wait-for event loop to be interrupted.
`private void`	`requestHelp()` Request HELP application execution on the server.
`void`	`resetActiveComboBox()` Reset the active combo box global reference and the locked mouse pointer that has been used by the active drop down.
`void`	`resetBufferSizeManager()` Reset buffer size manager to its initial state.
`private void`	`resetChanged(int frameId)` Resets the changed state for all widgets of the frame into unchanged.
`EhBrowseConfigKey`	`resetEnhancedConfig(int browseId, EnhancedBrowseSaveTarget resetTarget)` Reset (delete) an enhanced configuration at the certain level for this browse.
`private void`	`resetGoPending()` Sets isGoPending to 0.
`private void`	`resetGoPending(int val)` Sets isGoPending to val.
`void`	`resetWaitState()` Resets wait-state previously enabled by `setWaitState(MousePtrWrapper)`.
`boolean`	`restoreCursor(NativePoint curpos, boolean curvis)` Force the cursor to the specified location and make it visible again.
`private ChooseData`	`restoreEnabledAfterChoose(ChooseData c, Frame frame, Widget[] comps, ScreenBuffer[] sbo, boolean saveEnabled)` Restore enabled widget after CHOOSE processing.
`void`	`restoreInsState(int savedInsState, boolean force)` Restore insert mode after a prompting function or a trigger.
`void`	`restoreRedirection(int tempTerm)` Restore the terminal to redirected mode from interactive mode, if the terminal to switch to is not -1.
`void`	`resume(boolean silent)` Re-enables client UI processing (key reading, normal drawing mode).
`void`	`rowEntryCreated(int browseId, int newRowId)` Performs client-side actions after a new row has been added to the backing result set using CREATE-RESULT-LIST-ENTRY.
`void`	`rowEntryDeleted(int browseId, int deletedRowId)` Performs client-side actions after a row has been deleted from the backing result set using DELETE-RESULT-LIST-ENTRY.
`java.lang.String`	`runComboBoxInput(int windowId, int fieldWidth, java.lang.String fieldFormat, java.lang.String initialValue, java.lang.String title, ControlSetItem[] items)` Run combo box input dialog containing a combo box input field with OK and Cancel buttons.
`void`	`runModal(AbstractWidget<GuiOutputManager> dlg)` Run a widget as a modal dialog window.
`boolean`	`runOsPassExpirationCheck()` Starts the OS user pass expiration check.
`boolean`	`runReport(int browseId, java.lang.String outputFileName, MediaType outputFormat, ScreenBuffer[] sb)` Run browse report.
`java.lang.String`	`runTextInput(int windowId, int fieldWidth, java.lang.String fieldFormat, java.lang.String initialValue, java.lang.String title)` Run text input dialog containing a character input field with OK and Cancel buttons.
`int`	`saveInsState()` Save insert mode before using a prompting function or a trigger.
`EnhancedBrowseConfig`	`saveOrCacheEnhancedConfig(int browseId, EnhancedBrowseSaveTarget saveTarget)` Save the current enhanced browse configuration using the specified save target.
`NativePoint`	`screenToClient(int widgetId, NativePoint loc)` Converts screen (relative to display screen origin) location to client location - relative to the window workspace origin.
`void`	`scroll(int frameId, boolean fromCurrent, boolean up)` Scrolls the lines of the down frame up or down.
`void`	`scrollToCurrentRow(int browseId)` Scrolls a browse (if necessary) to bring the currently selected row into view.
`boolean`	`scrollToItem(int slId, int index)` Invokes the SCROLL-TO-ITEM() method on the specified selection-list widget.
`void`	`scrollToSelectedRow(int browseId, int selectedRowIndex)` Scrolls a browse (if necessary) to bring the specified selected row into view.
`java.lang.Boolean`	`searchInEditor(int id, java.lang.String pattern, int mode)` Searches for a specified string starting from the current text caret position.
`void`	`selectAll(int browseId)` Implements the SELECT-ALL() BROWSE widget method.
`void`	`selectFocusedRow(int browseId)` Implements the SELECT-FOCUSED-ROW() BROWSE widget method.
`private void`	`selectiveDisable(Frame frame)` Selectively disable and redraw widgets.
`logical`	`selectNextRow(int browseId)` Implements the SELECT-NEXT-ROW() widget method.
`private java.lang.String`	`selectPredefinedTitle(int alertType)` Select one of the standard titles.
`logical`	`selectPreviousRow(int browseId)` Implements the SELECT-PREV-ROW() widget method.
`boolean`	`selectRow(int browseId, int rowIndex)` Implements the SELECT-ROW() widget method.
`boolean`	`sendEntry(Widget widget)` Sends ENTRY event to the specified widget and returns a boolean result of the possible trigger invocation.
`boolean`	`sendEntry(Widget widget, boolean mouse)` Sends ENTRY event to the specified widget and returns a boolean result of the possible trigger invocation.
`boolean`	`sendEntry(Widget widget, boolean mouse, Widget oldFocus)` Sends ENTRY event to the specified widget and returns a boolean result of the possible trigger invocation.
`boolean`	`sendEntry(Widget widget, boolean mouse, Widget oldFocus, boolean skipActivation)` Sends ENTRY event to the specified widget and returns a boolean result of the possible trigger invocation.
`boolean`	`sendLeave(Widget widget, Widget newFocus)` Sends LEAVE event to the specified widget.
`boolean`	`sendLeave(Widget widget, Widget newFocus, boolean mouse)` Sends LEAVE event to the specified widget.
`int`	`sendToStream(java.lang.String message)` Send message to stream.
`private void`	`sendToUnnamedStream(java.lang.String message)` Send message to unnamed stream if redirection is active.
`void`	`set3D(boolean value)` Set the THREE-D value for this client session.
`void`	`setActiveComboBox(ComboBox activeComboBox, int widgetId, MousePtrWrapper ptr)` (De)register combo-box with active drop down.
`void`	`setAfterChoose(boolean afterChoose)` Force or reset forcing of automatic clearing.
`void`	`setAuthMode(boolean auth)` Set authentication mode flag.
`void`	`setBoolean(java.lang.String key, java.lang.Boolean value)` Saves the boolean value of this key in the client storage.
`private void`	`setChangedValue(Frame frame, Widget comp, BaseDataType value, java.lang.String fmt)` Changes the value of a widget in a frame.
`static void`	`setClientParameters(ClientParameters params)` Set the `clientParameters`.
`void`	`setClipboardValue(java.lang.String value)` Copies a string value to the client's system clipboard.
`void`	`setCurrentLanguage(java.lang.String language)` Set new current session language for the client.
`int`	`setCurrentRow(int browseId, int rowIndex)` Inform server about current row in the browse.
`java.lang.Boolean`	`setCursorOffset(int id, int offset)` Sets the cursor offset of the targeted widget.
`boolean`	`setCursorPos(NativePoint point)` Substitute for Win32 SetCursorPos.
`void`	`setDataEntryReturn(boolean on)` Set the state of SESSION:DATA-ENTRY-RETURN attribute.
`void`	`setDisableRedraw(boolean value)` Set the global SESSION:DISABLE-REDRAW attribute.
`void`	`setDynamicFiltering(int browseId, int[] columnOrdinals, BaseDataType[] values)` Set dynamic filtering for the browse.
`void`	`setDynamicSorting(int browseId, int[] columnOrdinals, boolean[] ascending)` Set dynamic sorting for the browse.
`java.lang.Boolean`	`setEditorCursorChar(int id, int pos)` Sets the cursor position in the current line of the targeted editor
`java.lang.Boolean`	`setEditorCursorLine(int id, int line)` Sets the cursor line of the targeted editor
`java.lang.Boolean`	`setEditorSelection(int id, int start, int end)` Selects text in the targeted editor between start and end points.
`java.lang.Boolean`	`setFillInSelection(int id, int start, int end)` Selects text in the targeted fill-in between start and end points.
`void`	`setFirstTabItem(int frameId, java.util.List<java.lang.Integer> fgWidgetIds, int widgetId)` Move specified widget to the first position in the tab order.
`void`	`setFocus(int widgetId, boolean forceWindowActivation)` Forces focus on the supplied widget.
`private void`	`setFocusSilent(Widget inFocus)` Silently restore and redraw the focus.
`void`	`setFormat(int widget, java.lang.String format)` Sets the format specification for the specified widget and redraws the widget.
`static void`	`setHelp(java.lang.String text, AbstractWidget widget)` Set help text.
`boolean`	`setImage(int wId, int type, byte[] image)` Sets the new image for given button or image widgets on the client side.
`void`	`setImmediateDisplay(boolean on)` Set the state of SESSION:IMMEDIATE-DISPLAY attribute.
`void`	`setInputActive(int inputActive)` Set input active counter.
`void`	`setKeep3DFillinBorder(boolean value)` Set the Keep3DFillinBorder environment value for this client session.
`void`	`setLastKeyData(int lastKey, int lastKeyState, int functionKey, Event lastEvent)` Set `LAST-EVENT` data.
`void`	`setLastViewed(Frame frame)` Set last viewed frame reference.
`boolean`	`setMousePointer(java.lang.Integer id, byte[] data, java.lang.String ptrName)` Set the custom mouse pointer for a widget or reset to the default one
`boolean`	`setMousePointer(java.lang.Integer id, java.io.InputStream data, java.lang.String ptrName)` Set the custom mouse pointer for a widget or reset to the default one
`java.lang.Boolean`	`setMousePointer(java.lang.Integer id, MousePointer ptr)` Set the the pre-defined custom mouse pointer for a widget or reset to the default one
`protected boolean`	`setMousePtr(java.lang.Integer id, MousePtrWrapper ptrWrapper)` Set the custom mouse pointer for a widget
`void`	`setMultitaskingInterval(long interval)` Set the state of SESSION:MULTITASKING-INTERVAL attribute.
`void`	`setNeedPause(boolean needPause, TopLevelWindow wnd)` Set new value for the `needPause` flag.
`void`	`setNumber(java.lang.String key, java.lang.Number value)` Saves the number value of this key in the client storage.
`void`	`setObject(java.lang.String key, java.lang.Object value)` Sets the object value of the given key for the client storage.
`void`	`setPendingCursorReset()` Set the flag indicating the cursor to be reset on server side.
`void`	`setPendingFocus(Widget pendingFocus)` Set `pendingFocus` widget.
`void`	`setPendingFocusApply(Widget widget)` Set `pendingFocusApply` reference.
`private void`	`setScreenBuffer(ScreenBuffer frameBuf)` Parses `ScreenBuffer` instance for current set of frames and assigns new widget values.
`private void`	`setScreenBuffer(ScreenBuffer frameBuf, boolean direct)` Parses `ScreenBuffer` instance for current set of frames and assigns new widget values.
`private void`	`setScreenBuffers(ScreenBuffer[] frameBuf)` Parses `ScreenBuffer` array for current set of frames and assigns new widget values.
`private void`	`setScreenBuffers(ScreenBuffer[] frameBuf, boolean checkFrameExists)` Parses `ScreenBuffer` array for current set of frames and assigns new widget values.
`static void`	`setSessionTooltips()` Initialize initial tooltip settings
`void`	`setSessionTooltips(boolean tooltips)` Sets the SESSION:TOOLTIPS attribute for this session.
`void`	`setString(java.lang.String key, java.lang.String value)` Saves the string value of this key in the client storage.
`void`	`setTerminalType(java.lang.String term)` Sets the terminal type.
`void`	`setTriggerNesting(int triggerNesting)` Set value of `triggerNesting` counter.
`PrintOptions`	`setupPrinter(int windowId, int copies, PrintOptions printOptions)` Displays the `Print` dialog box and lets the user set the default print context for subsequent print jobs.
`static void`	`setupTooltip(WidgetWithConfig<? extends WidgetConfig> widget)` Setup tooltip for widget
`void`	`setUserName(java.lang.String userName)` Sets new user name to be associated with given client session.
`boolean`	`setWaitState(byte[] data, boolean lockInput)` Initiate/cancel wait state
`boolean`	`setWaitState(java.io.InputStream data, boolean lockInput)` Initiate/cancel wait state
`boolean`	`setWaitState(MousePointer ptr, boolean lockInput)` Initiate/cancel wait state
`private boolean`	`setWaitState(MousePtrWrapper ptr)` Initiate/cancel wait state
`private boolean`	`setWaitState(MousePtrWrapper ptr, boolean lockInput)` Initiate/cancel wait state
`boolean`	`setWaitState(java.lang.String ptrName, boolean lockInput)` Initiate wait state with a custom cursor from file
`boolean`	`setWidgetAttribute(int widgetId, java.lang.String attr, java.lang.String val)` Set an attribute for a widget implemented at the driver level.
`boolean`	`setWindowDefaultIcon(TopLevelWindow.IconDataType type, java.lang.Object data)` Sets the default window icon for all new windows on the client side.
`boolean`	`setWindowIcon(int windowId, byte[] icon)` Sets the new application icon for given window on the client side.
`void`	`sortTreeList(int widgetId, int index, boolean resetSorting)` Sorts a tree list widget by a column.
`private void`	`startEditingMode(int focusWidgetId, EventList eventList)` Marks the beginning of the editing block and passes a customized list of GO-ON events that define termination condition for this I/O operation.
`private void`	`startInputStatus(boolean cursor)` Activate input mode.
`(package private) void`	`startWidgetOutput()` Mark start of widget drawing.
`void`	`statusDefault(java.lang.String text, boolean noLengthLimit, int windowId)` Specifies a new default status message for the running procedure when not in INPUT mode (when editing).
`void`	`statusInput(java.lang.String text, int windowId)` Specifies a new status message used when the user interface is blocked on input.
`void`	`statusInputOff(int windowId)` Disables display of the input status message.
`void`	`statusInputRevert(int windowId)` Reverts the input status message to the default.
`void`	`stopBatchSession()` Stops the associated client session by generating UnstoppableExitException.
`ScreenBuffer[]`	`stopEditingMode()` Marks the end of the editing block when triggered by any abnormal exit from the block on the server.
`private void`	`stopInputStatus()` Deactivate input mode.
`private void`	`stopInputStatus(boolean changeStatus)` Deactivate input mode.
`private void`	`stopNoAvailableWidgets()` Stop the WAIT-FOR loop, as it determined there are no available widgets, in the following cases: when the terminal is reset, inside an editing block when the WAIT-FOR loop is NOT waiting for global events and there are no enabled components registered for exit events
`Stream`	`streamFromId(int sid)` Returns the stream associated with a given stream.ID.
`private void`	`subGoPending()` Decrements isGoPending.
`void`	`suspend(boolean silent)` Temporarily halts the client UI processing (key reading, normal drawing mode) After entering suspend mode, the current contents of the terminal are cleared.
`int`	`suspendedPause()` Indefinitely pause and display the default message.
`private boolean`	`switchFrames(int streamId, int frameId)` Checks whether the stream and its redirected terminal need to switch to another frame and does switching if so.
`int`	`switchOutput(int newId, boolean clean)` Redirect terminal output to the stream represented by `newId` (or to the interactive terminal if `newId` is -1) and return the id of the current output destination.
`int`	`switchOutput(int newId, boolean clean, boolean endOut)` Redirect terminal output to the stream represented by `newId` (or to the interactive terminal if `newId` is -1) and return the id of the current output destination.
`private boolean`	`switchStreams(Frame frame)` Checks whether the frame needs switching streams and does switching.
`private int`	`switchWorker(int newId)` Redirect terminal output to the stream represented by `newId` (or to the interactive terminal if `newId` is -1) and return the id of the current output destination.
`void`	`systemHelp(java.lang.String systemHelpServicePath, java.lang.String windowName, SystemHelpAction action, java.lang.Object[] params)` Calls the Microsoft Windows Help engine to display Windows Help topics, and the HTML Help engine to display HTML Help topics.
`private Window<?>`	`targetWindowWorker(int windowId)` Resolves client-side window with specified id.
`static void`	`terminate()` When run in-process on the server, the client has threads with security context that must be shutdown.
`private void`	`transferFocusToFrame(Frame frame, Frame newFrame)` Transfer focus between frames.
`private boolean`	`trigger(int triggerId, int eventId, int sourceId, int otherId, long resourceId, int matchedWidgetId, int rowSourceId, ScreenBuffer sb, EventList previousEventList)` Signals a trigger to the application.
`private void`	`triggerSupport(java.lang.Runnable triggerCode)` Execute a provided code presuming that it will fire a server-side trigger.
`private void`	`unconditionalRedirectedDown(int frameId, int steps, Frame frame, RedirectedTerminal rt, Stream stream, boolean reducedDown, int prevLineNum, boolean flushed)` Handle unconditional DOWN processing in redirected mode.
`void`	`underline(int frameId, int[] widgetIds)` Underlines a set of widgets of the specified frame.
`void`	`updateClientMetrics()` Updates client metrics and pushes them to the server.
`private java.util.ArrayList<java.lang.Integer>`	`updateHeaders(ScreenBuffer frameBuf)` Update form headers from given `ScreenBuffer` instance.
`void`	`updateRow(int browseId, int rowIndex, int[] cellIndices, BaseDataType[] cellValues, boolean onlyNotifyRowReleased)` Updates selected cells in the given row.
`void`	`updateTabItemList(int[] frameIds, int[][] tabItemLists)` Update the tab item list for the given frame.
`boolean`	`validate(int sourceId, ScreenBuffer sb)` Signals a validation event to the application.
`boolean`	`validateDisplayValue()` Performs widget display value format validation.
`private static int`	`validateWidget(int id, int[] ids)` Validates the widget's ID by comparing with array of allowed IDs.
`private boolean`	`validateWidget(Widget widget)` Validates the widget's current value and displays the validation error message if any.
`boolean`	`validateWidget(Widget widget, boolean inBrowseEditor)` Validates the widget's current value and displays the validation error message if any.
`private void`	`view_(int widgetId, ScreenBuffer[] frameBuf, int[] widgetIds, boolean isView, boolean markTarget, int windowId)` Shows all fields of the specified frame on screen.
`void`	`view(int frameId)` Display frame content in redirected mode by page element.
`ScreenBuffer[]`	`view(int widgetId, ScreenBuffer[] frameBuf, int[] widgetIds, boolean isView, int windowId, int[] tabItemList)` Shows all fields of the specified frame on screen.
`WidgetConfig[]`	`view(int widgetId, ScreenBuffer[] frameBuf, int[] widgetIds, int streamId, boolean register, boolean pageTop, boolean isView, int windowId, int[] tabItemList)` Shows all fields of the specified frame on screen.
`static void`	`view(Widget widget, ScreenBuffer[] frameBuf, int[] widgetIds, boolean isView)` Externally accessible static wrapper for `viewWorker(Widget, ScreenBuffer[], int[], boolean, int)`.
`private void`	`viewWorker(Widget widget, ScreenBuffer[] frameBuf, int[] widgetIds, boolean isView, int windowId)` Force the visibility and drawing of all specified fields of the given frame.
`ScreenBuffer[]`	`waitFor(EventList list, int focusWidgetId, int millis, ScreenBuffer[] inbuf)` Wait for specified list of events.
`ScreenBuffer[]`	`waitFor(EventList list, int focusWidgetId, int millis, ScreenBuffer[] inbuf, BlockingOperation op, boolean force, int windowId)` Wait for specified list of events.
`private Event`	`waitForEvent(int millis, boolean frameAsTarget, boolean honorServerEvent)` Wait for key press indefinitely or for specified number of milliseconds.
`private Event`	`waitForEvent(int millis, boolean frameAsTarget, boolean honorServerEvent, boolean includeOSEvent)` Wait for key press indefinitely or for specified number of milliseconds.
`void`	`waitForNextKey()` Conditionally blocks until a next UI event is available.
`ScreenBuffer[]`	`waitForWorker(EventList list, int focusWidgetId, int millis, ScreenBuffer[] inbuf, boolean force, boolean status, boolean entryWindow, BlockingOperation operation, boolean restoreFocus, int windowId)` Main WAIT-FOR worker routine.
`ScreenBuffer[]`	`waitForWorker(EventList list, int focusWidgetId, int millis, ScreenBuffer[] inbuf, boolean force, boolean status, boolean entryWindow, BlockingOperation operation, int windowId)` Main WAIT-FOR worker routine.
`int`	`watchCtrlC()` Callback method that notifies the application about Ctrl-C keystroke and returns the decision the application has made about the disposition of the Ctrl-C keystroke.
`private void`	`withIndependentEventList(java.lang.Runnable block)` Executes the supplied runnable with currentEventList set to null.
`static void`	`wrapFrame(Frame frame)` Remove frame from the registry.

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.ClientExports
setWaitState, setWaitState, setWaitState

Field Detail
- LOG
```
private static final CentralLogger LOG
```
  Logger.
- PBH_DEFAULT_TEXT
```
private static final java.lang.String PBH_DEFAULT_TEXT
```
  Default pause before hide message text.
  
  See Also:
  
  Constant Field Values
- PBE_DEFAULT_TEXT
```
private static final java.lang.String PBE_DEFAULT_TEXT
```
  Default pause before end message text.
  
  See Also:
  
  Constant Field Values
- END_ERR_MSG
```
private static final java.lang.String END_ERR_MSG
```
  Exception message used in END-ERROR key processing.
  
  See Also:
  
  Constant Field Values
- local
```
private static final ContextLocal<ThinClient> local
```
  Context local instance of this class.
- modToken
```
private static java.lang.Object modToken
```
  Token used to authenticate with the dispatcher when registering APIs.
- sessToken
```
private static java.lang.Object sessToken
```
  Token used to authenticate with the dispatcher when registering APIs.
- logToken
```
private static java.lang.Object logToken
```
  Token used to authenticate with the dispatcher when registering APIs.
- logManagerService
```
private static LegacyLogManagerClientServiceImpl logManagerService
```
  Client LOG-MANAGER service
- useLocalStorage
```
private static boolean useLocalStorage
```
  Flag to indicate if localStorage needs to be used for client storage in web.
- storageId
```
private static java.lang.String storageId
```
  The unique id for the client storage.
- dynamicLayoutEnabled
```
private static boolean dynamicLayoutEnabled
```
  Flag indicating whether dynamic layout is enabled.
- forceDialogsInCenter
```
private static boolean forceDialogsInCenter
```
  Configurable flag to force dialog positioning in the center.
- bypassDefaultWindowShowInPauseNoMessage
```
private static boolean bypassDefaultWindowShowInPauseNoMessage
```
  Configurable flag to bypass default-window showing after pause x no-message
- COM_EVENT_TIME_COUNTER
```
private static final ValuesCounter COM_EVENT_TIME_COUNTER
```
  This variable represents an instance of the ValuesCounter class for measuring and tracking the time taken for COM event handlers to execute.
- viewRefresh
```
public boolean viewRefresh
```
  This view refreshes the frame including decorations
- viewDisplay
```
public boolean viewDisplay
```
  This view displays frame data
- keyboardState
```
public final java.util.Set<java.lang.Integer> keyboardState
```
  Track currently pressed keys
- viewInProgress
```
boolean viewInProgress
```
  This flag is on for the duration of view operation
- nextViewRefresh
```
boolean nextViewRefresh
```
  false has no effect. true forces full frame redrawing, including decorations.
- nextViewDisplay
```
boolean nextViewDisplay
```
  false has no effect. true forces data only output. Normally, only one of {nextViewRefresh, nextViewDisplay} flags should be set to true or else the requirements are in contradiction. If that happens nonetheless, nextViewRefresh takes precedence.
- tk
```
private OutputManager tk
```
  Reference to OutputManager instance.
- batchMode
```
private boolean batchMode
```
  Flag indicating the UI client is in batch mode.
- dedicatedThread
```
private java.lang.Thread dedicatedThread
```
  When running in the server process, this is the user's thread.
- server
```
private ServerExports server
```
  Server exports
- validationError
```
private java.lang.String validationError
```
  Validation message from last failed validation operation.
- needPause
```
private boolean needPause
```
  Pause before hide state flag. true means pause is due.
- timePBH
```
private int timePBH
```
  Pause before hide time for automatic frame hiding (in milliseconds).
- honorPBH
```
private boolean honorPBH
```
  Flag that determines if pause before hide mode is active.
- textPBH
```
private java.lang.String textPBH
```
  Text displayed while processing pause before hide.
- inputDefaultText
```
private java.lang.String inputDefaultText
```
  Default status message displayed when input operation is active. Can't be initialized here because the client's type is not available (GUI or ChUI).
- currentEventList
```
private EventList currentEventList
```
  Current active wait list.
- rowDisplayEvents
```
private java.util.Map<java.lang.Integer,java.lang.Integer> rowDisplayEvents
```
  Current registered ROW-DISPLAY events.
- inRowDisplayTrigger
```
private boolean inRowDisplayTrigger
```
  Flag indicating if a ROW-DISPLAY event is being executed.
- isGoPending
```
private int isGoPending
```
  Number of times when we've found that the GO event is pending.
- immediateException
```
private ConditionException immediateException
```
  An exception which causes all trigger processing recursions to be terminated.
- triggerNestingByWaitFor
```
private Stack<java.lang.Integer> triggerNestingByWaitFor
```
  Contains levels of trigger nesting relative to active WAIT-FOR cycles.
- triggerResultNoApply
```
private Stack<java.lang.Boolean> triggerResultNoApply
```
  Contains true if the last trigger result (on this level) returned no-apply.
- triggerHadApplyEntry
```
private Stack<java.lang.Boolean> triggerHadApplyEntry
```
  Contains true if the last trigger (on this level) had APPLY "entry" call for an explicit target.
- triggerHadWaitFor
```
private Stack<java.lang.Boolean> triggerHadWaitFor
```
  Contains true if the last trigger (on this level) did execute a nested wait-for loop.
- lastAppliedCode
```
private int lastAppliedCode
```
  The action code currently being applied by the apply() method.
- lastKey
```
private int lastKey
```
  Last key received from the keyboard.
- lastKeyState
```
private int lastKeyState
```
  Last extended key state received from the keyboard.
- fileSystem
```
private FileSystem fileSystem
```
  Managed file system.
- sd
```
private StreamDaemon sd
```
  Stream daemon (provides access to streams by id).
- pd
```
private ProcessDaemon pd
```
  Process daemon.
- mailer
```
private EmailDaemon mailer
```
  Email daemon.
- redirections
```
private java.util.Map<java.lang.Integer,RedirectedTerminal> redirections
```
  Tracks pseudo-terminals used for redirecting output to a stream.
- deferredCleanup
```
private java.util.Set<java.lang.Integer> deferredCleanup
```
  Tracks pseudo-terminals which need deferred cleanup processing.
- currentStream
```
private int currentStream
```
  Tracks the id of the current output stream (-1 for interactive).
- savedTermRedir
```
private int savedTermRedir
```
  The ID of the saved redirected terminal stream.
- interactions
```
private int interactions
```
  Tracks the number of I/O interactions within the current block
- pageElements
```
private java.util.Map<java.lang.Integer,PageElement> pageElements
```
  Tracks all page elements which are active.
- streamMap
```
private java.util.Map<PageElement,java.util.Set<Stream>> streamMap
```
  Tracks the streams in which a given page element is registered.
- triggerNesting
```
private int triggerNesting
```
  Level of nesting (recursion) that exists with trigger processing.
- conditionalUpDown
```
private int conditionalUpDown
```
  Tracks any conditional up or down that must be applied.
- conditionalFrameId
```
private int conditionalFrameId
```
  Tracks the frame ID associated with the conditional up or down.
- cursorVisible
```
private boolean cursorVisible
```
  Cache of the cursor visibility.
- oldcursor
```
private Stack<java.lang.Boolean> oldcursor
```
  Stores the state of the cursor at the time input mode was activated.
- suppressWarnings
```
private boolean suppressWarnings
```
  Flag to indicate if the warnings should be suppressed
- inEditingBlock
```
private boolean inEditingBlock
```
  Track editing block usage.
- implicitApplyNoTrigger
```
private boolean implicitApplyNoTrigger
```
  Track APPLY with implicit target usage and there is no focus.
- hadReset
```
private boolean hadReset
```
  Track resetTerminal usage in editing blocks.
- removedFrames
```
private java.util.ArrayList<java.lang.Integer> removedFrames
```
  List of frames which should be deleted at server.
- wrappedFrames
```
private java.util.ArrayList<java.lang.Integer> wrappedFrames
```
  List of DOWN frames which were wrapped.
- helpActive
```
private boolean helpActive
```
  Track HELP function activity
- lastViewed
```
private Frame lastViewed
```
  Last frame which was displayed.
- modalActive
```
private int modalActive
```
  Counter of nested modal UI elements (alert box, system file and print dialog, etc.). There are cases when more than a modal box are shown (and active from the POV of this flag), like when a system dialog opens a warning, confirmation or alert box.
- afterChoose
```
private boolean afterChoose
```
  Force automatic clearing.
- focusToRestoreFillIn
```
private FillIn focusToRestoreFillIn
```
  Saving the last focused widget before choose()
- leaveSent
```
private boolean leaveSent
```
  Tracks the LEAVE event sent status
- hadPause
```
private boolean hadPause
```
  Flags if the current operation had an implicit or explicit pause.
- waitForFrames
```
private java.util.Deque<ThinClient.WaitForOp> waitForFrames
```
  Stack of frames targeted by WAIT-FOR statements.
- editingFrames
```
private java.util.Deque<Frame> editingFrames
```
  Stack of frames targeted by editing blocks.
- eventLists
```
private Stack<EventList> eventLists
```
  Stack of event lists saved between editing blocks.
- repaints
```
private java.util.Map<WidgetId,java.util.Set<PaintEvent>> repaints
```
  A cache of repaints, per each generating window ID.
- editingFocus
```
private Stack<Widget> editingFocus
```
  Stack of prior focus before an editing block started.
- lastEvent
```
private Event lastEvent
```
  Last OS event received to be used as LAST-EVENT properties source.
- lastActionCode
```
private int lastActionCode
```
  Contains the action code of the last key input event.
- functionKey
```
private int functionKey
```
  Contains the action code of the last key input event.
- condExit
```
private boolean condExit
```
  Set to true when condition exception may be thrown.
- inEnable
```
private boolean inEnable
```
  If true then enable(..) function is being run.
- inputActive
```
private int inputActive
```
  Track input mode.
- mousePointers
```
private final java.util.Map<java.lang.String,MousePtrWrapper> mousePointers
```
  Custom mouse pointers by name
- wrappers
```
private final java.util.Map<MousePointer,MousePtrWrapper> wrappers
```
  Map pre-defined pointers to corresponding wrappers
- savedInsStates
```
private Stack<java.lang.Integer> savedInsStates
```
  The stack of saved insert indicator states. -1 value indicates that the saved state has been cleared (mostly because it has been applied to a fill-in). The current states are pushed at the beginning of SET/UPDATE/ PROMPT-FOR/MESSSAGE UPDATE/MESSAGE SET (including EDITING) blocks, and popped and their end. Note that this stack always keeps at least one value (in order to restore insert indicator state after leaving first-level prompting block).
- savedInsStateInitials
```
private Stack<java.lang.Integer> savedInsStateInitials
```
  The stack of saved insert indicator states. Unlike savedInsState, saved values cannot be cleared, and current states are pushed/popped only for EDITING blocks.
- pendingFocus
```
private Widget pendingFocus
```
  Save pending focus (to which will be adjusted to on the next wait-for loop.
- entrySourceOnLeaveMap
```
private java.util.Map<Widget,Widget> entrySourceOnLeaveMap
```
  Contains pairs of the ENTRY source widget and its next tab widget that obtains the focus on APPLY "LEAVE" to the ENTRY source widget with RETURN NO-APPLY.
- triggersContext
```
private Stack<ThinClient.State> triggersContext
```
  The stack of triggers context that holds information about the triggered widget and its event.
- pendingInvocationEvents
```
private java.util.Map<java.lang.Integer,java.util.List<InvocationEvent>> pendingInvocationEvents
```
  Postponed invocation events.
- nesting
```
private int nesting
```
  External procedure call nesting.
- pendingFocusApply
```
private Widget pendingFocusApply
```
  Save pending focus, when focus is disabled or hidden. In some case, it will be used by the APPLY statement.
- lastEditorDisplayed
```
private Editor lastEditorDisplayed
```
  Track the last displayed and enabled editor widget.
- skipCaretDraw
```
private boolean skipCaretDraw
```
  Flag indicating if caret draw is skipped on next cursor positioning, after a wait-for loop iteration.
- authMode
```
private boolean authMode
```
  Authentication mode flag.
- ignoreNextStopEditing
```
private boolean ignoreNextStopEditing
```
  Control editing mode processing.
- forceWipeScreen
```
private boolean forceWipeScreen
```
  Force wiping of the screen from PUT SCREEN artifacts on next frame hiding.
- messageClearQuirk
```
protected boolean messageClearQuirk
```
  Flag which controls behavior of message clear quirk simulation.
- cleanupSynchronizer
```
private java.lang.Object cleanupSynchronizer
```
  Synchronization object for pause/Ctrl-C handling.
- cleanupBlock
```
private java.lang.Runnable cleanupBlock
```
  Pause cleanup block.
- lastExposedFrame
```
private Frame lastExposedFrame
```
  Last frame, which was made visible
- currentBlockingOp
```
private BlockingOperation currentBlockingOp
```
  Track the type of the current blocking operation.
- refreshQuirk
```
private boolean refreshQuirk
```
  Control behavior of some wipe-out quirks.
- focusManager
```
private FocusManager focusManager
```
  FocusManager instance.
- typeAhead
```
private TypeAhead typeAhead
```
  Key reader and type ahead buffer processor.
- sigintThread
```
private SigintWaiter sigintThread
```
  Waiter thread for SIGINT incoming.
- redirectedConversion
```
private CoordinatesConversion redirectedConversion
```
  The coordinates conversion implementation used when the output is redirected.
- underWindows
```
private boolean underWindows
```
  Flag indicating if the client is running in windows compatibility mode.
- envVersion
```
private java.lang.String envVersion
```
  Gets the current version string of the Progress compatible environment.
- is3D
```
private boolean is3D
```
  THREE-D value for this session.
- disableRedraw
```
private boolean disableRedraw
```
  Holds the state of the SESSION:DISABLE-REDRAW attribute. This attribute is a FWD extension, not real 4GL!
- keep3DFillinBorder
```
private boolean keep3DFillinBorder
```
  The effective value of the keep3DFillinBorder environment variable.
- hovers
```
private final java.util.Stack<MouseHoverAction> hovers
```
  Active hovers stack
- recentlyHovered
```
private volatile MouseHoverAction recentlyHovered
```
  Most recent hovers action
- lockedMousePointer
```
private volatile java.util.Optional<MousePtrWrapper> lockedMousePointer
```
  Locked mouse pointer
- activeComboBox
```
private ComboBox activeComboBox
```
  Combo-box with active drop-down.
- isWaitState
```
private boolean isWaitState
```
  wait-state flag
- isImmediateDisplay
```
private boolean isImmediateDisplay
```
  The state of SESSION:IMMEDIATE-DISPLAY attribute
- multitaskingInterval
```
private long multitaskingInterval
```
  The value of SESSION:MULTITASKING-INTERVAL attribute. In FWD, this is assumed to be millis.
- isDataEntryReturn
```
private java.lang.Boolean isDataEntryReturn
```
  The state of SESSION:DATA-ENTRY-RETURN attribute
- currentTarget
```
private Widget currentTarget
```
  The target focus widget for the current BlockingOperation
- currentWindowId
```
private int currentWindowId
```
  Id of the window as specified in the IN WINDOW option of the current blocking operation
- timer
```
private java.util.concurrent.ScheduledExecutorService timer
```
  Timer service for asynchronous execution on the OS queue
- lastRepaintFlush
```
private long lastRepaintFlush
```
  The last time the repaints were processed in processRepaints().
- repaintInterval
```
private long repaintInterval
```
  The repaint flush interval, in milliseconds. Configured via client:gui:repaint.
- osUserName
```
private java.lang.String osUserName
```
  Currently associated OS user name.
- downMouseButtonOldFocus
```
private Widget<?> downMouseButtonOldFocus
```
  The old focused widget before the left button was pressed.
- downMouseButtonNewFocus
```
private Widget<?> downMouseButtonNewFocus
```
  The new focused widget after the left button was pressed.
- consumeNextMouseClick
```
private boolean consumeNextMouseClick
```
  Flag indicating that the next mouse left click event must be ignored.
- htmlBrowserWhitelist
```
private java.util.Map<java.lang.String,java.net.URI> htmlBrowserWhitelist
```
  Session-level cache of normalized urls of the HTML browser whitelist
- startupParameters
```
private StartupParameters startupParameters
```
  Startup parameters. Initialize with a default instance, the actual parameters will be assigned during TC init.
- clientParameters
```
private ClientParameters clientParameters
```
  The client parameters.
- pendingCursorReset
```
private boolean pendingCursorReset
```
  Flag to notify server side for cursor resetting.
- clientStorage
```
private ClientStorage clientStorage
```
  Client storage.
- loginPageAddress
```
private java.lang.String loginPageAddress
```
  Login page address.
- effectiveDirectUploads
```
private java.util.LinkedList<DirectUploadDef> effectiveDirectUploads
```
  Represents a list of effective direct upload definitions
- directUploadsModcount
```
private int directUploadsModcount
```
  Variable used to track modification count for the direct uploads list
- directUploadFiles
```
private java.lang.String[] directUploadFiles
```
  Array of files just directly uploaded or selected
- directUploadStatus
```
private boolean directUploadStatus
```
  Represents the status of the last direct upload process

Constructor Detail
- ThinClient
```
private ThinClient()
```
  Constructor.

Method Detail

getInstance
```
public static ThinClient getInstance()
```
Get the context-local instance of this class. When run in a single client JVM environment, this is effectively a singleton instance. Using context local support allows multiple instances to co-reside in the same JVM (e.g. used when the client code is hosted inside the application server).

Returns:

null if initializePrep(com.goldencode.p2j.cfg.BootstrapConfig) has not yet been called. Otherwise, the singleton instance of this class will be returned.

setHelp
```
public static void setHelp(java.lang.String text,
                           AbstractWidget widget)
```
Set help text. When the request comes from a widget which is part of an ongoing CHOOSE, the help text is overridden with whatever was supplied for the CHOOSE operation.

Parameters:

text - Text for help string or null, which indicates the default status message has to be restored.

widget - Optional widget for window detection. If null, the default window is selected for displaying the help message.

setClientParameters
```
public static void setClientParameters(ClientParameters params)
```
Set the clientParameters.

Parameters:

params - The client parameters.

getClientParameters
```
public static ClientParameters getClientParameters()
```
Get the clientParameters.

Returns:

See above.

initializePrep
```
public static void initializePrep(BootstrapConfig cfg)
```
Initialize core UI services and create or re-create the singleton instance of this class. This MUST only be called AFTER the security manager and dispatcher have been initialized BUT BEFORE any call to getInstance().

Parameters:

cfg - The bootstrap configuration file.

initOSResources
```
public void initOSResources()
```
Initializes the system resources. The method must be called during ThinClient initialization after the user session has been established.

initializePost
```
public static void initializePost(BootstrapConfig cfg,
                                  Session session,
                                  java.lang.Object context,
                                  StartupParameters startupParameters,
                                  java.lang.String iniFileName)
```
Initialize network services (must only be called after the user has been authenticated AND after initializePrep(com.goldencode.p2j.cfg.BootstrapConfig) has been called).

Parameters:

cfg - The configuration to use for setup of the client.

session - The connection to the server. null if this is running on the server side (and thus there is no network session).

context - The security context (if non-null). This is only used when run on the server. This context must be propagated to other threads which need to access context-specific

startupParameters - Client startup parameters.

iniFileName - Name of the ini configuration file specified as client startup.

loadEnvironment
```
public static void loadEnvironment(BootstrapConfig cfg)
```
The method is called when the environment has been fully initialized.

Parameters:

cfg - A valid bootstrap configuration.

setSessionTooltips
```
public static void setSessionTooltips()
```
Initialize initial tooltip settings

isDynamicLayoutEnabled
```
public static boolean isDynamicLayoutEnabled()
```
Returns true when dynamic layout is enabled.

Returns:

see above

isForceDialogsInCenterEnabled
```
public static boolean isForceDialogsInCenterEnabled()
```
Returns true when force-dialogs-in-center is enabled.

Returns:

see above

isBypassDefaultWindowShowInPauseNoMessage
```
public static boolean isBypassDefaultWindowShowInPauseNoMessage()
```
Returns true when bypass-default-window-show-in-pause-no-message is enabled.

Returns:

see above

updateClientMetrics
```
public void updateClientMetrics()
```
Updates client metrics and pushes them to the server.

getStartupParameters
```
public StartupParameters getStartupParameters()
```
Startup parameters getter. Note the method will return a default parameters instance up until initializePost(BootstrapConfig, Session, Object, StartupParameters, String) is called where the actual and valid startup parameters are assigned.

Returns:

The startup parameters object, never null.

getEnvVersion
```
public java.lang.String getEnvVersion()
```
Getter for envVersion.

Returns:

See above.

getUnderWindows
```
public boolean getUnderWindows()
```
Getter for underWindows.

Returns:

See above.

clearTerminal
```
private void clearTerminal()
```
Clears all content from the terminal. This is a direct output operation that clears the screen through ncurses.

terminate
```
public static void terminate()
```
When run in-process on the server, the client has threads with security context that must be shutdown. This method synchronously causes the threads to exit and returns when they are gone.

suspend
```
public void suspend(boolean silent)
```
Temporarily halts the client UI processing (key reading, normal drawing mode) After entering suspend mode, the current contents of the terminal are cleared. Use resume(boolean) to return to normal mode.

Parameters:

silent - silent mode flag value that can change driver reaction for some suspend/resume.

isWaitState
```
public static boolean isWaitState()
```
Check if wait state is active

Returns:

true if wait state is active

setActiveComboBox
```
public void setActiveComboBox(ComboBox activeComboBox,
                              int widgetId,
                              MousePtrWrapper ptr)
```
(De)register combo-box with active drop down.

Parameters:

activeComboBox - COMBO-BOX with active drop down or null when deacticated

widgetId - the ID of the widget which caused locking

ptr - locked mouse pointer

resetActiveComboBox
```
public void resetActiveComboBox()
```
Reset the active combo box global reference and the locked mouse pointer that has been used by the active drop down.

lockMousePointer

public void lockMousePointer(int widgetId,
                             MousePtrWrapper ptr)

Lock mouse pointer

Parameters:: widgetId - the ID of the widget which caused locking; ptr - locked mouse pointer

isMousePointerLocked
```
public static boolean isMousePointerLocked()
```
Check if mouse pointer is locked

Returns:

true if mouse pointer is locked

lockedMousePointer
```
public static java.util.Optional<MousePtrWrapper> lockedMousePointer()
```
Get locked mouse pointer if it is locked

Returns:

locked mouse pointer if it is locked

activeComboBox
```
public ComboBox<?> activeComboBox()
```
Get the combo-box with active drop-down.

Returns:

the active combo-box.

setUserName
```
public void setUserName(java.lang.String userName)
```
Sets new user name to be associated with given client session.

Parameters:

userName - New OS user name.

getUserName
```
public java.lang.String getUserName()
```
Returns the current user name for session.

Specified by:

getUserName in interface ClientExports

Returns:

The current OS logged in user name.

getHostName
```
public java.lang.String getHostName()
```
Returns the currently connected client's machine name for session.

Specified by:

getHostName in interface ClientExports

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 ClientExports

Parameters:

name - The name of the host to get IP.

Returns:

The current system logged in for the given session.

pushHover
```
public void pushHover(MouseHoverAction action)
```
Push action of the currently hovered widget on the stack

Parameters:

action - action of the currently hovered widget on the stack

getFileSystem
```
public FileSystem getFileSystem()
```
Returns the client-managed file system.

Returns:

A valid FileSystem reference.

popHover
```
public MouseHoverAction popHover()
```
Pop action of the recently hovered widget off the stack

Returns:

action of the recently hovered widget or null if the stack is empty

deregisterMouseActions
```
public final void deregisterMouseActions(java.util.Collection<MouseWidgetAction> toRemove)
```
Remove all registered mouse hover actions provided in the argument list.

Parameters:

toRemove - actions to remove

refreshHoverImpl
```
public void refreshHoverImpl(Window<?> wnd)
```
Refresh mouse cursor shape for currently hovered widget

refreshHover
```
public void refreshHover()
```
Refresh mouse cursor shape for ACTIVE-WINDOW

refreshHover
```
public void refreshHover(int widgetId)
```
Refresh mouse cursor shape for window

Parameters:

widgetId - Widget Id.

resume
```
public void resume(boolean silent)
```
Re-enables client UI processing (key reading, normal drawing mode). Before resuming the current contents of the terminal are cleared. This is the mechanism to return to normal processing mode after having called suspend(boolean).

Parameters:

silent - silent mode flag value that can change driver reaction for some suspend/resume.

refreshScreen
```
public void refreshScreen()
```
Redraw everything after suspending terminal or after use of terminal stream.

suspendedPause
```
public int suspendedPause()
```
Indefinitely pause and display the default message. This method works when in suspend mode and it will not trigger a full redraw of the entire screen.

Returns:

The key code of the key pressed to clear the pause or -1 on any failure.

sendToStream
```
public int sendToStream(java.lang.String message)
```
Send message to stream.

Parameters:

message - Message to send.

Returns:

redirection status.

pauseBeforeHide
```
public void pauseBeforeHide()
```
Process pause before hide as requested.

pauseAfterPage
```
public void pauseAfterPage()
```
Process pause after page for terminal stream.

apply
```
public ScreenBuffer[] apply(int widgetId,
                            int eventCode,
                            ScreenBuffer[] inbuf,
                            EventList eventList,
                            boolean explicit)
```
Applies the encoded event to the widget currently in focus in the given frame, or directly to the specified widget.

Specified by:

apply in interface ClientExports

Parameters:

widgetId - ID of frame or a contained widget.

eventCode - Progress-compatible event code.

inbuf - The screen buffer for the related frame if the widgetId is from a widget that is a frame or is contained within a frame. May be null if the widget is not associated with any frame (e.g. the session window).

eventList - The list of the latest triggers (which may be more recent than that used in any previous WAIT-FOR).

explicit - true if this APPLY call has an explicit target.

Returns:

Updated data for the associated frame representing the current screen values of all widgets in that frame. May be null if the frame has no data containing widgets or if the input screen buffer is null or is otherwise invalid.

apply
```
public void apply(long resId,
                  int eventCode,
                  EventList eventList)
```
Apply this event to a non-widget resource.

Specified by:

apply in interface ClientExports

Parameters:

resId - The resource ID to which this events needs to be applied.

eventCode - Progress-compatible event code.

eventList - The list of the latest triggers (which may be more recent than that used in any previous WAIT-FOR).

validateDisplayValue
```
public boolean validateDisplayValue()
```
Performs widget display value format validation. The method resolves currently focused widget and calls Widget.validateDisplayValue() on it.

Specified by:

validateDisplayValue in interface ClientExports

Returns:

Returns the value returned by Widget.validateDisplayValue() or true if no valid focused widget could be resolved.

sendToUnnamedStream
```
private void sendToUnnamedStream(java.lang.String message)
```
Send message to unnamed stream if redirection is active.

Parameters:

message - Message to send.

locateInFocus
```
private Widget locateInFocus(int widgetId)
```
Locate widget in focus.

Parameters:

widgetId - Widget ID to start search from.

Returns:

reference to widget in focus.

isValidFocusTarget
```
private static boolean isValidFocusTarget(Widget inFocus,
                                          Frame inFocusFrame)
```
Determines if the given widget in focus is a valid focus target.

Parameters:

inFocus - The widget in focus.

inFocusFrame - Parent frame of the widget in focus. Can be null.

Returns:

true if the given widget in focus is a valid focus target.

adjustFocusBeforeProcessing

private boolean adjustFocusBeforeProcessing(boolean explicit,
                                            Widget saveFocus,
                                            Widget focusFrame,
                                            int focusState,
                                            boolean frameChangeEvent)

Adjust focus before processing event.

Parameters:: explicit - Explicit event flag.; saveFocus - Saved old focused widget.; focusFrame - Frame which holds focused widget.; focusState - Focus state.; frameChangeEvent - true indicates frame change event.
Returns:: true if pending focus is valid.

refocusTarget

private void refocusTarget(int widgetId,
                           Widget inFocus)

Set focus to target.

Parameters:: widgetId - Widget ID.; inFocus - Focus target.

adjustFocusForTriggerMode
```
private void adjustFocusForTriggerMode(Widget pending,
                                       boolean isPendingValid)
```
Adjust focus when processing nested triggers.

Parameters:

pending - Pending focus target.

isPendingValid - flag indicating valid pending focus target.

handleFillInEntry

private void handleFillInEntry(int eventCode,
                               Widget inFocus)

Process event for FillIn widgets.

Parameters:: eventCode - Event code.; inFocus - Widget in focus.

bell
```
public void bell()
```
Rings a bell on the terminal.
This method corresponds to the Progress statement:
```
 BELL
 
```
Specified by:

bell in interface ClientExports

choose
```
public ChooseData choose(int frameId,
                         ChooseData c,
                         EventList wl)
```
Performs CHOOSE processing.
This method corresponds to this Progress statement:
CHOOSE

Specified by:

choose in interface ClientExports

Parameters:

frameId - ID of frame this request came for

c - CHOOSE statement options

wl - Event list.

Returns:

result of CHOOSE processing.

chooseWorker

private ChooseData chooseWorker(ChooseData c,
                                EventList wl,
                                Frame frame,
                                Widget[] comps,
                                int toFocusId)

CHOOSE processor.

Parameters:: c - Input CHOOSE parameters.; wl - Event list.; frame - Target frame.; comps - Widget list.; toFocusId - Target focus ID.
Returns:: result of CHOOSE processing.

restoreEnabledAfterChoose

private ChooseData restoreEnabledAfterChoose(ChooseData c,
                                             Frame frame,
                                             Widget[] comps,
                                             ScreenBuffer[] sbo,
                                             boolean saveEnabled)

Restore enabled widget after CHOOSE processing.

Parameters:: c - Input CHOOSE data.; frame - Target frame.; comps - Array of widgets to process.; sbo - Output screen buffers array.; saveEnabled - Saved frame enabled flag.
Returns:: Updated CHOOSE data.

enterChoose

private void enterChoose(ChooseData c,
                         Frame frame,
                         java.lang.Integer[] focusId,
                         Widget[] comps)

Start CHOOSE processing.

Parameters:: c - CHOOSE parameters.; frame - Target frame.; focusId - List of focus IDs.; comps - Widget list.

prepareChooseWidgetList

private Widget[] prepareChooseWidgetList(ChooseData c,
                                         Frame frame,
                                         java.lang.Integer[] focusId)

Prepare list of widgets involved in CHOOSE.

Parameters:: c - CHOOSE parameters.; frame - Target frame.; focusId - List of focused widget IDs.
Returns:: List of widgets.

enableChooseWidgets

private void enableChooseWidgets(ChooseData c,
                                 Widget[] list)

Enable widgets involved in CHOOSE.

Parameters:: c - Input CHOOSE data.; list - List of widgets to enable.

handleOutstandingNextPrompt
```
private int handleOutstandingNextPrompt(int toFocusId,
                                        int[] widgetIds)
```
Handle outstanding NEXT-PROMPT clause.

Parameters:

toFocusId - ID of pending widget.

widgetIds - Widget ID list.

Returns:

final target widget ID

clear
```
public ScreenBuffer[] clear(int frameId,
                            boolean noPause)
```
Clears the data and colors for all fill-in fields of the frame. For down frames, also clears side labels.
This method corresponds to this Progress statement:
CLEAR

Specified by:

clear in interface ClientExports

Parameters:

frameId - The ID of the frame to clear.

noPause - true if NO-PAUSE option was used (no pause will occur even if the client detects that the user has had no chance to review the screen's contents).

Returns:

The screen buffer array for all editable frames.

clearAll
```
public ScreenBuffer[] clearAll(int frameId,
                               boolean noPause)
```
Clears all occurrences for the down frame and resets the current display position to the top of the frame.
This method corresponds to this Progress statement:
CLEAR ALL

Specified by:

clearAll in interface ClientExports

Parameters:

frameId - The ID of the frame to clear.

noPause - true if NO-PAUSE option was used (no pause will occur even if the client detects that the user has had no chance to review the screen's contents).

Returns:

The screen buffer array for all editable frames.

clearAll
```
private ScreenBuffer clearAll(int frameId,
                              boolean noPause,
                              boolean resolveBuffer)
```
Clears all occurrences for the down frame and resets the current display position to the top of the frame.
This method corresponds to this Progress statement:
CLEAR ALL

Parameters:

frameId - The ID of the frame to clear.

noPause - true if NO-PAUSE option was used (no pause will occur even if the client detects that the user has had no chance to review the screen's contents).

resolveBuffer - When true, resolve the frame's screen buffer and return it.

Returns:

The frame's screen buffer.

deselectRows
```
public void deselectRows(int browseId)
```
Implements the DESELECT-ROWS() BROWSE widget method.

Specified by:

deselectRows in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for

notifyColumnsUpdated
```
public void notifyColumnsUpdated(int browseId,
                                 boolean refreshData)
```
Notify the client that columns have been added to the browse.

Specified by:

notifyColumnsUpdated in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

refreshData - true to refresh row data, false to only update UI.

hasRows
```
public boolean hasRows(int browseId)
```
Gets a value that indicates whether the browse contains one or more rows (including new rows).

Specified by:

hasRows in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

true if the browse contains one or more rows.

scrollToCurrentRow
```
public void scrollToCurrentRow(int browseId)
```
Scrolls a browse (if necessary) to bring the currently selected row into view. If the browse supports multiple selections, then SCROLL-TO-CURRENT-ROW() brings the most recently selected row into view.
The position of the scrolled row is the first row in the browse viewport, unless the current row is already visible. In this case, the current row remains in the original position.

Specified by:

scrollToCurrentRow in interface ClientExports

Parameters:

browseId - the id if the Browse widget

Throws:

ErrorConditionException - if a numbered error occurs.

scrollToSelectedRow
```
public void scrollToSelectedRow(int browseId,
                                int selectedRowIndex)
```
Scrolls a browse (if necessary) to bring the specified selected row into view.

Specified by:

scrollToSelectedRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

selectedRowIndex - Selected row within the browse. A numbered list of selected rows, starting at 1 is maintained. When the SCROLL-TO-SELECTED-ROW(n) method is encountered, the list is iterated to find the nth selected row.

Throws:

ErrorConditionException - if a numbered error occurs.

refreshCurrentRow
```
public void refreshCurrentRow(int browseId,
                              BrowseRow row)
```
Refresh the current browse row using the provided data.

Specified by:

refreshCurrentRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

row - Container with the new data for the current row. If an BrowseRow.data element is null, corresponding cell shouldn't be refreshed.

rowEntryCreated
```
public void rowEntryCreated(int browseId,
                            int newRowId)
```
Performs client-side actions after a new row has been added to the backing result set using CREATE-RESULT-LIST-ENTRY. Updates row IDs in the current view.

Specified by:

rowEntryCreated in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

newRowId - 0-based index of the newly created row in the browse model. Replaces the old negative row id of the current new row.

rowEntryDeleted
```
public void rowEntryDeleted(int browseId,
                            int deletedRowId)
```
Performs client-side actions after a row has been deleted from the backing result set using DELETE-RESULT-LIST-ENTRY. Updates row IDs in the current view.

Specified by:

rowEntryDeleted in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

deletedRowId - 0-based index of the deleted row in the browse model.

refreshBrowseColumnBuffers
```
public void refreshBrowseColumnBuffers(Browse browse)
```
Refresh server-side screen buffers of the columns of the given browse.

Parameters:

browse - Target browse.

deleteEditorLine
```
public java.lang.Boolean deleteEditorLine(int id)
```
Delete the line of text in which the targeted editor's cursor currently resides. Leave the cursor at the leftmost position of the same line number (which will be the line previously below this one if the cursor is not already on the last line) or at the leftmost position of the last line (if there are no lines below this one).

Specified by:

deleteEditorLine in interface ClientExports

Parameters:

id - Widget id of the target editor.

Returns:

true if the line was deleted.

setEditorSelection
```
public java.lang.Boolean setEditorSelection(int id,
                                            int start,
                                            int end)
```
Selects text in the targeted editor between start and end points.

Specified by:

setEditorSelection in interface ClientExports

Parameters:

id - Widget id of the target editor.

start - Starting offset.

end - Ending offset.

Returns:

true if the operation succeeded.

setFillInSelection
```
public java.lang.Boolean setFillInSelection(int id,
                                            int start,
                                            int end)
```
Selects text in the targeted fill-in between start and end points.

Specified by:

setFillInSelection in interface ClientExports

Parameters:

id - Widget id of the fill-in editor.

start - Starting offset.

end - Ending offset.

Returns:

true if the operation succeeded.

editCopySelection
```
public boolean editCopySelection(int id,
                                 boolean cut)
```
Copies the currently selected text from an Editor, Fill-In or ComboBox to Clibpoard.

Specified by:

editCopySelection in interface ClientExports

Parameters:

id - Widget id of the target editor.

cut - Flag indicating EDIT-CUT operation in use is TRUE.

Returns:

true if operation success, false otherwise.

editPaste
```
public boolean editPaste(int id)
```
Paste the Clipboard content into an Editor, Fill-In or ComboBox starting with current cursor position.

Specified by:

editPaste in interface ClientExports

Parameters:

id - Widget id of the target editor.

Returns:

true if operation success, false otherwise.

isEditCanPaste
```
public boolean isEditCanPaste(int id)
```
Checks if the Clipboard has data to paste from.

Specified by:

isEditCanPaste in interface ClientExports

Parameters:

id - Widget id of the target editor.

Returns:

true if operation success, false otherwise.

isEditCanUndo
```
public boolean isEditCanUndo(int id)
```
Checks if the widget can handle text undo request.

Specified by:

isEditCanUndo in interface ClientExports

Parameters:

id - Widget id of the target editor.

Returns:

true if operation success, false otherwise.

editUndo
```
public boolean editUndo(int id)
```
Undo the last changes in text editable widget if possible.

Specified by:

editUndo in interface ClientExports

Parameters:

id - Widget id of the target editor.

Returns:

true if operation success, false otherwise.

removeEditSelection
```
public void removeEditSelection(int id)
```
Removes the currently selected text from an Editor, Fill-In or ComboBox.

Specified by:

removeEditSelection in interface ClientExports

Parameters:

id - Widget id of the target editor.

setEditorCursorLine
```
public java.lang.Boolean setEditorCursorLine(int id,
                                             int line)
```
Sets the cursor line of the targeted editor

Specified by:

setEditorCursorLine in interface ClientExports

Parameters:

id - Widget id of the target editor.

line - the new cursor line value

Returns:

true if the cursor line is valid and set, null if no widget with given id is found

setEditorCursorChar
```
public java.lang.Boolean setEditorCursorChar(int id,
                                             int pos)
```
Sets the cursor position in the current line of the targeted editor

Specified by:

setEditorCursorChar in interface ClientExports

Parameters:

id - Widget id of the target editor.

pos - the new cursor position value

Returns:

true if the cursor position is valid and set, null if no widget with given id is found

debug
```
public void debug(int id,
                  java.lang.String message)
```
Utility method for debugging, can be used to include information from the server-side to the client-side log

Specified by:

debug in interface ClientExports

Parameters:

id - widget id

message - String parameter

setCursorOffset
```
public java.lang.Boolean setCursorOffset(int id,
                                         int offset)
```
Sets the cursor offset of the targeted widget.

Specified by:

setCursorOffset in interface ClientExports

Parameters:

id - Target widget id.

offset - The new offset value.

Returns:

true if the cursor offset is valid and set, null if no widget with given id is found.

insertEditorString
```
public java.lang.Boolean insertEditorString(int id,
                                            java.lang.String txt)
```
Inserts string at the current cursor position of the targeted editor.

Specified by:

insertEditorString in interface ClientExports

Parameters:

id - Widget id of the target editor.

txt - the string to be inserted

Returns:

true if the string is inserted, null if no widget with given id is found

insertEditorFile
```
public java.lang.Boolean insertEditorFile(int id,
                                          java.lang.String filePath)
```
Inserts the content of a file at the current cursor position of the targeted editor.

Specified by:

insertEditorFile in interface ClientExports

Parameters:

id - Widget id of the target editor.

filePath - The file to be inserted. Full or relative path may be used. In latter case, the PROPATH is used to find the file.

Returns:

true if the file content is inserted, null if no widget with given id is found.

replaceEditorSelectionText
```
public java.lang.Boolean replaceEditorSelectionText(int id,
                                                    java.lang.String txt)
```
Replace selection of the targeted editor with a given string.

Specified by:

replaceEditorSelectionText in interface ClientExports

Parameters:

id - Widget id of the target editor.

txt - the replacement string

Returns:

true if the selection is replaced, null if no widget with given id is found

replaceEditorString
```
public java.lang.Boolean replaceEditorString(int id,
                                             java.lang.String from,
                                             java.lang.String to,
                                             int flag)
```
Replace given substring of the targeted editor with a given string

Specified by:

replaceEditorString in interface ClientExports

Parameters:

id - Widget id of the target editor.

from - the string to be replaced

to - the replacement string

flag - the replacement mode flag as described in 4GL EDITOR:REPLACE documentation

Returns:

true if the replacement was performed, null if no widget with given id is found

searchInEditor

public java.lang.Boolean searchInEditor(int id,
                                        java.lang.String pattern,
                                        int mode)

Searches for a specified string starting from the current text caret position.

Specified by:

searchInEditor in interface ClientExports

Parameters:

id - Widget id of the target editor.

pattern - The string to be search. No wildcard allowed.

mode - a combinations of flags that specifies the type of search to be performed. The following values are accepted:

Type of search	Flag value
EditorWidget.FIND_NEXT_OCCURRENCE	1
EditorWidget.FIND_PREV_OCCURRENCE	2
EditorWidget.FIND_CASE_SENSITIVE	4
EditorWidget.FIND_WRAP_AROUND	16
EditorWidget.FIND_SELECT	32

Returns:

if the text is found and caret moved, the method returns yes.

enable
```
public ScreenBuffer[] enable(int frameId,
                             int[] widgetId,
                             ScreenBuffer[] sb,
                             boolean enabled,
                             int windowId,
                             int[] tabItemList)
```
Enables/disables input for all specified field-level widgets of the frame. If the enabled status changes, the widgets redraw themselves with the appropriate visual cue added or removed. This redrawing is limited to the widget rectangle, however, and should preserve any PUT SCREEN output that may have appeared anywhere else on the frame.
This method maintains the tab order of the specified frame. Every widget listed for enabling is moved to the end of the tab order retaining the same order as specified in the list. If a frame with x, y and z widgets gets an enable call for y and x (in that order), then the tab order will change from the default x y z to z y x. In the case where all widgets are enabled, no change to the tab order occurs.
This method corresponds to these Progress statements:
DISABLE ALL
DISABLE ALL EXCEPT
ENABLE ALL
ENABLE ALL EXCEPT

Specified by:

enable in interface ClientExports

Parameters:

frameId - ID of frame this request came for

widgetId - array of field level widget IDs to be enabled or null, which means all of them.

sb - The currently editable frames screen buffer array.

enabled - New state for widgets.

windowId - Id of target window

tabItemList - The array of widgets ids according to their tab order.

Returns:

ScreenBuffer array with the current values.

enable
```
public ScreenBuffer[] enable(int frameId,
                             int[] widgetId,
                             ScreenBuffer[] sb,
                             boolean enabled,
                             int windowId,
                             boolean resolveBuffer,
                             int[] tabItemList)
```
Enables/disables input for all specified field-level widgets of the frame. If the enabled status changes, the widgets redraw themselves with the appropriate visual cue added or removed. This redrawing is limited to the widget rectangle, however, and should preserve any PUT SCREEN output that may have appeared anywhere else on the frame.
This method maintains the tab order of the specified frame. Every widget listed for enabling is moved to the end of the tab order retaining the same order as specified in the list. If a frame with x, y and z widgets gets an enable call for y and x (in that order), then the tab order will change from the default x y z to z y x. In the case where all widgets are enabled, no change to the tab order occurs.
This method corresponds to these Progress statements:
DISABLE ALL
DISABLE ALL EXCEPT
ENABLE ALL
ENABLE ALL EXCEPT

Parameters:

frameId - ID of frame this request came for

widgetId - array of field level widget IDs to be enabled or null, which means all of them.

sb - The currently editable frames screen buffer array.

enabled - New state for widgets.

windowId - Id of target window

resolveBuffer - Flag indicating if the screen buffer needs to be resolved and returned.

tabItemList - tab items

Returns:

The frames screen buffer array, only if resolveBuffer flag is set to true.

getEnablePendingFocus
```
private Widget getEnablePendingFocus(Widget focus,
                                     int[] widgetId,
                                     boolean enabled)
```
Get widget which may receive focus after ENABLE.

Parameters:

focus - Frame ID.

widgetId - Array of enabled widget IDs.

enabled - true if call enables widgets.

Returns:

reference to widget which may receive focus or null if no focus management should be performed.

isEmpty
```
private static boolean isEmpty(int[] widgetId)
```
Check if array of widget IDs is empty.

Parameters:

widgetId - Array of widget IDs.

Returns:

true if array is null or contains no elements.

enableWorker

private void enableWorker(int[] widgetId,
                          ScreenBuffer[] sb,
                          boolean enabled,
                          Widget focus,
                          Frame frame,
                          boolean preview,
                          int windowId)

Widget enabling worker.

Parameters:: widgetId - List of widget IDs.; sb - Screen buffer array.; enabled - New enabled state.; focus - Focused widget.; frame - Focused frame.; preview - Preview flag.; windowId - target window id.

redrawEnabled

private void redrawEnabled(Frame frame,
                           Widget[] affw)

Redraw enabled widgets.

Parameters:: frame - Target frame.; affw - List of widgets to redraw.

processEnable

private Widget[] processEnable(Frame frame,
                               boolean enabled,
                               int[] widgetId,
                               ScreenBuffer[] sb,
                               Widget focus)

Process enable.

Parameters:: frame - Target frame.; enabled - New enabled state.; widgetId - List of widget IDs.; sb - Screen buffer array.; focus - Focused widgets.
Returns:: List of widgets.

moveAfterTabItem
```
public logical moveAfterTabItem(int frameId,
                                int widget,
                                int after)
```
Move specified widget after the widget "after".

Specified by:

moveAfterTabItem in interface ClientExports

Parameters:

frameId - ID of the frame that contains widgets being moved.

widget - ID of the widget to move.

after - ID of the widget after which the widget should be moved.

Returns:

TRUE - the widget was moved successfully, FALSE - otherwise.

moveBeforeTabItem
```
public logical moveBeforeTabItem(int frameId,
                                 int widget,
                                 int before)
```
Move specified widget before the widget "before" in the tab order. Widgets must be in the same field-group, that is checked on the server-side.

Specified by:

moveBeforeTabItem in interface ClientExports

Parameters:

frameId - ID of the frame that contains widgets being moved.

widget - ID of the widget to move.

before - ID of the widget before which the widget should be moved.

Returns:

TRUE - the widget was moved successfully, FALSE - otherwise.

updateTabItemList
```
public void updateTabItemList(int[] frameIds,
                              int[][] tabItemLists)
```
Update the tab item list for the given frame.

Specified by:

updateTabItemList in interface ClientExports

Parameters:

frameIds - IDs of the frame(s) that changes its tab item list.

tabItemLists - The array of widgets ids according to their tab order, for each frame.

setPendingFocusApply
```
public void setPendingFocusApply(Widget widget)
```
Set pendingFocusApply reference.

Parameters:

widget - Widget reference.

enable
```
public ScreenBuffer[] enable(int frameId,
                             int widgetId,
                             ScreenBuffer[] sb,
                             boolean enabled,
                             int windowId,
                             int[] tabItemList)
```
Enables/disables input for the specified field-level widget. This method preserves the current tab order of the frame.
This method corresponds to these Progress statement:
widget:SENSITIVE=true/false

Specified by:

enable in interface ClientExports

Parameters:

frameId - ID of frame this request came for

widgetId - widget ID to be enabled or disabled

sb - The currently editable frames screen buffer array.

enabled - New state of the widget

windowId - Id of target window

tabItemList - The array of widgets ids according to their tab order.

Returns:

The screen buffer array for editable frames.

underline
```
public void underline(int frameId,
                      int[] widgetIds)
```
Underlines a set of widgets of the specified frame. If the target frame is not a down frame, the frame is simply cleared.

Specified by:

underline in interface ClientExports

Parameters:

frameId - The frame ID this request came for.

widgetIds - The array of field level widget IDs to be underlined.

down
```
public WidgetConfig[] down(int frameId,
                           int lines,
                           boolean cond,
                           int sid)
```
Positions the cursor on a new line in a down frame. When lines is negative, this operates as a move of the cursor up.
This method corresponds to these Progress statements:
DOWN n UP n

Specified by:

down in interface ClientExports

Parameters:

frameId - ID of frame this request came for

lines - Number and direction of iterations of the data to move. If positive, the move is down, if negative the move is up. 0 is ignored.

cond - true means conditional down; lines is assumed to be 1

sid - The stream for which pending PUT or EXPORT output must be ended and written to the stream. -1 means that this is not necessary.

Returns:

If this is a down frame, the configs for the widgets in the new row. Otherwise null is returned.

downWorker
```
private boolean downWorker(int frameId,
                           int steps,
                           boolean conditional,
                           boolean newStream,
                           boolean noPause)
```
Positions the cursor on a new line in a down frame. When lines is negative, this operates as a move of the cursor up.
This method corresponds to these Progress statements:
DOWN n UP n

Parameters:

frameId - ID of frame this request came for

steps - Number and direction of iterations of the data to move. If positive, the move is down, if negative the move is up. 0 is ignored.

conditional - true when this call is for conditional up/down.

newStream - true when stream switch has just occurred

noPause - if true then no pause will be generated on cursor wrap.

Returns:

true if wrap is occurred.

flushNow
```
private int flushNow(int steps,
                     Stream stream)
```
Perform immediate stream flush.

Parameters:

steps - DOWN size.

stream - Output stream.

Returns:

The next line number AFTER all buffered lines are output.

advanceCursor

private boolean advanceCursor(int steps,
                              boolean noPause,
                              Frame frame)

Advance DOWN cursor.

Parameters:: steps - UP/DOWN size.; noPause - Disable pause processing/; frame - Target frame.
Returns:: true if cursor wrap has occurred

clearFrame

private void clearFrame(int frameId,
                        boolean conditional,
                        Frame frame,
                        boolean down)

Clear frame.

Parameters:: frameId - Frame ID.; conditional - true if DOWN processing is conditional/; frame - Target frame.; down - Direction flag.

isReducedDown

private boolean isReducedDown(boolean newStream,
                              Frame frame,
                              boolean down,
                              Stream stream)

Determine if DOWN is a reduced one.

Parameters:: newStream - Stream.; frame - Target frame.; down - DOWN direction.; stream - Old stream.
Returns:: true if DOWN is a reduced one.

unconditionalRedirectedDown

private void unconditionalRedirectedDown(int frameId,
                                         int steps,
                                         Frame frame,
                                         RedirectedTerminal rt,
                                         Stream stream,
                                         boolean reducedDown,
                                         int prevLineNum,
                                         boolean flushed)

Handle unconditional DOWN processing in redirected mode.

Parameters:: frameId - ID of frame this request came for.; steps - Number and direction of iterations of the data to move. If positive, the move is down, if negative the move is up. 0 is ignored.; frame - The processed frame.; rt - The RedirectedTerminal.; stream - The redirected stream.; reducedDown - true if this down is reduced.; prevLineNum - The next line number AFTER all buffered lines were flushed or -1 if the RedirectedTerminal was not flushed.; flushed - true if the RedirectedTerminal was flushed.

down
```
public WidgetConfig[] down(int frameId,
                           int lines,
                           int streamId,
                           boolean cond,
                           boolean endOut)
```
Positions the cursor on a new line in a down frame. When lines is negative, this operates as a move of the cursor up.
The terminal will be temporarily redirected to the given stream for the duration of this method call. This allows the caller to avoid bracketing this call with switchOutput(int, boolean) invocations, as the same result is achieved internal to this method's operation.
This method corresponds to these Progress statements:
DOWN n UP n

Specified by:

down in interface ClientExports

Parameters:

frameId - ID of frame this request came for

lines - Number and direction of iterations of the data to move. If positive, the move is down, if negative the move is up. 0 is ignored.

streamId - The stream to be used as the temporary terminal redirection (only for the duration of this call).

cond - true means conditional down; lines is assumed to be 1

endOut - true to force any pending PUT or EXPORT output to be ended for the given stream (so long as that stream is not the terminal).

Returns:

If this is a down frame, the configs for the widgets in the new row. Otherwise null is returned.

getFocusManager
```
public FocusManager getFocusManager()
```
Get the focus manager.

Returns:

current focus manager.

getFocus
```
public int getFocus()
```
Get ID of the widget which has the input focus.

Specified by:

getFocus in interface ClientExports

Returns:

ID of the focused widget.

setFocus
```
public void setFocus(int widgetId,
                     boolean forceWindowActivation)
```
Forces focus on the supplied widget. This method will set focus regardless the widget is or is not focusable (sensitive, read-only attributes are ignored).

Specified by:

setFocus in interface ClientExports

Parameters:

widgetId - Id of the widget to focus.

forceWindowActivation - Flag to force enclosing window activation.

getTimePBH
```
public int getTimePBH()
```
Returns pause before hide time for automatic frame hiding.

Returns:

See above.

isHonorPBH
```
public boolean isHonorPBH()
```
Returns true if pause before hide mode is active.

Returns:

See above.

getTextPBH
```
public java.lang.String getTextPBH()
```
Returns text displayed while processing pbh.

Returns:

See above.

postServerEvent
```
public void postServerEvent(ServerEvent event)
```
Post the server event to the client side. The event will be executed only on the next PROCESS-EVENTS or UI-blocking statement.

Specified by:

postServerEvent in interface ClientExports

Parameters:

event - The server event.

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 ClientExports

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,
                    boolean delayed)
```
Send a PUBLISH notification to a remote application.

Specified by:

publish in interface ClientExports

Parameters:

subId - The subscriber's ID, known by the remote application.

event - The published event name.

param - The parameters for this event.

delayed - Flag indicating if the PUBLISH must be executed immediately (when true) or posted to the client's event queue, otherwise.

postMouseEvent
```
public void postMouseEvent(java.awt.event.MouseEvent event,
                           int windowId)
```
Post the specified mouse event to the EventManager, which will save it in a dedicated queue.
This usage of an AWT event class is intentional. It is being used separately from the AWT/Swing event model. No other AWT/Swing usage is occurring in this class.

Parameters:

event - The mouse event.

windowId - The window where the event was captured.

postMouseEvent
```
public void postMouseEvent(java.awt.event.MouseEvent event,
                           int windowId,
                           int sourceId)
```
Post the specified mouse event to the EventManager, which will save it in a dedicated queue.
This usage of an AWT event class is intentional. It is being used separately from the AWT/Swing event model. No other AWT/Swing usage is occurring in this class.

Parameters:

event - The mouse event.

windowId - The window where the event was captured.

sourceId - The explicit source of this mouse event.

applyMessageA
```
public void applyMessageA(int hWnd,
                          int msg,
                          int wParam,
                          int lParam,
                          boolean sync)
```
Emulates PostMessageA and SendMessageA Win32 function by processing the message synchronous or asynchronous.

Specified by:

applyMessageA in interface ClientExports

Parameters:

hWnd - Integer handle value of the window containing the widget (same as widget ID).

msg - Message to be processed.

wParam - Additional message-specific information.

lParam - Additional message-specific information.

sync - Indicates whether the message process is synchronous.

cacheRepaint
```
public boolean cacheRepaint(WidgetId id,
                            PaintEvent evt)
```
Cache the given PaintEvent so that it will be processed when the UI gets into a user-interactive state.

Parameters:

id - The window ID to which the repaint belongs.

evt - The event to be cached.

Returns:

true if the event was cached, false otherwise.

postOSEvent
```
public void postOSEvent(Event event)
```
Post an OS event (which needs to be processed by the 4GL drawing layer, but not necessarily as a legacy 4GL event) to the event queue.

Parameters:

event - The event to be posted.

removeServerEvents
```
public void removeServerEvents(int[] eventIds)
```
Remove from the server event queue all the events in the given list, identified by their id.

Specified by:

removeServerEvents in interface ClientExports

Parameters:

eventIds - The list of event IDs to be removed.

invokeOnServer
```
public java.lang.Object invokeOnServer(java.util.function.Supplier<ServerReturnValue> code)
```
Invoke the specified server-side code, while maintaining any changes in the trigger registry.

Parameters:

code - The code to be executed.

Returns:

A custom payload returned by the server-side.

invokeLaterOS
```
public void invokeLaterOS(java.lang.Runnable runnable)
```
Asynchronously executes the supplied runnable reference on the event thread. A pseudo event is created and enqueued in the OS event queue and processed/executed in-order. The method returns right after the runnable is enqueued in the event queue.
Use this method for processing the OS input.

Parameters:

runnable - A valid Runnable reference.

Throws:

java.lang.IllegalArgumentException - when runnable is null.

invokeLaterOS
```
public void invokeLaterOS(Widget source,
                          java.lang.Runnable runnable,
                          boolean pending)
```
Asynchronously executes the supplied runnable reference on the event thread after the caller's trigger has been completed if the "pending" flag is set on, otherwise it works according to invokeLaterOS(Runnable) without "pending" flag.

Parameters:

source - A widget source which method to be executed on the event thread.

runnable - A valid Runnable reference.

pending - Indicates that the supplied runnable must be executed after the caller's trigger has been completed.

invokeLaterOS
```
public void invokeLaterOS(boolean priority,
                          java.lang.Runnable runnable)
```
Asynchronously executes the supplied runnable reference on the event thread. A pseudo event is created and enqueued in the OS event queue and processed/executed in-order. The method returns right after the runnable is enqueued in the event queue.
Use this method for processing the OS input.

Parameters:

priority - Mark OS events which need to execute with the main 4GL event processing, and not wait for a event processing loop.

runnable - A valid Runnable reference.

Throws:

java.lang.IllegalArgumentException - when runnable is null.

invokeLaterOS
```
public java.util.concurrent.ScheduledFuture<?> invokeLaterOS(java.lang.Runnable runnable,
                                                             long delay,
                                                             java.util.concurrent.TimeUnit unit)
```
Asynchronously executes the supplied runnable reference on the event thread after the specified delay. A pseudo event is created and enqueued in the OS event queue and processed/executed in-order. The method returns right after the runnable is enqueued in the event queue.
Use this method for processing the OS input.

Parameters:

runnable - A valid Runnable reference.

delay - The supplied runnable will be enqueued after the specified delay.

unit - Delay unit.

Returns:

The future object.

Throws:

java.lang.IllegalArgumentException - when runnable is null.

invokeLater
```
public static void invokeLater(java.lang.Runnable runnable)
```
Asynchronously executes the supplied runnable reference on the event thread. A pseudo event is created and enqueued in the application event queue and processed/executed in-order. The method returns right after the runnable is enqueued in the event queue.
Use this method for the widget-related application logic.

Parameters:

runnable - A valid Runnable reference.

Throws:

java.lang.IllegalArgumentException - when runnable is null.

registerPageElement
```
public void registerPageElement(int frameId,
                                boolean header)
```
Register the frame as a header or footer from the stream that is the current redirected terminal output destination. The terminal must be non-interactive for this method to process properly. Subsequent pagination operations on the stream will cause the header or footer to render as needed, without any further explicit request from the server.

Specified by:

registerPageElement in interface ClientExports

Parameters:

frameId - The id of the frame for this request.

header - true to register as a header, false to register as a footer.

registerPageElement
```
public void registerPageElement(int frameId,
                                boolean header,
                                boolean pulse)
```
Register the frame as a header or footer from the stream that is the current redirected terminal output destination. The terminal must be non-interactive for this method to process properly. Subsequent pagination operations on the stream will cause the header or footer to render as needed, without any further explicit request from the server.

Specified by:

registerPageElement in interface ClientExports

Parameters:

frameId - The id of the frame for this request.

header - true to register as a header, false to register as a footer.

pulse - true to make possible pulse on close, false otherwise.

registerPageElement
```
public void registerPageElement(int frameId,
                                boolean header,
                                int streamId)
```
Register the frame as a header or footer with the given stream as the redirected terminal output destination. Subsequent pagination operations on the stream will cause the header or footer to render as needed, without any further explicit request from the server.

Specified by:

registerPageElement in interface ClientExports

Parameters:

frameId - The id of the frame for this request.

header - true to register as a header, false to register as a footer.

streamId - The stream to associate with the frame as a page element.

registerPageElement
```
public void registerPageElement(int frameId,
                                boolean header,
                                int streamId,
                                boolean endOut)
```
Register the frame as a header or footer with the given stream as the redirected terminal output destination. Subsequent pagination operations on the stream will cause the header or footer to render as needed, without any further explicit request from the server.

Parameters:

frameId - The id of the frame for this request.

header - true to register as a header, false to register as a footer.

streamId - The stream to associate with the frame as a page element.

endOut - true to force any pending PUT or EXPORT output to be ended for the given stream (so long as that stream is not the terminal).

registerPageElement
```
public void registerPageElement(int frameId,
                                boolean header,
                                int streamId,
                                boolean endOut,
                                boolean pulse)
```
Register the frame as a header or footer with the given stream as the redirected terminal output destination. Subsequent pagination operations on the stream will cause the header or footer to render as needed, without any further explicit request from the server.

Parameters:

frameId - The id of the frame for this request.

header - true to register as a header, false to register as a footer.

streamId - The stream to associate with the frame as a page element.

endOut - true to force any pending PUT or EXPORT output to be ended for the given stream (so long as that stream is not the terminal).

pulse - true to make pulse on close, false otherwise.

deregisterPageElement
```
public void deregisterPageElement(int frameId,
                                  boolean header)
```
Deregister (remove) the frame as a header or footer from the stream that is the current redirected terminal output destination. The terminal must be non-interactive for this method to process properly.
This is called (among other places) during hide processing on the server, which must be safe to be called at any time. This is true, even if we aren't redirected, if the frame is not visible and/or if there was no page element ever registered for this frame (because it was never viewed).

Specified by:

deregisterPageElement in interface ClientExports

Parameters:

frameId - The id of the frame for this request.

header - true to register as a header, false to register as a footer.

deregisterPageElement
```
public void deregisterPageElement(int frameId,
                                  boolean header,
                                  int streamId)
```
Deregister (remove) the frame as a header or footer from the given stream.
This is called (among other places) during hide processing on the server, which must be safe to be called at any time. This is true, even if we aren't redirected, if the frame is not visible and/or if there was no page element ever registered for this frame (because it was never viewed).

Specified by:

deregisterPageElement in interface ClientExports

Parameters:

frameId - The id of the frame for this request.

header - true to register as a header, false to register as a footer.

streamId - The stream to associate with the frame as a page element.

forceDeregisterPageElement
```
public void forceDeregisterPageElement(int frameId,
                                       boolean header)
```
Deregister (remove) the frame as a header or footer from all streams in which it is registered.

Specified by:

forceDeregisterPageElement in interface ClientExports

Parameters:

frameId - The id of the frame for this request.

header - true to register as a header, false to register as a footer.

forceDeregisterPageElement
```
public void forceDeregisterPageElement(int frameId)
```
Deregister (remove) the frame either as a header or footer from all streams in which it is registered.

Parameters:

frameId - The id of the frame for this request.

forceFrameDraw
```
private void forceFrameDraw(RedirectedTerminal rt,
                            int frameId,
                            int streamId)
```
Force the given frame to output to the given stream in redirected mode.

Parameters:

rt - The current redirected terminal for the stream.

frameId - The frame to output.

streamId - The output destination.

getInputActive
```
public int getInputActive()
```
Get input active counter.

Returns:

current value of the counter.

setInputActive
```
public void setInputActive(int inputActive)
```
Set input active counter.

Parameters:

inputActive - value of the counter.

getOutputManager
```
public OutputManager getOutputManager()
```
Get input active counter.

Returns:

current value of the counter.

getFrameCol
```
public double getFrameCol(int frameId)
```
Returns the column position of the upper-left corner of the frame within its window (in coordinates that are relative to the containing window).
This method corresponds to the Progress built-in function:
```
 FRAME-COL
 
```
Specified by:

getFrameCol in interface ClientExports

Parameters:

frameId - The ID of the frame for this request.

Returns:

The column position for the upper-left corner of the frame.

getPixelsPerColumn
```
public int getPixelsPerColumn()
```
Get the PIXELS-PER-COLUMN value for this client session.

Specified by:

getPixelsPerColumn in interface ClientExports

Returns:

See above.

getPixelsPerRow
```
public int getPixelsPerRow()
```
Get the PIXELS-PER-ROW value for this client session.

Specified by:

getPixelsPerRow in interface ClientExports

Returns:

See above.

adjustFontTableSize
```
public void adjustFontTableSize(int numEntries)
```
Set the number of entries in the font-table.

Specified by:

adjustFontTableSize in interface ClientExports

Parameters:

numEntries - The new size of the font-table.

fontTableSize
```
public int fontTableSize()
```
Get the number of entries in the font-table.

Specified by:

fontTableSize in interface ClientExports

Returns:

See above.

getTextWidthPixels
```
public int getTextWidthPixels(java.lang.String txt,
                              int fontNum)
```
Get the width of the specified text, in pixels, using the specified font.

Specified by:

getTextWidthPixels in interface ClientExports

Parameters:

txt - The text.

fontNum - The entry in the font-table.

Returns:

See above.

getFontHeightPixels
```
public int getFontHeightPixels(int fontNum)
```
Get the height in pixels, of the specified font.

Specified by:

getFontHeightPixels in interface ClientExports

Parameters:

fontNum - The entry in the font-table.

Returns:

See above.

getFontKey
```
public java.lang.String getFontKey(int fontNum)
```
Resolve the font key associated with the given font, in the current window's font-table.

Specified by:

getFontKey in interface ClientExports

Parameters:

fontNum - The entry in the font-table.

Returns:

See above.

chooseFont
```
public boolean chooseFont(int fontNum,
                          int windowId,
                          boolean ansiOnly,
                          boolean fixedOnly,
                          int minSize,
                          int maxSize)
```
Change the specified font, in the user's environment.
This implements the SYSTEM-DIALOG FONT font-num statement.

Specified by:

chooseFont in interface ClientExports

Parameters:

fontNum - The font-table entry to be changed.

windowId - The id of the window that will be the parent for the dialog.

ansiOnly - Do not include graphic symbols in the set of fonts to be selected.

fixedOnly - Only allow mono-spaced fonts to be selected.

minSize - The minimum size of the font to be allowed to be selected.

maxSize - The maximum size of the font to be allowed to be selected.

Returns:

true if the dialog was accepted and false if the user cancelled the dialog.

chooseFont
```
public FontDetails chooseFont(FontDetails<?> font,
                              java.lang.Integer fontNum,
                              int windowId,
                              boolean ansiOnly,
                              boolean fixedOnly,
                              int minSize,
                              int maxSize)
```
Select font details using the font selection dialog.

Parameters:

font - Font selected by default.

fontNum - Font number or null if there is no corresponding entry in the font table.

windowId - The id of the window that will be the parent for the dialog.

ansiOnly - Do not include graphic symbols in the set of fonts to be selected.

fixedOnly - Only allow mono-spaced fonts to be selected.

minSize - The minimum size of the font to be allowed to be selected.

maxSize - The maximum size of the font to be allowed to be selected.

Returns:

details of the font selected in the dialog or null if the user has cancelled the dialog.

runTextInput
```
public java.lang.String runTextInput(int windowId,
                                     int fieldWidth,
                                     java.lang.String fieldFormat,
                                     java.lang.String initialValue,
                                     java.lang.String title)
```
Run text input dialog containing a character input field with OK and Cancel buttons.

Parameters:

windowId - Parent window ID.

fieldWidth - Width of the input field, in pixels.

fieldFormat - Format of the character input field, e.g. "x(30)".

initialValue - Initial value of the input field.

title - Dialog title.

Returns:

value of the input field or null if the dialog was dismissed.

runComboBoxInput

public java.lang.String runComboBoxInput(int windowId,
                                         int fieldWidth,
                                         java.lang.String fieldFormat,
                                         java.lang.String initialValue,
                                         java.lang.String title,
                                         ControlSetItem[] items)

Run combo box input dialog containing a combo box input field with OK and Cancel buttons.

Parameters:: windowId - Parent window ID.; fieldWidth - Width of the combo box, in pixels.; fieldFormat - Format of the combo box, e.g. "x(30)".; initialValue - Initial value of the selected value.; title - Dialog title.; items - The items which should appear in the combo box.
Returns:: the value selected or null if the dialog was dismissed.

setupPrinter
```
public PrintOptions setupPrinter(int windowId,
                                 int copies,
                                 PrintOptions printOptions)
```
Displays the Print dialog box and lets the user set the default print context for subsequent print jobs.
This implements the SYSTEM-DIALOG PRINTER-SETUP statement.
The copies parameter is currently ignored. The only supported print output in GUI is PDF and so the parameter is irrelevant.

Specified by:

setupPrinter in interface ClientExports

Parameters:

windowId - The id of the window that will be the parent for the dialog.

copies - The initial value of Copies field. Ignored if negative.

printOptions - The initial print options.

Returns:

Returns the print options set in the print setup dialog or null if the dialog is canceled by the user.

chooseFile
```
public ChooseFileResult chooseFile(int windowId,
                                   java.lang.String path,
                                   java.lang.String title,
                                   boolean findDirectories,
                                   boolean saveAs,
                                   boolean askOverwrite,
                                   boolean mustExist,
                                   boolean createTestFile,
                                   boolean returnToStartDir,
                                   boolean useFilename,
                                   java.lang.String defaultExtension,
                                   java.lang.String initialDir,
                                   java.lang.String[] filters,
                                   int initialFilter,
                                   boolean multiple,
                                   boolean atWebBrowser,
                                   boolean upload,
                                   java.lang.String uploadDir)
```
Displays the File Selection dialog box and prompt the user to select a file with configured constraints set by the options of the SYSTEM-DIALOG PRINTER-SETUP statement.

Specified by:

chooseFile in interface ClientExports

Parameters:

windowId - The id of the window that will be the parent for the dialog.

path - The initial selected filename, (only if useFilename == true).

title - The dialog's title (optional).

findDirectories - Allow only directories to be selected.

saveAs - This is a Save As... dialog.

askOverwrite - Prompt the user for overwriting if the file exists. Used only with saveAs option.

mustExist - Enforce that the file should already exist.

createTestFile - Test writing permissions by creating a temporary file.

returnToStartDir - Do not save the last location where the user navigated for subsequent calls.

useFilename - If true, use the path as the starting location.

defaultExtension - Configures the default extension for files to be selected.

initialDir - Configures the initial directory where the dialog is opened.

filters - A set of filters to be displayed to user.

initialFilter - The index of the filter to be active when the dialog opens.

multiple - When true multiple files may be selected by the user.

atWebBrowser - When true a file local to the web browser will be selected.

upload - When true the selected file will be also uploaded to the web server. This parameter is ignored when atWebBrowser is false.

uploadDir - This parameter is only relevant when upload is true and for web clients. This specifies the upload directory on web server.

Returns:

If the user accepted the dialog and selected a certain file/dir, then the full absolute path is returned. Otherwise null is returned (user selected Cancel button to close the dialog).

getUploadFileSizeLimits
```
public int[] getUploadFileSizeLimits()
```
Gets the values for uploaded file size limits from server.

Returns:

The file size limits values. Index 0 is for per file limit, 1 - total limit, 2 - the file size threshold for writing data to the disk

chooseColor
```
public int chooseColor(int rgbColor,
                       int windowId)
```
Change the specified color, in the user's environment. This implements the SYSTEM-DIALOG COLOR color-num statement.

Specified by:

chooseColor in interface ClientExports

Parameters:

rgbColor - The current RGB of the palette entry.

windowId - The window ID to which the edited font-table belongs.

Returns:

the RGB color selected if the dialog was accepted and -1 if the user cancelled the dialog.

chooseColorIndex
```
public java.lang.Integer chooseColorIndex(java.lang.Integer colorIndex,
                                          int windowId)
```
Select a color from the color table of the target window.

Specified by:

chooseColorIndex in interface ClientExports

Parameters:

colorIndex - The current index of the color in the color table. If null, a color is not selected.

windowId - ID of the target window.

Returns:

index of the color in the color table or null if the dialog was dismissed.

callDialog
```
public Frame callDialog(int windowId,
                        java.util.function.Supplier<Frame> createDialog)
```
Create and display a dialog. Run an event loop for it until it is dismissed.

Parameters:

windowId - Parent window ID.

createDialog - Code responsible for creation of the dialog.

Returns:

created dialog. It is assumed that it encapsulates the result of its execution.

systemHelp
```
public void systemHelp(java.lang.String systemHelpServicePath,
                       java.lang.String windowName,
                       SystemHelpAction action,
                       java.lang.Object[] params)
```
Calls the Microsoft Windows Help engine to display Windows Help topics, and the HTML Help engine to display HTML Help topics.

Specified by:

systemHelp in interface ClientExports

Parameters:

systemHelpServicePath - The system help service path relative to the service host.

windowName - The window name (optional, amy be null).

action - Help action. See SystemHelpAction for more information.

params - Parameters specific to current action.

activateConfigUpdates
```
public void activateConfigUpdates()
```
Inform the client-side that it can start sending the config updates.

Specified by:

activateConfigUpdates in interface ClientExports

isAfterChoose
```
public boolean isAfterChoose()
```
Is to force automatic clearing.

Returns:

See above.

setAfterChoose
```
public void setAfterChoose(boolean afterChoose)
```
Force or reset forcing of automatic clearing.

Parameters:

afterChoose - true force, false otherwise.

getLastKey
```
public int getLastKey()
```
Get the last key, received form keyboard.

Returns:

See above.

getFrameDown
```
public int getFrameDown(int frameId)
```
Returns the number of iterations in a down frame.
This method corresponds to the Progress built-in function:
```
 FRAME-DOWN
 
```
Specified by:

getFrameDown in interface ClientExports

Parameters:

frameId - The ID of the frame for this request.

Returns:

The number of data iterations in the frame.

getFrameLine
```
public int getFrameLine(int frameId,
                        int pendingUpDown)
```
Returns the current logical line number in a frame.
This method corresponds to the Progress built-in function:
```
 FRAME-LINE
 
```
Specified by:

getFrameLine in interface ClientExports

Parameters:

frameId - The ID of the frame for this request.

pendingUpDown - The pending down value for this frame.

Returns:

1-based ordinal of the current data iteration of the frame. If the frame is not a down frame then 1 will be returned.

getFrameRow
```
public double getFrameRow(int frameId)
```
Returns the row position of the upper-left corner of the frame within its window (in coordinates that are relative to the containing window).
This method corresponds to the Progress built-in function:
```
 FRAME-ROW
 
```
Specified by:

getFrameRow in interface ClientExports

Parameters:

frameId - The ID of the frame for this request.

Returns:

The row position for the upper-left corner of the frame.

getFirstTabItem
```
public int getFirstTabItem(int frameId,
                           java.util.List<java.lang.Integer> widgetIDs)
```
Gets the first widget in the tab order from the widgets of specified list. Widgets from the list are assumed from the field-group for which this method is called.

Specified by:

getFirstTabItem in interface ClientExports

Parameters:

frameId - ID of the containing frame.

widgetIDs - IDs of widgets in the target field-group.

Returns:

ID of the first widget in tab order.

setFirstTabItem
```
public void setFirstTabItem(int frameId,
                            java.util.List<java.lang.Integer> fgWidgetIds,
                            int widgetId)
```
Move specified widget to the first position in the tab order.

Specified by:

setFirstTabItem in interface ClientExports

Parameters:

frameId - ID of the frame that contains widgets being moved.

fgWidgetIds - Target field-group widgets.

widgetId - ID of the widget to move.

getMessageLines
```
public int getMessageLines()
```
Returns the number of screen lines available for message display.
This method corresponds to the Progress built-in function:
```
 MESSAGE-LINES
 
```
Specified by:

getMessageLines in interface ClientExports

Returns:

The number of available lines in the message area.

getNumSelectedRows
```
public int getNumSelectedRows(int browseId)
```
Getter for the NUM-SELECTED-ROWS attribute.

Specified by:

getNumSelectedRows in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for

Returns:

current value of NUM-SELECTED-ROWS attribute

getNextTabItem
```
public int getNextTabItem(int frameId,
                          int widgetId)
```
Gets the widget that is the next from specified in the tab order.

Specified by:

getNextTabItem in interface ClientExports

Parameters:

frameId - ID of the containing frame.

widgetId - The widget to get the next widget in the tab order.

Returns:

ID of the widget that is the next from specified in the tab order.

getSelectedRowIndex
```
public int getSelectedRowIndex(int browseId,
                               int n)
```
Retrieve the 0-based row index of the nth selected row in the given browse widget.

Specified by:

getSelectedRowIndex in interface ClientExports

Parameters:

browseId - ID of the browse widget associated with the request.

n - 0-based position of the row in the list of selected rows. -1 for the last selected row.

Returns:

0-based row index associated with the nth selected row in the browse, or -1 if the associated Browse widget could not be identified.

Throws:

ErrorConditionException - If selIndex is invalid or if there are no "available" rows.

checkDeleteEntryRowIndex
```
public void checkDeleteEntryRowIndex(int browseId)
```
Check that the current row can be deleted with DELETE-RESULT-LIST-ENTRY: the row should be existing and in the view.

Specified by:

checkDeleteEntryRowIndex in interface ClientExports

Parameters:

browseId - ID of the browse widget associated with the request.

Throws:

ErrorConditionException - If the current row is not existing or not in the view.

getSelectedRowIndexes
```
public int[] getSelectedRowIndexes(int browseId)
```
Retrieve the row indexes of the selected rows in the given browse widget.

Specified by:

getSelectedRowIndexes in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

Array of 0-based row indexes of the selected rows in the browse.

Throws:

ErrorConditionException - If selIndex is invalid or if there are no "available" rows.

getScreenLines
```
public double getScreenLines()
```
Returns the number of screen lines available for frame display (does not include the message or status lines).
This method corresponds to the Progress built-in function:
```
 SCREEN-LINES
 
```
Specified by:

getScreenLines in interface ClientExports

Returns:

The number of available screen lines.

getTerminalType
```
public java.lang.String getTerminalType()
```
Returns the terminal type. This usually corresponds to the value set as the TERM environment variable on UNIX or Linux unless set via setTerminalType(java.lang.String). On Windows it depends upon whether the terminal is in graphical or character mode. If it is in character mode, the result depends on the monitor type.
This method corresponds to the Progress built-in function:
```
 TERMINAL
 
```
Specified by:

getTerminalType in interface ClientExports

Returns:

Terminal type for in this session.

hide
```
public boolean hide(int widgetId,
                    boolean noPause,
                    boolean hidden)
```
Makes the specified frame or widget invisible.
This method corresponds to this Progress statement:
HIDE widget

Specified by:

hide in interface ClientExports

Parameters:

widgetId - ID of frame or widget this request came for

noPause - true if NO-PAUSE option was used

hidden - If true, set the HIDDEN attribute.

Returns:

true if the widget has been hidden, false otherwise.

hideAll
```
public void hideAll(boolean noPause,
                    int windowId)
```
Hides all widgets and messages displayed in the message area. If pausing is in effect, the standard message "Press space bar to continue" is displayed on the status line and the user is required to press a key.
This method operates on the contents of the interactive terminal no matter what redirection stream is in effect.
This method corresponds to the Progress statement
HIDE ALL [NO_PAUSE]

Specified by:

hideAll in interface ClientExports

Parameters:

noPause - true if no pause is required before hiding.

windowId - Id of target window or -1 for default window

hideMessage
```
public void hideMessage(boolean noPause,
                        int windowId)
```
Hides all messages displayed in the message area. If pausing is in effect, the standard message "Press space bar to continue" is displayed on the status line and the user is required to press a key.
This method corresponds to the Progress statement
HIDE MESSAGE [NO_PAUSE]

Specified by:

hideMessage in interface ClientExports

Parameters:

windowId - Id of target window or -1 for default window

noPause - true if no pause is required before hiding messages

inputClear
```
public void inputClear()
```
Clears the type-ahead buffer if the input source is the keyboard.
This method corresponds to the Progress statement
INPUT CLEAR

Specified by:

inputClear in interface ClientExports

isInBatchMode
```
public boolean isInBatchMode()
```
Checks if the client is running in batch mode.

Specified by:

isInBatchMode in interface ClientExports

Returns:

true for batch mode, false otherwise.

isBatchInBackground
```
public boolean isBatchInBackground()
```
Checks if the client is running in batch background mode.

Specified by:

isBatchInBackground in interface ClientExports

Returns:

true for background mode, false otherwise.

stopBatchSession
```
public void stopBatchSession()
                      throws UnstoppableExitException
```
Stops the associated client session by generating UnstoppableExitException.

Specified by:

stopBatchSession in interface ClientExports

Throws:

UnstoppableExitException

activateBatchMode
```
public void activateBatchMode(boolean on)
```
Changes the activation flag for batch mode driver if loaded.

Specified by:

activateBatchMode in interface ClientExports

Parameters:

on - The new satus of the active flag for batch driver.

displayError
```
public void displayError(java.lang.String errmsg,
                         boolean noMessageBox,
                         java.lang.String[] stack,
                         boolean logCallStack)
```
Displays the error message via current client side error writer. This does not use the client UI code tools, usually meaning standard output channel and further client termination.

Specified by:

displayError in interface ClientExports

Parameters:

errmsg - The error message to display.

noMessageBox - true if error is always displayed in message area or logged rather than displayed as a message box.

stack - Progress stack trace.

logCallStack - Add call stack to log. false when ALERT_BOX message.

displayError
```
public void displayError(java.lang.String errmsg,
                         boolean noMessageBox,
                         java.lang.String[] stack,
                         boolean logCallStack,
                         boolean isFromLogManager)
```
Displays the error message via current client side error writer. This does not use the client UI code tools, usually meaning standard output channel and further client termination.

Specified by:

displayError in interface ClientExports

Parameters:

errmsg - The error message to display.

noMessageBox - true if error is always displayed in message area or logged rather than displayed as a message box.

stack - Progress stack trace.

logCallStack - Add call stack to log. false when ALERT_BOX message.

isFromLogManager - Flag to indicate the error comes from LOG-MANAGER.

displayWarning
```
public void displayWarning(java.lang.String wrnmsg)
```
Displays the warning message via current client side error writer. This does not use the client UI code tools, usually meaning standard output channel and further client termination.
The method takes care of rendering the error message directly and does not interact with an error writer.

Specified by:

displayWarning in interface ClientExports

Parameters:

wrnmsg - The warning message to display

displayErrorRedirected
```
public void displayErrorRedirected(java.lang.String errmsg)
```
Displays the error message via current client side error writer. This does not use the client UI code tools, ususally meaning standard outpot channel anf further client termination. This is the redirected version of the displayError. If the output is redirected to file the message is writing to the file.

Specified by:

displayErrorRedirected in interface ClientExports

Parameters:

errmsg - The error message to display.

message
```
public static void message(java.lang.String message)
```
Renders the specified message into the message line.

Parameters:

message - The message body to be rendered.

message
```
public MessageReturnValue message(java.lang.String text,
                                  boolean set,
                                  BaseDataType var,
                                  boolean auto,
                                  java.lang.String format,
                                  Color cs,
                                  int windowId,
                                  java.lang.String[] stack)
```
Displays a message and sets or updates a character variable using a specified format for the temporary FillIn widget.
This method corresponds to the Progress statement
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT

Specified by:

message in interface ClientExports

Parameters:

text - Text to be displayed.

set - true for SET, false for UPDATE, not used if var parameter is null.

var - The variable to set or update. null means no set or update will occur.

auto - true if the AUTO-RETURN option is specified. This is only valid if var is not null.

format - The format specification to use for the set or update. This is only valid if var is not null.

cs - The color specification to use for the text.

windowId - Id of target window

stack - Progress stack trace. This can be null.

Returns:

The result of the input operation if input parameter var is not null and operation finished successfully and/or if any key was pressed during editing/pausing. If no pause occurred and there was no input (editing) in process, then null will be returned.

displayErrorMessage
```
public void displayErrorMessage(java.lang.String text)
```
Displays an error message. Depending on the UI mode (ChUI vs GUI) the message is rendered as a regular window message or as a GUI ALERT-BOX.
The method takes care of rendering the error message directly and does not interact with an error writer.

Specified by:

displayErrorMessage in interface ClientExports

Parameters:

text - Error text to be displayed.

displayErrorMessage
```
public void displayErrorMessage(java.lang.String text,
                                boolean noMessageBox)
```
Displays an error message. Depending on the UI mode (ChUI vs GUI) and noMessageBox flag, the message is rendered as a regular window message or as a GUI ALERT-BOX.
The method takes care of rendering the error message directly and does not interact with an error writer.

Specified by:

displayErrorMessage in interface ClientExports

Parameters:

text - Error text to be displayed.

noMessageBox - true if error is always displayed in message area rather than displayed as a message box.

displayErrorMessage
```
public void displayErrorMessage(java.lang.String text,
                                boolean noMessageBox,
                                java.lang.String[] stack,
                                boolean logCallStack)
```
Displays an error message. Depending on the UI mode (ChUI vs GUI) and noMessageBox flag, the message is rendered as a regular window message or as a GUI ALERT-BOX.
The method takes care of rendering the error message directly and does not interact with an error writer.

Specified by:

displayErrorMessage in interface ClientExports

Parameters:

text - Error text to be displayed.

noMessageBox - true if error is always displayed in message area rather than displayed as a message box.

stack - Progress stack trace

logCallStack - Add call stack to log. false when ALERT_BOX message.

displayErrorMessage
```
public void displayErrorMessage(java.lang.String text,
                                boolean noMessageBox,
                                java.lang.String[] stack,
                                boolean logCallStack,
                                boolean isFromLogManager)
```
Displays an error message. Depending on the UI mode (ChUI vs GUI) and noMessageBox flag, the message is rendered as a regular window message or as a GUI ALERT-BOX.
The method takes care of rendering the error message directly and does not interact with an error writer.

Specified by:

displayErrorMessage in interface ClientExports

Parameters:

text - Error text to be displayed.

noMessageBox - true if error is always displayed in message area rather than displayed as a message box.

stack - Progress stack trace

logCallStack - Add call stack to log. false when ALERT_BOX message.

isFromLogManager - Flag to indicate the error comes from LOG-MANAGER.

displayWarningMessage
```
public void displayWarningMessage(java.lang.String text)
```
Displays a warning message. Depending on the UI mode (ChUI vs GUI) the message is rendered as a regular window message or as a GUI ALERT-BOX.

Specified by:

displayWarningMessage in interface ClientExports

Parameters:

text - Warning text to be displayed.

messageBox
```
public logical messageBox(java.lang.Object[] list,
                          logical var,
                          int alertType,
                          int buttons,
                          java.lang.String title,
                          Color color,
                          int windowId,
                          java.lang.String[] stack)
```
Displays a list of text items and empty lines in an alert box and sets/updates a logical variable as a result of the action taken. This is a modal dialog with the specified title and button configuration. The message body is represented by a content array. Each line of the message including any number of empty lines (skip) are elements of the content array. Text elements of the content array must be Strings. In addition, there may be any number of skip elements which are encoded as a Java Integer instance where the integral value is equivalent to the number of lines to skip.
The value of the var being edited determines the default button if it is not null. true is the first button, false is the second button and for a 3-button dialog, unknown is the third button.
The result of the user's selection is returned and this result value can be mapped to a button following the same mapping as used for setting the default button (see above).
This method corresponds to the Progress statements:
```
 MESSAGE list VIEW-AS ALERT-BOX
 MESSAGE list VIEW-AS ALERT-BOX SET/UPDATE var
 ... and all other variants that include options such as title, buttons
 and colors
 
```
Specified by:

messageBox in interface ClientExports

Parameters:

list - The list of message text components.

var - The variable to update if not null.

alertType - One of the ALERT_* constants specifying message type.

buttons - One of the BTN_* constants specifying used button set.

title - The dialog title.

color - Color scheme to use.

windowId - Id of target window

stack - Progress stack trace

Returns:

The edited result which can be mapped into a specified button.

messageBox
```
public logical messageBox(java.lang.Object[] list,
                          logical var,
                          int alertType,
                          int buttons,
                          java.lang.String title,
                          Color color,
                          int windowId,
                          java.lang.String[] stack,
                          boolean asInBatch,
                          boolean logCallStack)
```
Displays a list of text items and empty lines in an alert box and sets/updates a logical variable as a result of the action taken. This is a modal dialog with the specified title and button configuration. The message body is represented by a content array. Each line of the message including any number of empty lines (skip) are elements of the content array. Text elements of the content array must be Strings. In addition, there may be any number of skip elements which are encoded as a Java Integer instance where the integral value is equivalent to the number of lines to skip.
The value of the var being edited determines the default button if it is not null. true is the first button, false is the second button and for a 3-button dialog, unknown is the third button.
The result of the user's selection is returned and this result value can be mapped to a button following the same mapping as used for setting the default button (see above).
This method corresponds to the Progress statements:
```
 MESSAGE list VIEW-AS ALERT-BOX
 MESSAGE list VIEW-AS ALERT-BOX SET/UPDATE var
 ... and all other variants that include options such as title, buttons
 and colors
 
```
Specified by:

messageBox in interface ClientExports

Parameters:

list - The list of message text components.

var - The variable to update if not null.

alertType - One of the ALERT_* constants specifying message type.

buttons - One of the BTN_* constants specifying used button set.

title - The dialog title.

color - Color scheme to use.

windowId - Id of target window

stack - Progress stack trace

asInBatch - treat redirected output like in batch mode (no dialogs)

logCallStack - Add call stack to log. false when MESSAGE VIEW-AS ALERT_BOX.

Returns:

The edited result which can be mapped into a specified button.

messageBox
```
private logical messageBox(java.lang.Object[] list,
                           logical var,
                           int alertType,
                           int buttons,
                           java.lang.String title,
                           Color color,
                           int windowId,
                           java.lang.String[] stack,
                           boolean asInBatch,
                           boolean logCallStack,
                           boolean isFromLogManager)
```
Displays a list of text items and empty lines in an alert box and sets/updates a logical variable as a result of the action taken. This is a modal dialog with the specified title and button configuration. The message body is represented by a content array. Each line of the message including any number of empty lines (skip) are elements of the content array. Text elements of the content array must be Strings. In addition, there may be any number of skip elements which are encoded as a Java Integer instance where the integral value is equivalent to the number of lines to skip.
The value of the var being edited determines the default button if it is not null. true is the first button, false is the second button and for a 3-button dialog, unknown is the third button.
The result of the user's selection is returned and this result value can be mapped to a button following the same mapping as used for setting the default button (see above).
This method corresponds to the Progress statements:
```
 MESSAGE list VIEW-AS ALERT-BOX
 MESSAGE list VIEW-AS ALERT-BOX SET/UPDATE var
 ... and all other variants that include options such as title, buttons
 and colors
 
```
Parameters:

list - The list of message text components.

var - The variable to update if not null.

alertType - One of the ALERT_* constants specifying message type.

buttons - One of the BTN_* constants specifying used button set.

title - The dialog title.

color - Color scheme to use.

windowId - Id of target window

stack - Progress stack trace

asInBatch - treat redirected output like in batch mode (no dialogs)

logCallStack - Add call stack to log. false when MESSAGE VIEW-AS ALERT_BOX.

isFromLogManager - Flag to indicate the error comes from LOG-MANAGER.

Returns:

The edited result which can be mapped into a specified button.

isModalBoxActive
```
public boolean isModalBoxActive()
```
Checks whether there are any modal boxes active. The modal boxes are processed client side only and not interact with the server in certain cases (like focus, P4GL keys: F1, F2, F4).
Note that frame dialog-boxes do not count in modalActive even though they are technically modal windows (boxes). This method takes into consideration only independent client-side dialogs whose events are not processed on server side while the dialog is shown.

Returns:

true if there is at least one modal box active.

modalEventLoop
```
private void modalEventLoop(IsModal modal,
                            int savedFocusState,
                            Widget savedFocus,
                            TopLevelWindow owner)
```
Event worker for modal UI elements (alert box, system file and print dialogs, etc.).

Parameters:

modal - Reference to a modal UI element.

savedFocusState - The focus state saved before the modal element is activated.

savedFocus - The focused widget before the modal element is activated.

owner - The owner window of the supplied modal UI element.

withIndependentEventList
```
private void withIndependentEventList(java.lang.Runnable block)
```
Executes the supplied runnable with currentEventList set to null. Upon the return of the runnable the original value of currentEventList is restored.

Parameters:

block - Runnable to execute.

selectPredefinedTitle
```
private java.lang.String selectPredefinedTitle(int alertType)
```
Select one of the standard titles.

Parameters:

alertType - Type of Alert.

Returns:

selected title.

modalEventLoopWorker
```
private void modalEventLoopWorker(IsModal modal)
```
Event worker for modal UI elements (alert box, system file and print dialogs, etc.).

Parameters:

modal - Reference to a modal UI element.

nextPrompt
```
public void nextPrompt(int frameId,
                       int widgetId)
```
Specifies the field to be put in focus during the next input operation which involves this field of the frame.
If the very next operation does not involve the field, this request will be disregarded.
The next high level input operation clears this information for the involved frame only. WAIT-FOR does not clear it, however.
This method corresponds to this Progress statement:
NEXT-PROMPT

Specified by:

nextPrompt in interface ClientExports

Parameters:

frameId - ID of frame this request came for

widgetId - widget to be put in focus

pause
```
public int pause(int millis,
                 java.lang.String text,
                 boolean noMessage,
                 int windowId)
```
Suspends processing for the specified number of milliseconds or until the user presses any key, whichever comes first. The type-ahead buffer is cleared. The specified (or no) message appears on the status line.
This method corresponds to the Progress statement
PAUSE n MESSAGE/NO-MESSAGE

Specified by:

pause in interface ClientExports

Parameters:

millis - Pause duration in milliseconds (0 means immediate return, -1 means infinite wait).

text - Either null if NO-MESSAGE is in effect, or the message text.

noMessage - true if NO-MESSAGE is in effect. This suppresses the message display, even if an explicit message text was passed.

windowId - Id of target window

Returns:

The key code of the key pressed to clear the pause or -1 if a timeout occurred (no key was pressed) or -2 if this was an immediate return due to a timeout of 0.

pause
```
public int pause(int millis,
                 java.lang.String text,
                 boolean noMessage,
                 TopLevelWindow wnd)
```
Suspends processing for the specified number of milliseconds or until the user presses any key, whichever comes first. The type-ahead buffer is cleared. The specified (or no) message appears on the status line.
Behaviour in case of batch processing: if the timeout is limited, it is honored, if infinite (milliseconds == -1) return immediately.
This method corresponds to the Progress statement
PAUSE n MESSAGE/NO-MESSAGE

Parameters:

millis - Pause duration in milliseconds (0 means immediate return, -1 means infinite wait).

text - Either null if NO-MESSAGE is in effect, or the message text.

noMessage - true if NO-MESSAGE is in effect. This suppresses the message display, even if an explicit message text was passed.

wnd - Not null target window. If null - an NPE will be thrown.

Returns:

The key code of the key pressed to clear the pause or -1 if a timeout occurred (no key was pressed) or -2 if this was an immediate return due to a timeout of 0.

pauseBeforeHide
```
public void pauseBeforeHide(int millis,
                            java.lang.String text,
                            int windowId)
```
Specifies the pause action the user must take whenever frames are hidden automatically. The pause lasts the specified number of milliseconds or until the user presses a key, whichever comes first. The specified (or no) message appears on the status line.
This method corresponds to Progress statements:
```
 PAUSE seconds BEFORE-HIDE MESSAGE text
 PAUSE seconds BEFORE-HIDE NO-MESSAGE
 
```
Specified by:

pauseBeforeHide in interface ClientExports

Parameters:

millis - Pause duration in milliseconds.

text - Either null if NO-MESSAGE is in effect or the message text to display.

windowId - Id of target window

processEvents
```
public ScreenBuffer[] processEvents(ScreenBuffer[] inbuf)
```
Processes all outstanding events without blocking for user input.
This method corresponds to the Progress statement
PROCESS EVENTS

Specified by:

processEvents in interface ClientExports

Parameters:

inbuf - current screen buffer array for editable frames known to the server

Returns:

ScreenBuffer array with the current values, or null if there is no active frame.

registerRowDisplayEvents
```
public void registerRowDisplayEvents(int[] wids,
                                     int[] triggerIds)
```
Register the specified ROW-DISPLAY events.

Specified by:

registerRowDisplayEvents in interface ClientExports

Parameters:

wids - The id of the browse widget for which there are ROW-DISPLAY triggers.

triggerIds - The corresponding trigger ID for each widget.

removeRowDisplayEvents
```
public void removeRowDisplayEvents(int[] triggers)
```
Remove the ROW-DISPLAY triggers from the specified list.

Specified by:

removeRowDisplayEvents in interface ClientExports

Parameters:

triggers - The triggers to be removed, if they are associated to a ROW-DISPLAY event.

pushMenuDescription
```
public void pushMenuDescription(MenuDescription[] md)
```
Send array of menu element descriptions to the client.

Specified by:

pushMenuDescription in interface ClientExports

Parameters:

md - Array of menu descriptions.

pushWidgetAttr
```
private void pushWidgetAttr(ConfigManager mgr,
                            boolean frameVisible,
                            int id,
                            java.lang.Runnable code)
```
Apply the specified widget attribute changes to the client-side.

Parameters:

mgr - The ConfigManager instance.

frameVisible - The current (after config change) visible frame state.

id - The widget ID.

code - The code to run, which applies the changes.

pushWidgetAttr
```
public void pushWidgetAttr(boolean frameVisible,
                           int id,
                           java.lang.String fname,
                           java.lang.Object value)
```
Push the specified widget attribute changes to the client-side.

Specified by:

pushWidgetAttr in interface ClientExports

Parameters:

frameVisible - The current (after config change) visible frame state.

id - The widget ID.

fname - The list of config field names.

value - The list of new config field values.

pushWidgetAttrInBatch
```
public void pushWidgetAttrInBatch(boolean frameVisible,
                                  int id,
                                  java.lang.Integer[] fids,
                                  java.lang.Object[] values)
```
Push the specified widget attribute changes to the client-side.

Parameters:

frameVisible - The current (after config change) visible frame state.

id - The widget ID.

fids - The list of config field ids.

values - The list of new config field values.

pushWidgetAttr
```
public void pushWidgetAttr(boolean frameVisible,
                           int id,
                           java.lang.String[] fnames,
                           java.lang.Object[] values)
```
Push the specified widget attribute changes to the client-side.

Specified by:

pushWidgetAttr in interface ClientExports

Parameters:

frameVisible - The current (after config change) visible frame state.

id - The widget ID.

fnames - The list of config field names.

values - The list of new config field values.

placeFrame
```
public void placeFrame(int frameId)
```
Place the frame.

Specified by:

placeFrame in interface ClientExports

Parameters:

frameId - The frame's ID.

attachRuntimeWidget
```
public void attachRuntimeWidget(int fid,
                                int wid,
                                WidgetConfig cfg)
```
Attach a widget to a frame, at runtime. The widget can be a dynamic widget or a full static frame.

Specified by:

attachRuntimeWidget in interface ClientExports

Parameters:

fid - The parent frame's ID.

wid - The widget ID.

cfg - The widget's configuration.

deleteDynamicWidget
```
public void deleteDynamicWidget(int fid,
                                int wid)
```
Delete and detach a widget from a frame, at runtime. The widget can be a dynamic widget or a full static frame.

Specified by:

deleteDynamicWidget in interface ClientExports

Parameters:

fid - The parent frame's ID.

wid - The widget ID.

pushScreenDefinition
```
public WidgetConfig[] pushScreenDefinition(ScreenDefinition[] sd)
```
Process array of frame/widget definitions provided by server.

Specified by:

pushScreenDefinition in interface ClientExports

Parameters:

sd - Array of screen definitions.

Returns:

For each down frame, the configs for the widgets in the new row. Otherwise null is returned.

pushOneDef
```
private void pushOneDef(ScreenDefinition definition)
```
Push one screen definition.

Parameters:

definition - Definition to push.

pushScreenBuffers
```
public void pushScreenBuffers(ScreenBuffer[] sb)
```
Process array of frame/widget buffers provided by server.

Specified by:

pushScreenBuffers in interface ClientExports

Parameters:

sb - Array of screen buffers.

pushWindow
```
public void pushWindow(WindowConfig config)
```
Process window configuration provided by server.

Specified by:

pushWindow in interface ClientExports

Parameters:

config - instance of WindowConfig

removeWindow
```
public void removeWindow(int window)
```
Remove the window instance from the client.

Specified by:

removeWindow in interface ClientExports

Parameters:

window - The window ID.

getActiveFrame
```
public int getActiveFrame()
```
Returns the ID of the currently active frame.

Specified by:

getActiveFrame in interface ClientExports

Returns:

The frame ID or -1 if there is no active frame (or if the active frame has been marked for destruction).

putCursor
```
public void putCursor(boolean onOff)
```
Turns cursor visibility on or off.
This method corresponds to the Progress statements
PUT CURSOR
PUT CURSOR OFF

Specified by:

putCursor in interface ClientExports

Parameters:

onOff - true if the cursor display is being turned on.

putCursor
```
public void putCursor(double row,
                      double column)
```
Puts cursor to the specified screen position. If the cursor visibility is OFF, this method will first make the cursor visible before moving it.
This method corresponds to the Progress statement
PUT CURSOR ROW COLUMN

Specified by:

putCursor in interface ClientExports

Parameters:

row - 1-based screen row number

column - 1-based screen column number

putScreen
```
public void putScreen(java.lang.String text,
                      double row,
                      double column,
                      Color color)
```
Puts text on the screen at the specified position and with the given text attributes. Such text is directly drawn on top of the Z-order and portions of that text will be automatically removed as those portions are obscured by other drawing on the screen (be it other calls to this method or any other drawing). Any partial obscuring of the output will leave any unobscured text on the screen until drawing occurs over those screen positions.
This method corresponds to the Progress statement:
```
 PUT SCREEN ROW y COLUMN x
 
```
Specified by:

putScreen in interface ClientExports

Parameters:

text - The text to display.

row - 1-based screen row number.

column - 1-based screen column number.

color - The color specification or -1 for the default color.

readKey
```
public ReadKeyResult readKey(int millis)
```
Reads and returns one keystroke from the keyboard type-ahead buffer.
This method corresponds to the Progress statements
READKEY PAUSE n READKEY

Specified by:

readKey in interface ClientExports

Parameters:

millis - -1 means indefinite wait, 0 means no wait and positive values mean the number of milliseconds to wait

Returns:

ReadKeyResult instance. If the operation times out the key code in the returned instance will be set to -1.

refresh
```
public void refresh(int browseId,
                    boolean deleteCurrentRowMode)
```
Refresh the browse cache and redisplay the browse.

Specified by:

refresh in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for

deleteCurrentRowMode - true if this function is used for update on DELETE-CURRENT-ROW. false if this function is used for update on REFRESH.

refreshAfterDeletion
```
public void refreshAfterDeletion(int browseId,
                                 int rowIndex)
```
Refresh the browse after some of its rows were deleted.

Specified by:

refreshAfterDeletion in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

rowIndex - 0-based index of the deleted row. -1 if all of the selected rows were deleted.

selectNextRow
```
public logical selectNextRow(int browseId)
```
Implements the SELECT-NEXT-ROW() widget method.
Deselects all currently selected rows in a browse and selects the row after the deselected row.
This method also repositions the query to the new row and copies the record into the database buffer. The browse automatically scrolls to the selected row if it is out of view.
This method is intended for use with a browse that supports the selection of a single row at a time (MULTIPLE attribute is set to FALSE). If more than one row is selected when you execute this method, all of the selected rows are deselected and the record after the last selected row becomes the selected row.

Specified by:

selectNextRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

true on success.

selectPreviousRow
```
public logical selectPreviousRow(int browseId)
```
Implements the SELECT-PREV-ROW() widget method.
Deselects all currently selected rows in a browse and selects the row before the deselected row.
This method also repositions the query to the new row and copies the record into the database buffer.The browse automatically scrolls to the selected row if it is out of view.
This method is intended for use with a browse that supports the selection of a single row at a time (MULTIPLE attribute is set to FALSE). If more than one row is selected when you execute this method, all of the selected rows are deselected and the record before the last selected row becomes the selected row.

Specified by:

selectPreviousRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

true on success.

remapKey
```
public void remapKey(java.lang.String keyLabel,
                     java.lang.String keyFunction)
```
Defines a specific action for the key.
This method corresponds to the Progress statement
ON key-label key-function

Specified by:

remapKey in interface ClientExports

Parameters:

keyLabel - the label of the key

keyFunction - the action to take when the user presses the key

scroll
```
public void scroll(int frameId,
                   boolean fromCurrent,
                   boolean up)
```
Scrolls the lines of the down frame up or down.
This method corresponds to this Progress statement:
SCROLL

Specified by:

scroll in interface ClientExports

Parameters:

frameId - ID of frame this request came for

fromCurrent - true if FROM-CURRENT option was used

up - true if scrolling up

selectAll
```
public void selectAll(int browseId)
```
Implements the SELECT-ALL() BROWSE widget method.

Specified by:

selectAll in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for

selectFocusedRow
```
public void selectFocusedRow(int browseId)
```
Implements the SELECT-FOCUSED-ROW() BROWSE widget method.

Specified by:

selectFocusedRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for

deselectFocusedRow
```
public void deselectFocusedRow(int browseId)
```
Implements the DESELECT-FOCUSED-ROW() BROWSE widget method.

Specified by:

deselectFocusedRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

isFocusedRowSelected
```
public boolean isFocusedRowSelected(int browseId)
```
Return true if the row that has focus is selected.

Specified by:

isFocusedRowSelected in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

true if the row that has focus is selected.

deselectSelectedRow
```
public boolean deselectSelectedRow(int browseId,
                                   int rowIndex)
```
Implements the DESELECT-SELECTED-ROW() widget method.
Deselects the nth selected row in a browse.
Progress maintains a numbered list of selected rows, starting at 1. When the DESELECT-SELECTED-ROW(n) method is encountered, Progress searches this list to find the nth selected row.

Specified by:

deselectSelectedRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

rowIndex - 1-based index of the row (in the list of selected rows) to deselect.

Returns:

true if the row is successfully deselected.

selectRow
```
public boolean selectRow(int browseId,
                         int rowIndex)
```
Implements the SELECT-ROW() widget method.
Selects the specified row if it is currently in the browse viewport. In a single-select browse, the previously selected row is deselected. No rows are deselected in a multiple-select browse.

Specified by:

selectRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

rowIndex - 1-based row index in the browse viewport.

Returns:

true if the row with the given index exist in the browse viewport.

isRowSelected
```
public boolean isRowSelected(int browseId,
                             int rowIndex)
```
Implements the IS-ROW-SELECTED() BROWSE widget method.

Specified by:

isRowSelected in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

rowIndex - 1-based row index in the browse viewport.

Returns:

true if a specified row in the browse viewport is currently selected.

moveColumnClient
```
public void moveColumnClient(int browseId,
                             int srcIndex,
                             int destIndex)
```
Implements the client side of the MOVE-COLUMN() widget method.
Repositions a column in a browse widget.

Specified by:

moveColumnClient in interface ClientExports

Parameters:

srcIndex - 0-based position of the column to be moved.

destIndex - 0-based position to which the column is moved.

browseId - ID of the browse widget this request came for.

applyEnhancedConfigClient
```
public void applyEnhancedConfigClient(int browseId)
```
Run client-side part of the code which should be executed after an enhanced configuration is applied to the browse.

Specified by:

applyEnhancedConfigClient in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

getClientEnhancedConfigs
```
public EnhancedBrowseConfig[] getClientEnhancedConfigs(EhBrowseConfigKey[] keys)
```
Get enhanced browse configurations stored on the client side.

Specified by:

getClientEnhancedConfigs in interface ClientExports

Parameters:

keys - Array of the keys of the target configurations to get.

Returns:

array containing the target configurations. It has the same size as the array of keys. If there is no configuration found for a key, the corresponding array element is null.

moveColumnServer
```
public void moveColumnServer(int browseId,
                             int src,
                             int dest)
```
Implements the server-side MOVE-COLUMN() widget method.
Repositions a column in the browse widget.

Parameters:

browseId - ID of the browse which should handle the request.

src - 0-based position of the column to be moved (column ordinal).

dest - 0-based position to which the column is moved (column ordinal).

notifyBrowseLayoutPerformed
```
public void notifyBrowseLayoutPerformed(int browseId)
```
Notify server that browse layout has been performed on the client side.

Parameters:

browseId - ID of the browse which should handle the request.

getFocusedRow
```
public integer getFocusedRow(int browseId)
```
Implements the FOCUSED-ROW attribute getter.

Specified by:

getFocusedRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

1-based index of the focused row in the viewport or -1 if browse doesn't exist.

getBrowsePageRowCount
```
public int getBrowsePageRowCount(int browseId)
```
Get number of rows in the browse viewport set either by DOWN or SIZE options.

Specified by:

getBrowsePageRowCount in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

number of rows in the browse viewport.

getBrowseCacheSize
```
public int getBrowseCacheSize(int browseId)
```
Get the number of entries visible in the browse.

Specified by:

getBrowseCacheSize in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

number of entries visible in the browse.

refreshScrollRow
```
public void refreshScrollRow(int browseId,
                             boolean leaveOnRowInView,
                             boolean preserveViewportRow,
                             boolean repositioned,
                             boolean repositionError,
                             int targetRepositionRow)
```
Refresh scroll row in the browse and redisplay. Unless specific parameters are passed, the current row becomes the scroll row.

Specified by:

refreshScrollRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

leaveOnRowInView - If the current row is in the viewport, do not update the scroll row.

preserveViewportRow - Try to preserve the current viewport row (i.e. the row at the same position in the viewport becomes the current row after refresh).

repositioned - If the browse is refreshed because the query was repositioned.

repositionError - For reposition mode - if an error has happened during reposition.

targetRepositionRow - For reposition mode - row used as the target for reposition. If it was deleted, reposition with fetching may end up on a different row.

executePendingRefresh
```
public void executePendingRefresh(int browseId,
                                  boolean queryReopened,
                                  boolean repositionBeforeReopen,
                                  int repositionedRow)
```
Execute pending refresh when REFRESHABLE is turned on. Includes pending query repositions and reopenings.

Specified by:

executePendingRefresh in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

queryReopened - true if there is a pending query reopening.

repositionBeforeReopen - true if the last pending reposition was before the last pending reopening.

repositionedRow - 0-based index of the last row the query was repositioned to. -1 if there is no repositioned row.

queryRepositioned
```
public void queryRepositioned(int browseId,
                              boolean repositionError,
                              int targetRepositionRow)
```
Notify the browse that the underlying query has been repositioned..

Specified by:

queryRepositioned in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

repositionError - For reposition mode - if an error has happened during reposition.

targetRepositionRow - For reposition mode - row used as the target for reposition. If it was deleted, reposition with fetching may end up on a different row.

queryClosed
```
public void queryClosed(int browseId)
```
Notify browse widget at client side that query was closed.

Specified by:

queryClosed in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for

isNewRow
```
public boolean isNewRow(int browseId)
```
Returns true if the current row is a new row and is not present in the database.

Specified by:

isNewRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

true if the current row is a new row and false otherwise.

isCurrentRowModified
```
public boolean isCurrentRowModified(int browseId)
```
Returns true if the current browse row is modified.

Specified by:

isCurrentRowModified in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

true if the current browse row is modified.

getBrowseColumnY
```
public int getBrowseColumnY(int browseId)
```
Get value of column.Y attribute for the columns of this browse: vertical offset of the current row from the top of the browse, in pixels for GUI or in chars for ChUI. The value is the same for all columns in the browse.

Specified by:

getBrowseColumnY in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

Returns:

value of column.Y attribute for the columns of this browse.

insertRow
```
public boolean insertRow(int browseId,
                         boolean after)
```
Inserts a blank row in an updateable browse before or after the last selected row. The blank row is a placeholder for a new record to be added through the browse.

Specified by:

insertRow in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

after - true if the row is added after the last selected row. false if the row is added before the last selected row.

Returns:

true if the row was successfully added.

calcBrowseDown
```
public int calcBrowseDown(int browseId,
                          int rowHeightPixels)
```
Calculate DOWN value for the browse basing on the given row height.

Specified by:

calcBrowseDown in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

rowHeightPixels - Row height in pixels.

Returns:

calculated DOWN value.

pushIntermediateRows
```
public void pushIntermediateRows(int browseId,
                                 BrowseRow[] rows)
```
Push "intermediate" rows (i.e. the rows that were already fetched in the process of getting new rows by BrowseWidget.getRows(int, int, boolean, int, ScreenBuffer[], RowDisplayStrategy)) to the client, so these rows can be drawn if a pause occurs in ROW-DISPLAY trigger.

Specified by:

pushIntermediateRows in interface ClientExports

Parameters:

browseId - ID of the browse widget this request came for.

rows - Set of rows to push.

scrollToItem
```
public boolean scrollToItem(int slId,
                            int index)
```
Invokes the SCROLL-TO-ITEM() method on the specified selection-list widget.

Specified by:

scrollToItem in interface ClientExports

Parameters:

slId - Widget ID of the selection list to scroll.

index - The 0-based index of the item to which to scroll.

Returns:

TRUE in success, FALSE otherwise.

setTerminalType
```
public void setTerminalType(java.lang.String term)
```
Sets the terminal type. This will cause the terminal to potentially change its configuration if the new type is different from the old type.
This processing also clears the input buffer and resets any key mappings to their default values.
This method corresponds to the Progress statement:
TERMINAL

Specified by:

setTerminalType in interface ClientExports

Parameters:

term - Terminal type name. If null, this resets the terminal without changing the type.

statusDefault
```
public void statusDefault(java.lang.String text,
                          boolean noLengthLimit,
                          int windowId)
```
Specifies a new default status message for the running procedure when not in INPUT mode (when editing).
This method is used to display a status message, which is trimmed to 63 chars only if the noLengthLimit flag is not set.

Specified by:

statusDefault in interface ClientExports

Parameters:

text - The new status message. null is the equivalent of the empty string.

noLengthLimit - flag indicating the status message should not be trimmed

windowId - Id of target window

statusInput
```
public void statusInput(java.lang.String text,
                        int windowId)
```
Specifies a new status message used when the user interface is blocked on input.
This method corresponds to the Progress statement STATUS INPUT text.

Specified by:

statusInput in interface ClientExports

Parameters:

text - The new status message. null is the equivalent of the empty string.

windowId - Id of target window

statusInputRevert
```
public void statusInputRevert(int windowId)
```
Reverts the input status message to the default.

Specified by:

statusInputRevert in interface ClientExports

Parameters:

windowId - Id of target window

statusInputOff
```
public void statusInputOff(int windowId)
```
Disables display of the input status message.
This method corresponds to the Progress statement STATUS INPUT OFF IN WINDOW wnd.

Specified by:

statusInputOff in interface ClientExports

Parameters:

windowId - Id of target window

view
```
public ScreenBuffer[] view(int widgetId,
                           ScreenBuffer[] frameBuf,
                           int[] widgetIds,
                           boolean isView,
                           int windowId,
                           int[] tabItemList)
```
Shows all fields of the specified frame on screen.

Specified by:

view in interface ClientExports

Parameters:

widgetId - The frame ID or widget this request came for.

frameBuf - The screen buffer with current values of widgets.

widgetIds - The array of field level widget IDs to be shown or null, which means all of them.

isView - true if the call is for VIEW, false for DISPLAY.

windowId - target window id.

tabItemList - The array of widgets ids according to their tab order.

Returns:

The frames screen buffer array.

view_
```
private void view_(int widgetId,
                   ScreenBuffer[] frameBuf,
                   int[] widgetIds,
                   boolean isView,
                   boolean markTarget,
                   int windowId)
```
Shows all fields of the specified frame on screen.
Notes on the logic of view/display calls in redirected mode:
Listed below are steps taken in redirected mode before the common worker viewWorker() is called.
- Check the redirected terminal (RT) ownership. If it's owned by another frame, do frame switching and set SWITCHED flag. otherwise clear SWITCHED flag and proceed with the next step.
  Frame switching flushes the RT buffer to the stream S and sets the RT ownership to F. The RT buffer becomes fresh.
- Check if the RT buffer is fresh. If it is not, all the remaining steps are skipped.
- The RT buffer is fresh and owned by the frame F. This is the only moment when we can determine whether:
  - the frame has to be drawn with or without headers;
  - the current page needs to be ejected;
  - the current page needs to be contiguous.
  The following steps do these determinations.
- Query the stream S and obtain the following values:
  - a flag FRESH-PAGE, telling whether the page is fresh or contains some output (page headers are not considered as output here)
  - page size PS;
  - remaining lines on the page RL. This value accounts for the size of the current output within S and all defined page footers.
- Query the frame F and obtain the following values:
  - a flag DOWN-FRAME which is true for the down frame;
  - a flag PAGE-LIST which is true if DOWN-FRAME is true and when F is not in pagedList for the stream S (pagedList gets reset with page break notifications as well as during frame switching and reflects the fact that this down frame has contributed some output to the current page with frame headers already in place)
  - size of frame headers HS;
  - size of frame body BS
- Determine whether the frame F needs headers and set NEED-HDR flag accordingly.
  Headers are needed if any condition below is true:
  - frame switch has happened, SWITCHED flag is set;
  - fresh page flag FRESH-PAGE is set;
  - this is a 1-down frame (DOWN-FRAME flag is reset);
  - PAGE-LIST flag is set.
- Calculate the number of lines the frame F needs on the page as
  FS = (NH ? HS : 0) + BS
- Handle the large output case. The large output means the frame size FS is greater than the page size PS and output is paged. If this is the case:
  - check whether we are on the fresh page, and if we are not, call the stream S and force page break;
  - now we are on the fresh page; call the stream S and set contiguous mode.
  The contiguous mode gets reset with the next flush and page break operation.
  In contiguous mode the rest of steps is skipped.
- Determine whether the page break is required. If the output is paged and the frame size FS is greater than the remaining lines RL, call the stream S and force page break.
  Page break outputs Form Feed character, resets page state variables and outputs page headers. During page headers drawing, the RT will be used for drawing, but this is safe since at this time the RT is fresh and the page break processing will return it back fresh.
Now the current view/display operation can proceed with drawing into the RT buffer with or without frame headers according to the NEED-HDR flag.
Parameters:

widgetId - The frame ID or widget this request came for.

frameBuf - The screen buffer array with current values of widgets in editable frames.

widgetIds - The array of field level widget IDs to be shown or null, which means all of them.

isView - true if the call is for VIEW, false for DISPLAY.

markTarget - true if the call is for regular frame, false for page elements rendering

windowId - target window id.

frameIdFromWidgetId
```
public static int frameIdFromWidgetId(int widgetId)
```
Retrieve the ID of the frame containing the widget with a given ID.

Parameters:

widgetId - The widget ID.

Returns:

The frame ID if widget is found or -1 if not.

displayAndDown
```
public void displayAndDown(int widgetId,
                           ScreenBuffer[] frameBuf,
                           int[] widgetIds,
                           int streamId,
                           boolean register,
                           boolean pageTop,
                           int windowId,
                           int[] tabItemList)
```
Support for the DISPLAY followed by DOWN combination.

Specified by:

displayAndDown in interface ClientExports

Parameters:

widgetId - The frame ID or widget this request came for.

frameBuf - The screen buffer array with current values of widgets for editable frames.

widgetIds - The array of field level widget IDs to be shown or null, which means all of them.

streamId - The stream to be used as the temporary terminal redirection (only for the duration of this call).

register - true if the frame associated with this request must be registered as a page element with the given stream.

pageTop - true if the page element registration is for a page top element, false for a page bottom element. This parameter is ignored if register is false.

windowId - Id of target window or WindowConfig.RESOLVE_WINDOW for current or default window.

tabItemList - The array of widgets ids according to their tab order.

view
```
public WidgetConfig[] view(int widgetId,
                           ScreenBuffer[] frameBuf,
                           int[] widgetIds,
                           int streamId,
                           boolean register,
                           boolean pageTop,
                           boolean isView,
                           int windowId,
                           int[] tabItemList)
```
Shows all fields of the specified frame on screen.
The terminal will be temporarily redirected to the given stream for the duration of this method call. This allows the caller to avoid bracketing this call with switchOutput(int, boolean) invocations, as the same result is achieved internal to this method's operation.

Specified by:

view in interface ClientExports

Parameters:

widgetId - The frame ID or widget this request came for.

frameBuf - The screen buffer array with current values of widgets for editable frames.

widgetIds - The array of field level widget IDs to be shown or null, which means all of them.

streamId - The stream to be used as the temporary terminal redirection (only for the duration of this call). If this is not -1, then the any pending PUT or EXPORT output on this stream will be ended/forced out.

register - true if the frame associated with this request must be registered as a page element with the given stream.

pageTop - true if the page element registration is for a page top element, false for a page bottom element. This parameter is ignored if register is false.

isView - true if the call is for VIEW, false for DISPLAY.

windowId - Id of target window or WindowConfig.RESOLVE_WINDOW for current or default window.

tabItemList - The array of widgets ids according to their tab order

Returns:

The frame's widget config array.

promptFor
```
public ScreenBuffer[] promptFor(int frameId,
                                int[] widgetIds,
                                ScreenBuffer[] sb,
                                int millis,
                                EventList el,
                                boolean doIO,
                                int windowId,
                                int[] tabItemList)
```
Provides a composite helper to implement a single call to the client which does an enable, wait-for, disable and hide message (in that order). This single call is more efficient than executing the calls separately since the client has all the state needed AND since it avoids extra round trips.

Specified by:

promptFor in interface ClientExports

Parameters:

frameId - ID of frame this request came for

widgetIds - array of field level widget IDs to be enabled or null, which means all of them.

sb - The currently editable frames screen buffer array.

millis - Time to wait for event.

el - List of events to wait for.

doIO - tells to perform the requested operation if true. otherwise prepares the frame for editing session only.

windowId - Id of target window or WindowConfig.RESOLVE_WINDOW for current or default window.

tabItemList - The array of widgets ids according to their tab order.

Returns:

ScreenBuffer array with the current values.

refreshFrameWidget
```
public java.lang.String refreshFrameWidget(int fid,
                                           int wid,
                                           BaseDataType value)
```
Refreshes the specified frame and widget with a new screen value.
The frame is not necessarily on top of Z-order and the widget is not necessarily fully visible. This operation does not change the Z-order.

Specified by:

refreshFrameWidget in interface ClientExports

Parameters:

fid - frame to refresh

wid - widget to refresh

value - new widget value

Returns:

string representation of the value

refreshFrameWidgets
```
public java.lang.String refreshFrameWidgets(int fid,
                                            int[] wids,
                                            BaseDataType[] values)
```
Refreshes the specified frame and widget with a new screen value.

Specified by:

refreshFrameWidgets in interface ClientExports

Parameters:

fid - frame to refresh

wids - widgets to refresh

values - new values for the widgets

Returns:

string representation of the value for the FRAME-FIELD widget.

refreshFrameWidgets
```
private java.lang.String refreshFrameWidgets(int fid,
                                             int[] wids,
                                             BaseDataType[] values,
                                             boolean asFrameField)
```
Refreshes the specified frame and widget with a new screen value.

Parameters:

fid - frame to refresh

wids - widgets to refresh

values - new values for the widgets

asFrameField - Flag indicating if the single widget in the array must be assumed as FRAME-FIELD.

Returns:

string representation of the value for the FRAME-FIELD widget.

iterateEditingBlock
```
private void iterateEditingBlock()
```
This method is called on each start of an EDITING block iteration.

view
```
public static void view(Widget widget,
                        ScreenBuffer[] frameBuf,
                        int[] widgetIds,
                        boolean isView)
```
Externally accessible static wrapper for viewWorker(Widget, ScreenBuffer[], int[], boolean, int).

Parameters:

widget - The frame or widget for this request.

frameBuf - The current values of widgets in editable frames.

widgetIds - Array of field level widget IDs to be shown or null, which means show all contained widgets (for frame only).

isView - true if the call is for VIEW, false for DISPLAY.

viewWorker
```
private void viewWorker(Widget widget,
                        ScreenBuffer[] frameBuf,
                        int[] widgetIds,
                        boolean isView,
                        int windowId)
```
Force the visibility and drawing of all specified fields of the given frame. This method may be safely called while processing in the view(int, com.goldencode.p2j.ui.ScreenBuffer[], int[], boolean, int, int[]) method.

Parameters:

widget - The frame or widget for this request.

frameBuf - The current values of widgets in editable frames.

widgetIds - Array of field level widget IDs to be shown or null, which means show all contained widgets (for frame only).

isView - true if the call is for VIEW, false for DISPLAY.

windowId - target window id.

endWidgetOutput
```
void endWidgetOutput()
```
Mark end of widget output.

startWidgetOutput
```
void startWidgetOutput()
```
Mark start of widget drawing.

conditionalRefresh
```
public void conditionalRefresh(Rectangle rect)
```
Conditionally refresh specified rectangle not occupied by frames.

Parameters:

rect - Rectangle to refresh.

conditionalLineRefresh
```
public void conditionalLineRefresh(Rectangle rect)
```
Conditionally refresh specified horizontal lice described by provided rectangle.

Parameters:

rect - Rectangle to refresh.

placeFrameInt
```
private void placeFrameInt(Frame frame,
                           boolean force)
```
Hide frames if necessary to prepare space for specified frame and then place and realize current frame.

Parameters:

frame - Frame which will be displayed.

force - true means forced frame placement even if the frame is currently visible; useful for recovering partially hidden frames.

hideFramesInt
```
private boolean hideFramesInt(Frame frame)
```
Internal method which hides frames if necessary and maintains global flag.

Parameters:

frame - Frame which is about to be displayed.

Returns:

true if pause was triggered.

markFrames
```
public void markFrames(MarkEntry me)
```
Perform operation on array of frames or widgets.

Parameters:

me - MarkEntry container with operation and array of frames to process.

waitFor
```
public ScreenBuffer[] waitFor(EventList list,
                              int focusWidgetId,
                              int millis,
                              ScreenBuffer[] inbuf)
```
Wait for specified list of events.
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget PAUSE n

Specified by:

waitFor in interface ClientExports

Parameters:

list - List of events to wait for.

focusWidgetId - Widget ID of a widget receiving focus first, or -1.

millis - Time to wait for event.

inbuf - currently editable frames screen buffer known to the server.

Returns:

ScreenBuffer array with the current values.

waitFor
```
public ScreenBuffer[] waitFor(EventList list,
                              int focusWidgetId,
                              int millis,
                              ScreenBuffer[] inbuf,
                              BlockingOperation op,
                              boolean force,
                              int windowId)
```
Wait for specified list of events.
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget PAUSE n

Parameters:

list - List of events to wait for.

focusWidgetId - Widget ID of a widget receiving focus first, or -1.

millis - Time to wait for event.

inbuf - currently editable frames screen buffer known to the server.

op - The type of blocking operation.

force - If true, on output, copy the current data into the returned screen buffer without regard to the changed flag.

windowId - Id of target window or WindowConfig.RESOLVE_WINDOW for current or default window. This parameter is used only when the blocking operation allows the @IN WINDOW@ option.

Returns:

ScreenBuffer array with the current values.

waitForWorker
```
public ScreenBuffer[] waitForWorker(EventList list,
                                    int focusWidgetId,
                                    int millis,
                                    ScreenBuffer[] inbuf,
                                    boolean force,
                                    boolean status,
                                    boolean entryWindow,
                                    BlockingOperation operation,
                                    int windowId)
```
Main WAIT-FOR worker routine.
It manages the focus scopes, sets the initial focus and provides a message processing loop. The focus validity is constantly monitored and when it needs adjustment and the conditions are appropriate, the focus gets adjusted.

Parameters:

list - List of events to wait for.

focusWidgetId - Widget ID of a widget receiving focus first, or -1.

millis - The time to wait for a given key event.

inbuf - The currently editable frames screen buffer known to the server.

force - If true, on output, copy the current data into the returned screen buffer without regard to the changed flag.

status - If true method will change status line.

entryWindow - true if ENTRY for window should be sent.

operation - The operation for which this event loop is executed.

windowId - Id of target window or WindowConfig.RESOLVE_WINDOW for current or default window. This parameter is used only when the blocking operation allows the @IN WINDOW@ option.

Returns:

ScreenBuffer array with the current values.

waitForWorker
```
public ScreenBuffer[] waitForWorker(EventList list,
                                    int focusWidgetId,
                                    int millis,
                                    ScreenBuffer[] inbuf,
                                    boolean force,
                                    boolean status,
                                    boolean entryWindow,
                                    BlockingOperation operation,
                                    boolean restoreFocus,
                                    int windowId)
```
Main WAIT-FOR worker routine.
It manages the focus scopes, sets the initial focus and provides a message processing loop. The focus validity is constantly monitored and when it needs adjustment and the conditions are appropriate, the focus gets adjusted.

Parameters:

list - List of events to wait for.

focusWidgetId - Widget ID of a widget receiving focus first, or -1.

millis - The time to wait for a given key event.

inbuf - The currently editable frames screen buffer known to the server.

force - If true, on output, copy the current data into the returned screen buffer without regard to the changed flag.

status - If true method will change status line.

entryWindow - true if ENTRY for window should be sent.

operation - The operation for which this event loop is executed.

restoreFocus - When true currenty focused widget will be kept before the event loop is started and eventually restored when condition is raised. When false the method will not attempt to restore focus.

windowId - Id of target window or WindowConfig.RESOLVE_WINDOW for current or default window. This parameter is used only when the blocking operation allows the @IN WINDOW@ option.

Returns:

ScreenBuffer array with the current values.

fixWaitForFocus
```
private void fixWaitForFocus(int cop,
                             Widget<?> saveFocus,
                             Widget<?> savePending,
                             int focusState,
                             int pendingState)
```
Fix the focus after a event loop has finished, regradless if a condition was raised or not.

Parameters:

cop - The current operation.

saveFocus - The focus before the event loop started.

savePending - The pending focus set via pendingFocus, before the event loop started.

focusState - The focus state for the saveFocus.

pendingState - The focus state for the savePending.

fixFocusedFrameZOrder
```
private void fixFocusedFrameZOrder()
```
Fix possible Z-ordering issues.

sendEntry
```
public boolean sendEntry(Widget widget)
```
Sends ENTRY event to the specified widget and returns a boolean result of the possible trigger invocation.

Parameters:

widget - target widget for sending ENTRY event

Returns:

true if no trigger or the trigger has returned normally
false if the trigger has returned no-apply

sendEntry
```
public boolean sendEntry(Widget widget,
                         boolean mouse)
```
Sends ENTRY event to the specified widget and returns a boolean result of the possible trigger invocation.

Parameters:

widget - target widget for sending ENTRY event

mouse - Flag indicating this ENTRY is posted from a mouse event. In this case, drawing is bypassed.

Returns:

true if no trigger or the trigger has returned normally
false if the trigger has returned no-apply

sendEntry
```
public boolean sendEntry(Widget widget,
                         boolean mouse,
                         Widget oldFocus)
```
Sends ENTRY event to the specified widget and returns a boolean result of the possible trigger invocation.

Parameters:

widget - target widget for sending ENTRY event

mouse - Flag indicating this ENTRY is posted from a mouse event. In this case, drawing is bypassed.

oldFocus - Widget leaving focus as the result of this ENTRY event.

Returns:

true if no trigger or the trigger has returned normally
false if the trigger has returned no-apply

sendEntry
```
public boolean sendEntry(Widget widget,
                         boolean mouse,
                         Widget oldFocus,
                         boolean skipActivation)
```
Sends ENTRY event to the specified widget and returns a boolean result of the possible trigger invocation.

Parameters:

widget - target widget for sending ENTRY event

mouse - Flag indicating this ENTRY is posted from a mouse event. In this case, drawing is bypassed.

oldFocus - Widget leaving focus as the result of this ENTRY event.

skipActivation - Skip activation flag. Depending on the flag value the window activation event will or will not be sent when ENTRY event is dispatched.

Returns:

true if no trigger or the trigger has returned normally
false if the trigger has returned no-apply

sendLeave
```
public boolean sendLeave(Widget widget,
                         Widget newFocus)
```
Sends LEAVE event to the specified widget.

Parameters:

widget - target widget for sending LEAVE event

newFocus - The widget which is supposed to receive focus after this LEAVE event.

Returns:

true if no trigger or the trigger has returned normally
false if the trigger has returned no-apply

sendLeave
```
public boolean sendLeave(Widget widget,
                         Widget newFocus,
                         boolean mouse)
```
Sends LEAVE event to the specified widget.

Parameters:

widget - target widget for sending LEAVE event

newFocus - The widget which is supposed to receive focus after this LEAVE event.

mouse - Flag indicating this LEAVE is posted from a mouse event. In this case, drawing is bypassed.

Returns:

true if no trigger or the trigger has returned normally and widget display value is valid
false if the trigger has returned no-apply or widget display value is invalid

isTriggerWasAppliedWithoutWaitFor
```
public boolean isTriggerWasAppliedWithoutWaitFor()
```
Check if trigger processing was finished with NO-APPLY and there was no WAIT-FOR during trigger processing.

Returns:

true if both conditions are met.

startInputStatus
```
private void startInputStatus(boolean cursor)
```
Activate input mode.

Parameters:

cursor - New state of the cursor. true for the cursor to be forced into visibility and false to hide the cursor.

stopInputStatus
```
private void stopInputStatus()
```
Deactivate input mode.

stopInputStatus
```
private void stopInputStatus(boolean changeStatus)
```
Deactivate input mode.

Parameters:

changeStatus - Allow changing status line.

trigger
```
private boolean trigger(int triggerId,
                        int eventId,
                        int sourceId,
                        int otherId,
                        long resourceId,
                        int matchedWidgetId,
                        int rowSourceId,
                        ScreenBuffer sb,
                        EventList previousEventList)
```
Signals a trigger to the application. If a trigger is registered for this event and source widget combination, then it will be executed.

Parameters:

triggerId - The trigger to be called.

eventId - The event which was generated.

sourceId - The widget which generated the event.

otherId - The companion widget id (for ENTER/LEAVE).

resourceId - The resource which generated the event.

matchedWidgetId - Id of the widget that actually matched the trigger.

rowSourceId - Id of the WIDGET-ENTER/WIDGET-LEAVE widget for a ROW-ENTRY/ROW-LEAVE event.

sb - The associated frame's current ScreenBuffer

previousEventList - current event list saved value

Returns:

true if the event must be consumed (this is equivalent to RETURN NO-APPLY.

validate
```
public boolean validate(int sourceId,
                        ScreenBuffer sb)
```
Signals a validation event to the application.
This signal is used to trigger validation execution on the server.

Parameters:

sourceId - widget ID of the widget generated the trigger.

sb - current ScreenBuffer

Returns:

result of validation check.

getEditableClientScreenBuffers
```
private ScreenBuffer[] getEditableClientScreenBuffers()
```
Retrieves the editable screen buffers. The method will use the active frame as the source of the default screen buffer. The default screen buffer will be placed at index 0 of the returned array.

Returns:

Array of screen buffers.

isKeyVariation
```
private static boolean isKeyVariation(int key,
                                      int variableKey)
```
Returns true if the given key equals variableKey, CTRL-variableKey, SHIFT-variableKey or CTRL-SHIFT-variableKey

Parameters:

key - The key to check.

variableKey - The key which variations are used for comparison with the key.

Returns:

see above.

getEditableClientScreenBuffers
```
private ScreenBuffer[] getEditableClientScreenBuffers(ScreenBuffer sbDefault)
```
Prepares the array of the screen buffers to pass to the server when calling the server export methods to be able the screen buffer synchronization.

Parameters:

sbDefault - The default screen buffer for the exact frame in processing.

Returns:

The array of the screen buffers to sync.

getEditableClientScreenBuffers
```
private ScreenBuffer[] getEditableClientScreenBuffers(ScreenBuffer sbDefault,
                                                      boolean onlyChildren)
```
Prepares the array of the screen buffers to pass to the server when calling the server export methods to be able the screen buffer synchronization.

Parameters:

onlyChildren - Flag indicating only child frames for the default screen buffer are computed.

sbDefault - The default screen buffer for the exact frame in processing.

Returns:

The array of the screen buffers to sync.

getValidationError
```
public java.lang.String getValidationError()
```
Returns the last validation error message.

Returns:

error message generated during the last validation call or null if the last validation succeeded.

getEditorsConfigs
```
public WidgetConfig[] getEditorsConfigs(int browseId)
```
Get configurations of widgets used for in-browse editing (fill-ins, toggle-boxes or combo-boxes).

Parameters:

browseId - ID of the browse which should handle the request.

Returns:

Array of configurations of widgets used for in-browse editing (fill-ins, toggle-boxes or combo-boxes). An array element is configuration of the widget for the corresponding editable column or null if the column is not editable. Return value is null if the browse is read-only.

getRowCount
```
public int getRowCount(int browseId)
```
Get the number of rows iterated by the query (for preselect queries - matches result size, for adaptive queries - matches the size of the part of the result set the query has already iterated over).

Parameters:

browseId - ID of the browse which should handle the request.

Returns:

number of iterated rows in the result set.

getRowCount
```
public int getRowCount(int browseId,
                       int startRow)
```
Get number of available rows starting from the given one.

Parameters:

browseId - ID of the browse which should handle the request.

startRow - Initial row to start count rows from.

Returns:

Number of rows in browse.

getRows
```
public BrowseRow[] getRows(int browseId,
                           int startRowIndex,
                           int count,
                           boolean forward,
                           int rowDisplayTriggerId,
                           ScreenBuffer[] sb,
                           RowDisplayStrategy displayStrategy)
```
Retrieves several subsequent rows from the database.

Parameters:

browseId - ID of the browse which should handle the request.

startRowIndex - Index of the first row to retrieve (0-based).

count - Maximum count of rows to return. -1 for no limit.

forward - true if rows are retrieved in the forward direction, false if rows are retrieved in the backward direction.

rowDisplayTriggerId - Trigger ID of the ROW-DISPLAY trigger. -1 if there is no ROW-DISPLAY trigger for this browse.

sb - Screen buffer for the ROW-DISPLAY trigger. null if there is no ROW-DISPLAY trigger for this browse.

displayStrategy - Specifies type of action for which rows are fetched and defines how rows are iterated / displayed.

Returns:

Array of rows. Each row is array of cell values, but the first element of the row array is 0-based index of the row in the browse model. Note that if rows are fetched in the backward direction, the resulting rows are returned in the straight order starting from the row with the least row number. If no query is specified or the query is closed, null is returned.

getRows
```
public BrowseRow[] getRows(int browseId,
                           char searchChar,
                           int searchColumn,
                           int viewportTopRow,
                           int viewportBottomRow,
                           int rowDisplayTriggerId,
                           ScreenBuffer[] sb)
```
This function is used when search by key is performed in a browse. Retrieves the set of rows which should be in view after search is completed. There are complex rules which determine the top row of the view depending on how the current row is positioned relatively to the current view and how the found row is positioned relatively to the current view and to the current row.

Parameters:

browseId - ID of the browse which should handle the request.

searchChar - Character to be searched for. Search is performed using only the first character (in the visual data representation) in the current column. Specifying a character puts this function in the search mode. This parameter is null for non-search mode.

searchColumn - For search mode: 0-based index of the column to be searched.

viewportTopRow - For search mode: 0-based index (in the result set) of the top row in the current view.

viewportBottomRow - For search mode: 0-based index (in the result set) of the bottom row in the current view.

rowDisplayTriggerId - Trigger ID of the ROW-DISPLAY trigger. -1 if there is no ROW-DISPLAY trigger for this browse.

sb - Screen buffer for the ROW-DISPLAY trigger. null if there is no ROW-DISPLAY trigger for this browse.

Returns:

Array of rows. Each row is array of cell values, but the first element of the row array is 0-based index of the row in the browse model. If no query is specified or the query is closed, null is returned.

updateRow
```
public void updateRow(int browseId,
                      int rowIndex,
                      int[] cellIndices,
                      BaseDataType[] cellValues,
                      boolean onlyNotifyRowReleased)
               throws DataValidationException
```
Updates selected cells in the given row.

Parameters:

browseId - ID of the browse which should handle the request.

rowIndex - Index of the row to update.

cellIndices - Cells for update indexes.

cellValues - Cells for update new values.

onlyNotifyRowReleased - Only notify server that the row has been released. Data is not updated.

Throws:

DataValidationException - New values don't passed database validation rules.

setCurrentRow
```
public int setCurrentRow(int browseId,
                         int rowIndex)
```
Inform server about current row in the browse.

Parameters:

browseId - ID of the browse which should handle the request.

rowIndex - 0-based index of the current row.

Returns:

New current row.

getCurrentRow
```
public int getCurrentRow(int browseId)
```
Get current row in the query.

Parameters:

browseId - ID of the browse which should handle the request.

Returns:

The current row index.

isRowAvailable
```
public boolean isRowAvailable(int browseId,
                              int rowIndex)
```
Determines if the specified browse row is "available", i.e. it is not deleted.

Parameters:

browseId - ID of the browse which should handle the request.

rowIndex - 0-base index of the target row in the browse model.

Returns:

true if the row is "available", i.e. it is not deleted.

runReport

public boolean runReport(int browseId,
                         java.lang.String outputFileName,
                         MediaType outputFormat,
                         ScreenBuffer[] sb)

Run browse report.

Parameters:: browseId - ID of the browse which should handle the request.; outputFileName - Name of the output file.; outputFormat - Format of the output format.; sb - The screen buffer array data.
Returns:: true on success.

getEnhancedBrowseSaveTargets
```
public EnhancedBrowseSaveTarget[] getEnhancedBrowseSaveTargets(int browseId)
```
Get save targets for an enhanced browse configuration, which are available for the current user.

Parameters:

browseId - ID of the browse which should handle the request.

Returns:

see above.

getColumnFiltersMappedDataTypes
```
public java.lang.String[] getColumnFiltersMappedDataTypes(int browseId)
```
For enhanced filtering: get data types of the fields mapped using DB-FILTER-FIELD-MAPPING. They are used in column filters. E.g. if a column has DB-FILTER-FIELD-MAPPING set to "some-table.some-date-field", data type from this column would be "date".

Parameters:

browseId - ID of the browse which should handle the request.

Returns:

array of data types, each array element corresponds a browse column. If a column doesn't have DB-FILTER-FIELD-MAPPING set, corresponding array element is null.

getEnhancedBrowseResetTargets
```
public EnhancedBrowseSaveTarget[] getEnhancedBrowseResetTargets(int browseId)
```
Get enhanced browse configuration reset targets available for the target browse and the current user. It is a list of levels which have existing enhanced browse configurations defined for the target browse, filtered according to the user's access rights.

Parameters:

browseId - ID of the browse which should handle the request.

Returns:

see above.

resetEnhancedConfig
```
public EhBrowseConfigKey resetEnhancedConfig(int browseId,
                                             EnhancedBrowseSaveTarget resetTarget)
```
Reset (delete) an enhanced configuration at the certain level for this browse.

Parameters:

browseId - ID of the browse which should handle the request.

resetTarget - Defines the level at which the configuration will be reset.

Returns:

key of the configuration that has been deleted or null if there is no configuration at this level.

applyEnhancedConfig
```
public boolean applyEnhancedConfig(int browseId,
                                   EnhancedBrowseConfig config)
```
Apply the given enhanced browse configuration to the given browse.

Parameters:

browseId - ID of the browse which should handle the request.

config - Enhanced browse configuration to apply.

Returns:

true on success.

saveOrCacheEnhancedConfig
```
public EnhancedBrowseConfig saveOrCacheEnhancedConfig(int browseId,
                                                      EnhancedBrowseSaveTarget saveTarget)
```
Save the current enhanced browse configuration using the specified save target. If the configuration is supposed to be stored on the client side then on the server side it is only cached.

Parameters:

browseId - ID of the browse which should handle the request.

saveTarget - Save target (if configuration is applied to "all browses" / "specific browse" and "all users" / "current user").

Returns:

the configuration that has been saved or cached. null on error.

setDynamicSorting
```
public void setDynamicSorting(int browseId,
                              int[] columnOrdinals,
                              boolean[] ascending)
```
Set dynamic sorting for the browse.

Parameters:

browseId - ID of the browse which should handle the request.

columnOrdinals - Array of the ordinals of the sort columns. Inside the array ordinals are positioned from the column which defines the most coarse sorting to the most granular.

ascending - Array of the sorting directions of the sort columns. true for ascending, false for descending. Inside the array directions are positioned from the column which defines the most coarse sorting to the most granular.

setDynamicFiltering
```
public void setDynamicFiltering(int browseId,
                                int[] columnOrdinals,
                                BaseDataType[] values)
```
Set dynamic filtering for the browse.

Parameters:

browseId - ID of the browse which should handle the request.

columnOrdinals - Array of the ordinals of the filtered columns.

values - Array of the filter values for the filtered columns..

openHyperlink
```
public void openHyperlink(BrowseColumnGuiImpl column,
                          java.lang.String hyperlinkText)
```
Open the hyperlink in the browse column by raising the event previously set for this column using the HYPERLINK attribute (FWD extension). hyperlinkText is used as the event parameter. I.e. opening of a hyperlink is an equivalent of
PUBLISH eventName (hyperlinkText).

Parameters:

column - Target browse column widget.

hyperlinkText - Text of the hyperlink to be opened.

continueEditing
```
public ContinueEditingResult continueEditing(boolean hadNext)
```
Checks to see whether a pending GO event is about to end the editing block.

Specified by:

continueEditing in interface ClientExports

Parameters:

hadNext - true if the executing business logic executed a NEXT statement causing the editing block to iterate. This will result in clearing any current GO-PENDING condition. This is passed as a parameter here so that a separate trip down to the client is not needed to process the editing block iteration state update.

Returns:

ContinueEditingResult result object. If ContinueEditingResult.goPending is false there is no GO-PENDING and the editing mode continues.

startEditingMode
```
private void startEditingMode(int focusWidgetId,
                              EventList eventList)
```
Marks the beginning of the editing block and passes a customized list of GO-ON events that define termination condition for this I/O operation.
This call is responsible for setting the initial focus to the first enabled widget or NEXT-PROMPT hint.

Parameters:

focusWidgetId - ID of the target frame for this editing session

eventList - Information about events to wait for.

stopEditingMode
```
public ScreenBuffer[] stopEditingMode()
```
Marks the end of the editing block when triggered by any abnormal exit from the block on the server. This method does NOT need to be called if the exit is naturally triggered via continueEditing(boolean). This method allows the client's state to be cleaned up in the abnormal termination case.

Specified by:

stopEditingMode in interface ClientExports

Returns:

The screen buffer array for currently editable frames.

waitForNextKey
```
public void waitForNextKey()
```
Conditionally blocks until a next UI event is available.

Specified by:

waitForNextKey in interface ClientExports

initLogging
```
public void initLogging(CentralLoggerClientConfig loggingConfig)
```
Indicates the server is ready to receive and handle logs and sends all logger levels.

Specified by:

initLogging in interface ClientExports

Parameters:

loggingConfig - Logging configs.

invalidateLoggerLevels
```
public void invalidateLoggerLevels(CentralLoggerClientConfig loggerLevels)
```
Indicates a server change to logger levels. Resets levels on the client.

Specified by:

invalidateLoggerLevels in interface ClientExports

Parameters:

loggerLevels - Logger levels.

getLoginPageAddress
```
public java.lang.String getLoginPageAddress()
```
Returns the web client login page address.

Specified by:

getLoginPageAddress in interface ClientExports

Returns:

See above.

getStorageId
```
public java.lang.String getStorageId()
```
Returns the storage id.

Specified by:

getStorageId in interface ClientExports

Specified by:

getStorageId in interface KeyValueStorage

Returns:

See above.

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 ClientExports

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 ClientExports

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 ClientExports

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 ClientExports

Returns:

true if the websocket connection is alive, false otherwise.

postKeyEvent
```
public void postKeyEvent(int widgetId,
                         int id,
                         int key)
```
This method posts a key event to a specific widget identified by its widget ID.

Specified by:

postKeyEvent in interface ClientExports

Parameters:

widgetId - the ID of the widget to post the key event to

id - the ID of the key event

key - the key code for the key event

repaintWidget
```
public void repaintWidget(int widgetId)
```
Repaints the widget with the specified ID.

Specified by:

repaintWidget in interface ClientExports

Parameters:

widgetId - the ID of the widget to be repainted

runOsPassExpirationCheck
```
public boolean runOsPassExpirationCheck()
```
Starts the OS user pass expiration check. If the password is to expire soon shows a dialog for changing the password.

Specified by:

runOsPassExpirationCheck in interface ClientExports

Returns:

true if the OS user password is not expired or is successfully changed, false otherwise.

setCurrentLanguage
```
public void setCurrentLanguage(java.lang.String language)
```
Set new current session language for the client.

Specified by:

setCurrentLanguage in interface ClientExports

Parameters:

language - The language identifier

getChanges
```
public java.io.Externalizable getChanges()
```
Called by the protocol driver to obtain the latest state that should be sent to the other side of the connection. This is called just before a "real" message is sent and any changes provided will be piggybacked into that message.
To enable incremental changes, it is guaranteed that this method will be called every time any message is sent to the other side of the connection. In addition, this will only be called once per message.
In a system in which control flow is "sent" to the other side of the connection (a type of "conversation" or single-threaded synchronous mode), it is further guaranteed that any changes that are made at the other side after this is called will result in a call to this side's applyChanges(java.io.Externalizable) method before this method is ever called again (when control flow returns to this side of the connection). This allows one to ensure that on the call to this method, any "dirty" flags can be safely cleared and the state of this side will be updated with the results of the other side's changes before this method must ever again check to see if there are changes to send.
Note that any user input events received by the application while the thread is waiting for the server's response are enqueued in the event queues and processed once server response is received and the thread resumes processing. During this time the client app appears as locked for any input.

Specified by:

getChanges in interface StateSynchronizer

Returns:

The payload of state changes to be sent to the other side or null if no changes need to be sent.

applyChanges
```
public void applyChanges(java.io.Externalizable changes)
```
Called by the protocol driver upon reading a message that contains state changes that need to be applied to this side of the connection. This is called just after a new message is read from the connection and only if that message had piggybacked state changes attached. This is guaranteed to be called before the containing message is enqueued for further "real" processing on this node.

Specified by:

applyChanges in interface StateSynchronizer

Parameters:

changes - The payload of state changes that must be locally applied.

processDirectUploadDefs
```
private void processDirectUploadDefs(java.util.List<DirectUploadDef> registerDirectUploads,
                                     java.util.List<DirectUploadDef> deregisterDirectUploads)
```
Processes the direct upload registrations and deregistrations and produces a list of effective direct upload definitions to be synchronized with web gui driver.

Parameters:

registerDirectUploads - A list of direct upload definitions to register.

deregisterDirectUploads - A list of direct upload definitions to deregister.

getEffectiveDirectUploads
```
public java.util.List<DirectUploadDef> getEffectiveDirectUploads()
```
Returns a list of effective direct uploads.

Returns:

A list of effective direct uploads.

getEffectiveDirectUpload
```
public DirectUploadDef getEffectiveDirectUpload(int widgetId)
```
Retrieves the effective direct upload definition for the specified widget ID.

Parameters:

widgetId - The ID of the widget for which to retrieve the effective direct upload definition.

Returns:

The effective direct upload definition for the specified widget ID, or null if no such definition exists.

getDirectUploadsModcount
```
public int getDirectUploadsModcount()
```
Retrieves the modification count of the list of effective direct upload definitions.

Returns:

The modcount value.

finishDirectUpload
```
public void finishDirectUpload(int uploadId,
                               java.lang.String[] files,
                               boolean result)
```
Finishes a direct upload for a given upload ID, updating the provided files and result.

Parameters:

uploadId - The ID of the direct upload.

files - The uploaded or selected files.

result - The result of the direct upload.

isChui
```
public boolean isChui()
```
Checks whether the CHUI is up and running on the client.

Specified by:

isChui in interface ClientExports

Returns:

true if ChUI driver false if GUI driver.

isEmbedded
```
public boolean isEmbedded()
```
Check the client type: embedded or not.

Specified by:

isEmbedded in interface ClientExports

Returns:

TRUE if the client is running in embedded mode, FALSE otherwise

isUnderWindows
```
public boolean isUnderWindows()
```
Check if the client is running in windows compatibility mode.

Returns:

See above.

setSessionTooltips
```
public void setSessionTooltips(boolean tooltips)
```
Sets the SESSION:TOOLTIPS attribute for this session.

Specified by:

setSessionTooltips in interface ClientExports

Parameters:

tooltips - The new value for session related TOOLTIPS attribute.

activateTooltipForWidget
```
public void activateTooltipForWidget(int wId)
```
Activates tootip feature for particular widget.

Specified by:

activateTooltipForWidget in interface ClientExports

Parameters:

wId - The widget ID to activate tooltip.

deactivateTooltipForWidget
```
public void deactivateTooltipForWidget(int wId)
```
Deactivates tootip feature for particular widget.

Specified by:

deactivateTooltipForWidget in interface ClientExports

Parameters:

wId - The widget ID to deactivate tooltip.

destroyFrame
```
public void destroyFrame(int frameId)
```
Destroy the frame and free associated resources as needed. If the frame is a dialog, it will be hidden immediately, otherwise it will be marked as out of scope and valid for being hidden and resources will be released when frame will be hidden.

Specified by:

destroyFrame in interface ClientExports

Parameters:

frameId - The frame requiring cleanup.

selectiveDisable
```
private void selectiveDisable(Frame frame)
```
Selectively disable and redraw widgets.

Parameters:

frame - Frame where widgets should be disabled.

isGoPending
```
public boolean isGoPending()
```
Checks whether a GO event is pending for this editing operation (either an editing block or a wait-for).
This method corresponds to the Progress built-in function:
GO-PENDING

Specified by:

isGoPending in interface ClientExports

Returns:

true if an event has been applied that caused pending GO for the current editing operation.

addGoPending
```
private void addGoPending()
```
Increments isGoPending.

subGoPending
```
private void subGoPending()
```
Decrements isGoPending.

resetGoPending
```
private void resetGoPending()
```
Sets isGoPending to 0.

resetGoPending
```
private void resetGoPending(int val)
```
Sets isGoPending to val.

Parameters:

val - Value set for isGoPending

getFrame
```
public Frame getFrame(int frameId)
```
Get frame widget from the given frame ID.

Parameters:

frameId - Frame ID.

Returns:

Reference to Frame instance.

getFrameLine
```
public static int getFrameLine(Frame frame,
                               int pendingUpDown)
```
Returns the current logical line number in a frame.
This method corresponds to the Progress built-in function:
```
 FRAME-LINE
 
```
Parameters:

frame - The frame for this request. Must NOT be null.

pendingUpDown - The pending down value for this frame.

Returns:

1-based ordinal of the current data iteration of the frame. If the frame is not a down frame then 1 will be returned.

cleanupQueue
```
private void cleanupQueue()
```
Process events internally if there are no interactive requests from the server.

restoreCursor
```
public boolean restoreCursor(NativePoint curpos,
                             boolean curvis)
```
Force the cursor to the specified location and make it visible again.

Parameters:

curpos - The 0-based location to which the cursor must be forced.

curvis - The new cursor visibility state (true means set the cursor visible).

Returns:

The previous cursor visibility state.

isInEditingBlock
```
public boolean isInEditingBlock()
```
Returns if processing is in editing block.

Returns:

true if in editing block, false - otherwise.

getLastViewed
```
public Frame getLastViewed()
```
Get the last viewed frame.

Returns:

See above.

setLastViewed
```
public void setLastViewed(Frame frame)
```
Set last viewed frame reference. This method is a no-op when the supplied frame is redirected.

Parameters:

frame - Last viewed frame.

honorConditionalUpDown
```
private boolean honorConditionalUpDown(boolean noPause)
```
Honor the deferred processing for a conditional up or down.

Parameters:

noPause - Make no pause if frame will need it during DOWN processing.

Returns:

true if down frame was wrapped during processing of conditional UP/DOWN.

honorConditionalUpDown
```
private void honorConditionalUpDown()
```
Honor the deferred processing for a conditional up or down.

getWidget
```
public Widget getWidget(WidgetId componentId)
```
Get Component instance for a given ID.

Parameters:

componentId - ID of the requested Component instance.

Returns:

reference to Component instance with given ID.

getWidget
```
public Widget getWidget(int componentId)
```
Get Component instance for a given ID.

Parameters:

componentId - ID of the requested Component instance.

Returns:

reference to Component instance with given ID.

setFormat
```
public void setFormat(int widget,
                      java.lang.String format)
```
Sets the format specification for the specified widget and redraws the widget.

Specified by:

setFormat in interface ClientExports

Parameters:

widget - The widget to modify.

format - The format specification.

getLastActionCode
```
public int getLastActionCode()
```
Returns the action code of the last key input event.

Returns:

The action code of the last key input event.

getCurrentEventList
```
public EventList getCurrentEventList()
```
Gets the current event list.

Returns:

The currently active event list.

putBrowseColumnValues
```
public ScreenBuffer putBrowseColumnValues(Browse browse,
                                          ScreenBuffer buffer)
```
Put the values of the column widgets of the given browse into the given screen buffer.

Parameters:

browse - Target browse.

buffer - Target buffer. If it is null, a new buffer will be created (if there are values to put).

Returns:

target buffer containing the widget values or null if there is no initial target buffer and there are no values to put.

makePauseText
```
private static java.lang.String makePauseText(int millis)
```
Prepare message text for specified time to wait.

Parameters:

millis - Milliseconds to wait for an event. Negative value means wait indefinitely and number of seconds is not displayed.

Returns:

prepared text message.

computeFocus
```
private Widget computeFocus(boolean frameAsTarget)
```
Compute the next focus in a wait-for loop.

Parameters:

frameAsTarget - if true, then the active frame is the target of events if nothing is enabled and in focus, otherwise the current window

Returns:

The currently focused widget, or null if no focus can be determind.

waitForEvent
```
private Event waitForEvent(int millis,
                           boolean frameAsTarget,
                           boolean honorServerEvent)
```
Wait for key press indefinitely or for specified number of milliseconds.

Parameters:

millis - -1 means indefinite wait, 0 means no wait and positive values mean the number of milliseconds to wait

frameAsTarget - if true, then the active frame is the target of events if nothing is enabled and in focus, otherwise the current window

honorServerEvent - flag indicating if server events should be honored or not.

Returns:

key event code or null if no key was received during specified time.

flushRepaints
```
public void flushRepaints(boolean force)
```
Flush the repaints, considering the state of the repaintInterval, isImmediateDisplay and multitaskingInterval values.

Parameters:

force - Flag indicating the the flush is forced, even if IMMEDIATE-DISPLAY and MULTITASKING-INTERVAL are not set.

processRepaints
```
public void processRepaints()
```
Process the delayed repaints so that the changes are drawn on the UI.

waitForEvent
```
private Event waitForEvent(int millis,
                           boolean frameAsTarget,
                           boolean honorServerEvent,
                           boolean includeOSEvent)
```
Wait for key press indefinitely or for specified number of milliseconds.

Parameters:

millis - -1 means indefinite wait, 0 means no wait and positive values mean the number of milliseconds to wait

frameAsTarget - if true, then the active frame is the target of events if nothing is enabled and in focus, otherwise the current window

honorServerEvent - flag indicating if server events should be honored or not.

includeOSEvent - flag indicating if OS events (mouse, window) should be considered the as action source or not. The flag is false if this method is called from PAUSE or READ-KEY

Returns:

key event code or null if no key was received during specified time.

checkForSystemEvent
```
private boolean checkForSystemEvent(KeyInput key)
```
Check if the given event can be treated by the focused widget on its own. Some widgets allow the event to be "consumed" and a new key read, in cases when a READKEY within a EDITING block is used: in these cases, the READKEY does not return until AFTER a key which has an associated trigger has be pressed IOR a key which is treated as a global system event.

Parameters:

key - The key to be checked.

Returns:

true if more keys need to be read.

pauseCleanup
```
private void pauseCleanup()
```
Run pause cleanup block if any.

getScreenBuffer
```
private ScreenBuffer getScreenBuffer(Widget widget)
```
Generate a copy of the ScreenBuffer instance for the given frame or for the frame in which the given widget is contained.

Parameters:

widget - A frame or a widget in the frame whose screen buffer must be returned.

Returns:

ScreenBuffer instance.

getScreenBuffer
```
private ScreenBuffer getScreenBuffer(Widget widget,
                                     java.util.function.Predicate<Frame> filter)
```
Generate a copy of the ScreenBuffer instance for the given frame or for the frame in which the given widget is contained.

Parameters:

widget - A frame or a widget in the frame whose screen buffer must be returned.

filter - If not null, it is used to test the resolved frame. When the predicate returns false, the method stops executing and returns null.

Returns:

ScreenBuffer instance.

getScreenBuffer
```
private ScreenBuffer getScreenBuffer(int frameId,
                                     boolean force)
```
Generate a copy of the ScreenBuffer instance for the given frame.

Parameters:

frameId - The frame whose screen buffer must be returned.

force - true to copy the current data into the screen buffer without regard to the changed flag.

Returns:

ScreenBuffer instance.

getScreenBuffer
```
private ScreenBuffer getScreenBuffer(int frameId,
                                     boolean force,
                                     java.util.Set<WidgetId> widgets)
```
Generate a copy of the ScreenBuffer instance for the given frame.

Parameters:

frameId - The frame whose screen buffer must be returned.

force - true to copy the current data into the screen buffer without regard to the changed flag.

widgets - A set of widget IDs for which the screen-buffer value is updated, or null to include all widgets.

Returns:

ScreenBuffer instance.

lastEventToClientState
```
private final void lastEventToClientState(ClientState cs)
```
Update client state with last event info.

Parameters:

cs - the object to update

putWidgetValue
```
private static void putWidgetValue(Widget widget,
                                   ScreenBuffer sb)
```
Put widget value into the screen buffer.

Parameters:

widget - Widget which value is put.

sb - Screen buffer into which the widget value is put.

processSideLabel
```
private static void processSideLabel(ScreenBuffer buffer,
                                     Widget<?> comp)
```
Process the side-label associated with the given widget.
As side-labels are detached from normal frame widgets, the frame's buffer needs to be manually updated.

Parameters:

buffer - The screen buffer.

comp - The widget for which the side-label needs processing.

setScreenBuffers
```
private void setScreenBuffers(ScreenBuffer[] frameBuf)
```
Parses ScreenBuffer array for current set of frames and assigns new widget values. No checking for frame existence.

Parameters:

frameBuf - ScreenBuffer array to apply.

setScreenBuffers
```
private void setScreenBuffers(ScreenBuffer[] frameBuf,
                              boolean checkFrameExists)
```
Parses ScreenBuffer array for current set of frames and assigns new widget values.

Parameters:

frameBuf - ScreenBuffer array to apply.

checkFrameExists - Flag indicating checking frame for existence before applying the buffer.

setScreenBuffer
```
private void setScreenBuffer(ScreenBuffer frameBuf)
```
Parses ScreenBuffer instance for current set of frames and assigns new widget values.

Parameters:

frameBuf - ScreenBuffer instance.

setScreenBuffer
```
private void setScreenBuffer(ScreenBuffer frameBuf,
                             boolean direct)
```
Parses ScreenBuffer instance for current set of frames and assigns new widget values.
Allows direct drawing of headers.

Parameters:

frameBuf - ScreenBuffer instance.

direct - if set to true, header widgets draw directly instead of posting PaintEvent.

updateHeaders
```
private java.util.ArrayList<java.lang.Integer> updateHeaders(ScreenBuffer frameBuf)
```
Update form headers from given ScreenBuffer instance.

Parameters:

frameBuf - The ScreenBuffer instance to update headers from.

Returns:

List of IDs of updated header widgets.

applyWorker
```
private void applyWorker(Event event)
```
Applies the encoded event to the widget currently in focus in the given frame, or directly to the specified widget.

Parameters:

event - Progress event

clearWorker
```
ScreenBuffer clearWorker(Frame frame,
                         boolean noPause,
                         boolean clearAll,
                         boolean resolveBuffer)
```
Clear specified frame widgets.

Parameters:

frame - Frame to clear.

noPause - Do not generate pause.

clearAll - If true then all widgets are cleared (the CLEAR ALL behavior).

resolveBuffer - When true, resolve the frame's screen buffer and return it.

Returns:

The frame's screen buffer, or null if the resolveBuffer flag is not set.

independentEventDrawingBracket
```
public boolean independentEventDrawingBracket(Widget<?> widget,
                                              java.lang.Runnable code)
```
Execute the given code inside a new bracket of event processing which starts the toolkit capturing invalidation rectangles, then starts a new event bracket with a push(), executes the code and then ends with a pop() and finally disables invalidation mode. The closing of the event bracket and the disabling of invalidation mode (which can cause drawing) occur even if the executed code throws an exception. This ensures that the event processing and drawing will never get out of balance.
This version avoids flushing the parent's collecting drawing - it will save the invalidate level and the ScreenBitmap state and restore it, allowing any outer drawing bracket to handle this drawing by itself. This is needed to avoid re-drawing cursor and widgets during focus change.

Parameters:

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

code - Logic to safely execute inside the event bracket.

Returns:

The result as returned by pop.

eventDrawingBracket
```
public boolean eventDrawingBracket(Widget<?> widget,
                                   java.lang.Runnable code)
```
Execute the given code inside a new bracket of event processing which starts the toolkit capturing invalidation rectangles, then starts a new event bracket with a push(), executes the code and then ends with a pop() and finally disables invalidation mode. The closing of the event bracket and the disabling of invalidation mode (which can cause drawing) occur even if the executed code throws an exception. This ensures that the event processing and drawing will never get out of balance.
This version forces flushing when the invalidation mode is disabled.

Parameters:

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

code - Logic to safely execute inside the event bracket.

Returns:

The result as returned by pop.

eventDrawingBracket
```
boolean eventDrawingBracket(Widget<?> widget,
                            boolean discard,
                            java.lang.Runnable code)
```
Execute the given code inside a new bracket of event processing which starts the toolkit capturing invalidation rectangles, then starts a new event bracket with a push(), executes the code and then ends with a pop() (or popTrash()) and finally disables invalidation mode. The closing of the event bracket and the disabling of invalidation mode (which can cause drawing) occur even if the executed code throws an exception. This ensures that the event processing and drawing will never get out of balance.
This version forces flushing when the invalidation mode is disabled.

Parameters:

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

discard - true to use popTrash, false to use pop.

code - Logic to safely execute inside the event bracket.

Returns:

The result as returned by pop. If popTrash is used, the result will always be false.

eventDrawingBracket
```
public boolean eventDrawingBracket(Widget<?> widget,
                                   boolean discard,
                                   boolean flush,
                                   java.lang.Runnable code)
```
Execute the given code inside a new bracket of event processing which starts the toolkit capturing invalidation rectangles, then starts a new event bracket with a push(), executes the code and then ends with a pop() (or popTrash()) and finally disables invalidation mode. The closing of the event bracket and the disabling of invalidation mode (which can cause drawing) occur even if the executed code throws an exception. This ensures that the event processing and drawing will never get out of balance.

Parameters:

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

discard - true to use popTrash, false to use pop.

flush - Force flushing when invalidation mode is disabled.

code - Logic to safely execute inside the event bracket.

Returns:

The result as returned by pop. If popTrash is used, the result will always be false.

eventBracket
```
public boolean eventBracket(java.lang.Runnable code)
```
Execute the given code inside a new bracket of event processing which starts with a push() and ends with a pop() even if the executed code throws an exception. This ensures that the event processing will never get out of balance.

Parameters:

code - Logic to safely execute inside the event bracket.

Returns:

The result as returned by pop.

eventBracket
```
public boolean eventBracket(boolean discard,
                            java.lang.Runnable code)
```
Execute the given code inside a new bracket of event processing which starts with a push() and ends with a pop() or popTrash() even if the executed code throws an exception. This ensures that the event processing will never get out of balance.

Parameters:

discard - true to use popTrash, false to use pop.

code - Logic to safely execute inside the event bracket.

Returns:

The result as returned by pop. If popTrash is used, the result will always be false.

pop
```
private boolean pop()
```
Process events and restore previous event queue.

Returns:

true if at least one frame related PaintEvent has been processed

popTrash
```
private static void popTrash()
```
Trash all events and restore previous event queue.

push
```
private static void push()
```
Save current event queue.

getTriggerNesting
```
public int getTriggerNesting()
```
Get trigger nesting.

Returns:

current trigger nesting level.

needPause
```
public static boolean needPause()
```
Get current state of the needPause flag. It tracks recent input and other operations to tell application that pause is required.

Returns:

Current state of the flag.

pauseBeforeEnd
```
public void pauseBeforeEnd()
```
Perform pause before end of application.

Specified by:

pauseBeforeEnd in interface ClientExports

watchCtrlC
```
public int watchCtrlC()
```
Callback method that notifies the application about Ctrl-C keystroke and returns the decision the application has made about the disposition of the Ctrl-C keystroke.
This method is called in the context of the key reader thread.
This implementation's goal is to properly generate the STOP condition.

Specified by:

watchCtrlC in interface Watcher

Returns:

Ctrl-C keystroke disposition value as one of the predefined action code constants.

postKeyboardStateEvent
```
public static final void postKeyboardStateEvent(int keyCode,
                                                boolean isReleased)
```
Post system key pressed/released event.

Parameters:

keyCode - the key code

isReleased - true if this is a key release event

setAuthMode
```
public void setAuthMode(boolean auth)
```
Set authentication mode flag. When authentication mode is enabled, Ctrl-C keystroke is not passed to Control but processed as a normal sequence.

Parameters:

auth - New state of the flag.

redirectedTerminalForStream
```
public static RedirectedTerminal redirectedTerminalForStream(Stream out)
```
Looks up the redirected terminal instance for a given stream.

Parameters:

out - The stream being queried.

Returns:

instance of RedirectedTerminal associated with the stream.

notifyClose
```
public void notifyClose(Stream out)
```
Notify the registered object that the given stream is being closed.
This listener is used to catch the event of the stream closure to flush any output that may remain sitting in the redirected terminal buffer.

Specified by:

notifyClose in interface CloseListener

Parameters:

out - The stream being closed.

notifyUnbind
```
public void notifyUnbind(Stream out)
```
Notify registered object that given stream reached end of life cycle and all references to it can be safely discarded.
This notification is used to unbind frames which were switched from interactive mode to redirected mode and restore their initial state.

Specified by:

notifyUnbind in interface CloseListener

Parameters:

out - The stream being closed.

notifyAdvance
```
public void notifyAdvance(Stream out)
```
Notify the registered object that the given stream is advancing page.
This listener is used to catch the event to flush any output that may remain sitting in the redirected terminal buffer.

Specified by:

notifyAdvance in interface AdvanceListener

Parameters:

out - The stream being paged

notifyFlush
```
public void notifyFlush(Stream out)
```
Notify the registered object that the given stream is flushing.
This listener is used to catch the event to flush any output that may remain sitting in the redirected terminal buffer.

Specified by:

notifyFlush in interface FlushListener

Parameters:

out - The stream being flushed.

idFromStream
```
public int idFromStream(Stream s)
```
Returns the stream ID associated with a given stream.

Parameters:

s - stream to operate on

Returns:

The stream ID or -1 if no stream ID is associated with the given stream.

streamFromId
```
public Stream streamFromId(int sid)
```
Returns the stream associated with a given stream.ID.

Parameters:

sid - stream ID

Returns:

The stream instance or null if stream ID unknown.

getSelection
```
public int[] getSelection(int widgetId)
```
Request indexes of selected items in RadioSet, ComboBox or SelectionList widgets.

Specified by:

getSelection in interface ClientExports

Parameters:

widgetId - Widget ID.

Returns:

array of 0-based indexes of selected items or null if specified widget does not exists or does not support such a request.

deleteFromControlSet
```
public boolean deleteFromControlSet(int widgetId,
                                    int idx)
```
Delete item from ControlSetEntity.

Specified by:

deleteFromControlSet in interface ClientExports

Parameters:

widgetId - Widget ID. Must point to a widget with ControlSetConfig.

idx - 1-based index of the item

Returns:

true if successful

requestHelp
```
private void requestHelp()
```
Request HELP application execution on the server.

triggerSupport
```
private void triggerSupport(java.lang.Runnable triggerCode)
```
Execute a provided code presuming that it will fire a server-side trigger. This will handle any required flag and counter modifications alike triggerNesting.

Parameters:

triggerCode - The code which should fire a server-side trigger.

isRedirected
```
public boolean isRedirected()
```
Reports if the terminal is currently redirected to a stream.

Specified by:

isRedirected in interface ClientExports

Returns:

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

isRedirected
```
public boolean isRedirected(Stream s)
```
Reports if the terminal is currently redirected to the specified stream.

Parameters:

s - a stream to to check the redirection for

Returns:

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

redirectOutput
```
public void redirectOutput(int oldId,
                           int newId)
```
Redirect terminal output to the stream represented by newId (or to the interactive terminal if newId is -1) and close/ cleanup resources for the redirected terminal associated with oldId (unless oldId is -1 in which case nothing needs to be closed).

Specified by:

redirectOutput in interface ClientExports

Parameters:

oldId - The previously redirected stream for which the redirected terminal is to be closed or -1 for no close/cleanup action.

newId - The stream for which a redirected terminal is to be setup for redirection or -1 to remove redirections and activate the interactive terminal.

switchOutput
```
public int switchOutput(int newId,
                        boolean clean)
```
Redirect terminal output to the stream represented by newId (or to the interactive terminal if newId is -1) and return the id of the current output destination. This may be another redirected terminal or it may be -1 if the interactive terminal is in use.
If redirection has not yet been established for the given stream, it will be setup.

Parameters:

newId - The stream for which a redirected terminal is to be setup for redirection or -1 to remove redirections and activate the interactive terminal.

clean - true if this stream will need deferred cleanup.

Returns:

The id of the previous terminal or -1 if the previous terminal was interactive.

switchOutput
```
public int switchOutput(int newId,
                        boolean clean,
                        boolean endOut)
```
Redirect terminal output to the stream represented by newId (or to the interactive terminal if newId is -1) and return the id of the current output destination. This may be another redirected terminal or it may be -1 if the interactive terminal is in use.
If redirection has not yet been established for the given stream, it will be setup.

Specified by:

switchOutput in interface ClientExports

Parameters:

newId - The stream for which a redirected terminal is to be setup for redirection or -1 to remove redirections and activate the interactive terminal.

clean - true if this stream will need deferred cleanup.

endOut - true to force any pending PUT or EXPORT output to be ended for the given stream (so long as that stream is not the terminal).

Returns:

The id of the previous terminal or -1 if the previous terminal was interactive.

cleanupPseudoTerminal
```
public void cleanupPseudoTerminal(int id)
```
Called when a stream is closed to ensure that any terminal resources associated with that id are cleaned up. While this will be called for any output stream close, actual cleanup processing is only triggered when the given stream id was used at least once via the switchOutput(int, boolean) interface.
This should never be called when the redirection is currently active.

Specified by:

cleanupPseudoTerminal in interface ClientExports

Parameters:

id - The stream needing cleanup.

nextTabItem
```
public int nextTabItem(int frameId,
                       int widgetId)
```
Obtains the next widget in the frame's tab order from the client.

Specified by:

nextTabItem in interface ClientExports

Parameters:

frameId - frame where the widget is placed

widgetId - target widget which is being queried

Returns:

id of the widget or-1.

resetBufferSizeManager
```
public void resetBufferSizeManager()
```
Reset buffer size manager to its initial state.

Specified by:

resetBufferSizeManager in interface ClientExports

removeFrame
```
public static void removeFrame(Frame frame)
```
Remove frame from the registry(). Here removed all local references to the frame and frame is registered in the list of frames which should be removed at server side. Actual removal of frames at server side is performed when processing of server request is done and result of processing is returned to server.

Parameters:

frame - The frame to remove.

removeWidget
```
public static void removeWidget(Widget<?> widget)
```
Remove the specified widget from the registry, and from its parent frame.

Parameters:

widget - The widget to be removed.

wrapFrame
```
public static void wrapFrame(Frame frame)
```
Remove frame from the registry. Here removed all local references to the frame and frame is registered in the list of frames which should be removed at server side. Actual removal of frames at server side is performed when processing of server request is done and result of processing is returned to server.

Parameters:

frame - The frame to remove.

isRefreshQuirkActive
```
public static boolean isRefreshQuirkActive()
```
Get status of refresh quirk (odd refreshing behavior in some terminal types).

Returns:

true if refreshing quirk is active.

setupTooltip
```
public static void setupTooltip(WidgetWithConfig<? extends WidgetConfig> widget)
```
Setup tooltip for widget

Parameters:

widget - the widget the tooltip is configured for

resetChanged
```
private void resetChanged(int frameId)
```
Resets the changed state for all widgets of the frame into unchanged.

Parameters:

frameId - ID of frame this request came for

switchWorker
```
private int switchWorker(int newId)
```
Redirect terminal output to the stream represented by newId (or to the interactive terminal if newId is -1) and return the id of the current output destination. This may be another redirected terminal or it may be -1 if the interactive terminal is in use.
If redirection has not yet been established for the given stream, it will be setup.

Parameters:

newId - The stream for which a redirected terminal is to be setup for redirection or -1 to remove redirections and activate the interactive terminal.

Returns:

The id of the previous terminal or -1 if the previous terminal was interactive.

forceInteractive
```
public int forceInteractive()
```
Switch the terminal into interactive mode if it is redirected. This is just a convenience function.

Returns:

The terminal id of the redirected terminal or -1 if the terminal is already interactive. Used with restoreRedirection(int) to restore the terminal when done with interactive mode.

restoreRedirection
```
public void restoreRedirection(int tempTerm)
```
Restore the terminal to redirected mode from interactive mode, if the terminal to switch to is not -1. This is just a convenience function.

Parameters:

tempTerm - The terminal id of the redirected terminal that was previously removed using forceInteractive() or -1 if there was no previous redirected terminal.

doInteractive
```
public void doInteractive(java.lang.Runnable run)
```
This is a helper method for wrapping the supplied code fragment between the calls to forceInteractive() and restoreRedirection(int).
This method can handle the case when the supplied code (indirectly) executes legacy code changing the redirection. This is done by restoring redirection with the value saved in savedTermRedir.

Parameters:

run - Code to run interactively.

doInteractive
```
public <T> T doInteractive(java.util.function.Supplier<T> run)
```
This is a helper method for wrapping the supplied code fragment between the calls to forceInteractive() and restoreRedirection(int).
This method can handle the case when the supplied code (indirectly) executes legacy code changing the redirection. This is done by restoring redirection with the value saved in savedTermRedir.

Type Parameters:

T - the object type

Parameters:

run - Code to run interactively.

Returns:

the call result

processEventsWorker
```
private boolean processEventsWorker()
```
Processes all outstanding events without blocking for user input.
This method corresponds to the Progress statement
PROCESS EVENTS

Returns:

true if at least one frame related PaintEvent has been processed

processMnemonic
```
public boolean processMnemonic(KeyInput evt,
                               int key,
                               Widget<?> src)
```
Worker to process the given key as a mnemonic (ALT or simple key), for normal widgets (not menus).

Parameters:

evt - The event to process.

key - The associated key.

src - The event's source.

Returns:

true if the key was processed as a mnemonic by a widget.

processProgressEvent
```
public void processProgressEvent(Event event)
```
Handle event as Progress event.
Precedence order for honoring Progress key events:
1. In the accelerator list for the current window.
2. In the event list for an active user interface trigger.
3. An active pop-up menu key.
4. An active menu mnemonic key.
5. An active field-level (button) mnemonic key (Windows only).
6. A special Progress internal key (built-in key function, like GO).
7. A key associated with a key function in the PROTERMCAP file (UNIX only).
8. A standard input key (A, B and so on).
If any exit condition is found, the isGoPending flag is set.
Parameters:

event - Event to handle.

processBrowseEvent
```
private static boolean processBrowseEvent(KeyInput evt)
```
Give a browse widget, if it is in this event's component hierarchy, a chance to process and consume the END-ERROR event. This is only necessary if the browse widget is in edit mode and is currently set to handle an internal, row-level undo. Otherwise the event is not handled or consumed.

Parameters:

evt - Current event.

Returns:

true if the event was an END-ERROR event and was handled and consumed by a browse widget in the event's component hierarchy; else false.

getRowDisplayTriggerId
```
public int getRowDisplayTriggerId(int browseId)
```
Get ID of the ROW-DISPLAY trigger for the target browse.

Parameters:

browseId - Browse widget ID.

Returns:

ID of the ROW-DISPLAY trigger for the target browse or -1 if there is no such trigger.

getEditableClientScreenBuffers
```
public ScreenBuffer[] getEditableClientScreenBuffers(Widget widget)
```
Prepares the array of the screen buffers to pass to the server when calling the server export methods to be able the screen buffer synchronization.

Parameters:

widget - Widget which initiates the call.

Returns:

The array of the screen buffers to sync.

invokeRowDisplayTrigger
```
public ThinClient.TriggerResult invokeRowDisplayTrigger(int widgetId)
```
Check the rowDisplayEvents map for a ROW-DISPLAY trigger associated with this widget. If this is a browse widget and such a trigger is found, it will be executed.

Parameters:

widgetId - event source.

Returns:

Execution and event consume flags for an executed trigger.

invokeTriggers
```
public ThinClient.TriggerResult invokeTriggers(Widget widget,
                                               int evtCode,
                                               boolean isKey)
```
Check active EventList instance for triggers defined for this event and widget pair and activate the first one found.
Triggers are searched either for a specific widget, or, if no widget is enabled (in focus), for the session window. The latter is also performed if the specific widget happens to be the session window.
The specific search is done in the following order:
- trigger for the specified widget and event;
- trigger for the specified event anywhere within the frame;
- trigger for the specified event anywhere globally.
The search for the session window is a one step process.
The first found trigger, if any, gets activated.
Parameters:

widget - event source.

evtCode - event code.

isKey - This flags marks reals keys typed by user.

Returns:

Execution and event consume flags for an executed trigger.

invokeTriggers
```
public ThinClient.TriggerResult invokeTriggers(Widget widget,
                                               Widget other,
                                               int evtCode,
                                               boolean isKey)
```
Check active EventList instance for triggers defined for this event and widget pair and activate the first one found.
Triggers are searched either for a specific widget, or, if no widget is enabled (in focus), for the session window. The latter is also performed if the specific widget happens to be the session window.
The specific search is done in the following order:
- trigger for the specified widget and event;
- trigger for the specified event anywhere within the frame;
- trigger for the specified event anywhere globally.
The search for the session window is a one step process.
The first found trigger, if any, gets activated.
Parameters:

widget - event source.

other - a companion widget (for ENTER/LEAVE events).

evtCode - event code.

isKey - This flags marks real keys typed by user.

Returns:

Execution and event consume flags for an executed trigger.

invokeTriggers
```
private ThinClient.TriggerResult invokeTriggers(Widget widget,
                                                long resourceId,
                                                int evtCode,
                                                boolean isKey)
```
Check active EventList instance for triggers defined for this event and widget pair and activate the first one found.
Triggers are searched either for a specific widget, or, if no widget is enabled (in focus), for the session window. The latter is also performed if the specific widget happens to be the session window.
The specific search is done in the following order:
- trigger for the specified widget and event;
- trigger for the specified event anywhere within the frame;
- trigger for the specified event anywhere globally.
The search for the session window is a one step process.
The first found trigger, if any, gets activated.
Parameters:

widget - event source.

resourceId - When not set to -1, is a valid resource ID (for non-widget events).

evtCode - event code.

isKey - This flags marks reals keys typed by user.

Returns:

Execution and event consume flags for an executed trigger.

invokeTriggers
```
private ThinClient.TriggerResult invokeTriggers(Widget widget,
                                                Widget other,
                                                long resourceId,
                                                int evtCode,
                                                boolean isKey)
```
Check active EventList instance for triggers defined for this event and widget pair and activate the first one found.
Triggers are searched either for a specific widget, or, if no widget is enabled (in focus), for the session window. The latter is also performed if the specific widget happens to be the session window.
The specific search is done in the following order:
- trigger for the specified widget and event;
- trigger for the specified event anywhere within the frame;
- trigger for the specified event anywhere globally.
The search for the session window is a one step process.
The first found trigger, if any, gets activated.
Parameters:

widget - event source.

other - a companion widget (for ENTER/LEAVE events).

resourceId - When not set to -1, is a valid resource ID (for non-widget events).

evtCode - event code.

isKey - This flags marks reals keys typed by user.

Returns:

Execution and event consume flags for an executed trigger.

invokeTriggers
```
public ThinClient.TriggerResult invokeTriggers(Widget widget,
                                               Widget other,
                                               long resourceId,
                                               int evtCode,
                                               boolean isKey,
                                               boolean specificWidget,
                                               Widget rowSourceWidget)
```
Check active EventList instance for triggers defined for this event and widget pair and activate the first one found.
Triggers are searched either for a specific widget, or, if no widget is enabled (in focus), for the session window. The latter is also performed if the specific widget happens to be the session window.
The specific search is done in the following order:
- trigger for the specified widget and event;
- trigger for the specified event anywhere within the frame;
- trigger for the specified event anywhere globally.
The search for the session window is a one step process.
The first found trigger, if any, gets activated.
Parameters:

widget - event source.

other - a companion widget (for ENTER/LEAVE events).

resourceId - When not set to -1, is a valid resource ID (for non-widget events).

evtCode - event code.

isKey - This flags marks reals keys typed by user.

specificWidget - This flags checks only for the triggers on specific widget.

rowSourceWidget - The WIDGET-ENTER/WIDGET-LEAVE widget for a ROW-ENTRY/ROW-LEAVE event.

Returns:

Execution and event consume flags for an executed trigger.

setFocusSilent
```
private void setFocusSilent(Widget inFocus)
```
Silently restore and redraw the focus. No LEAVE/ENTRY events should be generated here.

Parameters:

inFocus - Widget to focus.

checkHelpText
```
private static void checkHelpText(Widget focus)
```
Check help text and restore it if necessary.

Parameters:

focus - Widget in focus.

checkBreak
```
private boolean checkBreak(Widget widget,
                           int evtCode,
                           boolean isKey)
```
Check active EventList instance for exit conditions for this event and widget pair.
Events are searched either for a specific widget, or, if no widget is enabled (in focus), for the session window. The latter is also performed if the specific widget happens to be the session window.
The specific search is done in the following order:
- exact match for the specified widget and event;
- match for the specified event anywhere within the frame;
- match for the specified event anywhere globally.
The search for the session window is a one step process.
Parameters:

widget - event source.

evtCode - event code.

isKey - Mark real keys typed by user.

Returns:

true if a matching event exists

checkBreak
```
private boolean checkBreak(long resourceId,
                           int evtCode)
```
Check active EventList instance for exit conditions for this event and resource pair.
The specific search is done by exact match for the specified resource and event

Parameters:

resourceId - id of the resource generating the event.

evtCode - event code.

Returns:

true if a matching event exists

processCondition
```
private void processCondition(int action,
                              int opcode,
                              boolean inPause)
                       throws StopConditionException,
                              EndConditionException,
                              ErrorConditionException
```
Handles processing of ENDKEY, END-ERROR and STOP conditions in a uniform manner. The given action is checked for a match with the list of conditions, if a match exists then the associated condition is raised (an exception is thrown).

Parameters:

action - The key action to check against the list of possible conditions.

opcode - Specifies which operation is in process (for example, a EventList.WAIT_FOR).

inPause - Specifies whether the method is called from a pausing function.

Throws:

StopConditionException - If action is Keyboard.KA_STOP.

EndConditionException - If action is Keyboard.KA_ENDKEY or on Keyboard.KA_END_ERROR on the first interaction in the current block or when opcode is EventList.WAIT_FOR.

ErrorConditionException - If action is Keyboard.KA_END_ERROR and one of the above conditions does not hold.

validateWidget
```
private boolean validateWidget(Widget widget)
```
Validates the widget's current value and displays the validation error message if any.

Parameters:

widget - widget to validate

Returns:

The result of the validation.

validateWidget
```
public boolean validateWidget(Widget widget,
                              boolean inBrowseEditor)
```
Validates the widget's current value and displays the validation error message if any.

Parameters:

widget - widget to validate

inBrowseEditor - true if the validated widget is an in-browse editor.

Returns:

The result of the validation.

enableFillInAutoZap
```
private static void enableFillInAutoZap(Widget widget)
```
Activate AUTO-ZAP mode for widget if it a FillIn instance in ChUI mode.

Parameters:

widget - Widget to process.

validateWidget
```
private static int validateWidget(int id,
                                  int[] ids)
```
Validates the widget's ID by comparing with array of allowed IDs.

Parameters:

id - widget id to validate

ids - array of allowed ids or null

Returns:

equals the input id or -1

highlight
```
public void highlight(Widget widget,
                      boolean state)
```
Changes the highlighted state of the widget and repaints it.

Parameters:

widget - The widget to modify.

state - The new state of the widget's highlight.

saveInsState
```
public int saveInsState()
```
Save insert mode before using a prompting function or a trigger.

Returns:

Insert mode that was saved.

restoreInsState
```
public void restoreInsState(int savedInsState,
                            boolean force)
```
Restore insert mode after a prompting function or a trigger.

Parameters:

savedInsState - Insert mode that was before the call of the corresponding prompting function or trigger.

force - Whether we have to repaint the indicator even if the new mode is the same as the old one.

setNeedPause
```
public void setNeedPause(boolean needPause,
                         TopLevelWindow wnd)
```
Set new value for the needPause flag.

Parameters:

needPause - New value for the flag.

wnd - Not null target window. If null - an NPE will be thrown.

isNeedPause
```
boolean isNeedPause()
```
Get current value of the needPause flag.

Returns:

Returns the needPause.

isInEnable
```
public boolean isInEnable()
```
Returns true if enable(..) function is being run.

Returns:

See above.

getSavedInsState
```
public int getSavedInsState()
```
Returns saved insert indicator state that should be applied to the next focused fill-in, or -1 if there is no state to apply.

Returns:

See above.

clearSavedInsState
```
public void clearSavedInsState()
```
Clears saved insert mode.

getCurrentRedirection
```
public Stream getCurrentRedirection()
```
Get the stream to which the terminal is redirected or null if no redirection is currently in effect.

Returns:

The current redirection or null if not redirected.

view
```
public void view(int frameId)
```
Display frame content in redirected mode by page element.

Parameters:

frameId - Frame ID.

handleNextPrevFrameEvents
```
public void handleNextPrevFrameEvents(Frame frame,
                                      boolean nextFrame)
```
Execute the NEXT-FRAME or PREV-FRAME event, depending on flag. Frame search starts from the specified frame.

Parameters:

frame - The frame from which search will start.

nextFrame - true if this is the NEXT-FRAME event, false if this is the PREV-FRAME event.

nextFrame
```
private static Frame nextFrame(Frame frame)
```
Get next frame.

Parameters:

frame - Current frame.

Returns:

Next frame or null if no such frame available.

prevFrame
```
private static Frame prevFrame(Frame frame)
```
Get previous frame.

Parameters:

frame - Current frame.

Returns:

Previous frame or null if no such frame available.

transferFocusToFrame

private void transferFocusToFrame(Frame frame,
                                  Frame newFrame)

Transfer focus between frames.

Parameters:: frame - Frame which holds focus now.; newFrame - Frame which should receive focus.

switchStreams
```
private boolean switchStreams(Frame frame)
```
Checks whether the frame needs switching streams and does switching. The last used stream for the frame is compared with the current stream in effect. If these are different streams, the switching will occur.

Parameters:

frame - the target frame for the operation

Returns:

true if the stream switch has happened and it was not the very first switch for the frame

switchFrames
```
private boolean switchFrames(int streamId,
                             int frameId)
```
Checks whether the stream and its redirected terminal need to switch to another frame and does switching if so.
Switching the stream between frames causes flushing the buffers of the redirected terminal to the stream. Otherwise the redirected terminal receives continuous output from the same frame.

Parameters:

streamId - ID of the output stream the current output is redirected to.

frameId - ID of the frame about to produce some output

Returns:

true when the frame switch has happened or false for the case of continuous output.

flushStream
```
public void flushStream(Stream out)
```
Push any pending output from the redirected terminal to the stream and then flush the stream.

Parameters:

out - The stream being flushed.

isTriggerResultNoApply
```
public java.lang.Boolean isTriggerResultNoApply()
```
Check if outermost trigger processing result was 'NO-APPLY'.

Returns:

outermost trigger processing result.

isTriggerHadApplyEntry
```
public java.lang.Boolean isTriggerHadApplyEntry()
```
Check if the last trigger executed APPLY "entry" call for an explicit target.

Returns:

true if the last trigger executed APPLY "entry" call for an explicit target.

endOutput
```
private void endOutput(int sid)
```
Force the given stream to output any buffered PUT or EXPORT content, so long as the stream is not the terminal.

Parameters:

sid - The stream on which to call endOutput.

flushRedirected
```
private int flushRedirected(Stream stream,
                            boolean bypass)
```
Flushes all buffered output to the redirected output stream (does nothing if output is not redirected). This call may cause recursive calls to view(int, com.goldencode.p2j.ui.ScreenBuffer[], int[], boolean, int, int[]) in order to write page headers or footers.

Parameters:

stream - The stream to flush or null to flush the current redirection destination.

bypass - true if page header processing must be bypassed when flushing the output. This should be true if the caller has pushed pending redirected terminal output into the stream since this will have already processed the page headers and this will avoid duplicates.

Returns:

The next line number AFTER all buffered lines are output but BEFORE any final page break processing has occurred. This can be compared with the next line number as queried after this method returns to determine if a page break was output or not (among other uses). If there was no output or if the terminal is not redirected, then -1 will be returned.

setChangedValue

private void setChangedValue(Frame frame,
                             Widget comp,
                             BaseDataType value,
                             java.lang.String fmt)

Changes the value of a widget in a frame.

Parameters:: frame - Frame where the widget belongs; comp - Component for the widget; value - new value; fmt - format if formatted value

getActiveFrameInt
```
public Frame getActiveFrameInt()
```
Get reference to active frame.

Returns:

Reference to active frame or null if there is no such frame.

stopNoAvailableWidgets
```
private void stopNoAvailableWidgets()
```
Stop the WAIT-FOR loop, as it determined there are no available widgets, in the following cases:
- when the terminal is reset, inside an editing block
- when the WAIT-FOR loop is NOT waiting for global events and there are no enabled components registered for exit events
Throws:

StopConditionException - always thrown - stop all other processing

putScreenDirect

private void putScreenDirect(java.lang.String text,
                             double row,
                             double column,
                             Color color)

Outputs text as the result of PUT SCREEN operation.

Parameters:: text - Text to out.; row - Row.; column - Column.; color - Color.

positionCursor
```
private void positionCursor()
```
Positions the real cursor before pausing according to the focused widget "directions".

repaintAffectedWidgets
```
private static void repaintAffectedWidgets(Frame[] frames,
                                           java.lang.Iterable<Widget> widgets)
```
Repaint widgets affected during ENABLE/DISABLE processing.

Parameters:

frames - List of frames above current frame.

widgets - Array of affected widgets.

setPendingFocus
```
public void setPendingFocus(Widget pendingFocus)
```
Set pendingFocus widget.

Parameters:

pendingFocus - New value for pendingFocus.

getPendingFocus
```
public Widget getPendingFocus()
```
Get pendingFocus widget.

Returns:

current pendingFocus widget.

setTriggerNesting
```
public void setTriggerNesting(int triggerNesting)
```
Set value of triggerNesting counter.

Parameters:

triggerNesting - New value of triggerNesting counter.

preprocessView
```
private void preprocessView(ScreenBuffer[] frameBuf,
                            Widget widget,
                            int[] widgetIds)
```
If this is a nested frame, when performing a VIEW FRAME, in some cases all the ancestors need to be displayed, if not already visible.

Parameters:

frameBuf - The frames buffer array for editable frames.

widget - The widget targeted by VIEW (may be a FRAME or another widget).

widgetIds - The widget list.

preprocessFrameDef

private void preprocessFrameDef(Frame frame,
                                WidgetConfig cc)

Process frame definition.

Parameters:: frame - Frame to process.; cc - New widget config.

getServer
```
public ServerExports getServer()
```
Get the ServerExports instance.

Returns:

See above.

nextFocus
```
public static boolean nextFocus(Widget widget)
```
Performs conditional focus change procedure to the next widget. The focus change can be cancelled by a trigger.

Parameters:

widget - Component that is the reference widget, which is currently retaining focus.

Returns:

true if focus change is successful.

previousFocus
```
public static boolean previousFocus(Widget widget)
```
Performs conditional focus change procedure to the previous widget. The focus change can be cancelled by a trigger.

Parameters:

widget - Component that is the reference widget, which is currently retaining focus.

Returns:

true if focus change is successful.

nextTabStop
```
public static boolean nextTabStop(Widget widget)
```
Performs conditional focus change procedure to the next tab stop widget. The focus change can be cancelled by a trigger.

Parameters:

widget - Component that is the reference widget, which is currently retaining focus.

Returns:

true if focus change is successful.

previousTabStop
```
public static boolean previousTabStop(Widget widget)
```
Performs conditional focus change procedure to the previous tab stop widget. The focus change can be cancelled by a trigger.

Parameters:

widget - Component that is the reference widget, which is currently retaining focus.

Returns:

true if focus change is successful.

registry
```
public WidgetRegistry registry()
```
Resolve the widget registry being in use.

Returns:

the widget registry

targetWindowWorker
```
private Window<?> targetWindowWorker(int windowId)
```
Resolves client-side window with specified id.

Parameters:

windowId - Id of target window or -1 for current or default window

Returns:

target Window with specified Id or "default" window. See WindowManager.resolveWindow(com.goldencode.p2j.ui.client.widget.Widget<?>) for details.

getInputDefaultText
```
public java.lang.String getInputDefaultText()
```
Resolve the input default text (if not already resolved) and return it.

Returns:

See above.

getDisplayWidth
```
public int getDisplayWidth(int windowId)
```
Returns display width in native units. For multiple-display environments the display is selected based on the supplied window id.

Specified by:

getDisplayWidth in interface ClientExports

Parameters:

windowId - A valid window id.

Returns:

The width in native units.

getDisplayHeight
```
public int getDisplayHeight(int windowId)
```
Returns display height in native. For multiple-display environments the display is selected based on the supplied window id.

Specified by:

getDisplayHeight in interface ClientExports

Parameters:

windowId - A valid window id.

Returns:

The height in native.

getDisplayWorkAreaX
```
public int getDisplayWorkAreaX(int windowId)
```
Returns the X coordinate of the application-usable display area. For example, a task bar is not counted as the usable area. For multiple-display environments the display is selected based on the supplied window id.

Specified by:

getDisplayWorkAreaX in interface ClientExports

Parameters:

windowId - A valid window id.

Returns:

The value in native units.

getDisplayWorkAreaY
```
public int getDisplayWorkAreaY(int windowId)
```
Returns the Y coordinate of the application-usable display area. For example, a task bar is not counted as the usable area. For multiple-display environments the display is selected based on the supplied window id.

Specified by:

getDisplayWorkAreaY in interface ClientExports

Parameters:

windowId - A valid window id.

Returns:

The value in native units.

getDisplayWorkAreaWidth
```
public int getDisplayWorkAreaWidth(int windowId)
```
Returns the width of the application-usable display area. For example, a task bar is not counted as the usable area. For multiple-display environments the display is selected based on the supplied window id.

Specified by:

getDisplayWorkAreaWidth in interface ClientExports

Parameters:

windowId - A valid window id.

Returns:

The value in native units.

getDisplayWorkAreaHeight
```
public int getDisplayWorkAreaHeight(int windowId)
```
Returns the height of the application-usable display area. For example, a task bar is not counted as the usable area. For multiple-display environments the display is selected based on the supplied window id.

Specified by:

getDisplayWorkAreaHeight in interface ClientExports

Parameters:

windowId - A valid window id.

Returns:

The value in native units.

getDisplayWorkArea
```
public NativeRectangle getDisplayWorkArea(int windowId)
```
Returns an application-usable display area. For example, a task bar is not counted as the usable area. For multiple-display environments the display is selected based on the supplied window id.

Parameters:

windowId - A valid window id.

Returns:

The area in native units.

setWindowIcon
```
public boolean setWindowIcon(int windowId,
                             byte[] icon)
```
Sets the new application icon for given window on the client side.

Specified by:

setWindowIcon in interface ClientExports

Parameters:

windowId - A valid window id.

icon - A new icon image array date.

Returns:

TRUE if operation successful FALSE otherwise.

loadWindowIcon
```
public boolean loadWindowIcon(int windowId,
                              boolean small,
                              java.lang.String name)
```
Loads the new application icon for given window from the client side filesystem.

Specified by:

loadWindowIcon in interface ClientExports

Parameters:

windowId - A valid window id.

small - Flag indicating usage of the small icon case(16x16 in size).

name - The fully qualified file name for the icon to be loaded.

Returns:

TRUE if operation successful FALSE otherwise.

setWindowDefaultIcon
```
public boolean setWindowDefaultIcon(TopLevelWindow.IconDataType type,
                                    java.lang.Object data)
```
Sets the default window icon for all new windows on the client side.

Specified by:

setWindowDefaultIcon in interface ClientExports

Parameters:

type - Data type for second parameter.

data - Data to create new icon on client side. Can be the byte array, filename string or nothing for predefined icon from p2j.jar client side file.

Returns:

TRUE if operation successful FALSE otherwise.

setImage
```
public boolean setImage(int wId,
                        int type,
                        byte[] image)
```
Sets the new image for given button or image widgets on the client side.

Specified by:

setImage in interface ClientExports

Parameters:

wId - A valid wdget id.

type - Image type to load. Up, Down or Insensitive for buttons, -1 for image.

image - A new image array data.

Returns:

TRUE if operation successful FALSE otherwise.

loadImage
```
public boolean loadImage(int wId,
                         int type,
                         java.lang.String name)
```
Loads the new image for given button or image widgets from the client side filesystem.

Specified by:

loadImage in interface ClientExports

Parameters:

wId - A valid wdget id.

type - Image type to load. Up, Down or Insensitive for buttons, -1 for image.

name - The fully qualified file name for the image to be loaded.

Returns:

TRUE if operation successful FALSE otherwise.

addGlobalImage
```
public int addGlobalImage(int wId,
                          java.lang.String imgFile,
                          byte[] data)
```
Loads the supplied image from the file name if data null, and registers the image with ImageHelper.addGlobalImage(int, ImageWrapper). When the image is loaded successfully the returned value is the unique id of the loaded image (see ImageWrapper.getUniqueId()).

Specified by:

addGlobalImage in interface ClientExports

Parameters:

wId - A valid widget id.

imgFile - Valid file name for the image to be loaded, must not be null.

data - Image data. May be null, in which case the client will attempt to load the image.

Returns:

unique image id, positive value, if operation successful or -1 otherwise.

removeGlobalImages
```
public void removeGlobalImages(int wId)
```
Removes all previously registered global images for a specific widget.

Specified by:

removeGlobalImages in interface ClientExports

Parameters:

wId - Widget id of the widget for which images should be cleared.

removeGlobalImages
```
public void removeGlobalImages(int wId,
                               java.util.Collection<java.lang.Integer> uniqueIds)
```
Removes selected global images for a specific widget.

Specified by:

removeGlobalImages in interface ClientExports

Parameters:

wId - Widget ID of the widget for which images should be cleared.

uniqueIds - image IDs to be cleared

getImageFileName
```
public java.lang.String getImageFileName(java.lang.String imageName)
```
Find the name of the image file in PROPATH appending possible exensions, if needed.

Parameters:

imageName - the name of the image

Returns:

the name of the image file or null of not found

editorSaveFile
```
public boolean editorSaveFile(int wId,
                              java.lang.String name)
```
Save the content in the widgets in the client side filesystem.

Specified by:

editorSaveFile in interface ClientExports

Parameters:

wId - A valid editor widget id.

name - The file name for the file to be written.

Returns:

TRUE if operation successful FALSE otherwise.

editorReadFile
```
public boolean editorReadFile(int wId,
                              java.lang.String name)
```
Loads the file from the client side filesystem.

Specified by:

editorReadFile in interface ClientExports

Parameters:

wId - A valid editor widget id.

name - The file name for the file to be loaded.

Returns:

TRUE if operation successful FALSE otherwise.

getLocalFileName
```
public static java.lang.String getLocalFileName(java.lang.String name)
```
Locates a file name to load from local file system. The image file must be somewhere in the current PROPATH directories. The method will also adjust the case-sensitivity so that in case of porting from a Windows installation to Linux files can be open even if name does not match the exact cases required by Linux filesystem.

Parameters:

name - The name of the file to be located in the client file system.

Returns:

The file name from PROPATH directories with adjusted casings or null if the specified file cannot be found.

is3D
```
public boolean is3D()
```
Get the THREE-D value for this client session.

Specified by:

is3D in interface ClientExports

Returns:

See above.

set3D
```
public void set3D(boolean value)
```
Set the THREE-D value for this client session.

Specified by:

set3D in interface ClientExports

Parameters:

value - The value to set.

setDisableRedraw
```
public void setDisableRedraw(boolean value)
```
Set the global SESSION:DISABLE-REDRAW attribute. This attribute is a FWD extension, not real 4GL!

Specified by:

setDisableRedraw in interface ClientExports

Parameters:

value - New flag state.

isDisableRedraw
```
public boolean isDisableRedraw()
```
Getter for SESSION:DISABLE-REDRAW attribute.

Returns:

see above

isKeep3DFillinBorder
```
public boolean isKeep3DFillinBorder()
```
Get the Keep3DFillinBorder environment value for this client session.

Returns:

See above.

isKeepMessages
```
public boolean isKeepMessages()
```
Determines if the current stream is redirected and has KEEP-MESSAGES option

Returns:

true if keepMessages is active

setKeep3DFillinBorder
```
public void setKeep3DFillinBorder(boolean value)
```
Set the Keep3DFillinBorder environment value for this client session.

Parameters:

value - The value to set.

moveToTop
```
public java.lang.Boolean moveToTop(int id)
```
Move the widget to the top in z-order

Specified by:

moveToTop in interface ClientExports

Parameters:

id - widget id

Returns:

Boolean.TRUE if operation was successful null if no widget with given id is found

moveToBottom
```
public java.lang.Boolean moveToBottom(int id)
```
Move the widget to the bottom in z-order

Specified by:

moveToBottom in interface ClientExports

Parameters:

id - widget id

Returns:

Boolean.TRUE if operation was successful null if no widget with given id is found

setMousePointer
```
public boolean setMousePointer(java.lang.Integer id,
                               byte[] data,
                               java.lang.String ptrName)
```
Set the custom mouse pointer for a widget or reset to the default one

Specified by:

setMousePointer in interface ClientExports

Parameters:

id - The widget id. If null the cursor will be assigned application-wide.

data - the cursor data

ptrName - the pointer name

Returns:

true if operation was successful

setMousePointer
```
public boolean setMousePointer(java.lang.Integer id,
                               java.io.InputStream data,
                               java.lang.String ptrName)
```
Set the custom mouse pointer for a widget or reset to the default one

Parameters:

id - The widget id. If null the cursor will be assigned application-wide.

data - the data in the form of an input stream

ptrName - the pointer name

Returns:

true if operation was successful

setMousePointer
```
public java.lang.Boolean setMousePointer(java.lang.Integer id,
                                         MousePointer ptr)
```
Set the the pre-defined custom mouse pointer for a widget or reset to the default one

Specified by:

setMousePointer in interface ClientExports

Parameters:

id - The widget id. If null the cursor will be assigned application-wide.

ptr - the new custom mouse pointer or null

Returns:

true if operation was successful

loadMousePointer
```
public boolean loadMousePointer(int id,
                                java.lang.String fileName)
```
Load custom mouse pointer from a file

Specified by:

loadMousePointer in interface ClientExports

Parameters:

id - widget id

fileName - The fully qualified file name for the mouse pointer, fileName can be given by URL string.

Returns:

true if successful.

setImmediateDisplay
```
public void setImmediateDisplay(boolean on)
```
Set the state of SESSION:IMMEDIATE-DISPLAY attribute.

Specified by:

setImmediateDisplay in interface ClientExports

Parameters:

on - The new state for SESSION:IMMEDIATE-DISPLAY attribute.

setMultitaskingInterval
```
public void setMultitaskingInterval(long interval)
```
Set the state of SESSION:MULTITASKING-INTERVAL attribute.

Specified by:

setMultitaskingInterval in interface ClientExports

Parameters:

interval - The new value for SESSION:MULTITASKING-INTERVAL attribute.

setDataEntryReturn
```
public void setDataEntryReturn(boolean on)
```
Set the state of SESSION:DATA-ENTRY-RETURN attribute.

Specified by:

setDataEntryReturn in interface ClientExports

Parameters:

on - The new state for SESSION:DATA-ENTRY-RETURN attribute.

isDataEntryReturn
```
public static boolean isDataEntryReturn()
```
Get the state of SESSION:DATA-ENTRY-RETURN attribute.

Returns:

the state of SESSION:DATA-ENTRY-RETURN attribute.

setMousePtr
```
protected boolean setMousePtr(java.lang.Integer id,
                              MousePtrWrapper ptrWrapper)
```
Set the custom mouse pointer for a widget

Parameters:

id - The widget id. If null the cursor will be assigned application-wide.

ptrWrapper - the mouse pointer

Returns:

true on success

setWaitState
```
public boolean setWaitState(MousePointer ptr,
                            boolean lockInput)
```
Initiate/cancel wait state

Specified by:

setWaitState in interface ClientExports

Parameters:

ptr - new mouse pointer or null for cancel

lockInput - The input lock parameter, TRUE to block user input on client side, FALSE to only change the cursor shape.

Returns:

true if operation was successful

setWaitState
```
public boolean setWaitState(byte[] data,
                            boolean lockInput)
```
Initiate/cancel wait state

Specified by:

setWaitState in interface ClientExports

Parameters:

data - new mouse pointer data

lockInput - The input lock parameter, TRUE to block user input on client side, FALSE to only change the cursor shape.

Returns:

true if operation was successful

setWaitState
```
public boolean setWaitState(java.io.InputStream data,
                            boolean lockInput)
```
Initiate/cancel wait state

Parameters:

data - new mouse pointer data

lockInput - The input lock parameter, TRUE to block user input on client side, FALSE to only change the cursor shape.

Returns:

true if operation was successful

setWaitState
```
public boolean setWaitState(java.lang.String ptrName,
                            boolean lockInput)
```
Initiate wait state with a custom cursor from file

Specified by:

setWaitState in interface ClientExports

Parameters:

ptrName - the name of the file with new mouse pointer data

lockInput - The input lock parameter, TRUE to block user input on client side, FALSE to only change the cursor shape.

Returns:

true if operation was successful

endFileDrop
```
public boolean endFileDrop()
```
Terminates file dropping operation and clean up resources.

Specified by:

endFileDrop in interface ClientExports

Returns:

TRUE in success, FALSE otherwise.

getNumDroppedFiles
```
public int getNumDroppedFiles()
```
Gets the number of the dropped files.

Specified by:

getNumDroppedFiles in interface ClientExports

Returns:

The integer number for dropped file list size.

getDroppedFile
```
public java.lang.String getDroppedFile(int index)
```
Gets the name of the dropped file from internal 1-based list list.

Specified by:

getDroppedFile in interface ClientExports

Parameters:

index - 1-based number of the file name to get.

Returns:

The name of the file with given index.

messageBlasterSetTarget
```
public void messageBlasterSetTarget(long id,
                                    int hWndTarget)
```
Dispatches a set-target message to client-side peer of a MsgBlaster.

Specified by:

messageBlasterSetTarget in interface ClientExports

Parameters:

id - The id of the MsgBlaster

hWndTarget - The hwnd of the targeted widget.

messageBlasterAddMessage
```
public void messageBlasterAddMessage(long id,
                                     int index,
                                     int message,
                                     int pass)
```
Dispatches a add-propery message to client-side peer of a MsgBlaster.

Specified by:

messageBlasterAddMessage in interface ClientExports

Parameters:

id - The id of the MsgBlaster.

index - The index of the pair.

message - The message to listen to.

pass - How the message will be handled after being captured.

messageBlasterClearMessages
```
public void messageBlasterClearMessages(long id,
                                        boolean delete)
```
Request to clear the client-side peer of a MsgBlaster.

Specified by:

messageBlasterClearMessages in interface ClientExports

Parameters:

id - The id of the MsgBlaster.

delete - If true the whole object will be deleted as the server-side component was also released. Otherwise only the list of messages are cleared.

screenToClient
```
public NativePoint screenToClient(int widgetId,
                                  NativePoint loc)
```
Converts screen (relative to display screen origin) location to client location - relative to the window workspace origin.

Specified by:

screenToClient in interface ClientExports

Parameters:

widgetId - Widget id. Top-level window of this widget will be used for the conversion.

loc - Screen location to convert.

Returns:

Client location or null if the method fails.

focusAndSelect
```
public void focusAndSelect(int widgetId)
```
Sets focus to widget and selects all current content.

Specified by:

focusAndSelect in interface ClientExports

Parameters:

widgetId - The integer ID of the widget to focus and select everything.

lookupEvent
```
public TriggerMatch lookupEvent(EventList eventList,
                                int eventId,
                                int frameId,
                                int widgetId,
                                boolean trigger,
                                boolean isKey)
```
Checks whether this event matches any event defined in the current event list (see getCurrentEventList()).
This method forwards the call to EventList.lookup(int, int, boolean, boolean, boolean, TriggerMatch) using the current event list as the target instance.

Specified by:

lookupEvent in interface ClientExports

Parameters:

eventList - Merged event list of all scopes from the server trigger registry. Must not be null.

eventId - Id of the event to look for.

frameId - Frame ID, can be -1

widgetId - widget ID, can't be -1, but can be SESSION_WINDOW_ID.

trigger - true if the search is for a trigger or false to search for an exit condition.

isKey - Marks real key pressed by user.

Returns:

The result of the match.

getDialogExtraHeight
```
public int getDialogExtraHeight()
```
Get the theme specific extra pixels difference value for fialog frame height.

Specified by:

getDialogExtraHeight in interface ClientExports

Returns:

Extra pixels value to add to dialog height.

getDialogExtraWidth
```
public int getDialogExtraWidth()
```
Get the theme specific extra pixels difference value for fialog frame width.

Specified by:

getDialogExtraWidth in interface ClientExports

Returns:

Extra pixels value to add to dialog width.

propagate

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

Push information about the loaded mouse pointer for widget

Parameters:: windowId - to level window id; wid - widgetId; ptr - mouse pointer

getKeyboardLayoutsSettings
```
public KeyboardLayoutsSettings getKeyboardLayoutsSettings()
```
Gets the supported keyboard layouts defined by the directory.

Returns:

The keyboard layouts settings

getHTMLBrowserLoadTimeout
```
public java.lang.Integer getHTMLBrowserLoadTimeout()
```
Retrieve the number of milliseconds to wait when loading a HTML web page. This works as a timeout.

Returns:

An integer representing the HTML browser load timeout.

getSupportedHelperApplications
```
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getSupportedHelperApplications()
```
Gets the supported helper applications with their mime types.

Returns:

The the supported helper applications

getDisplayBounds
```
public NativeRectangle getDisplayBounds(int windowId)
```
Returns display size. For multiple-display environments the display is selected based on the supplied window id.

Parameters:

windowId - A valid window id.

Returns:

The dimensions in native units.

requestEndCurrentWaitForEventLoop
```
public void requestEndCurrentWaitForEventLoop()
```
Requests the current wait-for event loop to be interrupted. The request is not processed right away but it is enqueued in the OS event queue and dispatched later.

loadMousePointer
```
private MousePtrWrapper loadMousePointer(java.lang.String fileName)
```
Load custom mouse pointer from a file

Parameters:

fileName - The fully qualified file name for the mouse pointer, fileName can be given by URL string.

Returns:

mouse pointer.

createMousePointer

private MousePtrWrapper createMousePointer(java.io.InputStream data,
                                           java.lang.String ptrName)

Create mouse pointer from the binary data

Parameters:: data - cusrsor data; ptrName - pointer name
Returns:: pointer wrapper or null

createPtrWrapper
```
public MousePtrWrapper createPtrWrapper(MousePointer ptr)
```
Create wrapper for the pre-defined cursor

Parameters:

ptr - source mouse pointer

Returns:

wrapper for a pointer and a current GUI driver

setWaitState
```
private boolean setWaitState(MousePtrWrapper ptr)
```
Initiate/cancel wait state

Parameters:

ptr - new mouse pointer or null for cancel

Returns:

true if operation was successful

setWaitState
```
private boolean setWaitState(MousePtrWrapper ptr,
                             boolean lockInput)
```
Initiate/cancel wait state

Parameters:

ptr - new mouse pointer or null for cancel

lockInput - The input lock parameter, TRUE to block user input on client side, FALSE to only change the cursor shape.

Returns:

true if operation was successful

extractFrames
```
private static java.util.List<Frame> extractFrames(java.util.Deque<ThinClient.WaitForOp> waitForOps)
```
Extract the frames from the stack of wait-for event loops.

Parameters:

waitForOps - The current operations.

Returns:

The list of frames.

openMimeResource
```
public void openMimeResource(java.lang.String mimeType,
                             java.lang.String path,
                             ScreenDriver.UriPathAnchor uriPathAnchor)
```
Opens the specified resource given by its relative path in respect to the service host.

Specified by:

openMimeResource in interface ClientExports

Parameters:

mimeType - The resource mime type.

path - The resource path in respect to the service host.

uriPathAnchor - Instructs how to resolve the given resource path.

openMimeResource
```
public void openMimeResource(boolean deleteContent,
                             java.lang.String mimeType,
                             java.lang.String uriString,
                             boolean embedded)
```
Opens the specified resource in a browser's window.

Specified by:

openMimeResource in interface ClientExports

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.

openMimeResource
```
public void openMimeResource(boolean deleteContent,
                             java.lang.String filePath,
                             boolean embedded,
                             java.util.List<java.lang.String> preferredMimeTypes)
```
Opens the specified file resource in a browser's window.

Specified by:

openMimeResource in interface ClientExports

Parameters:

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

filePath - The file system path on the legacy system or the host system. If the legacy system path is given, then it is resolved to the host system path.

embedded - The document is embedded in the template document.

preferredMimeTypes - The preferred resource mime types.

getClipboardValue
```
public character getClipboardValue()
```
Exposes the client's system clipboard to the server.

Specified by:

getClipboardValue in interface ClientExports

Returns:

The clipboard content.

setClipboardValue
```
public void setClipboardValue(java.lang.String value)
```
Copies a string value to the client's system clipboard.

Specified by:

setClipboardValue in interface ClientExports

Parameters:

value - The string to be stored in the client's system clipboard.

getThemeSystemPalette
```
public java.util.Map<java.lang.Integer,ColorRgb> getThemeSystemPalette()
```
Obtain the default system palette for current theme from client.

Specified by:

getThemeSystemPalette in interface ClientExports

Returns:

the default system palette for current theme from client.

setCursorPos
```
public boolean setCursorPos(NativePoint point)
```
Substitute for Win32 SetCursorPos. Sets a temporal mouse position in the GuiDriver. Ads a event to queue to reset the temporal position set previously.

Specified by:

setCursorPos in interface ClientExports

Parameters:

point - Point coordinate for the new temporal mouse position.

Returns:

true if the temporal mouse position is set completed.

getMousePosition
```
public NativePoint getMousePosition()
```
Returns current mouse cursor position relative to the screen origin.
The method is only supported in GUI mode.

Specified by:

getMousePosition in interface ClientExports

Returns:

mouse cursor position, never null

getMousePosition
```
public int[] getMousePosition(int widgetId)
```
Returns current mouse cursor position relative to the provided widget id. If the widget id equals to -1 or it is invalid, the method returns position relative to the screen origin.
The method is only supported in GUI mode.

Specified by:

getMousePosition in interface ClientExports

Parameters:

widgetId - A widget id.

Returns:

mouse cursor position, x coordinate at index 0, y coordinate at index 1, never null

resetWaitState
```
public void resetWaitState()
```
Resets wait-state previously enabled by setWaitState(MousePtrWrapper). If wait-state isn't already enabled this method is a no-op. This method performs server callback in order to update the server wait-state state.

activateWindow
```
private void activateWindow()
```
The method implements window activation when a blocking operation is executed.
The user-input blocking operations CHOOSE, PAUSE, PROMPT-FOR and WAIT-FOR affect window activation. See below for the details.
CHOOSE resolves the WINDOW of the frame it uses to display the "choosing" widgets and makes it active, it will also make it visible if invisible. PAUSE and PROMPT-FOR will resolve the window defined in the IN WINDOW option or the CURRENT-WINDOW and make it active. It will also make the resolved window visible if invisible. WAIT-FOR will resolve the window defined in the IN WINDOW option or the CURRENT-WINDOW and make it active. It will not make the resolved window visible.
The other user-blocking operations READKEY, MESSAGE SET and MESSAGE UPDATE do not affect window activation or window visibility.

messageBlasterEvent
```
public void messageBlasterEvent(long id,
                                int msgVal,
                                int wParam,
                                int lParam,
                                int lplRetVal)
```
Sends a MessageBlaster notification back to server.

Parameters:

id - The id of the MessageBlaster instance.

msgVal - The message id. Should be one already added to msgList.

wParam - Message parameter 1.

lParam - Message parameter 2.

lplRetVal - Message parameter / return value.

readHtmlBrowserWhitelist
```
public java.util.Map<java.lang.String,java.net.URI> readHtmlBrowserWhitelist()
```
Look-up for the whitelisted HTML resource-base entries. This helps when considering the explicit base tags inside HTML rendered on Web.

Returns:

The temp directory in use.

setWidgetAttribute
```
public 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.

Specified by:

setWidgetAttribute in interface ClientExports

Parameters:

widgetId - The widget ID.

attr - The attribute name.

val - The attribute's value.

Returns:

true if setting this attribute completed.

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

Specified by:

invokeWidgetCommand in interface ClientExports

Parameters:

widgetId - Widget id.

command - The command to invoke.

args - Optional event arguments.

Returns:

the command return value.

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

Specified by:

invokeWidgetCommand in interface ClientExports

Parameters:

widgetId - Widget id.

command - The command to invoke.

args - Optional event arguments.

Returns:

the command return value.

setPendingCursorReset
```
public void setPendingCursorReset()
```
Set the flag indicating the cursor to be reset on server side.

getClientStorage
```
public ClientStorage getClientStorage()
```
Gets the client storage. The storage for registry methods, i.e. GET-KEY-VALUE, can be different.

Returns:

The client storage

getObject
```
public <T> T getObject(java.lang.String key,
                       java.lang.Class<T> clazz)
```
Retrieves the object value of the given key from the client storage.

Specified by:

getObject in interface ObjectStorage

Parameters:

key - The given key

clazz - The java class that represents this object

Returns:

The object value of the given key

setObject
```
public void setObject(java.lang.String key,
                      java.lang.Object value)
```
Sets the object value of the given key for the client storage.

Specified by:

setObject in interface ObjectStorage

Parameters:

key - The given key

value - The object value

getNumber
```
public java.lang.Number getNumber(java.lang.String key)
```
Retrieves the number value of the given key from the client storage.

Specified by:

getNumber in interface KeyValueStorage

Parameters:

key - The given key

Returns:

The number value of the given key

setNumber
```
public void setNumber(java.lang.String key,
                      java.lang.Number value)
```
Saves the number value of this key in the client storage.

Specified by:

setNumber in interface KeyValueStorage

Parameters:

key - The given key

value - The value of the given key

getBoolean
```
public java.lang.Boolean getBoolean(java.lang.String key)
```
Retrieves the boolean value of the given key from the client storage.

Specified by:

getBoolean in interface KeyValueStorage

Parameters:

key - The given key

Returns:

The boolean value of the given key

setBoolean
```
public void setBoolean(java.lang.String key,
                       java.lang.Boolean value)
```
Saves the boolean value of this key in the client storage.

Specified by:

setBoolean in interface KeyValueStorage

Parameters:

key - The given key

value - The value of the given key

getString
```
public java.lang.String getString(java.lang.String key)
```
Retrieves the string value of the given key from the client storage.

Specified by:

getString in interface KeyValueStorage

Parameters:

key - The given key

Returns:

The string value of the given key

setString
```
public void setString(java.lang.String key,
                      java.lang.String value)
```
Saves the string value of this key in the client storage.

Specified by:

setString in interface KeyValueStorage

Parameters:

key - The given key

value - The value of the given key

delete
```
public void delete(java.lang.String key)
```
Deletes the given key and its value from the client storage.

Specified by:

delete in interface KeyValueStorage

Parameters:

key - The given key

runModal
```
public void runModal(AbstractWidget<GuiOutputManager> dlg)
```
Run a widget as a modal dialog window.

Parameters:

dlg - the widget to run as dialog.

refreshWidget
```
public void refreshWidget(int widgetId)
```
Refresh widget. Some widgets like PROGRESS-BAR export a method like :Refresh( ).

Specified by:

refreshWidget in interface ClientExports

Parameters:

widgetId - Widget ID.

addDroppedFileName
```
public void addDroppedFileName(java.lang.String fileName)
```
Adds next file name to the list of the dropped files.

Specified by:

addDroppedFileName in interface ClientExports

Parameters:

fileName - The filename to add.

addDroppedFileName
```
public void addDroppedFileName(java.lang.String fileName,
                               int index)
```
Adds file name to the list of the dropped files at specified index .

Specified by:

addDroppedFileName in interface ClientExports

Parameters:

fileName - The filename to add.

index - Index position.

clearDroppedFiles
```
public void clearDroppedFiles()
```
Remove all dropped file names.

Specified by:

clearDroppedFiles in interface ClientExports

removeDroppedFile
```
public void removeDroppedFile(int index)
```
Remove dropped file name at specified position.

Specified by:

removeDroppedFile in interface ClientExports

Parameters:

index - Index position.

oleDrag
```
public void oleDrag(int widgetId)
```
Start an OLE drag/drop event with the given control as the source.

Specified by:

oleDrag in interface ClientExports

Parameters:

widgetId - Widget ID.

oleClear
```
public void oleClear()
```
Remove all objects from clipboard.

Specified by:

oleClear in interface ClientExports

oleGetData
```
public byte[] oleGetData(int format,
                         int id)
```
Get object of specified format.

Specified by:

oleGetData in interface ClientExports

Parameters:

format - clipboard format.

id - Source widget ID.

Returns:

data for specified format.

oleSetData
```
public void oleSetData(byte[] value,
                       int format)
```
Put object of specified format.

Specified by:

oleSetData in interface ClientExports

Parameters:

value - Object value

format - clipboard format.

oleGetFormat
```
public boolean oleGetFormat(int format)
```
Check if specified format is supported.

Specified by:

oleGetFormat in interface ClientExports

Parameters:

format - clipboard format.

Returns:

true if supported, false if not.

hitTest
```
public java.lang.Integer hitTest(int widgetId,
                                 int x,
                                 int y)
```
Get the TreeView node under mouse cursor. If no node under cursor return null value.

Specified by:

hitTest in interface ClientExports

Parameters:

widgetId - Widget ID.

x - Mouse cursor x position.

y - Mouse cursor y position.

Returns:

TreeView node id under cursor or null if miss.

findWidgetByCoordinates
```
public java.lang.Integer findWidgetByCoordinates(int containerId,
                                                 int x,
                                                 int y)
```
Find a widget in the given container under the mouse pointer given by coordinates relative to the owner window.

Specified by:

findWidgetByCoordinates in interface ClientExports

Parameters:

containerId - The widget ID of the given container

x - The relative x-coordinate of the given mouse pointer

y - The relative y-coordinate of the given mouse pointer

Returns:

The target widget id under the given mouse pointer or null

findTreeNodeByRelativeCoordinates
```
public java.lang.Integer findTreeNodeByRelativeCoordinates(int treeId,
                                                           int x,
                                                           int y)
```
Find a node id in the given tree under the mouse pointer given by coordinates relative to the container itself.

Specified by:

findTreeNodeByRelativeCoordinates in interface ClientExports

Parameters:

treeId - The widget ID of the given container

x - The relative x-coordinate of the given mouse pointer

y - The relative y-coordinate of the given mouse pointer

Returns:

The node id under the given mouse pointer or null

activatePopUpMenu
```
@Deprecated
public void activatePopUpMenu(int menuId,
                                          int64 x,
                                          int64 y)
```
Deprecated.

Calling the client side to activate already created menu.

Specified by:

activatePopUpMenu in interface ClientExports

Parameters:

menuId - The integer ID of the menu to activate.

x - The new X position of the menu, unknown value to keep the default value.

y - The new Y position of the menu, unknown value to keep the default value.

openPopup
```
public void openPopup(int widgetId)
```
Opens the popup menu set on the specified widget. The menu is positioned at the current mouse cursor location. When no menu is set on the widget or when the widget can't be resolved the method is a no-op.

Specified by:

openPopup in interface ClientExports

Parameters:

widgetId - Id of the target widget.

flushEnqueuedWidgetAttrs
```
public void flushEnqueuedWidgetAttrs()
```
This method is called when widget attribute changes must be sent to the client. These changes are serialized during StateSynchronizer.getChanges() and StateSynchronizer.applyChanges(Externalizable) so a remote call is needed to invoke these.

Specified by:

flushEnqueuedWidgetAttrs in interface ClientExports

emitComEvent
```
public BaseDataType[] emitComEvent(int widgetId,
                                   java.lang.String eventName,
                                   BaseDataType... args)
```
Emits the supplied COM event.

Parameters:

widgetId - Id of the widget that will become the source of the emitted event.

eventName - Event name.

args - Event arguments.

Returns:

A container including the array of all output arguments produced by the event, if any.

setLastKeyData
```
public void setLastKeyData(int lastKey,
                           int lastKeyState,
                           int functionKey,
                           Event lastEvent)
```
Set LAST-EVENT data.

Parameters:

lastKey - Corresponds LAST-EVENT:CODE.

lastKeyState - Extended key state for LAST-EVENT:CODE.

functionKey - Corresponds LAST-EVENT:FUNCTION.

lastEvent - Contains additional attributes for the LAST-EVENT, like LAST-EVENT:LABEL.

cleanUp
```
private void cleanUp(EventList save,
                     int oldGoPending,
                     boolean saveLeaveSent,
                     boolean curvis)
```
Convenience function used inside waitForWorker(EventList, int, int, ScreenBuffer[], boolean, boolean, boolean, BlockingOperation, int)

Parameters:

save - the event list to save

oldGoPending - saved doPending value isGoPending value

saveLeaveSent - saved leaveSent value

curvis - saved cursor status

applyWidgetAttributes
```
private void applyWidgetAttributes(int[] widgetAttrIds,
                                   java.lang.Object[] widgetAttrValues)
```
Applies widget attributes in the widget tree.

Parameters:

widgetAttrIds - Flat array of widget attribute ids.

widgetAttrValues - Flat array of widget attribute values.

invokeWidgetCommandImpl

private java.lang.Object invokeWidgetCommandImpl(int widgetId,
                                                 GuiDriver gd,
                                                 java.util.function.Supplier<java.lang.Object> driverInvocation)

Invokes a command on a widget implemented at the driver level.

Parameters:: widgetId - Widget id.; gd - The GUI driver.; driverInvocation - The driver invocation.
Returns:: the command return value.

sortTreeList
```
public void sortTreeList(int widgetId,
                         int index,
                         boolean resetSorting)
```
Sorts a tree list widget by a column.

Parameters:

widgetId - the ID of the tree list

index - the index of the column being sorted

resetSorting - if true, then reset column sorting

Class ThinClient

Nested Class Summary

Field Summary

Fields inherited from interface com.goldencode.p2j.ui.client.Watcher

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.ui.ClientExports

Field Detail

LOG

PBH_DEFAULT_TEXT

PBE_DEFAULT_TEXT

END_ERR_MSG

local

modToken

sessToken

logToken

logManagerService

useLocalStorage

storageId

dynamicLayoutEnabled

forceDialogsInCenter

bypassDefaultWindowShowInPauseNoMessage

COM_EVENT_TIME_COUNTER

viewRefresh

viewDisplay

keyboardState

viewInProgress

nextViewRefresh

nextViewDisplay

tk

batchMode

dedicatedThread

server

validationError

needPause

timePBH

honorPBH

textPBH

inputDefaultText

currentEventList

rowDisplayEvents

inRowDisplayTrigger

isGoPending

immediateException

triggerNestingByWaitFor

triggerResultNoApply

triggerHadApplyEntry

triggerHadWaitFor

lastAppliedCode

lastKey

lastKeyState

fileSystem

sd

pd

mailer

redirections

deferredCleanup

currentStream

savedTermRedir

interactions

pageElements

streamMap

triggerNesting

conditionalUpDown

conditionalFrameId

cursorVisible

oldcursor

suppressWarnings

inEditingBlock

implicitApplyNoTrigger

hadReset

removedFrames

wrappedFrames

helpActive

lastViewed

modalActive

afterChoose

focusToRestoreFillIn

leaveSent