public class LogicalTerminal extends java.lang.Object implements Initializable, Scopeable, StateSynchronizer
Modifier and Type | Class and Description |
---|---|
private class |
LogicalTerminal.ScopeProcessor
Callback mechanism to manage frame hiding, interactions counter and other
state.
|
Modifier and Type | Field and Description |
---|---|
private WindowWidget |
activeWindow
ACTIVE-WINDOW widget.
|
static int |
ALERT_ERROR
Alert type ERROR
|
static int |
ALERT_INFO
Alert type INFO
|
static int |
ALERT_MESSAGE
Alert type MESSAGE
|
static int |
ALERT_QUESTION
Alert type QUESTION
|
static int |
ALERT_WARNING
Alert type WARNING
|
static int |
APPL_ALERT
Alert for MESSAGE with APPL-ALERT-BOXES == true
|
private java.util.Stack<java.lang.Integer> |
blocks
Tracks data that is associated with specific blocks.
|
static int |
BTN_OK
Button set OK
|
static int |
BTN_OK_CANCEL
Button set OK_CANCEL
|
static int |
BTN_RETRY_CANCEL
Button set RETRY_CANCEL
|
static int |
BTN_YES_NO
Button set YES_NO
|
static int |
BTN_YES_NO_CANCEL
Button set YES_NO_CANCEL
|
private ClientExports |
client
Client interface
|
private boolean |
consumeEvent
Flag for the executing trigger's
NO-APPLY status. |
private static CoordinatesConversion |
coordinates
The coordinates conversion implementation.
|
private WindowWidget |
currentWindow
CURRENT-WINDOW widget
|
private int |
defaultTimeout
Default timeout for the waitFor() methods.
|
private WindowWidget |
defaultWindow
DEFAULT-WINDOW widget.
|
private PartitionedArray<ScreenDefinition> |
definitions
Tracks screen definitions that have yet to be pushed to the client.
|
private PartitionedArray<MenuDescription> |
descriptions
Tracks menu descriptions that have yet to be pushed to the client.
|
private java.util.Map<GenericFrame,java.util.Set<java.lang.Integer>> |
editableFrameRegistry
Registry of the currently editable frames to get the screen buffers to operate.
|
private EventInfo |
eventInfo
Data which are meaningful only within the trigger
Introduced for the WIDGET-LEAVE/WIDGET-ENTRY support
|
private java.lang.Integer |
eventX
The value of the LAST-EVENT:X attribute.
|
private java.lang.Integer |
eventY
The value of the LAST-EVENT:Y attribute.
|
private static ScreenDefinition[] |
EXEMPLAR
Cache this exemplar to make array processing faster.
|
private java.lang.String |
frameDb
Current value of FRAME-DB built-in function.
|
private java.lang.String |
frameField
Current value of FRAME-FIELD attribute.
|
private int |
frameFieldId
Current ID of FRAME-FIELD
|
private java.lang.String |
frameFile
Current value of FRAME-FILE built-in function.
|
private integer |
frameIndex
Current value of FRAME-INDEX attribute.
|
private java.lang.String |
frameName
Current value of FRAME-NAME built-in function.
|
private GenericFrame |
frameRef
Current active frame
|
private java.util.Map<java.lang.Integer,GenericFrame> |
frameRegistry
Registry for all frames for this user's session.
|
private java.lang.String |
frameValue
Current value of FRAME-VALUE attribute.
|
private int |
functionKey
The code of last event function (LAST-EVENT:FUNCTION)
|
private boolean |
helpActive
Flag identifying that HELP is active.
|
private int |
hlpFrameFieldId
The frame field targeted by FRAME-VALUE before HELP is invoked.
|
private GenericFrame |
hlpFrameRef
The frame targeted by FRAME-VALUE before HELP is invoked.
|
private static ContextLocal<LogicalTerminal> |
instance
Context-local instance of LogicalTerminal
|
private java.lang.Boolean |
isDataEntryReturn
The state of SESSION:DATA-ENTRY-RETURN attribute
|
private boolean |
isImmediateDisplay
The state of SESSION:IMMEDIATE-DISPLAY attribute
|
private boolean |
isUsingAlertBoxes
The state of SESSION:APPL-ALERT-BOXES attribute
|
private java.util.ArrayList<ScreenDefinition> |
level2definitions
Temporary storage for screen definitions.
|
private java.util.ArrayList<MenuDescription> |
level2descriptions
Temporary storage for screen definitions.
|
private static java.util.logging.Logger |
LOG
logger
|
private java.util.Map<java.lang.Integer,MenuContainerWidget<?>> |
menuRegistry
Registry for all menus for this user's session.
|
private ColorSpec |
messageColor
Current Logical Terminal MESSAGES color
|
private long |
millis
Timestamp for last readKey operation.
|
private ColorSpec |
msgBoxColor
Current logical color used for VIEW-AS ALERT-BOX
|
private int |
nesting
Current external procedures call nesting.
|
private java.util.Set<java.lang.Integer> |
pendingMenus
Temporary collect widget IDs for menus whose description were not forcefully pushed to
client.
|
private java.util.Set<java.lang.Integer> |
persistentTriggers
A set containing the IDs of all ON ..
|
private java.lang.Object |
registryLock
Mutex semaphore to serialize data access.
|
private boolean |
relogin
Flag that reflects relogin procedure.
|
private static ContextLocal<RowDisplayDrawListener> |
rowDisplayDrawListener
Listener is a browse in the process of getting new rows.
|
private ScopedDictionary |
scope
scoped dictionary for all possible targets
|
private LogicalTerminal.ScopeProcessor |
scopeTrack
Scope chain.
|
private integer |
screenLines
Cached number of screen lines.
|
private ServerState |
state
State to synchronize on the next trip to the client.
|
private java.lang.String |
terminalType
Cached terminal type value
|
private java.util.LinkedList<java.lang.Integer> |
triggerEvent
active triggers events stack (synced to widgets stack)
|
private java.util.Map<java.lang.Integer,TriggerDefinition> |
triggerRegistry
Registry for all triggers for this user's session.
|
private java.util.LinkedList<WrappedResource> |
triggerResource
active triggers widgets/procedures stack
|
private java.lang.String |
waitState
WAIT STATE name
|
private java.util.Map<java.lang.Integer,java.lang.Object> |
widgetRegistry
All widgets map for given class instance except default window including dynamic and static.
|
private java.util.Map<java.lang.Integer,WindowWidget> |
windowRegistry
Window widgets dynamic created
|
private java.lang.String |
windowSystem
Cached value of
SESSION:WINDOW-SYSTEM . |
Modifier | Constructor and Description |
---|---|
private |
LogicalTerminal()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
static logical |
_isDataEntryReturn()
Get the state of SESSION:DATA-ENTRY-RETURN attribute.
|
static logical |
_isUsingAlertBoxes()
Get the state of SESSION:APPL-ALERT-BOXES attribute.
|
static handle |
_self()
Returns the instance of a widget associated with the currently executing
trigger.
|
static void |
activateBatchMode(boolean on)
Changes the activation flag for batch mode driver if loaded.
|
static handle |
activeWindow()
Returns a handle for the instance of the only window, which is always active.
|
(package private) static void |
addDynamicFrame(GenericFrame dynFrame,
int idFrame)
Adds new dynamic frame to the application context.
|
void |
addEditableFrameForWidgets(GenericFrame widFrame,
int[] widIdToCheck)
Possibly add the frame with given widget ID to the editable frames list if it is not already
there.
|
(package private) void |
addMarkEntry(MarkEntry me)
Add instance of
MarkEntry to list. |
static void |
apply(character event)
Applies the named event to the widget in focus in the active frame.
|
static void |
apply(double eventCode)
Applies the encoded event to the widget in focus in the active frame.
|
static void |
apply(GenericFrame frame,
int eventCode)
Applies the encoded event to the widget currently in focus in the given
frame.
|
static void |
apply(GenericFrame frame,
int widgetId,
int eventCode)
Applies the encoded event to the specified widget.
|
static void |
apply(GenericFrame frame,
int widgetId,
java.lang.String event)
Applies the named event to the specified widget.
|
static void |
apply(GenericFrame frame,
java.lang.String event)
Applies the named event to the widget currently in focus in the given
frame.
|
static void |
apply(handle h,
character event)
Applies the named event to the specified resource.
|
static void |
apply(handle h,
double eventCode)
Applies the named event to the specified resource.
|
static void |
apply(handle h,
integer eventCode)
Applies the named event to the specified resource.
|
static void |
apply(handle h,
java.lang.String event)
Applies the named event to the specified resource.
|
static void |
apply(int64 eventCode)
Applies the encoded event to the widget in focus in the active frame.
|
static void |
apply(long eventCode)
Applies the encoded event to the widget in focus in the active frame.
|
static void |
apply(java.lang.String event)
Applies the named event to the widget in focus in the active frame.
|
static void |
apply(WrappedResource res,
character event)
Applies the named event to the specified resource.
|
static void |
apply(WrappedResource res,
double eventCode)
Applies the named event to the specified resource.
|
static void |
apply(WrappedResource res,
integer eventCode)
Applies the named event to the specified resource.
|
static void |
apply(WrappedResource res,
java.lang.String event)
Applies the named event to the specified resource.
|
void |
applyChanges(java.io.Serializable 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.
|
private static void |
applyToHandleError(boolean invalidHandle)
Show errors related to APPLY ...
|
static void |
bell()
Rings a bell on the terminal.
|
static int |
calcBrowseDown(BrowseWidget bw,
int rowHeightPixels)
Calculate DOWN value for the browse basing on the given row height.
|
static boolean |
canUnloadEnvironment(java.lang.String envName)
Check if are registered windows assigned to specified environment.
|
private boolean |
checkDuplicate(MarkEntry me)
Check if last entry in list is identical to specified one.
|
static void |
choose(GenericFrame frame,
Choose c,
ColorSpec cs)
Performs CHOOSE processing.
|
static void |
cleanupDynamicFrames()
Cleanup the dynamic frames, as the client is resetting.
|
private boolean |
cleanupList(int frameId)
Check for presence of
MarkEntry.OPEN_SCOPE entry in the list and
if found then cleanup list of MarkEntry instances from
operations related to specified frame at current level of scope nesting. |
static void |
cleanupPending()
Cleanup the pending shared resources, as external program instantiation failed.
|
static void |
cleanupPseudoTerminal(int id)
Called when a stream is closed to ensure that any terminal resources
associated with that id are cleaned up.
|
static void |
cleanupTriggers(java.lang.Long resourceId,
int widgetId)
Cleanup all triggers registered for the specified resource or widget ID, assuming these are
being deleted.
|
static void |
cleanupTriggers(java.lang.Object referent)
Cleanup all triggers created in the specified external program.
|
static void |
clear()
Clears the data and colors for all fill-in fields of the default frame.
|
static void |
clear(boolean noPause)
Clears the data and colors for all fill-in fields of the default frame.
|
static void |
clear(GenericFrame frame,
boolean noPause)
Clears the data and colors for all fill-in fields of the frame.
|
static void |
clearAll()
Clears all occurrences for the active down frame and resets the current
display position to the top of the frame.
|
static void |
clearAll(boolean noPause)
Clears all occurrences for the active down frame and resets the current
display position to the top of the frame.
|
static void |
clearAll(GenericFrame frame,
boolean noPause)
Clears all occurrences for the down frame and resets the current display
position to the top of the frame.
|
private void |
clearEventInfo()
Clear the value of the eventInfo
to be used after trigger activation
(typically in the
finally block) |
static void |
clientLog(java.lang.String message,
java.lang.String[] stack)
Write message and stack trace to the client log
|
private static Color |
color(ColorSpec cs,
ColorSpec defaultColorspec)
Get color from given color spec or from default messages color.
|
static int |
connectEvent(long resourceId,
long clientSocketId)
Called by the P2J client side, it will inform the server that a server event was generated.
|
static void |
consumeEvent()
Suppresses the default behavior for the current UI event so that it has
the effect of RETURN NO-APPLY.
|
static boolean |
continueEditing(boolean hadNext)
Checks to see whether a pending GO event is about to end the editing block.
|
static CoordinatesConversion |
coordinates()
Returns the coordinate conversion implementation based on LogicalTerminal
of the current session context.
|
static long |
createExternal()
Create an
external resource to be used by a remote, non P2J, side. |
static long |
createSocket(int id)
Create a socket and associated with the given ID.
|
static WindowWidget |
createWindow()
Return new instance of Window widget.
|
static handle |
currentWindow()
Returns a handle for the instance of the only window, which is always current.
|
static handle |
currentWindow(handle phandle)
Get CURRENT-WINDOW attribute for given procedure handle.
|
static 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
|
static GenericFrame |
defaultFrame()
Get current default frame.
|
static handle |
defaultWindow()
Returns a handle for the instance of the default window.
|
static void |
deferPush(MenuDescription menuDescr)
Queue a menu description for a future push down to the client using
processDeferredPush() . |
static void |
deferPush(ScreenDefinition frameDef)
Queue a screen definition for a future push down to the client using
processDeferredPush() . |
static java.lang.Boolean |
deleteEditorLine(int id)
Delete the line of text in which the targeted editor's cursor currently resides.
|
static void |
deleteHandle(long handleId)
Delete the resource associated with the specified handle.
|
(package private) static void |
deregisterFrame(int frameId)
Deletes the frame from the internal registry.
|
private void |
deregisterFrameContentInt(GenericFrame frameToProcess)
Internal worker for content cleanup.
|
private void |
deregisterFrameInt(int frameId)
Internal worker for
deregisterFrame(int) . |
(package private) static void |
deregisterMenu(int menuId)
Deletes the menu from the internal registry.
|
private void |
deregisterMenuContentInt(MenuContainerWidget<?> menu)
Removes static menu widgets from widget rigstry
|
private void |
deregisterMenuInt(int menuId)
Internal worker for
deregisterMenu(int) . |
static 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.
|
static void |
deregisterPageElement(int frameId,
boolean header,
int streamId)
Deregister (remove) the frame as a header or footer from the given
stream.
|
static void |
deregisterTrigger(EventList events)
Deregisters a non-persistent trigger within the current scope for
specified events and widgets.
|
static void |
deregisterTrigger(int triggerId)
Deregisters a non-persistent trigger entirely by its ID.
|
static void |
deregisterTrigger(int triggerId,
boolean force)
Deregisters a trigger entirely by its ID, depending on its state and
on the
force flag. |
(package private) static void |
deregisterWidget(int widgetId)
Deregister a widget which ID from widget registry map.
|
(package private) static void |
deregisterWindow(WindowWidget window)
Deregister a window widget which was dynamically created, as it is now deleted.
|
static void |
deselectFocusedRow(BrowseWidget bw)
Implements the DESELECT-FOCUSED-ROW() BROWSE widget
method.
|
static void |
deselectRows(BrowseWidget bw)
Implements the DESELECT-ROWS() BROWSE widget method.
|
static boolean |
deselectSelectedRow(BrowseWidget bw,
int rowIndex)
Implements the DESELECT-SELECTED-ROW() widget method.
|
static void |
destroyFrame(GenericFrame frame)
Notifies the logical terminal that a frame is going out of scope.
|
static void |
destroyMenu(MenuContainerWidget<?> menu)
Notifies the logical terminal that a menu is going out of scope.
|
static void |
destroyWidgets(int[] widgetIds)
Mark the specified widgets to be destroyed, from the client-side.
|
static void |
disable(GenericFrame frame,
int[] widgetId)
Disables input for all specified field-level widgets of the frame.
|
static void |
disable(GenericFrame frame,
int[] widgetId,
handle hWin)
Disables input for all specified field-level widgets of the frame.
|
static void |
displayAndDown(GenericFrame frame,
int[] widgetIds,
int streamId,
boolean register,
boolean pageTop)
Support for the DISPLAY followed by DOWN combination.
|
static void |
displayError(java.lang.String errmsg)
Displays the error message via current client side error writer.
|
static void |
displayErrorRedirected(java.lang.String errmsg)
Displays the error message via current client side error writer.
|
static void |
down(GenericFrame frame,
int lines,
boolean cond)
Positions the cursor on a new line in a down frame.
|
static void |
down(GenericFrame frame,
int lines,
boolean cond,
int sid)
Positions the cursor on a new line in a down frame.
|
static void |
down(GenericFrame frame,
int lines,
int streamId,
boolean cond,
boolean endOut)
Positions the cursor on a new line in a down frame.
|
static boolean |
editorReadFile(int wId,
java.lang.String fileName)
Read file into widgets on the client side.
|
static boolean |
editorSaveFile(int wId,
java.lang.String fileName)
Write data from widget into the file the client side.
|
static void |
enable(GenericFrame frame,
int[] widgetId)
Enables input for all specified field-level widgets of the frame.
|
static void |
enable(GenericFrame frame,
int[] widgetId,
handle hWin)
Enables input for all specified field-level widgets of the frame.
|
private static int |
encodeEvent(java.lang.String event)
Converts a named event into a numeric event code.
|
static void |
executePendingRefresh(BrowseWidget bw,
boolean queryReopened,
boolean repositionBeforeReopen,
int repositionedRow)
Execute pending refresh when REFRESHABLE is turned on.
|
private static java.util.List<java.lang.Integer> |
extractWidgetIDs(java.util.Collection<GenericWidget<?>> widgets)
Calculates widgets IDs by input collection of widgets.
|
(package private) static java.util.List<WindowWidget> |
findDirectChildren(WindowWidget parent)
Find the direct children of the specified parent window.
|
static handle |
focus()
Returns the instance of a field level widget which has focus.
|
static void |
forceDeregisterPageElement(int frameId,
boolean header)
Deregister (remove) the frame as a header or footer from all streams
in which it is registered.
|
static int |
frameIdFromWidgetId(int widgetId)
Retrieve the ID of the frame containing the widget with a given ID.
|
static java.util.Collection<MenuWidget> |
getAllMenus()
Returns all registered menus.
|
static int |
getBrowsePageRowCount(BrowseWidget bw)
Get number of rows in the browse viewport set either by DOWN or SIZE options.
|
java.io.Serializable |
getChanges()
Called by the protocol driver to obtain the latest state that should
be sent to the other side of the connection.
|
static ClientExports |
getClient()
Get the
ClientExports for this session. |
static character |
getClientType()
Get the value of CLIENT-TYPE attribute, one of the following values:
Standard ABL client: 4GLCLIENT
WebClient: WEBCLIENT
AppServer agent: APPSERVER
WebSpeed agent: WEBSPEED
Other special-purpose clients: Unknown value (?)
|
static int |
getColor(java.lang.String envName,
int index)
Get RGB value for specified index from color table associate to a Window.
|
static GenericFrame |
getCurrentFrame()
Return the topmost or active frame.
|
static int |
getCurrentRow(int browseId)
Get current row in the query.
|
int |
getDefaultTimeout()
Get default timeout used by this session for processing WAIT-FOR
requests when no explicit timeout is specified.
|
static character |
getDisplayType()
Gets the display type (GUI or TTY).
|
private ScreenBuffer[] |
getEditableServerScreenBuffers(GenericFrame frDefault)
Prepares the array of the screen buffers to pass to the client when calling the client
export methods or returning from server export to be able the screen buffer synchronization.
|
static WidgetConfig[] |
getEditorsConfigs(int browseId)
Get configurations of editors (fill-ins, toggle-boxes or combo-boxes) used for in-browse
editing.
|
static EventInfo |
getEventInfo()
Get the value of the event info
|
static java.lang.Integer |
getEventX()
Implementation of the LAST-EVENT system handle's X attribute.
|
static java.lang.Integer |
getEventY()
Implementation of the LAST-EVENT system handle's Y attribute.
|
static int |
getFirstTabItem(FieldGroup fieldGroup)
Gets the first widget in the tab order of specified field-group.
|
private WindowWidget |
getFirstVisibleWindow()
Finds the first visible valid window according their creation order if there exists a target
window, otherwise returns the default window.
|
static int |
getFocusedRow(BrowseWidget bw)
Implements the FOCUSED-ROW attribute getter.
|
static decimal |
getFrameCol(GenericFrame frame)
Returns the column position of the upper-left corner of the frame
within its window (in coordinates that are relative to the containing
window).
|
static character |
getFrameDb()
Returns the backing database that was used to define the widget where the cursor is or was
most recently.
|
static integer |
getFrameDown(GenericFrame frame)
Returns the number of iterations in a down frame.
|
static character |
getFrameField()
Returns the field name where the cursor is or was most recently.
|
static character |
getFrameFile()
Returns the backing table that was used to define the widget where the cursor is or was
most recently.
|
static integer |
getFrameIndex()
Returns the field index within the array of fields where the cursor is
or was the most recently.
|
static integer |
getFrameLine(GenericFrame frame,
int pendingUpDown)
Returns the current logical line number in a down frame.
|
static character |
getFrameName()
Returns the frame name where the cursor is or was most recently.
|
static decimal |
getFrameRow(GenericFrame frame)
Returns the row position of the upper-left corner of the frame
within its window (in coordinates that are relative to the containing
window).
|
static character |
getFrameValue()
Gets the value from a field of the active frame, which is in focus.
|
static int |
getFunctionKey()
Get code of last event function (LAST-EVENT:FUNCTION)
|
static double |
getHeight(GenericFrame frame)
Returns the height of the specified frame (the
FRAME:HEIGHT-CHARS
attribute). |
static decimal |
getHeightChars()
HEIGHT-CHARS attribute for SESSION handle.
|
static integer |
getHeightPixels()
HEIGHT-PIXELS attribute for SESSION handle.
|
private static java.io.InputStream |
getImageStreamFromApplication(java.lang.String imgName)
Gets the image stream from application jar file or nul if the resource is not found.
|
static int[] |
getLegacyTextMetrics(java.lang.String text,
java.lang.String key)
Get the legacy metrics for the given text, using the font specified by the given key.
|
static integer |
getMessageLines()
Returns the number of screen lines available for message display.
|
static int |
getNextTabItem(GenericWidget<?> widget)
Gets the widget that is the next from specified in the tab order.
|
static int |
getNumSelectedRows(BrowseWidget bw)
Getter for the NUM-SELECTED-ROWS attribute.
|
static java.util.List<java.lang.Integer> |
getParentFrames(int widgetId)
Returns all parent frames up the root frame starting from the provided widget.
|
static java.lang.String[] |
getProgressStackTrace()
Get the Progress stack trace
|
private static java.lang.String |
getRefinedPathName(java.lang.String nameDirty,
java.lang.String separator)
Gets image path string to be cleared from invalid sequences and file separator duplication.
|
static 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).
|
static int |
getRowCount(int browseId,
int startRow)
Get number of available rows starting from the given one.
|
static 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.
|
static BrowseRow[] |
getRows(int browseId,
int startRowIndex,
int count,
boolean forward,
int rowDisplayTriggerId,
ScreenBuffer[] sb,
RowDisplayStrategy displayStrategy)
Retrieves several subsequent rows from the database.
|
static integer |
getScreenLines()
Returns the number of screen lines available for frame display (does
not include the message or status lines).
|
static int |
getSelectedRowIndex(BrowseWidget bw,
int n)
Retrieve the 0-based row index of the nth selected row in the
given browse widget.
|
static int[] |
getSelectedRowIndexes(BrowseWidget bw)
Retrieve the row indexes of the selected rows in the given browse widget.
|
static int[] |
getSelection(int widgetId)
Request indexes of selected items in RadioSet, ComboBox or SelectionList
widgets.
|
static ServerState |
getServerState()
Get server state object.
|
static boolean |
getSessionTooltips()
Accesses the SESSION:TOOLTIPS attribute for this session.
|
static character |
getTerminalType()
Returns the terminal type.
|
static java.util.Map<java.lang.Integer,ColorRgb> |
getThemeSystemPalette()
Obtain the default system palette for current theme from client.
|
static TriggerDefinition |
getTriggerDefinition(int triggerId)
Get the trigger definition for the specified trigger ID.
|
static java.lang.String |
getUiTheme()
Check the directory for the UI
Theme . |
static character |
getWaitState()
The value of state-string determines the wait state and the type of wait cursor displayed.
|
static GenericWidget<?> |
getWidgetForId(int widgetId)
Retrieve the widget associated with a given ID.
|
private GenericWidget<?> |
getWidgetForIdInt(int widgetId)
Retrieve the widget or header widget associated with a given ID.
|
static handle |
getWidgetHandleById(int id)
Returns the haadle of a field level widget with given id.
|
static double |
getWidth(GenericFrame frame)
Returns the width of the specified frame (the
FRAME:WIDTH-CHARS
attribute). |
static decimal |
getWidthChars()
WIDTH-CHARS attribute for SESSION handle.
|
static integer |
getWidthPixels()
WIDTH-PIXELS attribute for SESSION handle.
|
protected static WindowWidget |
getWindowById(int id)
Get window by its id or throw an exception if not found.
|
static character |
getWindowSystem()
Get the value of the WINDOW-SYSTEM attribute, which is the version on which the client was
started.
|
static integer |
getWorkAreaHeightPixels()
WORK-AREA-HEIGHT-PIXELS attribute for SESSION handle.
|
static integer |
getWorkAreaWidthPixels()
WORK-AREA-WIDTH-PIXELS attribute for SESSION handle.
|
static integer |
getWorkAreaX()
WORK-AREA-X attribute for SESSION handle.
|
static integer |
getWorkAreaY()
WORK-AREA-Y attribute for SESSION handle.
|
private static void |
handleScreenBuffer(GenericFrame gfr,
ScreenBuffer sb,
boolean allow)
Honors any changes to the screen buffer received from the client, by
merging these into the proper frame's state.
|
private static void |
handleScreenBuffer(ScreenBuffer sb)
Honors any changes to the screen buffer received from the client, by merging these into
the proper frame's state.
|
private static void |
handleScreenBuffers(GenericFrame gfr,
ScreenBuffer[] sb,
boolean allow)
Honors any changes to the screen buffer received from the client, by merging these into the
proper frame's state.
|
private static void |
handleScreenBuffers(ScreenBuffer[] sb)
Honors any changes to the screen buffer array received from the client, by merging these
into the proper frame's state.
|
private static void |
handleScreenBuffers(ScreenBuffer[] sb,
int indexStart)
Honors any changes to the screen buffer array received from the client, by merging these
into the proper frame's state.
|
static void |
help(int lastKey,
ScreenBuffer[] buffer)
Locates and executes a preconfigured HELP application.
|
static boolean |
hide(int widgetId,
boolean noPause,
boolean hidden)
Makes the frame or widget invisible.
|
static void |
hide(int widgetId,
boolean noPause,
handle hWin)
Makes the frame or widget invisible.
|
static void |
hideAll(boolean noPause)
Hides all widgets and messages displayed in the message area.
|
static void |
hideAll(handle hWin,
boolean noPause)
Hides all widgets and messages displayed in the message area, in the given stream.
|
static void |
hideAll(Stream stream,
boolean noPause)
Hides all widgets and messages displayed in the message area, in the given stream.
|
static void |
hideMessage(boolean noPause)
Hides all messages displayed in the message area.
|
static void |
hideMessage(handle hWin,
boolean noPause)
Hides all messages displayed in the message area.
|
static void |
hideMessage(Stream stream,
handle hWin,
boolean noPause)
Hides all messages displayed in the message area.
|
private GenericFrame |
identifyFrame(int frameId)
Obtains the frame associated with the given frame ID.
|
void |
init()
Performs initialization.
|
static void |
initialize()
Register with the
TransactionManager a
factory object which creates instances of this class, so that they can be registered to
receive notifications of runtime scope start and finish events. |
static void |
initWidgetConfigurations(java.util.Map<java.lang.String,java.util.List<java.lang.String>> configs)
Synchronize the field IDs for the server-side widget configurations with the given one.
|
static void |
inputClear()
Clears the type-ahead buffer if the input source is the keyboard.
|
static 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.
|
static java.lang.Boolean |
insertEditorString(int id,
java.lang.String txt)
Inserts string at the current cursor position of the targeted editor.
|
static boolean |
insertRow(BrowseWidget bw,
boolean after)
Inserts a blank row in an updateable browse before or after the last selected row.
|
static ServerReturnValue |
invoke(InvocationRequestPayload request)
This API is used when P2J client runs in embedded mode (i.e.
|
private java.lang.Object |
invokeOnServer(ServerReturnValue srv,
java.util.function.Supplier<java.lang.Object> code)
Invoke the specified code on the server-side, maintaining the trigger registry: any new
triggers are sent to the client side to be added, and dead triggers are sent to be removed.
|
static ServerReturnValue |
invokeServerEvent(int id)
Called from the client-side, it executes the server-side event by calling
ServerEvent.invoke(int) . |
static logical |
is3D()
Get THREE-D attribute value for SESSION handle.
|
static boolean |
isBatchInBackground()
Checks if the client is running in batch background mode.
|
private static boolean |
isButton(int wId)
Checks if the given ID presents the button widgets.
|
private static boolean |
isButtonOrImage(int wId)
Checks if the given ID presents the button or image widgets.
|
static boolean |
isChui()
Check driver type: CHUI or not
|
static boolean |
isCurrentRowModified(BrowseWidget bw)
Returns
true if the current row is modified. |
static boolean |
isEmbedded()
Check the client type: embedded or not.
|
static logical |
isGoPending()
Checks whether a GO event is pending for this editing block.
|
static logical |
isImmediateDisplay()
Get the state of SESSION:IMMEDIATE-DISPLAY attribute.
|
static boolean |
isInBatchMode()
Checks if the client is running in batch mode.
|
static boolean |
isNewRow(BrowseWidget bw)
Returns
true if the current row is a new row and is not present in the
database. |
static boolean |
isPersistentTrigger(int triggerId)
Check if the given trigger is persistent (was added to the
persistentTriggers set. |
static boolean |
isRowAvailable(int browseId,
int rowIndex)
Determines if the specified browse row is "available", i.e.
|
static boolean |
isRowSelected(BrowseWidget bw,
int rowIndex)
Implements the IS-ROW-SELECTED() BROWSE widget method.
|
static boolean |
isWidgetIdInUse(int widgetId)
Checks if the given widget ID is in use by some widget or frame.
|
private static boolean |
isWindowRealized(WindowWidget winHandle)
Determines if specified window is realized (viewed) at this moment.
|
static character |
kbLabel(character function)
Translates a string of text, which is a key function, into the key label
of a keyboard key, currently assigned for this function.
|
static character |
kbLabel(java.lang.String function)
Translates a string of text, which is a key function, into the key label
of a keyboard key, currently assigned for this function.
|
static integer |
keyCode(character label)
Evaluates a key label and returns the corresponding integer key code.
|
static integer |
keyCode(java.lang.String label)
Evaluates a key label and returns the corresponding integer key code.
|
static character |
keyFunction(integer code)
Evaluates key code and returns event name assigned to specified key.
|
static character |
keyLabel(integer code)
Evaluates key code and returns a label of specified key.
|
static byte[] |
loadEnvironment(java.lang.String env)
Load the specified environment as resource.
|
static boolean |
loadMousePointer(int id,
java.lang.String ptrName)
Load custom mouse pointer from a file
|
private static LogicalTerminal |
locate()
Gets the instance of the LogicalTerminal for the current context.
|
private int |
lookupFrameIdFromWidgetId(int widgetId)
Retrieve the ID of the frame containing the widget with a given ID.
|
private void |
markInteractive()
Trip processing based on an interactive function being invoked by the
business logic.
|
private void |
markInteractive(boolean update)
Trip processing based on an interactive function being invoked by the
business logic.
|
static void |
message()
Displays the empty string in the message line of the client.
|
(package private) static void |
message(ErrorManager.ErrorEntry... res)
Utility method for convenient error reporting at client side.
|
static void |
message(handle hWin)
Displays the empty string in the message line of the client.
|
static void |
message(java.lang.Object text)
Displays a standard message.
|
static void |
message(java.lang.Object[] list)
Displays a message.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var)
Displays a message and sets or updates a character variable.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
boolean auto)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
boolean auto,
ColorSpec cs)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
boolean auto,
ColorSpec cs,
handle hWin)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
boolean auto,
handle hWin)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
boolean auto,
java.lang.String format)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] text,
boolean set,
Accessor var,
boolean auto,
java.lang.String format,
ColorSpec cs)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
boolean auto,
java.lang.String format,
ColorSpec cs,
handle hWin)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
boolean auto,
java.lang.String format,
handle hWin)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
ColorSpec cs)
Displays a message and sets or updates a character variable.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
ColorSpec cs,
handle hWin)
Displays a message and sets or updates a character variable.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
handle hWin)
Displays a message and sets or updates a character variable.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
java.lang.String format)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
java.lang.String format,
ColorSpec cs)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
java.lang.String format,
ColorSpec cs,
handle hWin)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
boolean set,
Accessor var,
java.lang.String format,
handle hWin)
Displays a message and sets or updates a character variable using a
specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object[] list,
ColorSpec cs)
Displays a message.
|
static void |
message(java.lang.Object[] list,
ColorSpec cs,
handle hWin)
Displays a message.
|
static void |
message(java.lang.Object[] list,
handle hWin)
Displays a message.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var)
Displays a standard message and sets or updates a character variable.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
boolean auto)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
boolean auto,
ColorSpec cs)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
boolean auto,
ColorSpec cs,
handle hWin)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
boolean auto,
handle hWin)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
boolean auto,
java.lang.String format)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
boolean auto,
java.lang.String format,
ColorSpec cs)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
boolean auto,
java.lang.String format,
ColorSpec cs,
handle hWin)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
boolean auto,
java.lang.String format,
handle hWin)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
ColorSpec cs)
Displays a standard message and sets or updates a character variable.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
ColorSpec cs,
handle hWin)
Displays a standard message and sets or updates a character variable.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
handle hWin)
Displays a standard message and sets or updates a character variable.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
java.lang.String format)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
java.lang.String format,
ColorSpec cs)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
java.lang.String format,
ColorSpec cs,
handle hWin)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
boolean set,
Accessor var,
java.lang.String format,
handle hWin)
Displays a standard message and sets or updates a character variable
using a specified format for the temporary FillIn widget.
|
static void |
message(java.lang.Object text,
ColorSpec cs)
Displays a standard message.
|
static void |
message(java.lang.Object text,
ColorSpec cs,
handle hWin)
Displays a standard message.
|
static void |
message(java.lang.Object text,
handle hWin)
Displays a standard message.
|
static void |
messageBox(java.lang.Object text)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object[] list)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
boolean set,
Accessor var,
int alertType,
int buttons,
character title)
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. |
static void |
messageBox(java.lang.Object[] list,
boolean set,
Accessor var,
int alertType,
int buttons,
character title,
ColorSpec cs)
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. |
static void |
messageBox(java.lang.Object[] list,
boolean set,
Accessor var,
int alertType,
int buttons,
character title,
ColorSpec cs,
handle hWin)
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. |
static void |
messageBox(java.lang.Object[] list,
boolean set,
Accessor var,
int alertType,
int buttons,
character title,
handle hWin)
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. |
static void |
messageBox(java.lang.Object[] list,
boolean set,
Accessor var,
int alertType,
int buttons,
java.lang.String title)
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. |
static void |
messageBox(java.lang.Object[] list,
boolean set,
Accessor var,
int alertType,
int buttons,
java.lang.String title,
ColorSpec cs)
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. |
static void |
messageBox(java.lang.Object[] list,
boolean set,
Accessor var,
int alertType,
int buttons,
java.lang.String title,
ColorSpec cs,
handle hWin)
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. |
static void |
messageBox(java.lang.Object[] list,
boolean set,
Accessor var,
int alertType,
int buttons,
java.lang.String title,
handle hWin)
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. |
static void |
messageBox(java.lang.Object[] list,
ColorSpec col)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
ColorSpec col,
handle hWin)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
handle hWin)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
int alertType,
int buttons,
character title)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
int alertType,
int buttons,
character title,
ColorSpec col)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
int alertType,
int buttons,
character title,
ColorSpec col,
handle hWin)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
int alertType,
int buttons,
character title,
handle hWin)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
int alertType,
int buttons,
java.lang.String title)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
int alertType,
int buttons,
java.lang.String title,
ColorSpec col)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
int alertType,
int buttons,
java.lang.String title,
ColorSpec col,
handle hWin)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object[] list,
int alertType,
int buttons,
java.lang.String title,
handle hWin)
Displays a list of text items and empty lines in an alert box.
|
static void |
messageBox(java.lang.Object text,
boolean set,
Accessor var,
int alertType,
int buttons,
character title)
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. |
static void |
messageBox(java.lang.Object text,
boolean set,
Accessor var,
int alertType,
int buttons,
character title,
ColorSpec col)
Displays a text item in an alert box and sets/updates a
logical variable as a result of the action taken. |
static void |
messageBox(java.lang.Object text,
boolean set,
Accessor var,
int alertType,
int buttons,
character title,
ColorSpec col,
handle hWin)
Displays a text item in an alert box and sets/updates a
logical variable as a result of the action taken. |
static void |
messageBox(java.lang.Object text,
boolean set,
Accessor var,
int alertType,
int buttons,
character title,
handle hWin)
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. |
static void |
messageBox(java.lang.Object text,
boolean set,
Accessor var,
int alertType,
int buttons,
java.lang.String title)
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. |
static void |
messageBox(java.lang.Object text,
boolean set,
Accessor var,
int alertType,
int buttons,
java.lang.String title,
ColorSpec col)
Displays a text item in an alert box and sets/updates a
logical variable as a result of the action taken. |
static void |
messageBox(java.lang.Object text,
boolean set,
Accessor var,
int alertType,
int buttons,
java.lang.String title,
ColorSpec col,
handle hWin)
Displays a text item in an alert box and sets/updates a
logical variable as a result of the action taken. |
static void |
messageBox(java.lang.Object text,
boolean set,
Accessor var,
int alertType,
int buttons,
java.lang.String title,
handle hWin)
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. |
static void |
messageBox(java.lang.Object text,
ColorSpec col)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
ColorSpec col,
handle hWin)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
handle hWin)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
int alertType,
int buttons,
character title)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
int alertType,
int buttons,
character title,
ColorSpec col)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
int alertType,
int buttons,
character title,
ColorSpec col,
handle hWin)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
int alertType,
int buttons,
character title,
handle hWin)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
int alertType,
int buttons,
java.lang.String title)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
int alertType,
int buttons,
java.lang.String title,
ColorSpec col)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
int alertType,
int buttons,
java.lang.String title,
ColorSpec col,
handle hWin)
Displays a text item in an alert box.
|
static void |
messageBox(java.lang.Object text,
int alertType,
int buttons,
java.lang.String title,
handle hWin)
Displays a text item in an alert box.
|
static logical |
moveAfterTabItem(FieldGroup fieldGroup,
CommonWidget widget,
CommonWidget before)
Moves specified widget before the widget "after" in the tab order.
|
static logical |
moveBeforeTabItem(FieldGroup fieldGroup,
CommonWidget widget,
CommonWidget before)
Moves specified widget before the widget "before" in the tab order.
|
static void |
moveColumnClient(BrowseWidget bw,
int srcIndex,
int destIndex)
Implements the client side of the MOVE-COLUMN() widget method.
|
static void |
moveColumnServer(int browseId,
int src,
int dest)
Implements the server-side MOVE-COLUMN() widget method.
|
static java.lang.Boolean |
moveToBottom(int id)
Move the widget to the bottom in z-order
|
static java.lang.Boolean |
moveToTop(int id)
Move the widget to the top in z-order
|
static void |
nextPrompt(GenericFrame frame,
int widgetId)
Specifies the field to be put in focus during the next input operation.
|
static GenericWidget<?> |
nextTabItem(GenericFrame frame,
GenericWidget<?> widget)
Obtains the next widget in the frame's tab order from the client.
|
static void |
notifyColumnsUpdated(BrowseWidget bw)
Notify the client that columns have been added to the browse.
|
private static void |
notifyRowDisplayDrawListener()
If an event such as pause or message box occurs in ROW-DISPLAY trigger, this functions
notifies corresponding browse so it is redrawn with the new rows.
|
static void |
pause()
Suspends processing until the user presses any key.
|
static void |
pause(character text)
Suspends processing until the user presses any key.
|
static void |
pause(double seconds)
Suspends processing for the specified number of seconds or until the
user presses any key, whichever comes first.
|
static void |
pause(double seconds,
character text)
Suspends processing for the specified number of seconds or until the
user presses any key, whichever comes first.
|
static void |
pause(double seconds,
handle hWin)
Suspends processing for the specified number of seconds or until the
user presses any key, whichever comes first.
|
static void |
pause(double seconds,
java.lang.String text)
Suspends processing for the specified number of seconds or until the
user presses any key, whichever comes first.
|
static void |
pause(double seconds,
java.lang.String text,
handle hWin)
Suspends processing for the specified number of seconds or until the user
presses any key.
|
static void |
pause(handle hWin)
Suspends processing until the user presses any key.
|
static void |
pause(NumberType seconds)
Suspends processing for the specified number of seconds or until the
user presses any key, whichever comes first.
|
static void |
pause(NumberType seconds,
character text)
Suspends processing for the specified number of seconds or until the
user presses any key, whichever comes first.
|
static void |
pause(NumberType seconds,
java.lang.String text)
Suspends processing for the specified number of seconds or until the
user presses any key, whichever comes first.
|
static void |
pause(java.lang.String text)
Suspends processing until the user presses any key.
|
static void |
pause(java.lang.String text,
handle hWin)
Suspends processing until the user presses any key.
|
void |
pauseBeforeEnd(boolean isQuit)
Perform pause before end of application.
|
static void |
pauseBeforeHide()
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(character text)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(double seconds)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(double seconds,
character text)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(double seconds,
handle hWin)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(double seconds,
java.lang.String text)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(double seconds,
java.lang.String text,
handle hWin)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(handle hWin)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(NumberType seconds)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(NumberType seconds,
character text)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(NumberType seconds,
java.lang.String text)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
static void |
pauseBeforeHide(java.lang.String text)
Specifies the pause action the user must take whenever frames are hidden
automatically.
|
private static java.lang.String |
pauseText(character text)
Prepare text for pause message.
|
private static void |
pauseWorker(int seconds,
java.lang.String text,
boolean noMessage,
handle hWin)
Suspends processing for the specified number of seconds or until the user presses any key,
whichever comes first.
|
static void |
postServerEvent(ServerEvent event)
Post the server event to the client side.
|
private EventList |
prepareEventList(GenericFrame frame,
EventList wait)
Prepare a new event list using the current triggers and the given
wait list as a basis.
|
private void |
processCondition(ConditionException ce)
Set the last key and maintain the interactions counter as needed.
|
static void |
processDeferredPush()
Push the entire list of queued screen definitions down to the client.
|
private static void |
processDownConfigs(WidgetConfig[] wcfgs)
Refresh the server-side widget configs so that their state is in sync with the current
frame row, as determined by client-side.
|
static void |
processEvents()
Processes all outstanding events without blocking for user input.
|
static void |
promptFor(GenericFrame frame,
int[] widgetIds,
EventList wait,
boolean doIO,
handle hWin) |
static void |
publish(ExternalResource res,
java.lang.String event,
java.lang.String[] param,
boolean delayed)
Send a PUBLISH notification to a remote application.
|
static void |
publishExternal(java.lang.String event,
long publisher,
java.lang.String[] args)
Notify all subscribers (to the given event) that the event has occurred.
|
static void |
pushIntermediateRows(BrowseWidget bw,
BrowseRow[] rows)
Push "intermediate" rows (i.e.
|
private static void |
pushMenuDescrInt(MenuDescription[] menuDescr)
Send menu description to client and reset 'suppress redraw' flag.
|
static void |
pushMenuDescription(MenuDescription[] menuDescr)
Pushes the menu description instance down to the client.
|
static void |
pushScreenDefinition(ScreenDefinition[] frameDef)
Pushes the screen definition instance down to the client.
|
private static void |
pushScreenDefInt(ScreenDefinition[] screenDef)
Send screen definition to client and reset 'suppress redraw' flag.
|
static void |
pushWindow(WindowConfig window)
Pushes the window configuration instance down to the client.
|
static void |
putCursor(boolean onOff)
Turns cursor display on or off.
|
static void |
putCursor(double row,
double column)
Puts cursor to the specified screen position.
|
static void |
putCursor(double row,
NumberType column)
Puts cursor to the specified screen position.
|
static void |
putCursor(NumberType row,
double column)
Puts cursor to the specified screen position.
|
static void |
putCursor(NumberType row,
NumberType column)
Puts cursor to the specified screen position.
|
static void |
putScreen(character text)
Puts text on the screen at the (1,1) position and with the default
text attributes.
|
static void |
putScreen(character text,
ColorSpec cs)
Puts text on the screen at the (1,1) position and with the given
text attributes.
|
static void |
putScreen(character text,
double row,
double column)
Puts text on the screen at the specified position and with the default
text attributes.
|
static void |
putScreen(character text,
double row,
double column,
ColorSpec cs)
Puts text on the screen at the specified position and with the given
text attributes.
|
static void |
putScreen(character text,
double row,
NumberType column)
Puts text on the screen at the specified position and with the default
text attributes.
|
static void |
putScreen(character text,
double row,
NumberType column,
ColorSpec cs)
Puts text on the screen at the specified position and with the given
text attributes.
|
static void |
putScreen(character text,
NumberType row,
double column)
Puts text on the screen at the specified position and with the default
text attributes.
|
static void |
putScreen(character text,
NumberType row,
double column,
ColorSpec cs)
Puts text on the screen at the specified position and with the given
text attributes.
|
static void |
putScreen(character text,
NumberType row,
NumberType column)
Puts text on the screen at the specified position and with the default
text attributes.
|
static void |
putScreen(character text,
NumberType row,
NumberType column,
ColorSpec cs)
Puts text on the screen at the specified position and with the given
text attributes.
|
static void |
putScreen(java.lang.String text)
Puts text on the screen at the (1,1) position and with the default
text attributes.
|
static void |
putScreen(java.lang.String text,
ColorSpec cs)
Puts text on the screen at the (1,1) position and with the given
text attributes.
|
static void |
putScreen(java.lang.String text,
double row,
double column)
Puts text on the screen at the specified position and with the default
text attributes.
|
static void |
putScreen(java.lang.String text,
double row,
double column,
ColorSpec cs)
Puts text on the screen at the specified position and with the given
text attributes.
|
static void |
putScreen(java.lang.String text,
double row,
NumberType column)
Puts text on the screen at the specified position and with the default
text attributes.
|
static void |
putScreen(java.lang.String text,
double row,
NumberType column,
ColorSpec cs)
Puts text on the screen at the specified position and with the given
text attributes.
|
static void |
putScreen(java.lang.String text,
NumberType row,
double column)
Puts text on the screen at the specified position.
|
static void |
putScreen(java.lang.String text,
NumberType row,
double column,
ColorSpec cs)
Puts text on the screen at the specified position and with the given
text attributes.
|
static void |
putScreen(java.lang.String text,
NumberType row,
NumberType column)
Puts text on the screen at the specified position and with the default
text attributes.
|
static void |
putScreen(java.lang.String text,
NumberType row,
NumberType column,
ColorSpec cs)
Puts text on the screen at the specified position and with the given
text attributes.
|
static void |
queryClosed(BrowseWidget bw)
Notify browse widget at client side that query was closed.
|
static void |
queryRepositioned(BrowseWidget bw,
boolean repositionError,
int targetRepositionRow)
Notify the browse that the underlying query has been repositioned..
|
static ColorTable.EnvironmentColorTable |
readColorTable(java.lang.String envName)
Get color table of the specified environment.
|
static FontDetails<?>[] |
readDefaultFonts()
Read the default fonts.
|
static FontDetails<?>[] |
readFontTable()
Read the entire font-table.
|
static int |
readKey(int seconds)
Reads and returns one keystroke from the keyboard type-ahead buffer.
|
static java.util.Map<java.lang.String,int[]> |
readLegacyTextMetrics()
Read the legacy text metrics for all the texts and each font defined in the font table, for
this user.
|
static int |
readResponseEvent(long resourceId)
Called by the P2J client side, it will inform the server that a server-event was generated.
|
static ColorTableEntry[] |
readSystemColorTable()
Get system colors table.
|
static FontDetails<?>[] |
readSystemFontTable()
Read the font-table with the name of the legacy system fonts.
|
static 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 pseudo-terminal associated with
oldId (unless oldId is -1 in which case
nothing needs to be closed). |
static void |
refresh(BrowseWidget bw,
boolean deleteCurrentRowMode)
Refresh the browse cache and redisplay the browse.
|
static ScreenBuffer[] |
refresh(int frameId)
Obtains the latest screen buffer associated with the given frame.
|
static void |
refreshAfterDeletion(BrowseWidget bw,
int rowIndex)
Refresh the browse after some of its rows were deleted.
|
static void |
refreshBuffers(ScreenBuffer[] buffer)
Refresh the server-side buffer for the given frame.
|
private void |
refreshFrameDown(int frameId,
int down)
Internal worker for
applyChanges(Serializable) . |
static void |
refreshFrameWidget(GenericFrame frame,
int wid,
BaseDataType value)
Refreshes the specified frame and widget with a new screen value.
|
static void |
refreshScrollRow(BrowseWidget bw,
boolean leaveOnRowInView,
boolean preserveViewportRow,
boolean repositioned,
boolean repositionError,
int targetRepositionRow)
Refresh scroll row in the browse and redisplay.
|
(package private) static int |
registerFrame(GenericFrame frame)
Adds the frame to the internal registry.
|
static void |
registerFrameInScope(GenericFrame frame)
Register frame at current scope.
|
(package private) static int |
registerMenu(MenuContainerWidget<?> menu)
Adds the menu to the internal registry.
|
static 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.
|
static 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.
|
(package private) static void |
registerSharedFrame(GenericFrame frame)
Register the shared frame.
|
static void |
registerTrigger(EventList events,
java.lang.Class<?> trigger,
java.lang.Object contain)
Register a trigger inner class within the current scope.
|
static void |
registerTrigger(EventList events,
java.lang.Class<?> trigger,
java.lang.Object contain,
boolean trans)
Register a trigger inner class within the current scope.
|
static void |
registerTrigger(EventList events,
java.lang.Object contain,
boolean trans,
Trigger trigger)
Register a specific trigger instance within the current scope.
|
static void |
registerTrigger(EventList events,
java.lang.Object contain,
Trigger trigger)
Register a specific trigger instance within the current scope.
|
static void |
registerTrigger(EventList events,
TriggerDefinition td,
boolean persistent)
Registers a trigger within the current scope.
|
static void |
registerTriggerPersistent(EventList events,
java.lang.String proc)
Register a trigger within the current scope.
|
static void |
registerTriggerPersistent(EventList events,
java.lang.String proc,
BaseDataType... params)
Register a trigger within the current scope.
|
private static void |
registerTriggerPersistent(EventList events,
java.lang.String proc,
handle instance,
BaseDataType... params)
Register a trigger within the current scope.
|
static void |
registerTriggerPersistentIn(EventList events,
java.lang.String proc,
handle instance)
Register a trigger within the current scope.
|
static void |
registerTriggerPersistentIn(EventList events,
java.lang.String proc,
handle instance,
BaseDataType... params)
Register a trigger within the current scope.
|
(package private) static void |
registerWidget(GenericWidget<?> widget,
int widgetId)
Register a widget which ID in widget registry map.
|
(package private) static void |
registerWindow(WindowConfig config,
WindowWidget window)
Register a window widget which was dynamically created.
|
(package private) static void |
releaseSharedFrame(int frameId)
Release shared frame reference from the inactive shared frame pool.
|
static void |
remapKey(character keyLabel,
character keyFunction)
Defines a specific action for the key.
|
static void |
remapKey(character keyLabel,
java.lang.String keyFunction)
Defines a specific action for the key.
|
static void |
remapKey(java.lang.String keyLabel,
character keyFunction)
Defines a specific action for the key.
|
static void |
remapKey(java.lang.String keyLabel,
java.lang.String keyFunction)
Defines a specific action for the key.
|
static 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 |
removeEditableFrameForWidgets(GenericFrame widFrame,
int[] widIdToCheck)
Possibly remove the frame with given widget ID from the editable frames list if there is no
more enabled focused widgets in a frame left.
|
static void |
removeEditSelection(int id)
Removes the currently selected text from an Editor, Fill-In or ComboBox.
|
static void |
removeRowDisplayEvents(int[] triggers)
Remove the ROW-DISPLAY triggers from the specified list.
|
static void |
removeServerEvents(java.util.Set<java.lang.Integer> eventIds)
Remove from the server event queue all the events in the given set, identified by their id.
|
static java.lang.Boolean |
replaceEditorSelectionText(int id,
java.lang.String txt)
Replace selection of the targeted editor with a given string.
|
static 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
|
(package private) static GenericFrame |
replaceFrame(GenericFrame frame)
Replace a frame in the internal registry.
|
static void |
resetBufferSizeManager()
Reset buffer size manager to its initial state.
|
static void |
resetFrame(GenericFrame frame)
Deferred resetting of the down frame content.
|
static void |
resetTerminal()
Resets the terminal but does not change the current terminal type.
|
private void |
restoreFrameStatements(java.util.Map<java.lang.Integer,UIStatement> state)
Restore the UI statement for each registered frame to the saved value.
|
private java.util.Map<java.lang.Integer,UIStatement> |
saveFrameStatements()
Save the
UIStatement running for each registered frame. |
void |
scopeDeleted()
Notification that the instantiating procedure where the scope was opened was deleted.
|
void |
scopeFinished()
Process a notification that a scope is about to be exited.
|
void |
scopeStart()
Process a notification that a new block scope is about to be entered.
|
static void |
scroll(GenericFrame frame,
boolean fromCurrent,
boolean upDown)
Scrolls the lines of the down frame up or down.
|
static void |
scrollToCurrentRow(BrowseWidget bw)
Scrolls a browse (if necessary) to bring the currently selected row into view.
|
static boolean |
scrollToItem(int slId,
int index)
Calls the client side to implement SCROLL-TO-ITEM() method for selection-list widget.
|
static void |
scrollToSelectedRow(BrowseWidget bw,
int selectedRowIndex)
Scrolls a browse (if necessary) to bring the specified selected row into view.
|
static java.lang.Boolean |
searchInEditor(int id,
java.lang.String pattern,
int mode)
Searches for a specified string starting from the current text caret position.
|
static void |
selectAll(BrowseWidget bw)
Implements the SELECT-ALL() BROWSE widget method.
|
static void |
selectFocusedRow(BrowseWidget bw)
Implements the SELECT-FOCUSED-ROW() BROWSE widget
method.
|
static logical |
selectNextRow(BrowseWidget bw)
Implements the SELECT-NEXT-ROW() widget method.
|
static logical |
selectPreviousRow(BrowseWidget bw)
Implements the SELECT-PREV-ROW() widget method.
|
static boolean |
selectRow(BrowseWidget bw,
int rowIndex)
Implements the SELECT-ROW() widget method.
|
static void |
set3D(logical value)
Set THREE-D attribute value for SESSION handle.
|
static void |
setActiveWindow(handle h)
Assigns ACTIVE-WINDOW system handle.
|
static void |
setActiveWindow(WindowWidget window)
Assigns ACTIVE-WINDOW system handle.
|
static void |
setConditionalUpDown(int upDown,
int frameId)
Each frame tracks whether there has been any iteration or explicit
requests for down or up that are conditional.
|
static int |
setCurrentRow(int browseId,
int rowIndex)
Inform server side browse about current row in the browse.
|
static void |
setCurrentWindow(handle h)
Assigns CURRENT-WINDOW system handle to a new window.
|
static void |
setCurrentWindow(WindowWidget window)
Assigns CURRENT-WINDOW system handle to a new window within ACTIVE-WINDOW.
|
static void |
setDataEntryReturn(boolean on)
Set the state of SESSION:DATA-ENTRY-RETURN attribute.
|
void |
setDefaultTimeout(int timeout)
Set default timeout used by this session for processing WAIT-FOR
requests when no explicit timeout is specified.
|
static void |
setDefaultWindow(handle h)
Assigns DEFAULT-WINDOW system handle.
|
static void |
setDefaultWindow(WindowWidget window)
Assigns DEFAULT-WINDOW system handle .
|
static java.lang.Boolean |
setEditorCursorChar(int id,
int pos)
Sets the cursor position in the current line of the targeted editor
|
static java.lang.Boolean |
setEditorCursorLine(int id,
int line)
Sets the cursor line of the targeted editor
|
static java.lang.Boolean |
setEditorCursorOffset(int id,
int offset)
Sets the cursor offset of the targeted editor.
|
static java.lang.Boolean |
setEditorSelection(int id,
int start,
int end)
Selects text in the targeted editor between start and end points.
|
private void |
setEventInfo(EventInfo eventInfo)
Set the value of the eventIfo
to be used before the trigger activation
|
static void |
setFirstTabItem(FieldGroup fieldGroup,
CommonWidget firstWidget)
Move specified widget to the first position in the tab order.
|
static void |
setFormat(int widget,
java.lang.String format)
Sets the format specification for the specified widget and redraws the
widget.
|
static void |
setFrameValue(BaseDataType value)
Stores the value in a field of the active frame, which is in focus and
redisplays the field.
|
static void |
setFrameValue(boolean value)
Stores the value in a field of the active frame, which is in focus and
redisplays the field.
|
static void |
setFrameValue(double value)
Stores the value in a field of the active frame, which is in focus and
redisplays the field.
|
static void |
setFrameValue(int value)
Stores the value in a field of the active frame, which is in focus and
redisplays the field.
|
static void |
setFrameValue(java.lang.String value)
Stores the value in a field of the active frame, which is in focus and
redisplays the field.
|
static void |
setHardFormatCheck(int id)
Enable hard format check for specified frame.
|
static void |
setHeightChars(double h)
HEIGHT-CHARS attribute is read-only for SESSION handle.
|
static void |
setHeightChars(NumberType h)
HEIGHT-CHARS attribute is read-only for SESSION handle.
|
static void |
setHeightPixels(int heightPixels)
HEIGHT-PIXELS attribute is read-only for SESSION handle.
|
static void |
setHeightPixels(NumberType heightPixels)
HEIGHT-PIXELS attribute is read-only for SESSION handle.
|
static boolean |
setImage(int wId,
int type,
java.lang.String imageName)
Sets the new image for given button or image widgets on the client side.
|
static void |
setImmediateDisplay(boolean on)
Set the state of SESSION:IMMEDIATE-DISPLAY attribute.
|
static void |
setNumericFormat(char decSep,
char groupSep)
Set the new decimal and group separators.
|
static void |
setProcCurrentWindow(handle phandle,
handle cWinHandle)
Set CURRENT-WINDOW for the given procedure handle.
|
static void |
setRelogin(boolean relogin)
Sets the relogin flag.
|
static void |
setRowDisplayDrawListener(RowDisplayDrawListener listener)
Set listener (browse) which listens to specific events that can appear in ROW-DISPLAY
trigger (e.g.
|
static void |
setSensitive(GenericWidget<?> widget,
boolean sensitive)
Enables or disables the specified widget without changing the tab order,
which is how widget:SENSITIVE=YES/NO works.
|
static void |
setTerminalType(character term)
Sets the terminal type.
|
static void |
setTerminalType(java.lang.String term)
Sets the terminal type.
|
static void |
setThemePreferredFonts(java.util.Map<java.lang.String,java.lang.String> themeFonts,
java.util.Map<java.lang.String,java.lang.String> themeFontAliases)
Set the theme preferred fonts.
|
static void |
setUsesAlertBoxes(boolean on)
Set the state of SESSION:APPL-ALERT-BOXES attribute.
|
static logical |
setWaitState(character state)
The value of state-string determines the wait state and the type of wait cursor displayed.
|
static logical |
setWaitState(java.lang.String state)
The value of state-string determines the wait state and the type of wait cursor displayed.
|
static void |
setWidthChars(double h)
WIDTH-CHARS attribute is read-only for SESSION handle.
|
static void |
setWidthChars(NumberType h)
WIDTH-CHARS attribute is read-only for SESSION handle.
|
static void |
setWidthPixels(int widthPixels)
WIDTH-PIXELS attribute is read-only for SESSION handle.
|
static void |
setWidthPixels(NumberType widthPixels)
WIDTH-PIXELS attribute is read-only for SESSION handle.
|
static boolean |
setWindowDefaultIcon()
Sets the new default application icon on the client side.
|
static boolean |
setWindowIcon(int windowId,
boolean small,
java.lang.String iconName)
Sets the new application icon for given window on the client side.
|
static void |
setWorkAreaHeightPixels(NumberType heightPixels)
WORK-AREA-HEIGHT-PIXELS attribute is read-only for SESSION handle.
|
static void |
setWorkAreaWidthPixels(NumberType widthPixels)
WORK-AREA-WIDTH-PIXELS attribute is read-only for SESSION handle.
|
static void |
setWorkAreaX(NumberType x)
WORK-AREA-X attribute is read-only for SESSION handle.
|
static void |
setWorkAreaY(NumberType y)
WORK-AREA-Y attribute is read-only for SESSION handle.
|
static void |
signalFrameScope(GenericFrame frame,
int type)
Deferred signalling of the frame entering a new scope.
|
static void |
statusDefault()
Resets the status message for the running procedure back to the
standard message (which is blank or the empty string).
|
static void |
statusDefault(character text)
Specifies a new default status message for the running procedure when
not in INPUT mode (editing).
|
static void |
statusDefault(character text,
handle hWin)
Specifies a new default status message for the running procedure when
not in INPUT mode (when editing).
|
static void |
statusDefault(handle hWin)
Resets the status message for the running procedure back to the standard message
(which is blank or the empty string).
|
static void |
statusDefault(java.lang.String text)
Specifies a new default status message for the running procedure when
not in INPUT mode (when editing).
|
static void |
statusDefault(java.lang.String text,
boolean noLengthLimit)
Specifies a new default status message for the running procedure when
not in INPUT mode (when editing).
|
static void |
statusDefault(java.lang.String text,
handle hWin)
Specifies a new default status message for the running procedure when
not in INPUT mode (when editing).
|
static void |
statusInput()
Resets the status message for the blocked on input procedure back to
the default, which is "Enter data or press 'END-ERROR' to end".
|
static void |
statusInput(character text)
Specifies a new status message used when the user interface is blocked
on input.
|
static void |
statusInput(java.lang.String text)
Specifies a new status message used when the user interface is blocked
on input.
|
static void |
statusInput(java.lang.String text,
handle hWin)
Specifies a new status message used when the user interface is blocked
on input.
|
static void |
statusInputOff()
Disables display of the input status message.
|
static void |
statusInputOff(handle hWin)
Disables display of the input status message in specified window.
|
static void |
stopBatchSession()
Stops the associated client session by generating UnstoppableExitException.
|
static void |
stopEditingMode()
Marks the end of the editing block when triggered by any abnormal exit
from the block on the server.
|
static long |
subscribeExternal(boolean global,
java.lang.Long subscriber,
java.lang.String event,
java.lang.Long publisher)
Create a new subscription to the given event for a specified external resource.
|
static 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. |
static 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. |
static void |
synch(ColorTable.EnvironmentColorTable ect)
Synchronize environment color table state.
|
static void |
systemHelp(java.lang.String fileName,
SystemHelpAction action)
Calls the Microsoft Windows Help engine to display Windows Help topics,
and the HTML Help engine to display HTML Help topics.
|
static int |
targetWindowWorker(GenericFrame frame,
handle hWin,
boolean ignoreThisProc)
Determines target window for different window-aware operations such as MESSAGE, PAUSE
or others.
|
static int |
targetWindowWorker(handle hWin,
boolean ignoreThisProc)
Determines target window for different window-aware operations such as MESSAGE, PAUSE
or others.
|
private static WindowWidget |
targetWindowWorkerInt(handle hWin,
boolean ignoreThisProc,
boolean checkRealized)
Determines target window for different window-aware operations such as MESSAGE, PAUSE
or others.
|
static ServerReturnValue |
trigger(int triggerId,
int eventId,
int sourceId,
int otherId,
long resourceId,
ScreenBuffer[] sb)
Signals a trigger to the application.
|
static void |
underline(GenericFrame frame,
int[] widgetIds)
Underlines a set of widgets of the specified frame.
|
static void |
unsubscribeExternal(boolean global,
java.lang.Long subscriber,
java.lang.String event,
java.lang.Long publisher)
Delete a subscription to the given event for the specified external resource.
|
static void |
updateRow(int browseId,
int rowIndex,
int[] cellIndices,
BaseDataType[] cellValues,
boolean onlyNotifyRowReleased)
Updates selected cells in the given row.
|
static ValidationResult |
validate(int sourceId,
ScreenBuffer[] sb)
Signals a validation event to the application.
|
static boolean |
validResource(long id)
Check if the resource with the given id is still valid to be used in a WAIT-FOR statement.
|
static void |
view(GenericFrame frame,
int[] widgetIds)
Shows all fields of the specified frame on screen.
|
static void |
view(GenericFrame frame,
int[] widgetIds,
handle hWin)
Shows all fields of the specified frame on screen.
|
static void |
view(GenericFrame frame,
int[] widgetIds,
int streamId,
boolean register,
boolean pageTop,
boolean viewDisp)
Shows all fields of the specified frame on screen.
|
static void |
view(GenericFrame frame,
int[] widgetIds,
int streamId,
boolean register,
boolean pageTop,
boolean viewDisp,
handle hWin)
Shows all fields of the specified frame on screen.
|
static void |
view(GenericFrame frame,
ScreenBuffer[] frameBuf,
int[] widgetId)
Shows all fields of the specified frame on screen.
|
static void |
view(int widgetId)
Shows the specified frame or widget on screen.
|
private static void |
view(int widgetId,
ScreenBuffer[] frameBuf,
int[] widgetIds,
boolean viewDisp,
int windowId)
Shows all fields of the specified frame on screen.
|
static void |
waitFor(CommonFrame frame)
Waits for a default list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el)
Waits for specified list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el,
CommonFrame focusFrame)
Waits for specified list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el,
CommonFrame focusWidget,
int seconds)
Waits for specified list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el,
GenericWidget<?> focusWidget)
Waits for specified list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el,
GenericWidget<?> focusWidget,
int seconds)
Waits for specified list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el,
GenericWidget<?> focusWidget,
NumberType seconds)
Waits for specified list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el,
int seconds)
Waits for specified list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el,
int focusWidgetId,
int seconds)
Waits for specified list of events.
|
static void |
waitFor(CommonFrame frame,
EventList el,
NumberType seconds)
Waits for specified list of events.
|
static void |
waitForNextKey()
Conditionally blocks until a next UI event is available.
|
public static final int ALERT_MESSAGE
public static final int ALERT_QUESTION
public static final int ALERT_INFO
public static final int ALERT_ERROR
public static final int ALERT_WARNING
public static final int APPL_ALERT
public static final int BTN_YES_NO
public static final int BTN_YES_NO_CANCEL
public static final int BTN_OK
public static final int BTN_OK_CANCEL
public static final int BTN_RETRY_CANCEL
private static final java.util.logging.Logger LOG
private static final ContextLocal<LogicalTerminal> instance
private static final ContextLocal<RowDisplayDrawListener> rowDisplayDrawListener
private static final ScreenDefinition[] EXEMPLAR
private static CoordinatesConversion coordinates
private GenericFrame frameRef
private boolean helpActive
private int hlpFrameFieldId
private GenericFrame hlpFrameRef
private java.lang.String frameValue
private java.lang.String frameField
private java.lang.String frameName
private java.lang.String frameDb
private java.lang.String frameFile
private integer frameIndex
private int frameFieldId
private ColorSpec messageColor
private ColorSpec msgBoxColor
private int defaultTimeout
private ClientExports client
private java.util.Map<java.lang.Integer,GenericFrame> frameRegistry
private java.util.Map<GenericFrame,java.util.Set<java.lang.Integer>> editableFrameRegistry
private java.util.Map<java.lang.Integer,MenuContainerWidget<?>> menuRegistry
private java.util.Map<java.lang.Integer,TriggerDefinition> triggerRegistry
private ScopedDictionary scope
private java.util.Set<java.lang.Integer> persistentTriggers
private WindowWidget currentWindow
private WindowWidget activeWindow
private WindowWidget defaultWindow
private java.util.LinkedList<WrappedResource> triggerResource
private java.util.LinkedList<java.lang.Integer> triggerEvent
private integer screenLines
private java.util.Stack<java.lang.Integer> blocks
private PartitionedArray<ScreenDefinition> definitions
private PartitionedArray<MenuDescription> descriptions
private java.util.ArrayList<ScreenDefinition> level2definitions
private java.util.ArrayList<MenuDescription> level2descriptions
private java.util.Set<java.lang.Integer> pendingMenus
private int functionKey
private java.lang.Integer eventX
private java.lang.Integer eventY
private LogicalTerminal.ScopeProcessor scopeTrack
private ServerState state
private boolean relogin
private boolean consumeEvent
NO-APPLY
status.private int nesting
private long millis
private java.lang.String terminalType
private java.util.Map<java.lang.Integer,WindowWidget> windowRegistry
private java.util.Map<java.lang.Integer,java.lang.Object> widgetRegistry
private java.lang.Object registryLock
private java.lang.String windowSystem
SESSION:WINDOW-SYSTEM
.private EventInfo eventInfo
private java.lang.String waitState
private boolean isImmediateDisplay
private java.lang.Boolean isDataEntryReturn
private boolean isUsingAlertBoxes
public void init()
Initializable
init
in interface Initializable
private void setEventInfo(EventInfo eventInfo)
eventInfo
- the new eventInfo valueprivate void clearEventInfo()
finally
block)public static EventInfo getEventInfo()
public static void pushWindow(WindowConfig window)
window
- instance of WindowConfig
public int getDefaultTimeout()
public void setDefaultTimeout(int timeout)
timeout
- New timeout value.public static void bell()
This method corresponds to the Progress statement:
BELL
public static void hideAll(boolean noPause)
This method corresponds to the Progress statement:
HIDE ALL [NO_PAUSE]
noPause
- true
if no pause is required before hiding
messagespublic static void hideAll(handle hWin, boolean noPause)
This method corresponds to the Progress statement:
HIDE STREAM stream ALL [NO_PAUSE] IN WINDOW hWin
hWin
- Target window handle or null for default window.noPause
- true
if no pause is required before hiding
messagespublic static void hideAll(Stream stream, boolean noPause)
This method corresponds to the Progress statement:
HIDE STREAM stream ALL [NO_PAUSE]
stream
- The stream for which the frames need to be hidden.noPause
- true
if no pause is required before hiding
messagespublic static void resetBufferSizeManager()
public static void setFrameValue(int value)
This method corresponds to this Progress statement:
FRAME-VALUE = expression
value
- the value to store in the frame fieldpublic static void setFrameValue(double value)
This method corresponds to this Progress statement:
FRAME-VALUE = expression
value
- the value to store in the frame fieldpublic static void setFrameValue(java.lang.String value)
This method corresponds to this Progress statement:
FRAME-VALUE = expression
value
- the value to store in the frame fieldpublic static void setFrameValue(boolean value)
This method corresponds to this Progress statement:
FRAME-VALUE = expression
value
- the value to store in the frame fieldpublic static void setFrameValue(BaseDataType value)
This method corresponds to this Progress statement:
FRAME-VALUE = expression
value
- the value to store in the frame fieldpublic static character getFrameValue()
This method corresponds to this Progress built-in function
FRAME-VALUE
public static void refreshFrameWidget(GenericFrame frame, int wid, BaseDataType value)
frame
- frame to refreshwid
- widget to refreshvalue
- new widget valuepublic static void hideMessage(boolean noPause)
This method corresponds to the Progress statement:
HIDE MESSAGE [NO_PAUSE]
noPause
- true
if no pause is required before hiding
messagespublic static void hideMessage(Stream stream, handle hWin, boolean noPause)
This method corresponds to the Progress statement:
HIDE MESSAGE [NO_PAUSE]
stream
- The stream for which the frames need to be hidden.hWin
- Target window handle.noPause
- true
if no pause is required before hiding
messagespublic static void hideMessage(handle hWin, boolean noPause)
This method corresponds to the Progress statement:
HIDE MESSAGE [NO_PAUSE]
hWin
- Target window handle.noPause
- true
if no pause is required before hiding
messagespublic static void inputClear()
This method corresponds to the Progress statement:
INPUT CLEAR
public static void message()
This method corresponds to the Progress statement:
MESSAGE
public static void message(handle hWin)
This method corresponds to the Progress statement:
MESSAGE
hWin
- handle of target window.public static void message(java.lang.Object text)
This method corresponds to the Progress statement:
MESSAGE
text
- message text either as character
or
String
public static void message(java.lang.Object text, handle hWin)
This method corresponds to the Progress statement:
MESSAGE
text
- message text either as character
or
String
hWin
- handle of target window.public static void message(java.lang.Object[] list)
This method corresponds to the Progress statement:
MESSAGE
list
- list of message text componentspublic static void message(java.lang.Object[] list, handle hWin)
This method corresponds to the Progress statement:
MESSAGE
list
- list of message text componentshWin
- handle of target window.public static void message(java.lang.Object text, boolean set, Accessor var)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.public static void message(java.lang.Object text, boolean set, Accessor var, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.hWin
- handle of target window.public static void message(java.lang.Object[] list, boolean set, Accessor var)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.public static void message(java.lang.Object[] list, boolean set, Accessor var, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.hWin
- handle of target window.public static void message(java.lang.Object text, boolean set, Accessor var, boolean auto)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.public static void message(java.lang.Object text, boolean set, Accessor var, boolean auto, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.hWin
- handle of target window.public static void message(java.lang.Object[] list, boolean set, Accessor var, boolean auto)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.public static void message(java.lang.Object[] list, boolean set, Accessor var, boolean auto, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.hWin
- handle of target window.public static void message(java.lang.Object text, boolean set, Accessor var, java.lang.String format)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.format
- temporary FillIn format specificationpublic static void message(java.lang.Object text, boolean set, Accessor var, java.lang.String format, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.format
- temporary FillIn format specificationhWin
- handle of target window.public static void message(java.lang.Object[] list, boolean set, Accessor var, java.lang.String format)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable FORMAT
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.format
- temporary FillIn format specificationpublic static void message(java.lang.Object[] list, boolean set, Accessor var, java.lang.String format, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable FORMAT
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.format
- temporary FillIn format specificationhWin
- handle of target window.public static void message(java.lang.Object text, boolean set, Accessor var, boolean auto, java.lang.String format)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.format
- temporary FillIn format specificationpublic static void message(java.lang.Object text, boolean set, Accessor var, boolean auto, java.lang.String format, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.format
- temporary FillIn format specificationhWin
- handle of target window.public static void message(java.lang.Object[] list, boolean set, Accessor var, boolean auto, java.lang.String format)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
list
- Array of message text components either as
character
or String
instances.set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.format
- temporary FillIn format specificationpublic static void message(java.lang.Object[] list, boolean set, Accessor var, boolean auto, java.lang.String format, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
list
- Array of message text components either as
character
or String
instances.set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.format
- temporary FillIn format specificationhWin
- handle of target window.public static void message(java.lang.Object text, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE
text
- message text either as character
or
String
cs
- color specification.public static void message(java.lang.Object text, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE
text
- message text either as character
or
String
cs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object[] list, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE
list
- list of message text componentscs
- color specification.public static void message(java.lang.Object[] list, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE
list
- list of message text componentscs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object text, boolean set, Accessor var, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.cs
- color specification.public static void message(java.lang.Object text, boolean set, Accessor var, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.cs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object[] list, boolean set, Accessor var, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.cs
- color specification.public static void message(java.lang.Object[] list, boolean set, Accessor var, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.cs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object text, boolean set, Accessor var, boolean auto, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.cs
- color specification.public static void message(java.lang.Object text, boolean set, Accessor var, boolean auto, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.cs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object[] list, boolean set, Accessor var, boolean auto, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.cs
- color specification.public static void message(java.lang.Object[] list, boolean set, Accessor var, boolean auto, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.cs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object text, boolean set, Accessor var, java.lang.String format, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.format
- temporary FillIn format specificationcs
- color specification.public static void message(java.lang.Object text, boolean set, Accessor var, java.lang.String format, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.format
- temporary FillIn format specificationcs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object[] list, boolean set, Accessor var, java.lang.String format, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable FORMAT
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.format
- temporary FillIn format specificationcs
- color specification.public static void message(java.lang.Object[] list, boolean set, Accessor var, java.lang.String format, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable FORMAT
list
- list of message text componentsset
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.format
- temporary FillIn format specificationcs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object text, boolean set, Accessor var, boolean auto, java.lang.String format, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.format
- temporary FillIn format specificationcs
- color specification.public static void message(java.lang.Object text, boolean set, Accessor var, boolean auto, java.lang.String format, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.format
- temporary FillIn format specificationcs
- color specification.hWin
- handle of target window.public static void message(java.lang.Object[] text, boolean set, Accessor var, boolean auto, java.lang.String format, ColorSpec cs)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
text
- message text either as character
or
String
set
- true
for SET, false
for UPDATE.var
- Variable to set or update. Must not be null
.auto
- true
if AUTO-RETURN option is specified.format
- temporary FillIn format specificationcs
- color specification.public static void message(java.lang.Object[] list, boolean set, Accessor var, boolean auto, java.lang.String format, ColorSpec cs, handle hWin)
This method corresponds to the Progress statement:
MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
list
- list of message text componentsset
- true
for SET, false
for UPDATE,
not used if var parameter is null
.var
- Variable to set or update. If null
, this is a
regular MESSAGE without SET or UPDATE.auto
- true
if AUTO-RETURN option is specified.format
- temporary FillIn format specificationcs
- color specificationhWin
- Handle of the target windowpublic static boolean isInBatchMode()
true
for batch mode, false
otherwise.public static boolean isBatchInBackground()
true
for background mode, false
otherwise.public static void stopBatchSession()
public static void displayError(java.lang.String errmsg)
errmsg
- The error message to displaypublic static void displayErrorRedirected(java.lang.String errmsg)
errmsg
- The error message to displaypublic static void activateBatchMode(boolean on)
on
- The new status of the active flag for batch driver.public static void messageBox(java.lang.Object text)
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX
text
- A single message text component to display.public static void messageBox(java.lang.Object text, handle hWin)
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX
text
- A single message text component to display.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list)
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.
This method corresponds to the Progress statement:
MESSAGE list VIEW-AS ALERT-BOX
list
- The list of message text components.public static void messageBox(java.lang.Object[] list, handle hWin)
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.
This method corresponds to the Progress statement:
MESSAGE list VIEW-AS ALERT-BOX
list
- The list of message text components.hWin
- handle of target window.public static void messageBox(java.lang.Object text, ColorSpec col)
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX COLOR color
text
- A single message text component to display.col
- Color scheme to use.public static void messageBox(java.lang.Object text, ColorSpec col, handle hWin)
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX COLOR color
text
- A single message text component to display.col
- Color scheme to use.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, ColorSpec col)
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.
This method corresponds to the Progress statement:
MESSAGE list VIEW-AS ALERT-BOX COLOR color
list
- The list of message text components.col
- Color scheme to use.public static void messageBox(java.lang.Object[] list, ColorSpec col, handle hWin)
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.
This method corresponds to the Progress statement:
MESSAGE list VIEW-AS ALERT-BOX COLOR color
list
- The list of message text components.col
- Color scheme to use.hWin
- handle of target window.public static void messageBox(java.lang.Object text, int alertType, int buttons, java.lang.String title)
This method corresponds to the Progress statements:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title
text
- A single message text component to display.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.public static void messageBox(java.lang.Object text, int alertType, int buttons, character title)
This method corresponds to the Progress statements:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title
text
- A single message text component to display.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.public static void messageBox(java.lang.Object text, int alertType, int buttons, java.lang.String title, handle hWin)
This method corresponds to the Progress statements:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title
text
- A single message text component to display.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.hWin
- handle of target window.public static void messageBox(java.lang.Object text, int alertType, int buttons, character title, handle hWin)
This method corresponds to the Progress statements:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title
text
- A single message text component to display.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, int alertType, int buttons, java.lang.String title)
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.
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title
list
- The list of message text components.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.public static void messageBox(java.lang.Object[] list, int alertType, int buttons, character title)
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.
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title
list
- The list of message text components.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.public static void messageBox(java.lang.Object[] list, int alertType, int buttons, java.lang.String title, handle hWin)
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.
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title
list
- The list of message text components.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, int alertType, int buttons, character title, handle hWin)
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.
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title
list
- The list of message text components.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.hWin
- handle of target window.public static void messageBox(java.lang.Object text, int alertType, int buttons, java.lang.String title, ColorSpec col)
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title COLOR color
text
- A single message text component to display.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.col
- Color scheme to use.public static void messageBox(java.lang.Object text, int alertType, int buttons, character title, ColorSpec col)
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title COLOR color
text
- A single message text component to display.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.col
- Color scheme to use.public static void messageBox(java.lang.Object text, int alertType, int buttons, java.lang.String title, ColorSpec col, handle hWin)
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title COLOR color
text
- A single message text component to display.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.col
- Color scheme to use.hWin
- handle of target window.public static void messageBox(java.lang.Object text, int alertType, int buttons, character title, ColorSpec col, handle hWin)
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title COLOR color
text
- A single message text component to display.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.col
- Color scheme to use.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, int alertType, int buttons, java.lang.String title, ColorSpec col)
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.
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title COLOR color
list
- The list of message text components.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.col
- Color scheme to use.public static void messageBox(java.lang.Object[] list, int alertType, int buttons, character title, ColorSpec col)
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.
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title COLOR color
list
- The list of message text components.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.col
- Color scheme to use.public static void messageBox(java.lang.Object[] list, int alertType, int buttons, java.lang.String title, ColorSpec col, handle hWin)
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.
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title COLOR color
list
- The list of message text components.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.col
- Color scheme to use.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, int alertType, int buttons, character title, ColorSpec col, handle hWin)
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.
This method corresponds to the Progress statement:
MESSAGE text VIEW-AS ALERT-BOX alertType BUTTONS buttons TITLE title COLOR color
list
- The list of message text components.alertType
- One of the ALERT_* constants specifying message type.buttons
- One of the BTN_* constants specifying used button set.title
- The dialog title.col
- Color scheme to use.hWin
- handle of target window.public static void messageBox(java.lang.Object text, boolean set, Accessor var, int alertType, int buttons, java.lang.String title)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title
text
- A single message text component to display.set
- true
for SET, false
for UPDATE.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.public static void messageBox(java.lang.Object text, boolean set, Accessor var, int alertType, int buttons, character title)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title
text
- A single message text component to display.set
- true
for SET, false
for UPDATE.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.public static void messageBox(java.lang.Object text, boolean set, Accessor var, int alertType, int buttons, java.lang.String title, handle hWin)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title
text
- A single message text component to display.set
- true
for SET, false
for UPDATE.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.hWin
- handle of target window.public static void messageBox(java.lang.Object text, boolean set, Accessor var, int alertType, int buttons, character title, handle hWin)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title
text
- A single message text component to display.set
- true
for SET, false
for UPDATE.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.hWin
- handle of target window.public static void messageBox(java.lang.Object text, boolean set, Accessor var, int alertType, int buttons, java.lang.String title, ColorSpec col)
logical
variable as a result of the action taken. This
is a modal dialog with the specified title and button configuration.
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 text VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title COLOR color
text
- A single message text component to display.set
- true
for SET, false
for UPDATE.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.col
- Color scheme to use.public static void messageBox(java.lang.Object text, boolean set, Accessor var, int alertType, int buttons, character title, ColorSpec col)
logical
variable as a result of the action taken. This
is a modal dialog with the specified title and button configuration.
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 text VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title COLOR color
text
- A single message text component to display.set
- true
for SET, false
for UPDATE.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.col
- Color scheme to use.public static void messageBox(java.lang.Object text, boolean set, Accessor var, int alertType, int buttons, java.lang.String title, ColorSpec col, handle hWin)
logical
variable as a result of the action taken. This
is a modal dialog with the specified title and button configuration.
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 text VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title COLOR color
text
- A single message text component to display.set
- true
for SET, false
for UPDATE.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.col
- Color scheme to use.hWin
- handle of target window.public static void messageBox(java.lang.Object text, boolean set, Accessor var, int alertType, int buttons, character title, ColorSpec col, handle hWin)
logical
variable as a result of the action taken. This
is a modal dialog with the specified title and button configuration.
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 text VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title COLOR color
text
- A single message text component to display.set
- true
for SET, false
for UPDATE.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.col
- Color scheme to use.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, boolean set, Accessor var, int alertType, int buttons, java.lang.String title)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title
list
- The list of message text components.set
- true
for SET, false
for UPDATE.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.public static void messageBox(java.lang.Object[] list, boolean set, Accessor var, int alertType, int buttons, character title)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title
list
- The list of message text components.set
- true
for SET, false
for UPDATE.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.public static void messageBox(java.lang.Object[] list, boolean set, Accessor var, int alertType, int buttons, java.lang.String title, handle hWin)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title
list
- The list of message text components.set
- true
for SET, false
for UPDATE.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.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, boolean set, Accessor var, int alertType, int buttons, character title, handle hWin)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title
list
- The list of message text components.set
- true
for SET, false
for UPDATE.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.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, boolean set, Accessor var, int alertType, int buttons, java.lang.String title, ColorSpec cs)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title COLOR color
list
- The list of message text components.set
- true
for SET, false
for UPDATE.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.cs
- Color specification.public static void messageBox(java.lang.Object[] list, boolean set, Accessor var, int alertType, int buttons, character title, ColorSpec cs)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title COLOR color
list
- The list of message text components.set
- true
for SET, false
for UPDATE.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.cs
- Color specification.public static void messageBox(java.lang.Object[] list, boolean set, Accessor var, int alertType, int buttons, character title, ColorSpec cs, handle hWin)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title COLOR color
list
- The list of message text components.set
- true
for SET, false
for UPDATE.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.cs
- Color specification.hWin
- handle of target window.public static void messageBox(java.lang.Object[] list, boolean set, Accessor var, int alertType, int buttons, java.lang.String title, ColorSpec cs, handle hWin)
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 statement:
MESSAGE list VIEW-AS ALERT-BOX alertType SET/UPDATE var BUTTONS buttons TITLE title COLOR color
list
- The list of message text components.set
- true
for SET, false
for UPDATE.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.cs
- Color specification.hWin
- handle of target window.public static void remapKey(character keyLabel, character keyFunction)
This method corresponds to the Progress statement:
ON key-label key-function
keyLabel
- the label of the keykeyFunction
- the action to take when the user presses the keypublic static void remapKey(java.lang.String keyLabel, java.lang.String keyFunction)
This method corresponds to the Progress statement:
ON key-label key-function
keyLabel
- the label of the keykeyFunction
- the action to take when the user presses the keypublic static void remapKey(character keyLabel, java.lang.String keyFunction)
This method corresponds to the Progress statement:
ON key-label key-function
keyLabel
- the label of the keykeyFunction
- the action to take when the user presses the keypublic static void remapKey(java.lang.String keyLabel, character keyFunction)
This method corresponds to the Progress statement:
ON key-label key-function
keyLabel
- the label of the keykeyFunction
- the action to take when the user presses the keypublic static void pause()
This method corresponds to the Progress statement: PAUSE
public static void pause(character text)
This method corresponds to the Progress statement: PAUSE MESSAGE/NO-MESSAGE
text
- Either null
if NO-MESSAGE is in effect, or a
message text.public static void pause(handle hWin)
This method corresponds to the Progress statement: PAUSE IN WINDOW h
hWin
- Handle of target window.public static void pause(double seconds, handle hWin)
This method corresponds to the Progress statement: PAUSE n IN WINDOW h
seconds
- The number of seconds to pause. If specified as a
non-positive number this method immediately returns.hWin
- Handle of target window.public static void pause(java.lang.String text, handle hWin)
This method corresponds to the Progress statement: PAUSE MESSAGE/NO-MESSAGE IN WINDOW h
text
- Either null
if NO-MESSAGE is in effect, or a
message text.hWin
- Handle of target window.public static void pause(double seconds, java.lang.String text, handle hWin)
This method corresponds to the Progress statement: PAUSE n MESSAGE/NO-MESSAGE IN WINDOW h
seconds
- The number of seconds to pause. If specified as a
non-positive number this method immediately returns.text
- Either null
if NO-MESSAGE is in effect, or a
message text.hWin
- Handle of target window.public static void pause(java.lang.String text)
This method corresponds to the Progress statement: PAUSE MESSAGE/NO-MESSAGE
text
- Either null
if NO-MESSAGE is in effect, or a
message text.public static void pause(double seconds)
This method corresponds to the Progress statement:
PAUSE n
seconds
- The number of seconds to pause. If specified as a
non-positive number this method immediately returns.public static void pause(NumberType seconds) throws ErrorConditionException
This method corresponds to the Progress statement:
PAUSE n
seconds
- The number of seconds to pause. If specified as a
non-positive number this method immediately returns.ErrorConditionException
- If the number of seconds is the unknown value
or is null
.public static void pause(double seconds, character text)
This method corresponds to the Progress statement:
PAUSE n MESSAGE/NO-MESSAGE
seconds
- The number of seconds to pause. If specified as a
non-positive number this method immediately returns.text
- Either null
if NO-MESSAGE is in effect, or the
message text.public static void pause(NumberType seconds, character text) throws ErrorConditionException
This method corresponds to the Progress statement:
PAUSE n MESSAGE/NO-MESSAGE
seconds
- The number of seconds to pause. If specified as a
non-positive number this method immediately returns.text
- Either null
if NO-MESSAGE is in effect, or the
message text.ErrorConditionException
- If the number of seconds is the unknown value
or is null
.public static void pause(double seconds, java.lang.String text)
This method corresponds to the Progress statement:
PAUSE n MESSAGE/NO-MESSAGE
seconds
- The number of seconds to pause. If specified as a
non-positive number this method immediately returns.text
- Either null
if NO-MESSAGE is in effect, or the
message text.public static void pause(NumberType seconds, java.lang.String text)
This method corresponds to the Progress statement:
PAUSE n MESSAGE/NO-MESSAGE
seconds
- The number of seconds to pause. If specified as a
non-positive number this method immediately returns.text
- Either null
if NO-MESSAGE is in effect, or the
message text.public static void pauseBeforeHide()
This method corresponds to Progress statement:
PAUSE BEFORE-HIDE
public static void pauseBeforeHide(character text)
This method corresponds to Progress statement:
PAUSE BEFORE-HIDE MESSAGE text PAUSE BEFORE-HIDE NO-MESSAGE
text
- Either null
if NO-MESSAGE is in effect or the
message text to display.public static void pauseBeforeHide(java.lang.String text)
This method corresponds to Progress statement:
PAUSE BEFORE-HIDE MESSAGE text PAUSE BEFORE-HIDE NO-MESSAGE
text
- Either null
if NO-MESSAGE is in effect or the
message text to display.public static void pauseBeforeHide(double seconds)
This method corresponds to Progress statement:
PAUSE seconds BEFORE-HIDE
seconds
- Pause duration in seconds.public static void pauseBeforeHide(double seconds, java.lang.String text)
This method corresponds to Progress statement:
PAUSE seconds BEFORE-HIDE MESSAGE/NO-MESSAGE
seconds
- Pause duration in seconds.text
- Either null
if NO-MESSAGE is in effect or the
message text to display.public static void pauseBeforeHide(NumberType seconds)
This method corresponds to Progress statement:
PAUSE seconds BEFORE-HIDE
seconds
- Pause duration in seconds.public static void pauseBeforeHide(double seconds, character text)
This method corresponds to Progress statements:
PAUSE seconds BEFORE-HIDE MESSAGE text PAUSE seconds BEFORE-HIDE NO-MESSAGE
seconds
- Pause duration in seconds.text
- Either null
if NO-MESSAGE is in effect or the
message text to display.public static void pauseBeforeHide(handle hWin)
This method corresponds to Progress statement:
PAUSE BEFORE-HIDE IN WINDOW h.
hWin
- Handle of target window.public static void pauseBeforeHide(double seconds, handle hWin)
This method corresponds to Progress statement:
PAUSE seconds BEFORE-HIDE IN WINDOW h.
seconds
- Pause duration in seconds.public static void pauseBeforeHide(NumberType seconds, character text)
This method corresponds to Progress statements:
PAUSE seconds BEFORE-HIDE MESSAGE text PAUSE seconds BEFORE-HIDE NO-MESSAGE
seconds
- Pause duration in seconds.text
- Either null
if NO-MESSAGE is in effect or the
message text to display.public static void pauseBeforeHide(double seconds, java.lang.String text, handle hWin)
This method corresponds to Progress statements:
PAUSE seconds BEFORE-HIDE MESSAGE text PAUSE seconds BEFORE-HIDE NO-MESSAGE
seconds
- Pause duration in seconds.text
- Either null
if NO-MESSAGE is in effect or the
message text to display.hWin
- target window for IN WINDOUW clause.public static void pauseBeforeHide(NumberType seconds, java.lang.String text)
This method corresponds to Progress statements:
PAUSE seconds BEFORE-HIDE MESSAGE text PAUSE seconds BEFORE-HIDE NO-MESSAGE
seconds
- Pause duration in seconds.text
- Either null
if NO-MESSAGE is in effect or the
message text to display.public static void processEvents()
This method corresponds to the Progress statement:
PROCESS EVENTS
public static void putCursor(boolean onOff)
This method corresponds to these Progress statements:
PUT CURSOR
PUT CURSOR OFF
onOff
- true
if the cursor display is being turned on.public static void putCursor(double row, double column)
This method corresponds to the Progress statement:
PUT CURSOR ROW COLUMN
row
- 1-based screen row numbercolumn
- 1-based screen column numberpublic static void putCursor(NumberType row, NumberType column)
This method corresponds to the Progress statement:
PUT CURSOR ROW COLUMN
row
- 1-based screen row numbercolumn
- 1-based screen column numberpublic static void putCursor(double row, NumberType column)
This method corresponds to the Progress statement:
PUT CURSOR ROW COLUMN
row
- 1-based screen row numbercolumn
- 1-based screen column numberpublic static void putCursor(NumberType row, double column)
This method corresponds to the Progress statement:
PUT CURSOR ROW COLUMN
row
- 1-based screen row numbercolumn
- 1-based screen column numberpublic static void putScreen(character text)
This method corresponds to the Progress statement:
PUT SCREEN text
text
- The text to display. The output will be generated using
character.toStringMessage
public static void putScreen(java.lang.String text)
This method corresponds to the Progress statement:
PUT SCREEN text
text
- The text to display.public static void putScreen(character text, double row, double column)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.public static void putScreen(java.lang.String text, double row, double column)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.public static void putScreen(character text, NumberType row, NumberType column)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.public static void putScreen(java.lang.String text, NumberType row, NumberType column)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.public static void putScreen(character text, double row, NumberType column)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.public static void putScreen(java.lang.String text, double row, NumberType column)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.public static void putScreen(character text, NumberType row, double column)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.public static void putScreen(java.lang.String text, NumberType row, double column)
This method corresponds to the Progress statement:
PUT SCREEN ROW COLUMN
text
- string of text to displayrow
- 1-based screen row numbercolumn
- 1-based screen column numberpublic static void putScreen(character text, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text
text
- The text to display.cs
- The color specification or -1 for the default color.public static void putScreen(java.lang.String text, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text
text
- The text to display.cs
- The color specification or -1 for the default color.public static void putScreen(character text, double row, double column, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.cs
- The color specification or -1 for the default color.public static void putScreen(java.lang.String text, double row, double column, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.cs
- The color specification or null
for the default color.public static void putScreen(character text, NumberType row, NumberType column, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.cs
- The color specification or null
for the default color.public static void putScreen(java.lang.String text, NumberType row, NumberType column, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.cs
- The color specification or null
for the default color.public static void putScreen(character text, double row, NumberType column, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.cs
- The color specification or null
for the default color.public static void putScreen(java.lang.String text, double row, NumberType column, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.cs
- The color specification or null
for the default color.public static void putScreen(character text, NumberType row, double column, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.cs
- The color specification or -1 for the default color.public static void putScreen(java.lang.String text, NumberType row, double column, ColorSpec cs)
This method corresponds to the Progress statement:
PUT SCREEN text ROW y COLUMN x
text
- The text to display.row
- 1-based screen row number.column
- 1-based screen column number.cs
- The color specification or -1 for the default color.public static int readKey(int seconds) throws StopConditionException
This method corresponds to these Progress statements:
READKEY PAUSE n
READKEY
seconds
- -1 means indefinite wait, 0 means no wait and any positive
value is the number of seconds to wait.StopConditionException
- If CTRL-C is input.public static void statusDefault()
This method corresponds to the Progress statement
STATUS DEFAULT
.
public static void statusDefault(character text)
This method corresponds to the Progress statement
STATUS DEFAULT text
.
text
- The new status message. unknown value
is the
equivalent of the empty string.public static void statusDefault(java.lang.String text)
This method corresponds to the Progress statement
STATUS DEFAULT text
.
text
- The new status message. null
is the equivalent
of the empty string.public static void statusDefault(handle hWin)
This method corresponds to the Progress statement
STATUS DEFAULT IN WINDOW ...
.
hWin
- Handle of target window.public static void statusDefault(java.lang.String text, handle hWin)
This method corresponds to the Progress statement
STATUS DEFAULT text IN WINDOW wnd
.
text
- The new status message. null
is the equivalent
of the empty string.hWin
- Handle of target window.public static void statusDefault(character text, handle hWin)
This method corresponds to the Progress statement
STATUS DEFAULT text IN WINDOW wnd
.
text
- The new status message. Unknown value is the equivalent
of the empty string.hWin
- Handle of target window.public static void statusDefault(java.lang.String text, boolean noLengthLimit)
This method is used to display a status message, which is trimmed to
63 chars only if the noLengthLimit
flag is not set.
text
- The new status message. null
is the equivalent
of the empty string.noLengthLimit
- flag indicating the status message should not be trimmedpublic static void statusInput()
This method corresponds to the Progress statement
STATUS INPUT
.
public static void statusInput(java.lang.String text)
This method corresponds to the Progress statement
STATUS INPUT text
.
text
- The new status message. null
is the equivalent
of the empty string.public static void statusInput(java.lang.String text, handle hWin)
This method corresponds to the Progress statement
STATUS INPUT text IN WINDOW wnd.
.
text
- The new status message. null
is the equivalent
of the empty string.hWin
- Handle of the target windowpublic static void statusInput(character text)
This method corresponds to the Progress statement
STATUS INPUT text
.
text
- The new status message. unknown
is the
equivalent of the empty string.public static void statusInputOff()
This method corresponds to the Progress statement
STATUS INPUT OFF
.
public static void statusInputOff(handle hWin)
This method corresponds to the Progress statement
STATUS INPUT OFF IN WINDOW wnd.
.
hWin
- Handle of target window.public static void underline(GenericFrame frame, int[] widgetIds)
frame
- The frame for which this request came.widgetIds
- The array of field level widget IDs to be underlined.public static void waitFor(CommonFrame frame)
This method corresponds to the Progress statement:
WAIT-FOR
frame
- The frame for which this request came or null
if the currently focused frame should be used.public static void waitFor(CommonFrame frame, EventList el)
This method corresponds to the Progress statement:
WAIT-FOR
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.public static void waitFor(CommonFrame frame, EventList el, GenericWidget<?> focusWidget)
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.focusWidget
- Widget which is to be in focus or null
for no
widget.public static void waitFor(CommonFrame frame, EventList el, int seconds)
This method corresponds to the Progress statement:
WAIT-FOR PAUSE n
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.seconds
- Maximum time to wait for event.public static void waitFor(CommonFrame frame, EventList el, NumberType seconds)
This method corresponds to the Progress statement:
WAIT-FOR PAUSE n
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.seconds
- Maximum time to wait for event.public static void waitFor(CommonFrame frame, EventList el, GenericWidget<?> focusWidget, int seconds)
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget PAUSE n
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.focusWidget
- Widget which is to be in focus or null
for no
widget.seconds
- Maximum time to wait for event.public static void waitFor(CommonFrame frame, EventList el, GenericWidget<?> focusWidget, NumberType seconds)
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget PAUSE n
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.focusWidget
- Widget which is to be in focus or null
for no
widget.seconds
- Maximum time to wait for event.public static void waitFor(CommonFrame frame, EventList el, CommonFrame focusFrame)
This method corresponds to the Progress statement:
WAIT-FOR FOCUS FRAME frame
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.focusFrame
- Frame which is to be in focus.public static void waitFor(CommonFrame frame, EventList el, CommonFrame focusWidget, int seconds)
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget PAUSE n
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.focusWidget
- Widget which is to be in focus or null
for no
widget.seconds
- Maximum time to wait for event.public static void waitFor(CommonFrame frame, EventList el, int focusWidgetId, int seconds)
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget PAUSE n
frame
- The frame for which this request came or null
if the currently focused frame should be used.el
- List of events to wait for or null
for the
default.focusWidgetId
- Widget ID which is to be in focus or -1 for no widget.seconds
- Maximum time to wait for event.public static GenericFrame getCurrentFrame()
null
if there is no active
frame.public static character kbLabel(character function)
This method corresponds to the Progress built-in function:
KBLABEL
function
- text, describing the key functionpublic static character kbLabel(java.lang.String function)
This method corresponds to the Progress built-in function:
KBLABEL
function
- text, describing the key functionpublic static integer keyCode(character label)
This method corresponds to the Progress built-in function:
KEYCODE
label
- Label to evaluate.public static integer keyCode(java.lang.String label)
This method corresponds to the Progress built-in function:
KEYCODE
label
- Label to evaluate.public static character keyFunction(integer code)
This method corresponds to the Progress built-in function:
KEYFUNCTION
code
- Code to evaluate.public static character keyLabel(integer code)
This method corresponds to the Progress built-in function:
KEYLABEL
code
- Code to evaluate.public static logical moveBeforeTabItem(FieldGroup fieldGroup, CommonWidget widget, CommonWidget before)
fieldGroup
- Containing field-group.widget
- The widget to move.before
- The widget before which the widget should be moved.public static logical moveAfterTabItem(FieldGroup fieldGroup, CommonWidget widget, CommonWidget before)
fieldGroup
- Containing field-group.widget
- The widget to move.before
- The widget before which the widget should be moved.public static handle activeWindow()
This method corresponds to the Progress system handle:
ACTIVE-WINDOW
public static handle currentWindow()
This method corresponds to the Progress system handle:
CURRENT-WINDOW
public static handle defaultWindow()
This method corresponds to the Progress system handle:
DEFAULT-WINDOW
public static void setCurrentWindow(WindowWidget window)
window
- a window reference.public static void setCurrentWindow(handle h)
h
- a handle reference.public static void setActiveWindow(WindowWidget window)
window
- a window reference.public static void setActiveWindow(handle h)
h
- a handle reference.public static void setDefaultWindow(WindowWidget window)
window
- a window reference.public static void setDefaultWindow(handle h)
h
- a handle reference.public static handle currentWindow(handle phandle)
phandle
- Procedure handle.public static handle focus()
This method corresponds to the Progress system handle:
FOCUS
public static handle getWidgetHandleById(int id)
id
- the id of the widgetpublic static void setFormat(int widget, java.lang.String format)
widget
- The widget to modify.format
- The format specification.public static void setNumericFormat(char decSep, char groupSep)
decSep
- The new decimal separator.groupSep
- The new group separator.public static void registerPageElement(int frameId, boolean header)
frameId
- The id of the frame for this request.header
- true
to register as a header, false
to register as a footer.public static void registerPageElement(int frameId, boolean header, int streamId)
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.public static void deregisterPageElement(int frameId, boolean header)
frameId
- The id of the frame for this request.header
- true
to register as a header, false
to register as a footer.public static void deregisterPageElement(int frameId, boolean header, int streamId)
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).
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.public static void forceDeregisterPageElement(int frameId, boolean header)
frameId
- The id of the frame for this request.header
- true
to register as a header, false
to register as a footer.public static handle _self()
public static void apply(handle h, character event)
h
- The resource to which the event is applied.event
- Progress event namepublic static void apply(handle h, java.lang.String event)
h
- The resource to which the event is applied.event
- Progress event namepublic static void apply(handle h, double eventCode)
h
- The resource to which the event is applied.eventCode
- Progress event codepublic static void apply(handle h, integer eventCode)
h
- The resource to which the event is applied.eventCode
- Progress event codepublic static void apply(WrappedResource res, character event)
res
- The resource to which the event is applied.event
- Progress event codepublic static void apply(WrappedResource res, java.lang.String event)
res
- The resource to which the event is applied.event
- Progress event codepublic static void apply(WrappedResource res, integer eventCode)
res
- The resource to which the event is applied.eventCode
- Progress event codepublic static void apply(WrappedResource res, double eventCode)
res
- The resource to which the event is applied.eventCode
- Progress event codepublic static void apply(GenericFrame frame, java.lang.String event)
frame
- instance of GenericFrame
this request came forevent
- Progress event namepublic static void apply(GenericFrame frame, int eventCode)
frame
- instance of GenericFrame
this request came foreventCode
- Progress event codepublic static void apply(GenericFrame frame, int widgetId, java.lang.String event)
frame
- instance of GenericFrame
this request came forwidgetId
- widget to apply the event toevent
- Progress event namepublic static void apply(GenericFrame frame, int widgetId, int eventCode)
frame
- instance of GenericFrame
this request came forwidgetId
- widget to apply the event toeventCode
- Progress event codepublic static void apply(java.lang.String event)
event
- Progress event namepublic static void apply(character event)
event
- Progress event namepublic static void apply(int64 eventCode)
eventCode
- Progress event codepublic static void apply(double eventCode)
eventCode
- Progress event codepublic static void apply(long eventCode)
eventCode
- Progress event codepublic static ServerReturnValue invokeServerEvent(int id)
ServerEvent.invoke(int)
.id
- The id of the server event.public static boolean validResource(long id)
false
if:
false
.true
id
- The resource id.public static void postServerEvent(ServerEvent event)
event
- The server event.public static void removeServerEvents(java.util.Set<java.lang.Integer> eventIds)
eventIds
- The set of event IDs to be removed.public static int readResponseEvent(long resourceId)
resourceId
- The resource ID for the socket to which the READ-RESPONSE event belongs.-1
if a event could not be
posted (i.e. the resource is not SENSITIVE).public static int connectEvent(long resourceId, long clientSocketId)
resourceId
- The resource ID for the server socket to which the CONNECT event belongs.clientSocketId
- The resource ID of the socket created for the new connection accepted by the
server socket.-1
if a event could not be
posted (i.e. the resource is not SENSITIVE).public static long createSocket(int id)
LowLevelSocketImpl
instance.id
- The ID of the associated LowLevelSocketImpl
instance.SocketImpl
resource.public static java.lang.String getUiTheme()
Theme
. If
any Theme
is configured in registry (in any scope) it is returned, otherwise
null
is returned so that the client will chose the default.public static void setThemePreferredFonts(java.util.Map<java.lang.String,java.lang.String> themeFonts, java.util.Map<java.lang.String,java.lang.String> themeFontAliases)
themeFonts
- The fonts the current installed Theme
on client prefers.themeFontAliases
- The font aliases currently installed Theme
on client prefers.public static FontDetails<?>[] readFontTable()
public static FontDetails<?>[] readSystemFontTable()
public static FontDetails<?>[] readDefaultFonts()
public static int[] getLegacyTextMetrics(java.lang.String text, java.lang.String key)
text
- The text.key
- The font's key.public static java.util.Map<java.lang.String,int[]> readLegacyTextMetrics()
public static boolean setWindowIcon(int windowId, boolean small, java.lang.String iconName)
windowId
- A valid window id.small
- Flag indicating usage of the small icon case(16x16 in size).iconName
- The icon name to be loaded on server side and sent to client.TRUE
if operation successful FALSE
otherwise.public static boolean setWindowDefaultIcon()
TRUE
if operation successful FALSE
otherwise.public static boolean setImage(int wId, int type, java.lang.String imageName)
wId
- A valid widget id.type
- Image type to load. Up, Down or Insensitive for buttons, -1 for image.imageName
- The image name to be loaded on server side and sent to client.TRUE
if operation successful FALSE
otherwise.public static boolean loadMousePointer(int id, java.lang.String ptrName)
id
- widget idptrName
- the name of the pointer datatrue
if successful.private static java.io.InputStream getImageStreamFromApplication(java.lang.String imgName)
imgName
- The image name to be loaded on server side.NULL
if data is not found.private static java.lang.String getRefinedPathName(java.lang.String nameDirty, java.lang.String separator)
nameDirty
- The not yet refined image path string.separator
- The string representing file separator to use in result.private static boolean isButtonOrImage(int wId)
wId
- A valid wdget id.TRUE
if button or image FALSE
otherwise.private static boolean isButton(int wId)
wId
- A valid wdget id.TRUE
if button FALSE
otherwise.public static void initWidgetConfigurations(java.util.Map<java.lang.String,java.util.List<java.lang.String>> configs)
configs
- A map of configurations, having as hey a class name and as value a list of field
names (the order in this list gives the field ID).public static byte[] loadEnvironment(java.lang.String env)
env
- The INI file source.null
if the environment file could not be
loaded.public static void choose(GenericFrame frame, Choose c, ColorSpec cs)
This method corresponds to this Progress statement:
CHOOSE COLOR
frame
- instance of GenericFrame
this request came forc
- CHOOSE statement optionscs
- color specification for use with CHOOSEpublic static void clear(GenericFrame frame, boolean noPause)
This method corresponds to this Progress statement:
CLEAR FRAME
frame
- instance of GenericFrame
this request came fornoPause
- true
if NO-PAUSE option was usedpublic static void clear()
This method corresponds to this Progress statement:
CLEAR
public static void clear(boolean noPause)
This method corresponds to this Progress statement:
CLEAR
noPause
- true
if NO-PAUSE option was usedpublic static void cleanupPending()
public static void clearAll(GenericFrame frame, boolean noPause)
This method corresponds to this Progress statement:
CLEAR ALL
frame
- instance of GenericFrame
this request came fornoPause
- true
if NO-PAUSE option was usedpublic static void clearAll()
This method corresponds to this Progress statement:
CLEAR ALL
public static void clearAll(boolean noPause)
This method corresponds to this Progress statement:
CLEAR ALL
noPause
- true
if NO-PAUSE option was usedpublic static java.lang.Boolean deleteEditorLine(int id)
id
- Widget id of the target editor.true
if the line was deleted,
null if no widget with given id is foundpublic static void removeEditSelection(int id)
id
- Widget id of the target editor.public static java.lang.Boolean setEditorSelection(int id, int start, int end)
id
- Widget id of the target editor.start
- Starting offset.end
- Ending offset.true
if the operation succeeded.public static java.lang.Boolean setEditorCursorOffset(int id, int offset)
id
- Widget id of the target editor.offset
- the new offset value. Use -1 to move the caret at the end (MOVE-TO-EOF).true
if the cursor offset is valid and set, null
if no widget
with given id
is found.public static java.lang.Boolean setEditorCursorChar(int id, int pos)
id
- Widget id of the target editor.pos
- the new cursor position valuetrue
if the cursor position is valid and set,
null if no widget with given id is foundpublic static java.lang.Boolean setEditorCursorLine(int id, int line)
id
- Widget id of the target editor.line
- the new cursor line valuetrue
if the cursor line is valid and set,
null if no widget with given id is foundpublic static java.lang.Boolean insertEditorString(int id, java.lang.String txt)
id
- Widget id of the target editor.txt
- The string to be inserted.true
if the string is inserted, null
if no widget with given
id
is found.public static java.lang.Boolean insertEditorFile(int id, java.lang.String filePath)
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.true
if the file content is inserted, null
if no widget with given
id
is found.public static java.lang.Boolean replaceEditorSelectionText(int id, java.lang.String txt)
id
- Widget id of the target editor.txt
- the replacement stringtrue
if the selection is replaced,
null if no widget with given id is foundpublic static java.lang.Boolean replaceEditorString(int id, java.lang.String from, java.lang.String to, int flag)
id
- Widget id of the target editor.from
- the string to be replacedto
- the replacement stringflag
- the replacement mode flag as described in 4GL EDITOR:REPLACE documentationtrue
if the replacement was performed,
null if no widget with given id is foundpublic static java.lang.Boolean searchInEditor(int id, java.lang.String pattern, int mode)
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 |
yes
.public static void disable(GenericFrame frame, int[] widgetId)
This method corresponds to these Progress statements:
DISABLE ALL
DISABLE ALL EXCEPT
frame
- instance of GenericFrame
this request came forwidgetId
- array of field level widget IDs to be disabled or
null
, which means all of them.public static void disable(GenericFrame frame, int[] widgetId, handle hWin)
This method corresponds to these Progress statements:
DISABLE ALL
DISABLE ALL EXCEPT
frame
- instance of GenericFrame
this request came forwidgetId
- array of field level widget IDs to be disabled or
null
, which means all of them.public static void enable(GenericFrame frame, int[] widgetId)
This method corresponds to these Progress statements:
ENABLE ALL
ENABLE ALL EXCEPT
frame
- instance of GenericFrame
this request came forwidgetId
- array of field level widget IDs to be enabled or
null
, which means all of them.public static void enable(GenericFrame frame, int[] widgetId, handle hWin)
This method corresponds to these Progress statements:
ENABLE ALL IN WINDOW
ENABLE ALL EXCEPT IN WINDOW
frame
- instance of GenericFrame
this request came forwidgetId
- array of field level widget IDs to be enabled or
null
, which means all of them.hWin
- Handle of target window.public static void setSensitive(GenericWidget<?> widget, boolean sensitive)
widget
- widget to enable or disablesensitive
- TRUE
enables the widget, FALSE
disables it.public static boolean isChui()
TRUE
if the CHUI, FALSE
otherwisepublic static boolean isEmbedded()
TRUE
if the client is running in embedded mode,
FALSE
otherwisepublic static void view(int widgetId)
This method corresponds to these Progress statements: VIEW widget
widgetId
- The frame ID or widget ID to show.public static void view(GenericFrame frame, int[] widgetIds)
This method corresponds to these Progress statements: VIEW widgets
frame
- The frame to make visible.widgetIds
- The array of field level widget IDs to be shown or
null
, which means all of them.public static void view(GenericFrame frame, int[] widgetIds, handle hWin)
This method corresponds to these Progress statements: VIEW widgets
frame
- The frame to make visible.widgetIds
- The array of field level widget IDs to be shown or
null
, which means all of them.hWin
- Handle of target window.public static void view(GenericFrame frame, int[] widgetIds, int streamId, boolean register, boolean pageTop, boolean viewDisp)
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.
frame
- The frame to make visible.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
.viewDisp
- true
if the call is for VIEW, false
for DISPLAY.public static void displayAndDown(GenericFrame frame, int[] widgetIds, int streamId, boolean register, boolean pageTop)
frame
- The frame this request came for.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
.public static void view(GenericFrame frame, int[] widgetIds, int streamId, boolean register, boolean pageTop, boolean viewDisp, handle hWin)
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.
frame
- The frame to make visible.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
.viewDisp
- true
if the call is for VIEW, false
for DISPLAY.hWin
- Handle of target window.public static void view(GenericFrame frame, ScreenBuffer[] frameBuf, int[] widgetId)
This method corresponds to these Progress statements: DISPLAY widgets
frame
- The frame for which this request came.frameBuf
- The screen buffer array to send to the client, does not need to be
the current screen buffer of the frame.widgetId
- An array of field level widget IDs to be shown or
null
, which means all widgets.public static void promptFor(GenericFrame frame, int[] widgetIds, EventList wait, boolean doIO, handle hWin)
frame
- The frame to be edited.widgetIds
- array of field level widget IDs to be enabled or
null
, which means all of them.wait
- List of events to wait for or null
for the
default.doIO
- tells to perform the requested operation if true
.
otherwise prepares the frame for editing session only.hWin
- Handle of target window.public static void down(GenericFrame frame, int lines, boolean cond)
frame
- The frame for which this request came.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 1public static void down(GenericFrame frame, int lines, boolean cond, int sid)
frame
- The frame for which this request came.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 1sid
- The stream for which pending PUT or EXPORT output must be
ended and written to the stream. -1 means that this is not
necessary.public static void down(GenericFrame frame, int lines, int streamId, boolean cond, boolean endOut)
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
frame
- The frame for which this request came.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 1endOut
- 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).public static boolean hide(int widgetId, boolean noPause, boolean hidden)
This method corresponds to this Progress statement:
HIDE widget
widgetId
- instance of GenericFrame
this request came fornoPause
- true
if NO-PAUSE option was usedhidden
- If true
, set the HIDDEN attribute.public static void hide(int widgetId, boolean noPause, handle hWin)
This method corresponds to this Progress statement:
HIDE widget
widgetId
- instance of GenericFrame
this request came fornoPause
- true
if NO-PAUSE option was usedhWin
- Handle of target window.public static void nextPrompt(GenericFrame frame, int widgetId)
This method corresponds to this Progress statement:
NEXT-PROMPT
frame
- instance of GenericFrame
this request came forwidgetId
- widget to be put in focuspublic static void scroll(GenericFrame frame, boolean fromCurrent, boolean upDown)
This method corresponds to this Progress statement:
SCROLL
frame
- instance of GenericFrame
this request came forfromCurrent
- true
if FROM-CURRENT option was usedupDown
- true
if scrolling uppublic static void pushScreenDefinition(ScreenDefinition[] frameDef)
frameDef
- an array of ScreenDefinition
objectspublic static void pushMenuDescription(MenuDescription[] menuDescr)
menuDescr
- an array of MenuDescription
objectspublic static void deferPush(ScreenDefinition frameDef)
processDeferredPush()
.frameDef
- an array of ScreenDefinition
objectspublic static void deferPush(MenuDescription menuDescr)
processDeferredPush()
.menuDescr
- an array of MenuDescription
objectspublic static void processDeferredPush()
deferPush(com.goldencode.p2j.ui.ScreenDefinition)
.public static void registerTriggerPersistent(EventList events, java.lang.String proc)
events
- List of events and widgets for which this trigger executes.proc
- The internal or external procedure's name to be executed.public static void registerTriggerPersistent(EventList events, java.lang.String proc, BaseDataType... params)
events
- List of events and widgets for which this trigger executes.proc
- The internal or external procedure's name to be executed.params
- The parameters to be passed to the procedure (INPUT only).
Each parameter is evaluated at trigger definition; the
parameters do not get reevaluated on trigger invocation.public static void registerTriggerPersistentIn(EventList events, java.lang.String proc, handle instance)
events
- List of events and widgets for which this trigger executes.proc
- The internal or external procedure's name to be executed.instance
- The where the procedure is searched.public static void registerTriggerPersistentIn(EventList events, java.lang.String proc, handle instance, BaseDataType... params)
events
- List of events and widgets for which this trigger executes.proc
- The internal or external procedure's name to be executed.instance
- The where the procedure is searched.params
- The parameters to be passed to the procedure (INPUT only).
Each parameter is evaluated at trigger definition; the
parameters do not get reevaluated on trigger invocation.private static void registerTriggerPersistent(EventList events, java.lang.String proc, handle instance, BaseDataType... params)
events
- List of events and widgets for which this trigger executes.proc
- The internal or external procedure's name to be executed.instance
- The where the procedure is searched.params
- The parameters to be passed to the procedure (INPUT only).
Each parameter is evaluated at trigger definition; the
parameters do not get reevaluated on trigger invocation.public static void cleanupTriggers(java.lang.Object referent)
referent
- The external program which is being deleted.public static void cleanupTriggers(java.lang.Long resourceId, int widgetId)
resourceId
- The resource ID.widgetId
- The widget IDpublic static void registerTrigger(EventList events, java.lang.Class<?> trigger, java.lang.Object contain)
events
- List of events and widgets for which this trigger executes.trigger
- The class of the trigger. Must not be null
.contain
- The containing object (all triggers are implemented as
non-static inner classes, so they must have a reference to
the containing class). Must not be null
.public static void registerTrigger(EventList events, java.lang.Class<?> trigger, java.lang.Object contain, boolean trans)
events
- List of events and widgets for which this trigger executes.trigger
- The class of the trigger. Must not be null
.contain
- The containing object (all triggers are implemented as
non-static inner classes, so they must have a reference to
the containing class). Must not be null
.trans
- true
if this trigger should start a full
transaction. false
if the trigger should be
a sub-transaction.public static void registerTrigger(EventList events, java.lang.Object contain, Trigger trigger)
events
- List of events and widgets for which this trigger executes.trigger
- The specific instance of the trigger. Must not be null
.contain
- The containing object (all triggers are implemented as
non-static inner classes, so they must have a reference to
the containing class). Must not be null
.public static void registerTrigger(EventList events, java.lang.Object contain, boolean trans, Trigger trigger)
events
- List of events and widgets for which this trigger executes.trigger
- The specific instance of the trigger. Must not be null
.contain
- The containing object (all triggers are implemented as
non-static inner classes, so they must have a reference to
the containing class). Must not be null
.trans
- true
if this trigger should start a full
transaction. false
if the trigger should be
a sub-transaction.public static void registerTrigger(EventList events, TriggerDefinition td, boolean persistent)
events
- List of events and widgets for which this trigger executes.td
- The definition of the trigger that allows deferred and
repeated instantiation of a fresh instance of the defined
trigger.public static boolean isPersistentTrigger(int triggerId)
persistentTriggers
set.triggerId
- The trigger's ID.true
if the given trigger is persistent.public static void removeRowDisplayEvents(int[] triggers)
triggers
- The triggers to be removed, if they are associated to a
ROW-DISPLAY event. May be null
.public static void deregisterTrigger(EventList events)
events
- List of events and widgets for which this trigger executes.public static void deregisterTrigger(int triggerId)
triggerId
- The trigger ID to deregister.public static void deregisterTrigger(int triggerId, boolean force)
force
flag.triggerId
- The trigger ID to deregister.force
- flag indicating that the trigger should be deregistered,
regardless of its state, persistent or non-persistentpublic static TriggerDefinition getTriggerDefinition(int triggerId)
triggerId
- The trigger ID.public static ServerReturnValue trigger(int triggerId, int eventId, int sourceId, int otherId, long resourceId, ScreenBuffer[] sb)
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.sb
- The editable frames ScreenBuffer
arrayScreenBuffer
representing the latest screen values of all widgets and the
consume flag.public static ValidationResult validate(int sourceId, ScreenBuffer[] sb)
This signal is used to trigger validation execution on the server.
sourceId
- widget ID of the widget generated the trigger.sb
- updated ScreenBuffer
arrayValidationResult
representing the validation
result, error message and screen value changes.public static void help(int lastKey, ScreenBuffer[] buffer)
The directory node consulted is named "helpapp". it should conform to the general guidelines of the runtime configuration set forth by the getDirectoryNodeString() helper.
lastKey
- The most recent key event codebuffer
- The screen buffer array associated with the FOCUS as before HELP is invoked and
other editable frames.public static ScreenBuffer[] refresh(int frameId)
frameId
- The frame for which the screen buffer should be returned.ScreenBuffer
array representing the current screen
values of all widgets in the given frame and other editable frames.public static void consumeEvent()
public static boolean isWidgetIdInUse(int widgetId)
widgetId
- The widget ID to check.TRUE
if ID is in use, FALSE
otherwise.public static GenericWidget<?> nextTabItem(GenericFrame frame, GenericWidget<?> widget)
frame
- frame where the widget is placedwidget
- target widget which is being queriedGenericWidget
or null
.static int registerFrame(GenericFrame frame)
frame
- The instance of a GenericFrame
to add to the
registry. Must not be null
and the frame ID
of this frame must be unique.static int registerMenu(MenuContainerWidget<?> menu)
menu
- The instance of a MenuWidget
to add to the
registry. Must not be null
and the menu ID
of this menu must be unique.static void deregisterFrame(int frameId)
frameId
- The ID of frame which should be removed from registry.static void deregisterMenu(int menuId)
menuId
- The ID of menu which should be removed from registry.static GenericFrame replaceFrame(GenericFrame frame)
This method is intended to support shared frames, where the
GenericFrame
instance backing a shared frame in one scope
must be replaced temporarily with a new instance to back a "matching"
frame in a more deeply nested scope. This ensures that all frame and
widget lookups within the nested scope find the proper objects in the
registry.
frame
- Replacement frame instance.static void releaseSharedFrame(int frameId)
frameId
- ID of the frame to release.static void registerSharedFrame(GenericFrame frame)
frame
- The shared frame to add back to the registry.private static void processDownConfigs(WidgetConfig[] wcfgs)
wcfgs
- The widget configs for the current frame row.private ScreenBuffer[] getEditableServerScreenBuffers(GenericFrame frDefault)
frDefault
- The default frame is used as first element in array.public void addEditableFrameForWidgets(GenericFrame widFrame, int[] widIdToCheck)
widFrame
- instance of GenericFrame
this request came forwidIdToCheck
- The widget ID to check.public void removeEditableFrameForWidgets(GenericFrame widFrame, int[] widIdToCheck)
widFrame
- instance of GenericFrame
this request came forwidIdToCheck
- The widget ID to check.private void deregisterFrameInt(int frameId)
deregisterFrame(int)
.frameId
- The ID of frame which should be removed from registry.private void deregisterMenuInt(int menuId)
deregisterMenu(int)
.menuId
- The ID of menu which should be removed from registry.private void deregisterFrameContentInt(GenericFrame frameToProcess)
frameToProcess
- The frame to remove all containing widgets from registry.private void deregisterMenuContentInt(MenuContainerWidget<?> menu)
menu
- The menu to remove all containing widgets from registry.static void addDynamicFrame(GenericFrame dynFrame, int idFrame)
FrameWidget.resourceDelete()
.dynFrame
- The dynamic frame widget to be added to registry.idFrame
- The widget ID to be used for this frameprivate void refreshFrameDown(int frameId, int down)
applyChanges(Serializable)
.frameId
- The ID of frame which should be removed from registry.down
- New DOWN value.private GenericFrame identifyFrame(int frameId)
frameId
- The frame ID of the frame to identify.GenericFrame
or null
.private java.util.Map<java.lang.Integer,UIStatement> saveFrameStatements()
UIStatement
running for each registered frame.private void restoreFrameStatements(java.util.Map<java.lang.Integer,UIStatement> state)
state
- The state, as computed by saveFrameStatements()
.public static int frameIdFromWidgetId(int widgetId)
widgetId
- The widget ID.public static java.util.List<java.lang.Integer> getParentFrames(int widgetId)
widgetId
- A widget id.private int lookupFrameIdFromWidgetId(int widgetId)
widgetId
- The widget ID.private static java.lang.String pauseText(character text)
text
- The text to be prepared in pause message.private static int encodeEvent(java.lang.String event)
event
- Progress event nameprivate static LogicalTerminal locate()
LogicalTerminal
for this session.public static GenericWidget<?> getWidgetForId(int widgetId)
widgetId
- The widget ID.null
if the widget ID is invalid.private GenericWidget<?> getWidgetForIdInt(int widgetId)
widgetId
- The widget ID.null
if the widget ID is invalid.private WindowWidget getFirstVisibleWindow()
public static void cleanupDynamicFrames()
public static void destroyWidgets(int[] widgetIds)
widgetIds
- A list of widget IDs.public static void destroyFrame(GenericFrame frame)
frame
- The frame requiring cleanup.public static void destroyMenu(MenuContainerWidget<?> menu)
menu
- The menu requiring cleanup.public static decimal getFrameCol(GenericFrame frame)
This method corresponds to the Progress built-in function:
FRAME-COL
frame
- The frame for this request.public static int getFirstTabItem(FieldGroup fieldGroup)
fieldGroup
- Target field-group.public static void setFirstTabItem(FieldGroup fieldGroup, CommonWidget firstWidget)
fieldGroup
- Containing field-group.firstWidget
- The widget to make first.public static double getWidth(GenericFrame frame)
FRAME:WIDTH-CHARS
attribute).frame
- The frame for this request.public static double getHeight(GenericFrame frame)
FRAME:HEIGHT-CHARS
attribute).frame
- The frame for this request.public static integer getFrameDown(GenericFrame frame)
This method corresponds to the Progress built-in function:
FRAME-DOWN
frame
- The frame for this request.public static integer getFrameLine(GenericFrame frame, int pendingUpDown)
This method corresponds to the Progress built-in function:
FRAME-LINE
frame
- The frame for this request.pendingUpDown
- The pending down value for this frame.public static decimal getFrameRow(GenericFrame frame)
This method corresponds to the Progress built-in function:
FRAME-ROW
frame
- The frame for this request.public static integer getScreenLines()
This method corresponds to the Progress built-in function:
SCREEN-LINES
public static integer getMessageLines()
This method corresponds to the Progress built-in function:
MESSAGE-LINES
public static java.util.Collection<MenuWidget> getAllMenus()
public static character getTerminalType()
TERM
environment variable on UNIX or Linux unless set
via setTerminalType(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
public static void setTerminalType(character term)
This processing also clears the input buffer and resets any key mappings to their default values.
This method corresponds to the Progress statement:
TERMINAL
term
- Terminal type name. If null
, this resets the
terminal without changing the type.public static void setTerminalType(java.lang.String term)
This processing also clears the input buffer and resets any key mappings to their default values.
This method corresponds to the Progress statement:
TERMINAL
term
- Terminal type name. If null
, this resets the
terminal without changing the type.public static void resetTerminal()
This method corresponds to the Progress statement:
TERMINAL = TERMINAL
public static character getFrameField()
This method corresponds to the Progress FRAME-FIELD
built-in function.
public static character getFrameFile()
This method corresponds to the Progress FRAME-FILE
built-in function.
public static character getFrameDb()
This method corresponds to the Progress FRAME-DB
built-in function.
public static character getFrameName()
This method corresponds to the Progress built-in function:
FRAME-NAME
public static integer getFrameIndex()
This method corresponds to the Progress built-in function:
FRAME-INDEX
public static logical isGoPending()
This method corresponds to the Progress built-in function:
GO-PENDING
public static int getNumSelectedRows(BrowseWidget bw)
bw
- instance of BrowseWidget
this request came forpublic static int getNextTabItem(GenericWidget<?> widget)
widget
- The widget to get the next widget in the tab order.public static int getSelectedRowIndex(BrowseWidget bw, int n)
bw
- 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.ErrorConditionException
- If selIndex
is invalid or if there are no "available" rows.public static int[] getSelectedRowIndexes(BrowseWidget bw)
bw
- Browse widget associated with the request.ErrorConditionException
- If selIndex
is invalid or if there are no "available" rows.public static void selectAll(BrowseWidget bw)
bw
- instance of BrowseWidget
this request came forpublic static void deselectRows(BrowseWidget bw)
bw
- instance of BrowseWidget
this request came forpublic static void notifyColumnsUpdated(BrowseWidget bw)
bw
- instance of BrowseWidget
this request came for.public static void scrollToCurrentRow(BrowseWidget bw)
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.
bw
- Instance of BrowseWidget
this request came for.ErrorConditionException
- if a numbered error occurs.public static void scrollToSelectedRow(BrowseWidget bw, int selectedRowIndex)
bw
- Instance of BrowseWidget
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.ErrorConditionException
- if a numbered error occurs.public static void refresh(BrowseWidget bw, boolean deleteCurrentRowMode)
bw
- instance of BrowseWidget
this request came fordeleteCurrentRowMode
- true
if this function is used for update on DELETE-CURRENT-ROW.
false
if this function is used for update on REFRESH.public static void refreshAfterDeletion(BrowseWidget bw, int rowIndex)
bw
- instance of BrowseWidget
this request came for.rowIndex
- 0-based index of the deleted row. -1
if all of the selected rows were
deleted.public static logical selectNextRow(BrowseWidget bw)
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.
bw
- instance of BrowseWidget
this request came for.true
on success.public static logical selectPreviousRow(BrowseWidget bw)
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.
bw
- instance of BrowseWidget
this request came for.true
on success.public static void selectFocusedRow(BrowseWidget bw)
bw
- instance of BrowseWidget
this request came forpublic static void deselectFocusedRow(BrowseWidget bw)
bw
- instance of BrowseWidget
this request came forpublic static boolean deselectSelectedRow(BrowseWidget bw, int rowIndex)
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.
bw
- instance of BrowseWidget
this request came for.rowIndex
- 1-based index of the row (in the list of selected rows) to deselect.true
if the row is successfully deselected.public static boolean selectRow(BrowseWidget bw, int rowIndex)
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.
bw
- instance of BrowseWidget
this request came for.rowIndex
- 1-based row index in the browse viewport.true
if the row with the given index exist in the browse viewport.public static boolean isRowSelected(BrowseWidget bw, int rowIndex)
bw
- instance of BrowseWidget
this request came for.rowIndex
- 1-based row index in the browse viewport.true
if a specified row in the browse viewport is currently selected.public static int getFocusedRow(BrowseWidget bw)
public static int getBrowsePageRowCount(BrowseWidget bw)
bw
- instance of BrowseWidget
this request came for.public static void executePendingRefresh(BrowseWidget bw, boolean queryReopened, boolean repositionBeforeReopen, int repositionedRow)
bw
- instance of BrowseWidget
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.public static void refreshScrollRow(BrowseWidget bw, boolean leaveOnRowInView, boolean preserveViewportRow, boolean repositioned, boolean repositionError, int targetRepositionRow)
bw
- Instance of BrowseWidget
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
- Row used as the target for reposition. If it was deleted, reposition with fetching
may end up on a different row.public static void queryRepositioned(BrowseWidget bw, boolean repositionError, int targetRepositionRow)
bw
- Instance of BrowseWidget
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.public static void queryClosed(BrowseWidget bw)
bw
- instance of BrowseWidget
this request came forpublic static int calcBrowseDown(BrowseWidget bw, int rowHeightPixels)
bw
- Instance of BrowseWidget
this request came for.rowHeightPixels
- Row height in pixels.public static void pushIntermediateRows(BrowseWidget bw, BrowseRow[] rows)
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.bw
- Instance of BrowseWidget
this request came for.rows
- Set of rows to push.public static boolean isNewRow(BrowseWidget bw)
true
if the current row is a new row and is not present in the
database.bw
- instance of BrowseWidget
this request came for.true
if the current row is a new row and false
otherwise.public static boolean isCurrentRowModified(BrowseWidget bw)
true
if the current row is modified.bw
- instance of BrowseWidget
this request came for.true
if the current row is modified.public static boolean insertRow(BrowseWidget bw, boolean after)
bw
- Instance of BrowseWidget
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.true
if the row was successfully added.public static void moveColumnClient(BrowseWidget bw, int srcIndex, int destIndex)
Repositions a column in a browse widget.
srcIndex
- 0-based position of the column to be moved.destIndex
- 0-based position to which the column is moved.public static void moveColumnServer(int browseId, int src, int dest)
Repositions a column in the browse widget.
browseId
- ID of the browse which should handle the request.src
- 0-based position of the column to be moved.dest
- 0-based position to which the column is moved.public static void setConditionalUpDown(int upDown, int frameId)
view
. This method provides a facility for a frame to
store a "one-shot" update that will be synchronized with the client
at the next message. This must only be done JUST BEFORE a subsequent
call to one of the FRAME-SPECIFIC client calls that require honoring
this conditional value. This requirement is necessary to avoid
tracking a list of all frame IDs and associated pending up/down values.
Since this requirement is highly coupled to the FRAME-SPECIFIC calls,
this should not be a problem.upDown
- -1 for up or 1 for down.frameId
- The frame for which the update must be made. This is really
just here for safety in case the state sync is triggered
before we expect.public static void setHardFormatCheck(int id)
id
- public static boolean scrollToItem(int slId, int index)
slId
- Widget ID of the selection list to make scrolling.index
- The 1-based index of an item to scroll.TRUE
in success, FALSE
otherwise.public static void initialize()
TransactionManager
a
factory object which creates instances of this class, so that they can be registered to
receive notifications of runtime scope start and finish events.
This method should be invoked once during the server bootstrap phase.
The registered factory functions conditionally. It uses the TransactionManager._isHeadless()
to check whether the context has been declared headless.
public void scopeStart()
In the Logical Terminal, a new top level block scope causes creation of a new scope in the dictionary of registered triggers.
If some other class of objects requires scoping, it can be added here.
scopeStart
in interface Scopeable
public void scopeFinished()
In the Logical Terminal, the current scope in the dictionary of registered triggers is destroyed, but only when exiting a top level block.
scopeFinished
in interface Scopeable
public void scopeDeleted()
This implementation is a no-op.
scopeDeleted
in interface Scopeable
public java.io.Serializable getChanges()
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.Serializable)
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.
getChanges
in interface StateSynchronizer
null
if no changes need to be sent.public void applyChanges(java.io.Serializable changes)
applyChanges
in interface StateSynchronizer
changes
- The payload of state changes that must be locally applied.void addMarkEntry(MarkEntry me)
MarkEntry
to list.
Note that if MarkEntry
which should be added to the list is
MarkEntry.CLOSE_SCOPE
, then we check if list still contains
MarkEntry.OPEN_SCOPE
for this frame. If this is so, then all
entries which belong to this frame at current scope nesting can be
safely removed since there were no client calls between opening and
closing scope and frame state is not changed. This optimisation becomes
vital in cases when frame scope is opened/closed many times in loop
before triggering actual frame call. Such a scenario may result to
generation of very large list of operations which are effectively no-op
but consume significant amount of network traffic/memory and can even
crash client.
me
- Instance of MarkEntry to add into state list of frame marking
entries.private boolean checkDuplicate(MarkEntry me)
me
- Entry to compare with.true
if entries are equal.private boolean cleanupList(int frameId)
MarkEntry.OPEN_SCOPE
entry in the list and
if found then cleanup list of MarkEntry
instances from
operations related to specified frame at current level of scope nesting.frameId
- Frame ID.true
if list was cleaned up.public static void redirectOutput(int oldId, int newId)
newId
(or to the interactive terminal if newId
is -1) and close/
cleanup resources for the pseudo-terminal associated with
oldId
(unless oldId
is -1 in which case
nothing needs to be closed).oldId
- The previously redirected stream for which the pseudo-terminal
is to be closed or -1 for no close/cleanup action.newId
- The stream for which a pseudo-terminal is to be setup for
redirection or -1 to remove redirections and activate the
interactive terminal.public static int switchOutput(int newId, boolean clean)
newId
(or to the interactive terminal if newId
is -1) and return
the id of the current output destination. This may be another
pseudo-terminal or it may be -1 if the interactive terminal is in
use.
If redirection has not yet been established for the given stream,
newId
- The stream for which a pseudo-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.public static int switchOutput(int newId, boolean clean, boolean endOut)
newId
(or to the interactive terminal if newId
is -1) and return
the id of the current output destination. This may be another
pseudo-terminal or it may be -1 if the interactive terminal is in
use.
If redirection has not yet been established for the given stream,
newId
- The stream for which a pseudo-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).public static void cleanupPseudoTerminal(int id)
switchOutput(int, boolean)
interface.
This should never be called when the redirection is currently active.
id
- The stream needing cleanup.public static void setRelogin(boolean relogin)
relogin
- new state of the flagpublic void pauseBeforeEnd(boolean isQuit)
isQuit
- Set to true
if QUIT statement is processed.public static WidgetConfig[] getEditorsConfigs(int browseId)
browseId
- ID of the browse which should handle the request.null
if the
column is not editable. Return value is null
if the browse is
read-only.public static int getRowCount(int browseId)
browseId
- ID of the browse which should handle the request.public static int getRowCount(int browseId, int startRow)
browseId
- ID of the browse which should handle the request.startRow
- Initial row to start count rows from.public static BrowseRow[] getRows(int browseId, int startRowIndex, int count, boolean forward, int rowDisplayTriggerId, ScreenBuffer[] sb, RowDisplayStrategy displayStrategy)
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.null
is returned.public static BrowseRow[] getRows(int browseId, char searchChar, int searchColumn, int viewportTopRow, int viewportBottomRow, int rowDisplayTriggerId, ScreenBuffer[] sb)
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.null
is returned.public static void updateRow(int browseId, int rowIndex, int[] cellIndices, BaseDataType[] cellValues, boolean onlyNotifyRowReleased) throws DataValidationException
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.DataValidationException
- New values don't passed database validation rules.public static int setCurrentRow(int browseId, int rowIndex)
browseId
- ID of the browse which should handle the request.rowIndex
- Index of the current row.public static int getCurrentRow(int browseId)
browseId
- ID of the browse which should handle the request.public static boolean isRowAvailable(int browseId, int rowIndex)
browseId
- ID of the browse which should handle the request.rowIndex
- 0-base index of the target row in the browse model.true
if the row is "available", i.e. it is not deleted.public static void stopEditingMode()
continueEditing(boolean)
. This
method allows the client's state to be cleaned up in the abnormal
termination case.public static void waitForNextKey()
public static boolean continueEditing(boolean hadNext)
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.true
if there is no GO-PENDING
and the editing mode
continues.public static void resetFrame(GenericFrame frame)
frame
- Frame to reset.public static void signalFrameScope(GenericFrame frame, int type)
This signal is used by down frames for resetting both the contents and the cursor to the initial state so that the frame can be properly reused if it enters new scope.
frame
- Frame to signal.type
- Signal type.private void markInteractive(boolean update)
TransactionManager
and may increment a counter of the
interactive requests have occurred in the current iteration of the
current block.update
- true
to increment the number of interactions in
this block.private void markInteractive()
TransactionManager
and will increment a counter of the
interactive requests have occurred in the current iteration of the
current block IF the current block is not EDITING
.private static void pauseWorker(int seconds, java.lang.String text, boolean noMessage, handle hWin)
seconds
- The number of seconds to pause. If specified as a -1 number this method waits
indefinitely unless in batch mode. In latter case the method returns immediately.text
- If null
the default message is used, otherwise the user-specified message
will be used.noMessage
- true
if NO-MESSAGE is in effect. This suppresses the message display, even
if an explicit message text was passed.hWin
- target window for IN WINDOW clause.public static int[] getSelection(int widgetId)
widgetId
- Widget ID.null
if specified widget does not exists or does not support such a
request.public static ServerState getServerState()
public static void registerFrameInScope(GenericFrame frame)
frame
- instance of GenericFrame
to register.public static void systemHelp(java.lang.String fileName, SystemHelpAction action)
fileName
- Path to the help file.action
- Help action. See SystemHelpAction
for more information.public static character getClientType()
Currently, this returns either APPSERVER
if this is an appserver session or
CLIENT
in all other cases.
public static character getWindowSystem()
ScreenDriver.getWindowSystem()
client:driver:window-system
key.window-system
node, searched using the
Directory.ID_RELATIVE
method.SESSION:WINDOW-SYSTEM
.public static character getWaitState()
Valid return values are:
This only works on GUI clients.
public static logical setWaitState(java.lang.String state)
state
- The new wait-state value.true
if the operation was successful. Returns unknown
and is a no-op if not in GUI mode.public static logical setWaitState(character state)
state
- The new wait-state value.true
if the operation was successful. Returns unknown
and is a no-op if not in GUI mode.static void message(ErrorManager.ErrorEntry... res)
res
- Array of error entries.private static void pushScreenDefInt(ScreenDefinition[] screenDef)
screenDef
- Array of definitions.private static void pushMenuDescrInt(MenuDescription[] menuDescr)
menuDescr
- Array of definitions.private static void handleScreenBuffer(GenericFrame gfr, ScreenBuffer sb, boolean allow)
gfr
- The frame associated with the screen buffer.sb
- The screen buffer to process.allow
- true
to allow the switching of screen buffers if
the frame is a non-redirected down frame and the frame-line is
detected as changing. Otherwise this switching will be
disabled.private static void handleScreenBuffers(GenericFrame gfr, ScreenBuffer[] sb, boolean allow)
gfr
- The frame associated with the screen buffer.sb
- The screen buffer array to process.allow
- true
to allow the switching of screen buffers if
the frame is a non-redirected down frame and the frame-line is
detected as changing. Otherwise this switching will be
disabled.private static void handleScreenBuffer(ScreenBuffer sb)
This does not update the FRAME-VALUE, FRAME-FIELD, FRAME-NAME functions.
sb
- The screen buffer to process.private static void handleScreenBuffers(ScreenBuffer[] sb)
This does not update the FRAME-VALUE, FRAME-FIELD, FRAME-NAME functions.
sb
- The screen buffer array to process.private static void handleScreenBuffers(ScreenBuffer[] sb, int indexStart)
This does not update the FRAME-VALUE, FRAME-FIELD, FRAME-NAME functions.
sb
- The screen buffer array to process.indexStart
- The array index to start handling -1 means starting with 0.private EventList prepareEventList(GenericFrame frame, EventList wait)
frame
- The frame to be edited.wait
- List of events to wait for or null
for the
default.private void processCondition(ConditionException ce)
ce
- The exception to process.public static WindowWidget createWindow()
public static GenericFrame defaultFrame()
public static decimal getHeightChars()
public static void setHeightChars(NumberType h)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.h
- Not used.public static void setHeightChars(double h)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.h
- Not used.public static decimal getWidthChars()
public static void setWidthChars(NumberType h)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.h
- Not used.public static void setWidthChars(double h)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.h
- Not used.public static integer getWidthPixels()
public static void setWidthPixels(NumberType widthPixels)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.widthPixels
- Not used.public static void setWidthPixels(int widthPixels)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.widthPixels
- Not used.public static integer getHeightPixels()
public static void setHeightPixels(NumberType heightPixels)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.heightPixels
- Not used.public static void setHeightPixels(int heightPixels)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.heightPixels
- Not used.public static integer getWorkAreaX()
public static void setWorkAreaX(NumberType x)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.x
- Not used.public static integer getWorkAreaY()
public static void setWorkAreaY(NumberType y)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.y
- Not used.public static integer getWorkAreaWidthPixels()
public static void setWorkAreaWidthPixels(NumberType widthPixels)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.widthPixels
- Not used.public static integer getWorkAreaHeightPixels()
public static void setWorkAreaHeightPixels(NumberType heightPixels)
SessionUtils.readOnlyError(java.lang.String)
to display appropriate error message.heightPixels
- Not used.public static character getDisplayType()
SESSION:DISPLAY-TYPE
system handle attribute.public static logical is3D()
public static void set3D(logical value)
value
- The value to set.public static void setProcCurrentWindow(handle phandle, handle cWinHandle)
phandle
- Procedure handle.cWinHandle
- handle to the Window reference.private static Color color(ColorSpec cs, ColorSpec defaultColorspec)
cs
- Color specification.defaultColorspec
- Logical terminal instance.public static int getFunctionKey()
public static java.lang.Integer getEventX()
public static java.lang.Integer getEventY()
static void registerWindow(WindowConfig config, WindowWidget window)
config
- Window configuration.window
- The new created window widget.static java.util.List<WindowWidget> findDirectChildren(WindowWidget parent)
parent
- The parent window.static void deregisterWindow(WindowWidget window)
window
- The deleted window widget.public static boolean canUnloadEnvironment(java.lang.String envName)
envName
- Environment name.true
if exist at least one windows having assigned the specified
environment true
otherwise.static void registerWidget(GenericWidget<?> widget, int widgetId)
widget
- Widget object to register.widgetId
- The integer ID to associate with new widget.static void deregisterWidget(int widgetId)
widgetId
- The integer ID of widget to remove from the map.public static ClientExports getClient()
ClientExports
for this session.public static int getColor(java.lang.String envName, int index)
envName
- Environment name.index
- Color table index.public static ColorTableEntry[] readSystemColorTable()
public static ColorTable.EnvironmentColorTable readColorTable(java.lang.String envName)
envName
- Environment name. Could be null
if is default environment.public static void synch(ColorTable.EnvironmentColorTable ect)
ect
- Color table to synchronizepublic static boolean getSessionTooltips()
true
if tooltips are available for this session
false
otherwise.public static java.lang.String[] getProgressStackTrace()
public static ServerReturnValue invoke(InvocationRequestPayload request)
request
- The details about the request.public static UnformattedPayload remoteCall(UnformattedPayload request)
This API is expected to block waiting for a response.
request
- The request data incoming from 4GL.public static void publish(ExternalResource res, java.lang.String event, java.lang.String[] param, boolean delayed)
res
- The external resource which needs to be notified of this PUBLISH event.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.public static void deleteHandle(long handleId)
Only external programs ran by the embedded side and external resources
can be deleted via this API.
handleId
- The handle ID of the resource.public static long subscribeExternal(boolean global, java.lang.Long subscriber, java.lang.String event, java.lang.Long publisher)
global
- Flag indicating if the subscription is for global (cross-session) events.subscriber
- The resource to notify when the specified event is published. If null
,
a ExternalResource
will be built and its ID return.event
- The name of the event which is being published.publisher
- The handle representing the program or resource that is the source of the event.
If specified, the named event will only cause a notification if the event source
matches this handle. null
represents the ANYWHERE
option
which means that the events will not be filtered by source.public static void unsubscribeExternal(boolean global, java.lang.Long subscriber, java.lang.String event, java.lang.Long publisher)
ErrorManager.silentErrorEnable()
/ErrorManager.silentErrorDisable()
bracket, as the UNSUBSCRIBE
statement is executed with a default NO-ERROR
clause.global
- Flag indicating if the search is done in the global (cross-session) event register.subscriber
- The resource whose subscription is to be deleted. Must not be null
.event
- The name of the event which is being published. If this is null
, then
subscriptions to all events will be deleted.publisher
- The procedure or resource handle representing the source of the event.
If specified, the subscription will only be deleted if the event source matches
this handle. null
represents the ALL
option which means
that the events will not be filtered by source. When null
, it means
that the publisher was not set.public static void publishExternal(java.lang.String event, long publisher, java.lang.String[] args)
All processing is done with silent error mode implicitly enabled.
The subscriptions are fired in the order they were subscribed. Although 4GL documentation specifically states, that "If a named event has multiple subscribers, the order in which the AVM notifies subscribers is undefined.", the actual 4GL implementation (OpenEdge 10.2B) does fire the events in the order the subscriptions get subscribed.
event
- The name of the event which is being published.publisher
- The procedure or resource handle representing the program that is the source of
the event. Must not be null
.args
- The parameters passed to the subscriber. May be null
to represent no
parameters. When null
, it means that no parameters were specified for
this call.public static long createExternal()
external resource
to be used by a remote, non P2J, side.public static void refreshBuffers(ScreenBuffer[] buffer)
buffer
- The buffer array data to be refreshed. May be null
.private static java.util.List<java.lang.Integer> extractWidgetIDs(java.util.Collection<GenericWidget<?>> widgets)
widgets
- Input collection of widgets.public static int targetWindowWorker(GenericFrame frame, handle hWin, boolean ignoreThisProc)
frame
- A frame used in current operation (for example ENABLE, VIEW and so on).hWin
- Target window for IN WINDOW clause. null
means get default window.ignoreThisProc
- true
if concrete operation ignores THIS-PROCEDURE:CURRENT-WINDOW.WindowConfig.RESOLVE_WINDOW
.public static int targetWindowWorker(handle hWin, boolean ignoreThisProc)
hWin
- Target window for IN WINDOUW clause. null
means get default window.ignoreThisProc
- true
if concrete operation ignores THIS-PROCEDURE:CURRENT-WINDOW.WindowConfig.RESOLVE_WINDOW
.private static WindowWidget targetWindowWorkerInt(handle hWin, boolean ignoreThisProc, boolean checkRealized)
hWin
- Target window for IN WINDOUW clause. null
means get default window.ignoreThisProc
- true
if concrete operation ignores THIS-PROCEDURE:CURRENT-WINDOW.checkRealized
- true
means necessity to check if target window is realized.
If window is realized - it is used as a result.
false
means that there is not necessity to check if window is visible.
For example, if hWin = null && !ignoreThisProc
then
THIS-PROCEDURE:CURRENT-WINDOW is returned in spite of whether it realized or not.private static boolean isWindowRealized(WindowWidget winHandle)
winHandle
- A handle of window to check.true
if realized, false
otherwise.protected static WindowWidget getWindowById(int id)
id
- valid window id.java.lang.IllegalArgumentException
- If there is not window with this id exists.public static CoordinatesConversion coordinates()
private static void applyToHandleError(boolean invalidHandle)
invalidHandle
- When true
error 3135 is also shown; otherwise, only the 3190 error
is shown.private static void view(int widgetId, ScreenBuffer[] frameBuf, int[] widgetIds, boolean viewDisp, int windowId)
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.viewDisp
- true
if the call is for VIEW, false
for DISPLAY.windowId
- Id of target window or WindowConfig.RESOLVE_WINDOW
for
current or default window.public static boolean editorReadFile(int wId, java.lang.String fileName)
wId
- A valid editor widget id.fileName
- The file name to be loaded on client side.TRUE
if operation successful FALSE
otherwise.public static boolean editorSaveFile(int wId, java.lang.String fileName)
wId
- A valid editor widget id.fileName
- The file name to be saved on client side.TRUE
if operation successful FALSE
otherwise.public static void debug(int id, java.lang.String message)
id
- widget idmessage
- String parameterpublic static java.lang.Boolean moveToTop(int id)
id
- widget idBoolean.TRUE
if operation was successful
null if no widget with given id is foundpublic static java.lang.Boolean moveToBottom(int id)
id
- widget idBoolean.TRUE
if operation was successful
null if no widget with given id is foundpublic static void setImmediateDisplay(boolean on)
on
- The new state for SESSION:IMMEDIATE-DISPLAY attribute.public static logical isImmediateDisplay()
public static void setDataEntryReturn(boolean on)
on
- The new state for SESSION:DATA-ENTRY-RETURN attribute.public static logical _isDataEntryReturn()
public static void setUsesAlertBoxes(boolean on)
on
- The new state for SESSION:APPL-ALERT-BOXES attribute.public static logical _isUsingAlertBoxes()
public static java.util.Map<java.lang.Integer,ColorRgb> getThemeSystemPalette()
ThemeManager.getCurrentTheme().getDefaultSystemPalette()
remotely, on the client.public static void clientLog(java.lang.String message, java.lang.String[] stack)
message
- the messagestack
- the Progress stack tracepublic static void setRowDisplayDrawListener(RowDisplayDrawListener listener)
private java.lang.Object invokeOnServer(ServerReturnValue srv, java.util.function.Supplier<java.lang.Object> code)
srv
- The instance where to save the trigger differences.code
- The code to be executed.private static void notifyRowDisplayDrawListener()