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

java.lang.Object
- com.goldencode.p2j.ui.GenericFrame

All Implemented Interfaces:

CommonFrame, Finalizable, IterableResource, Sizeable, java.lang.reflect.InvocationHandler
```
public class GenericFrame
extends java.lang.Object
implements java.lang.reflect.InvocationHandler, CommonFrame, Finalizable
```
This class implements a frame factory method which produces instances of interfaces generated at conversion time.
The implementation is based on the GCD dynamic proxy library. Factory generated instances are proxies. They forward method calls back to this class.
The forwarded methods are:
- widget value getters;
- widget value setters;
- widget accessors;
Widgets corresponds to either single variables or those defined in Progress as having extents (arrays).
Arrays implement two types of methods: for single individually named elements or for generic names that require a runtime calculated index.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private class`	`GenericFrame.AggregateHandler` Manages `AggregatorElements` associated with the enclosing frame instance.
`private class`	`GenericFrame.EditingCleaner` Provides a cleanup mechanism for editing blocks that exits abnormally (without a natural exit via `continueEditing(com.goldencode.p2j.ui.FrameElement[], boolean)`).
`private static interface`	`GenericFrame.WidgetCheck<One,Two>` Simple functional interface which accepts two parameters and returns a boolean.

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`afterDown` Set to `true` if last operation was DOWN.
`private boolean`	`afterUnderline` Set to `true` if last down() was internal underline() call.
`private GenericFrame.AggregateHandler`	`aggregateHandler` The aggregate handler currently active for this frame
`private boolean`	`batch` batch modifications flag
`private boolean`	`canHide` Can hide other frames.
`private java.lang.Class<?>`	`configClass` class of the frame configuration implementation class
`private java.lang.Object`	`configInstance` instance of the frame configuration implementation class
`private FieldGroup`	`currentFieldGroup` The current field-group.
`private int`	`currentOp` Identifies type of editing block (PROMPT_FOR, SET or UPDATE).
`private UIStatement`	`currentStatement` The current UI statement in use for this frame.
`private boolean`	`defaultFrame` `true` for a default frame (a static frame without name)
`private FrameElement[]`	`deferredAggregators` List of aggregators, deferred to be registered on the first iteration.
`private int`	`dynamicDown` Dynamic DOWN value.
`private Resolvable`	`dynColumn` Callback expression for the frame column.
`private Resolvable`	`dynDown` Callback expression for the number of iterations in a down frame.
`private Resolvable`	`dynRow` Callback expression for the frame row.
`private CharacterExpression`	`dynTitle` The registered storage for the current frame title.
`private java.lang.Object`	`editLock` Lock object for synchronization of shared editing block data.
`private static java.lang.String`	`ENABLE_INPUT_REDIRECTED` Error message for enable statement during input redirection.
`private ErrorManager.ErrorHelper`	`errHlp` Context-local error state.
`private FieldGroup`	`fieldGroup` The first field group in the frame (holds all non-header widgets).
`private boolean`	`finalCheck` Final format check control.
`private boolean`	`flushed` Track frame data flushing in redirected mode.
`private java.util.Set<java.lang.Integer>`	`formatFilter` Widget IDs stored in this map are not checked for formatting errors.
`private FrameWidget`	`frame` frame config
`private ScreenBuffer`	`frameBuf` screen buffer for this frame
`private ScreenDefinition`	`frameDef` frame definition
`private int`	`frameId` frame ID
`private java.lang.String`	`frameName` legacy frame name as found in the 4GL with case-preserved.
`private boolean`	`framePlacing` Flag indicating we are inside a `placeFrame()` call.
`private boolean`	`hadCondition` Track presence of condition during frame processing.
`private boolean`	`hadView` Set to true when frame is viewed first time.
`private FrameElement[]`	`headers` Frame headers.
`private boolean`	`insideSetup` Set to `true` when frame is initialized by appropriate `Settable` instance.
`private static int`	`INVOKE_ACCESS` proxy accessor call
`private static int`	`INVOKE_GET` proxy getter call
`private static int`	`INVOKE_SET` proxy setter call
`private FieldGroup`	`literalFieldGroup` The field-group for the literal widget
`private static CentralLogger`	`LOG` logger
`private java.util.Map<java.lang.String,GenericWidget<?>>`	`n2b` Maps background widget names to widget instances (from the frame definition).
`private java.util.Map<java.lang.String,GenericWidget<?>>`	`n2h` Maps header widget names to widget instances (from the frame definition).
`private java.util.Map<java.lang.String,java.lang.String>`	`n2n` Maps converted widget names to original ones
`private java.util.Map<java.lang.String,GenericWidget<?>>`	`n2w` Maps widget names to widget instances (from the frame definition).
`private static java.lang.String`	`NO_INPUT_SOURCE_ATTEMPT` Error message for set/prompt-for statements in batch mode.
`private static java.lang.String`	`NO_OUTPUT_DESTINATION_ATTEMPT` Error message for output related statements in batch mode.
`private int`	`pendingUpDown` Keeps state of the conditional DOWN and/or UP cursor movements.
`private Stream`	`redirOut` Stream to which redirected aggregator element output is sent
`private java.util.Map<java.lang.Integer,FieldGroup>`	`rows2fg` The mapping from row number to corresponding field-group
`private boolean`	`sameViewDataRedirected` Track whether we change data from one iteration to another
`private int`	`scopeNesting` Nesting scope counter.
`private java.util.Map<java.lang.Integer,ScreenBuffer>`	`screenBufferCache` A screen-buffer cache to be used with a down frame.
`private boolean`	`shared` Shared flame flag.
`private boolean`	`silentFormatErrors` Second and subsequent formatting errors are suppressed.
`private GenericWidget<?>`	`statsColumn` The widget used for displaying a statistic's description.
`private java.util.List<FrameElement>`	`textGroup` List of widgets in text groups in current editing block.
`private int`	`triggerActive` Track implicit validation nesting.
`private GenericWidget<?>[]`	`widgets` List of widgets in ID order.

Fields inherited from interface com.goldencode.p2j.ui.CommonFrame
NONE, PROMPT_FOR, SET, UPDATE

Constructor Summary

Constructors
Modifier Constructor and Description

protected GenericFrame()
Default constructor; creates a new instance of a frame.

Constructors
Modifier	Constructor and Description
`protected`	`GenericFrame()` Default constructor; creates a new instance of a frame.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`_getName()` Get frame name.
`boolean`	`_isVisible()` Gets the VISIBLE attribute of the frame.
`void`	`_setName(java.lang.String name)` Set frame name.
`(package private) void`	`addDynamicWidget(GenericWidget<?> dynWidget)` Adding new dynamic widget to the current frame.
`private void`	`addScreenBufferToCache(ScreenBuffer buff, int row)` Adds a screen buffer instance to the cache for the specified row.
`(package private) void`	`addWidget(GenericWidget<?> widget)` Adding new widget to the current frame.
`private java.util.List<GenericWidget<?>>`	`allWidgets()` Get all the widgets associated with this frame.
`void`	`apply(character event)` Applies an event to the widget in focus.
`void`	`apply(double eventCode)` Applies an event to the widget in focus.
`void`	`apply(integer eventCode)` Applies an event to the widget in focus.
`void`	`apply(java.lang.String event)` Applies an event to the widget in focus.
`void`	`assignScreenValue(FrameElement data)` Obtain the current value in the screen buffer for the given widget and assign this into the backing variable.
`FrameWidget`	`asWidget()` Get this frame as instance of `GenericFrame`.
`handle`	`asWidgetHandle()` Get this frame wrapped in a handle.
`void`	`batch(boolean on)` Sets batching mode for frame modification.
`void`	`batch(boolean on, boolean force)` Sets batching mode for frame modification and optionally pushes the screen definition to the client.
`private void`	`checkFieldGroup(GenericWidget<?> widget)` Check the widget's FIELD-GROUP and log a message if is not part of CURRENT-ITERATION.
`void`	`choose(Choose c)` Performs CHOOSE processing.
`void`	`choose(Choose c, ColorSpec cs)` Performs CHOOSE processing.
`void`	`cleanNonTabItems()` Remove from the list of tab items the items that became non-tab items.
`void`	`clear(boolean noPause)` Clears the data and colors for all fill-in fields of the frame.
`void`	`clearAll(boolean noPause)` Clears all occurrences for the down frame and resets the current display position to the top of the frame.
`private void`	`conditionalUpDown()` Executes delayed conditional cursor movement.
`private void`	`conditionalUpDown(boolean force)` Executes delayed conditional cursor movement.
`boolean`	`continueEditing(FrameElement[] list, boolean hadNext)` Checks to see whether a pending GO event is about to end the editing block.
`java.lang.Object`	`convertScreenValue(java.lang.Class<?> dataType, java.lang.Object value, java.lang.String format)` Convert given value into proper form for further conversion onto SCREEN-VALUE.
`private void`	`copyFromScreenBuffer(FrameElement[] data, boolean defaults, boolean calledBySet)` Get the value in the screen buffer for each widget using the widget id as the index, then assign this back to the variable from the caller.
`private void`	`copyToScreenBuffer(FrameElement[] data)` Set each value in the screen buffer for each widget using the widget id as the index.
`private boolean`	`coreInitialize(java.lang.Class<?> configClass, java.lang.Object configInstance, java.lang.String frameName, boolean dynamic)` Core initialization processing.
`static <T extends CommonFrame> T`	`createDynamicFrame(java.lang.Class<T> iface, FrameWidget frameWidget)` Creates new dynamic frame as a proxy object (as a local resource).
`private void`	`createFieldGroup()` Creates and initializes the new field group and returns it.
`static <T extends CommonFrame> T`	`createFrame(java.lang.Class<T> iface, java.lang.String name)` Creates new frame as a proxy object (as a local resource).
`private static <T extends CommonFrame> T`	`createFrameProxy(java.lang.Class<T> iface)` Create and initialize a frame as a proxy object, loading the static frame definition.
`private LiteralWidget`	`createLiteralWidget(GenericWidget<?> widget, java.lang.String txt)` Create a LITERAL widget to be added to the `literalFieldGroup`.
`static <T extends CommonFrame> T`	`createSharedFrame(java.lang.Class<T> iface, java.lang.String name)` Creates new frame as a proxy object and exports that new frame as a shared resource (non-global).
`handle`	`currentIteration()` Conversion of CURRENT-ITERATION attribute (KW_CUR_ITER) of frame widget.
`void`	`deleted()` This is a no-op.
`(package private) void`	`deleteDynamicWidget(GenericWidget<?> dynWidget)` Removing dynamic widget from the current frame.
`(package private) void`	`deleteDynamicWidget(GenericWidget<?> dynWidget, boolean pushScreenDefinitions)` Removing dynamic widget from the current frame.
`(package private) void`	`deleteFieldGroups()` Delete all field-groups created for this frame.
`void`	`destroy()` Final cleanups when frame completely leaves outer execute() scope (only occurs once for a frame, even if this is a shared frame which has nested `openScope()` invocations).
`void`	`disable()` Disables input for all field-level widgets of the frame.
`void`	`disable(FrameElement[] list)` Disables input for the given field-level widgets of the frame.
`void`	`disable(GenericWidget<?>[] list)` Disables input for the given field-level widgets of the frame.
`void`	`disableExcept(GenericWidget<?> widget)` Disables input for all field-level widgets of the frame, except the specified one.
`void`	`disableExcept(GenericWidget<?>[] xcpt)` Disables input for all field-level widgets of the frame, except the specified ones.
`void`	`disableUnlessHidden()` Disables input for all field-level widgets of the frame.
`void`	`disableUnlessHidden(FrameElement[] list)` Disables input for the given field-level widgets of the frame.
`void`	`disableUnlessHidden(GenericWidget<?>[] list)` Disables input for the given field-level widgets of the frame.
`void`	`display()` Displays a frame with no "data container" fields on the screen.
`void`	`display(BrowseWidget browse)` Refresh specified browse widget.
`void`	`display(BrowseWidget browse, handle hWin)` Refresh specified browse widget.
`void`	`display(FrameElement[] data)` Displays a list of fields from the frame on the screen.
`void`	`display(FrameElement[] data, handle hWin)` Displays a list of fields from the frame on the screen.
`void`	`display(handle hWin)` Displays a frame with no "data container" fields on the screen.
`void`	`display(Stream out)` Displays (writes) non-data-containing fields from the frame to the given stream.
`void`	`display(Stream out, FrameElement[] data)` Displays (writes) a list of fields from the frame on the given stream.
`private void`	`display(Stream out, FrameElement[] data, boolean windowClause, handle hWin)` Displays (writes) a list of fields from the frame on the given stream.
`void`	`display(Stream out, FrameElement[] data, handle hWin)` Displays (writes) a list of fields from the frame on the given stream.
`void`	`display(Stream out, handle hWin)` Displays (writes) non-data-containing fields from the frame to the given stream.
`void`	`displayAndDown()` Support for the DISPLAY followed by the DOWN combination.
`void`	`displayAndDown(FrameElement[] data)` Support for the DISPLAY followed by the DOWN combination.
`void`	`displayAndDown(Stream out)` Support for the DISPLAY STREAM ...
`void`	`displayAndDown(Stream out, FrameElement[] data)` Support for the DISPLAY STREAM ...
`private void`	`displayAndDownWorker(Stream out, FrameElement[] data)` Support for the DISPLAY STREAM ...
`void`	`displayUnlessHidden()` Displays this frame (emulates a view) unless it is hidden.
`void`	`displayUnlessHidden(FrameElement[] data)` Displays a list of fields from the frame on the screen.
`private void`	`displayUnlessHidden(FrameElement[] data, boolean windowClause, handle hWin)` Displays a list of fields from the frame on the screen.
`void`	`displayUnlessHidden(FrameElement[] data, handle hWin)` Displays a list of fields from the frame on the screen.
`void`	`displayUnlessHiddenAndDown()` Support for the DISPLAY UNLESS HIDDEN followed by the DOWN combination.
`void`	`displayUnlessHiddenAndDown(FrameElement[] data)` Support for the DISPLAY UNLESS HIDDEN followed by the DOWN combination.
`private void`	`displayWorker(FrameElement[] data, boolean windowClause, handle hWin)` Displays a list of fields from the frame on the screen.
`void`	`down()` Positions the cursor on a new line in a down frame.
`void`	`down(double lines)` Positions the cursor on a new line in a down frame.
`void`	`down(NumberType lines)` Positions the cursor on a new line in a down frame.
`void`	`down(Stream out)` Writes a single new-line to the given stream.
`void`	`down(Stream out, double lines)` Writes `lines` number of new-lines to the given stream.
`void`	`down(Stream out, NumberType lines)` Writes `lines` number of new-lines to the given stream.
`private void`	`downInt()` Positions the cursor on a new line in a down frame.
`private void`	`downWorker(int lines, boolean cond)` DOWN worker routine for the unnamed stream, redirected or not.
`private void`	`downWorker(int lines, int id, boolean cond, boolean endOut)` DOWN worker routine for named streams.
`void`	`enable()` Enables input for all field-level widgets of the frame.
`void`	`enable(FrameElement[] list)` Enables input for the given field-level widgets of the frame.
`void`	`enable(FrameElement[] list, handle hWin)` Enables input for the given field-level widgets of the frame.
`void`	`enable(GenericWidget<?>[] list)` Enables input for the given field-level widgets of the frame.
`private void`	`enable(GenericWidget<?>[] list, boolean windowClause, handle hWin)` Enables input for the given field-level widgets of the frame.
`void`	`enable(GenericWidget<?>[] list, handle hWin)` Enables input for the given field-level widgets of the frame.
`void`	`enable(handle hWin)` Enables input for all field-level widgets of the frame.
`void`	`enableExcept(GenericWidget<?> widget)` Enables input for all field-level widgets of the frame, except the specified one.
`void`	`enableExcept(GenericWidget<?>[] xcpt)` Enables input for all field-level widgets of the frame, except the specified ones.
`void`	`enableExcept(GenericWidget<?>[] all, GenericWidget<?>[] xcpt, boolean windowClause, handle hWin)` Enables input for given field-level widgets of the frame, except the specified ones.
`void`	`enableExcept(GenericWidget<?>[] xcpt, handle hWin)` Enables input for all field-level widgets of the frame, except the specified ones.
`void`	`enableExcept(GenericWidget<?> widget, handle hWin)` Enables input for all field-level widgets of the frame, except the specified one.
`private void`	`enableFinalFormatCheck()` Enable format check at the end of input loop.
`void`	`enableUnlessHidden()` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHidden(FrameElement[] list)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHidden(FrameElement[] list, handle hWin)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHidden(GenericWidget<?> widget)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHidden(GenericWidget<?>[] list)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHidden(GenericWidget<?>[] list, handle hWin)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHidden(GenericWidget<?> widget, handle hWin)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHiddenExcept(GenericWidget<?> widget)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHiddenExcept(GenericWidget<?>[] xcpt)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHiddenExcept(GenericWidget<?>[] xcpt, handle hWin)` Enables input for the given field-level widgets of the frame.
`void`	`enableUnlessHiddenExcept(GenericWidget<?> widget, handle hWin)` Enables input for the given field-level widgets of the frame.
`private boolean`	`errorOnBatchModeEnable(int num, java.lang.String txt)` Raise an error condition with the given error number and text IF unnamed input has been redirected.
`private boolean`	`errorOnBatchModeSetPrompt(int num, java.lang.String txt)` Raise an error condition with the given error number and text IF unnamed input has been redirected.
`private boolean`	`errorOnRedirectedInput(int num, java.lang.String txt)` Raise an error condition with the given error number and text IF unnamed input has been redirected.
`(package private) void`	`finishConfigProcessing()` Finish the config processing for this frame.
`void`	`finished()` Cleanup that must occur at the end of the block to which the frame is scoped.
`private void`	`finishSetup(boolean withHidden, boolean recursive)` Finish initialization for all widgets in the frame: `GenericWidget.finishSetup()` is called for each widget.
`handle`	`firstChild()` Get the first child of the frame which will be the field group that contains all non-header widgets.
`(package private) void`	`frameCleanup()` Cleanup this frame, as it was deleted.
`decimal`	`frameCol()` Returns the column position of the left corner of the frame within its window.
`(package private) void`	`frameDelete()` Delete this frame, if is not dynamic and its associated instantiated procedure no longer exists.
`integer`	`frameDown()` Returns the number of iterations in a down frame.
`integer`	`frameLine()` Returns the current logical line number in a frame.
`private int`	`frameLineWorker()` Returns the current logical line number in a frame.
`decimal`	`frameRow()` Returns the row position of the upper-left corner of the frame within its window.
`private java.lang.String`	`generateWidgetName(java.lang.String base, int op, java.lang.Object index)` Generate an indexed widget name from a simple base name and a numeric object that represents the index.
`integer`	`getBgColor()` Get display color.
`integer`	`getBgColorRgb()` Get display color RGB option.
`decimal`	`getColumn()` Returns the column position of the upper-left corner of the frame within its window (in coordinates that are relative to the containing window).
`private static java.lang.Object`	`getConfigInstance(java.lang.Class<?> iface)` Retrieve the frame definition class and create and return a new instance of this class.
`private java.lang.String`	`getDynamicWidgetName(GenericWidget<?> dynWidget)` Construct the string name for dynamic widget based on unique ID number.
`integer`	`getFgColor()` Get input (prompt-for) color.
`integer`	`getFgColorRgb()` Get input (prompt-for) color RGB option.
`private java.lang.Integer`	`getFGRow(handle groupHandle)` This method searches the frame row for specified field-group.
`(package private) static boolean`	`getField(Stream in, Accessor data, ScreenBuffer frameBuf, GenericWidget<?> wid, java.lang.String fmt, boolean assign)` Read the next field from the given stream using any whitespace as the delimiter and validate the data against the widget's format string before assigning the data into the screen-buffer and back to the user's variable.
`(package private) FieldGroup`	`getFieldGroup()` Returns the frame's field group.
`integer`	`getFont()` Get the FONT specification of this frame.
`ScreenBuffer`	`getFrameBuffer(boolean force)` Gets the differential screen buffer of this frame.
`ScreenBuffer`	`getFrameBufferRaw()` Gets the screen buffer reference for this frame, without any update to dynamic content.
`handle`	`getFrameHandle()` Gets "parent" frame for this frame.
`int`	`getFrameId()` Gets the unique numeric ID of this frame.
`FrameWidget`	`getFrameWidget()` Gets the frame widget of this frame.
`(package private) int`	`getFrameWidgetId(GenericWidget<?> widget)` Returns -1 if the widget is invalid, otherwise it returns the assigned widget ID.
`(package private) GenericWidget<?>`	`getHeaderWidgetForId(int id)` Looks up the header widget by its ID.
`decimal`	`getHeight()` Get the HEIGHT Progress attribute.
`decimal`	`getHeightChars()` Returns the height of the widget.
`integer`	`getHeightPixels()` Returns the width of the widget in pixels.
`integer`	`getHWND()` Gets the integer value of the window containing the widget.
`handle`	`getIteration(int level)` Implements the GET-ITERATION() widget method.
`java.lang.String`	`getName(GenericWidget<?> widget)` Get widget name for the given widget.
`handle`	`getNextTabItem()` Getting the NEXT-TAB-ITEM attribute.
`java.lang.String`	`getOriginalName(GenericWidget<?> widget)` Get original widget name for the given widget.
`boolean`	`getPageBottom()` Gets the PAGE-BOTTOM option.
`boolean`	`getPageTop()` Gets the PAGE-TOP option.
`handle`	`getParentHandle()` Get the PARENT option.
`handle`	`getPreviousTabItem()` Getting the PREV-TAB-ITEM attribute.
`Stream`	`getRedirOut()` Getter for the redirOut field.
`(package private) int`	`getRemoteStreamId(Stream out)` Dereferences the given stream to find and return the remote stream ID.
`decimal`	`getRow()` Returns the row position of the upper-left corner of the frame within its window (in coordinates that are relative to the containing window).
`(package private) int`	`getScopeNesting()` Get the current scope nesting.
`private ScreenBuffer`	`getScreenBufferFromCache(int row)` Gets the screen buffer associated for this row.
`character`	`getScreenValue(GenericWidget<?> widget)` Obtain the current value in the screen buffer of the backing data for the given widget and return it as a `character` type.
`character`	`getScreenValue(GenericWidget<?> widget, boolean ignoreFormat)` Obtain the current value in the screen buffer of the backing data for the given widget and return it as a `character` type.
`int[]`	`getSelection(GenericWidget<?> widget)` Request indexes of selected items in RadioSet, ComboBox or SelectionList widgets.
`UIStatement`	`getStatement()` Get the `currentStatement`.
`int[]`	`getStaticWidgetIds(boolean headerWidgetsIncluded)` Create an array of widgets in this frame that are static including possible header ones.
`int[]`	`getTabItemsList()` Gets the current tab item list.
`(package private) java.lang.Object`	`getter(int widgetId, java.lang.Class<?> dataType, boolean defaults, boolean validate)` Returns the current screen value of the specified widget.
`private java.lang.Object`	`getter(java.lang.String widgetName, java.lang.Class<?> dataType)` Returns the current screen value of the specified widget.
`character`	`getTitle()` Gets the frame title.
`java.util.Set<GenericWidget<?>>`	`getValidationSet()` Gets a set of widgets of this frame that require validation.
`private GenericWidget<?>`	`getWidget(java.lang.String widgetName, int op, int numArgs, java.lang.Object index)` Core widget accessor processing, which handles the various widget name forms and the lookup of the widget including proper processing of array elements.
`private GenericWidget<?>`	`getWidgetByName(java.lang.String name)` Simple helper to lookup a widget by a given name.
`(package private) GenericWidget<?>`	`getWidgetForId(int id)` Looks up the widget by its ID.
`(package private) int`	`getWidgetId(GenericWidget<?> widget)` Returns -1 if the widget is invalid or `null`, otherwise it returns the assigned widget ID.
`(package private) int`	`getWidgetId(java.lang.String widgetName)` Returns -1 if the widget name is invalid or `null`, otherwise it returns the assigned widget ID.
`decimal`	`getWidth()` Get the WIDTH Progress attribute.
`decimal`	`getWidthChars()` Returns the width of the widget.
`integer`	`getWidthPixels()` Returns the width of the widget in pixels.
`(package private) int`	`getWindowId()` Get an ID of window owning this frame or -1 when there is no owning window.
`integer`	`getX()` Returns the horisontal position of the frame.
`integer`	`getY()` Returns the vertical position of the frame.
`boolean`	`hasFieldGroup()` Tests if the field group is initialized for this frame.
`void`	`hide()` Makes the frame invisible with the default pause.
`void`	`hide(boolean noPause)` Makes the frame invisible.
`void`	`hide(FrameElement[] data)` Makes widgets in the frame invisible.
`void`	`hide(FrameElement[] data, boolean noPause)` Makes widgets in the frame invisible.
`void`	`hide(FrameElement[] data, handle hWin)` Makes widgets in the frame invisible.
`void`	`hide(FrameElement[] data, handle hWin, boolean noPause)` Makes widgets in the frame invisible.
`void`	`hide(handle hWin)` Makes the frame invisible with the default pause.
`void`	`hide(handle hWin, boolean noPause)` Makes the frame invisible.
`void`	`hide(Stream out, boolean noPause)` If the frame is a PAGE-TOP or PAGE-BOTTOM and the stream is paged, the frame is removed from the list of those used for the header or footer.
`void`	`hide(Stream out, handle hWin, boolean noPause)` If the frame is a PAGE-TOP or PAGE-BOTTOM and the stream is paged, the frame is removed from the list of those used for the header or footer.
`(package private) void`	`hideWorker(boolean noPause, boolean hidden)` A worker to perform frame hide.
`private int[]`	`idSetToArray(java.util.Set<java.lang.Integer> widgetIds)` Converts the given set of `Integer` values into an array of primitive `int`.
`private int[]`	`idsFromWidgets(GenericWidget<?>[] widgets)` Converts a widget array into an array of widget IDs.
`static <T extends CommonFrame> T`	`importSharedFrame(java.lang.Class<T> iface, java.lang.String name)` Import an existing frame as a proxy object from the shared resource manager.
`private java.lang.String`	`indexAsString(java.lang.Object index)` Takes a numeric type (`NumberType`, `Integer` or `Double`) and converts this into a string that can be used as a name component for a widget getter/setter/accessor.
`private void`	`initBackgroundGroup()` Create BACKGROUND field group for the frame and add background widgets to it, if any.
`private void`	`initialize(java.lang.Class<?> configClass, java.lang.Object configInstance, java.lang.String frameName)` Full initialization processing.
`private void`	`initializeEmptyFrame(java.lang.Class<?> configClass, java.lang.Object configInstance, FrameWidget frameWidget)` Full initialization processing for empty frame.
`private static <T extends CommonFrame> void`	`initializeNewFrame(GenericFrame frame, java.lang.Class<T> iface, java.lang.String name, FrameWidget frameWidget, boolean dynamic)` Initialize the frame and register it with the transaction manager.
`private FieldGroup`	`initLiteralFG()` Literal field group initialization procedure.
`private void`	`initScreenDefinition()` Unconditionally initializes the frame's screen definition.
`java.lang.Object`	`invoke(java.lang.Object proxy, java.lang.reflect.Method method, java.lang.Object[] args)` This method acts as an interceptor which is called every time a method of the proxy object is invoked.
`private boolean`	`isAbleToDisplayWindow(handle hWin)` Checks if the parameter - valid window handle.
`boolean`	`isBatch()` Queries batching mode for frame modification.
`boolean`	`isCanHide()` Check if frame can hide other frames.
`logical`	`isCarefulPaint()` Get the CAREFUL-PAINT attribute.
`boolean`	`isDialogBox()` Get current state of VIEW-AS DIALOG-BOX option.
`private static boolean`	`isEmptyFormat(java.lang.String s, java.lang.String ignoredTokens)` Utility method used by `parseScreenValue()` method to identify the empty screen values.
`private boolean`	`isFGAssigned(handle groupHandle)` This method checks if the specified field-group is used for some row in this frame.
`(package private) boolean`	`isFlushed()` Return `true` if frame content was flushed since last VIEW.
`logical`	`isHidden()` Queries the HIDDEN attribute of this frame.
`boolean`	`isInsideSetup()` Check if the frame is currently being initialized
`(package private) boolean`	`isOutRedirected()` Reports if there is a cached output stream for use with redirecting the output from aggregation.
`(package private) boolean`	`isOutTerm()` Check if output stream is a terminal.
`(package private) boolean`	`isPageElement(Stream out)` Reports if this frame is a page element (a header or footer).
`(package private) boolean`	`isRealized()` Reports if the frame was already realized.
`(package private) boolean`	`isRedirected()` Reports if the unnamed stream is redirected at this time.
`logical`	`isSensitive()` Queries the SENSITIVE attribute of this frame.
`boolean`	`isShared()` Check if frame is shared.
`boolean`	`isViewed()` Get state of internal flag which is set to `true` if frame was viewed at client at least once.
`logical`	`isVisible()` Gets the VISIBLE attribute of the frame.
`void`	`iterate()` Provides a notification that the block whose scope in which the object is registered is about to iterate and attempt another pass.
`integer`	`line()` Get the current iteration number for down frame.
`private void`	`makeFrameEnable()` Makes the frame and all its field-level widgets enabled and visible.
`private boolean`	`makeFrameEnableImpl()` Makes the frame and all its field-level widgets enabled and visible.
`private void`	`makeFrameVisible()` Makes the frame and all its field-level widgets visible.
`boolean`	`moveAfterTabItem(GenericWidget<?> widget)` This method implements MOVE-AFTER-TAB function.
`void`	`nextPrompt(GenericWidget<?> field)` Specifies the field to be put in focus during the next input operation.
`void`	`openScope()` Notifies the frame about entering a new frame scope.
`static <T extends BaseDataType> T`	`parseFieldValue(java.lang.Class<T> type, character value, java.lang.String format)` Parses field value (i.e.
`static <T extends BaseDataType> T`	`parseScreenValue(java.lang.Class<T> type, character value, java.lang.String format)` Parses screen value (i.e.
`static <T extends BaseDataType> T`	`parseValue(java.lang.Class<T> type, character value, java.lang.String format, boolean fieldValue)` Parses screen/field value (i.e.
`(package private) void`	`placeFrame()` Place the frame.
`private int[]`	`prepareView(FrameElement[] data)` Makes visible specified widgets.
`private void`	`printFieldGroups(int lines)` This method prints field-groups of the frame and is needed only for debugging purposes.
`private void`	`processAggregates(FrameElement[] fe, boolean accumulate)` Processes any aggregator elements in the given array of frame elements.
`private void`	`processStreamInput(Stream in, FrameElement[] wids, boolean assign, boolean windowClause, handle hWin)` Drive the input stream reading process, where each frame element in the list resolves to the read of a field from the stream, a bypass of the field in the stream or an embedded assignment.
`void`	`promptFor(FrameElement[] widgets)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptFor(FrameElement[] widgets, EventList wait)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptFor(FrameElement[] widgets, EventList wait, handle hWin)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptFor(FrameElement[] widgets, handle hWin)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptFor(GenericWidget<?>[] widgets)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptFor(GenericWidget<?>[] widgets, EventList wait)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptFor(GenericWidget<?>[] widgets, EventList wait, handle hWin)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptFor(GenericWidget<?>[] widgets, handle hWin)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptFor(Stream in, FrameElement[] widgets)` For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set.
`void`	`promptFor(Stream in, FrameElement[] widgets, handle hWin)` For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set.
`void`	`promptForUnlessHidden(FrameElement[] widgets)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptForUnlessHidden(FrameElement[] widgets, handle hWin)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptForUnlessHidden(GenericWidget<?>[] widgets)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`void`	`promptForUnlessHidden(GenericWidget<?>[] widgets, handle hWin)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`private void`	`promptForWorker(FrameElement[] widgets, EventList wait, boolean windowClause, handle hWin)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`private void`	`promptForWorker(GenericWidget<?>[] widgets, EventList wait, boolean windowClause, handle hWin)` Enables a list of widgets from the frame on the screen, shifts into input blocking mode via `waitFor()` and after the user's edits are complete the list of widgets are disabled.
`(package private) void`	`pushScreenDefinition()` Conditionally pushes the screen definition instance down to the client.
`(package private) void`	`pushScreenDefinition(boolean force)` Conditionally pushes the screen definition instance down to the client.
`(package private) void`	`refreshDown(int down)` Refresh current DOWN value.
`void`	`registerAccumulators(FrameElement[] fe)` Register all the widgets which need accumulation with this frame.
`void`	`registerHeader(FrameElement[] fe)` Register header frame elements.
`private int[]`	`remainingIds(GenericWidget<?>[] xcpt)` Create an array of all widgets in this frame that are NOT in the given array.
`private int[]`	`remainingIds(GenericWidget<?>[] all, GenericWidget<?>[] xcpt)` Create an array of given widgets in this frame that are NOT in the given array.
`static FrameElement[]`	`removeHiddenWidgets(FrameElement[] inputList)` Removes the widgets with hidden attribute value set as TRUE.
`private GenericWidget<?>[]`	`removeHiddenWidgets(GenericWidget<?>[] inputList)` Removes the widgets with hidden attribute value set as TRUE.
`void`	`removeWidget(GenericWidget<?> widget)` Remove the specified widget from this frame.
`(package private) void`	`resetFlushed()` Reset 'flushed' flag.
`private void`	`resetFrameBuf()` Reset frame buffer.
`void`	`resetStatement()` Set the `currentStatement` back to `null`.
`private void`	`restoreWidgetRegistry()` Restores the widget registry for static content of this frame based on header and non-header widget info.
`void`	`retry()` Provides a notification that the block whose scope in which the object is registered is about to retry and re-attempt the current iteration.
`void`	`scroll(boolean fromCurrent, boolean upDown)` Scrolls the lines of the down frame up or down.
`private void`	`sendWidgetScreenValue(FrameElement[] data)` Set the screen-value for each widget in the given list, if is not hidden.
`void`	`set(FrameElement[] data)` Enables a list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`set(FrameElement[] widgets, EventList wait)` Enables a list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`set(FrameElement[] widgets, EventList wait, handle hWin)` Enables a list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`set(FrameElement[] data, handle hWin)` Enables a list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`set(Stream in, FrameElement[] data)` For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set.
`void`	`set(Stream in, FrameElement[] data, handle hWin)` For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set.
`void`	`setAttrSpace(boolean attr_space)` Sets the ATTR-SPACE option.
`void`	`setBgColor(int color)` Sets the display color.
`void`	`setBgColor(NumberType color)` Sets the display color.
`void`	`setBgColorRgb(int colorRgb)` Sets the display color RGB option.
`void`	`setBgColorRgb(NumberType colorRgb)` Sets the display color RGB option.
`void`	`setCancelButtonOption(GenericWidget<?> cancelButton)` Sets the cancel button for this frame (an option in the frame phrase).
`void`	`setCarefulPaint(boolean careful)` Sets the CAREFUL-PAINTattribute.
`void`	`setCarefulPaint(logical careful)` Sets the CAREFUL-PAINTattribute.
`void`	`setCentered(boolean centered)` Sets the CENTERED option.
`void`	`setColors(ColorSpec display, ColorSpec prompt, GenericWidget<?> widget)` Sets custom colors for the given output field, input field, or both.
`void`	`setColors(ColorSpec display, ColorSpec prompt, GenericWidget<?>[] widgets)` Sets custom colors for output fields, input fields, or both in all specified widgets.
`void`	`setColumn(Accessor column)` Sets the frame column as a callback to read the current value stored in the given `Accessor`.
`void`	`setColumn(double column)` Sets the column position for this frame (statically).
`void`	`setColumn(NumberType column)` Sets the column position for this frame (statically).
`void`	`setColumn(Resolvable column)` Sets the frame column as a callback to read the current value calculated by the given expression.
`void`	`setColumns(int columns)` Sets the number of columns.
`(package private) void`	`setCondition()` Let frame know that there was a condition during frame processing.
`void`	`setCurrentIteration(handle newIter)` Set the CURRENT-ITERATION widget handle for this frame.
`void`	`setDColor(Color color)` Sets the display color.
`void`	`setDColor(ColorSpec cs)` Sets the display color.
`void`	`setDColor(int color)` Sets the display color.
`void`	`setDefaultButtonOption(GenericWidget<?> defaultButton)` Sets the default button for this frame (an option in the frame phrase).
`void`	`setDialogBox(boolean dialogBox)` Sets the VIEW-AS DIALOG-BOX option.
`void`	`setDown(Accessor down)` Sets the size of a DOWN frame as a callback to read the current value stored in the given `Accessor`.
`void`	`setDown(double down)` Sets the size of a DOWN frame (statically).
`void`	`setDown(NumberType down)` Sets the size of a DOWN frame (statically).
`void`	`setDown(Resolvable down)` Sets the size of a DOWN frame as a callback to read the current value calculated by the given expression.
`void`	`setDropTarget(boolean dropTarget)` Sets DROP-TARGET option.
`void`	`setDynamicTitle(Accessor dyntitle)` Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
`void`	`setDynamicTitle(Accessor title, ColorSpec titleColor)` Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
`void`	`setDynamicTitle(BaseDataType title)` Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
`void`	`setDynamicTitle(BaseDataType title, ColorSpec titleColor)` Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
`void`	`setDynamicTitle(CharacterExpression title)` Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
`void`	`setDynamicTitle(CharacterExpression title, ColorSpec titleColor)` Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
`void`	`setFgColor(int color)` Sets the input (prompt-for) color.
`void`	`setFgColor(NumberType color)` Sets the input (prompt-for) color.
`void`	`setFgColorRgb(int colorRgb)` Sets the input (prompt-for) color RGB option.
`void`	`setFgColorRgb(NumberType colorRgb)` Sets the input (prompt-for) color RGB option.
`private void`	`setFieldGroupWidgets(FieldGroup fg, GenericWidget<?>[] widgets)` Add the specified widgets to that FIELD-GROUP.
`void`	`setFont(int64 fontNum)` Set the FONT specification of this frame.
`void`	`setFont(long fontNum)` Set the FONT specification of this frame.
`void`	`setFrame(handle hFrame)` Sets the containing frame instance.
`void`	`setFrameHandle(handle hFrame)` Sets "parent" frame for this frame.
`void`	`setFrameValue(int wid, BaseDataType value)` Set the current value in the screen buffer of the backing data for the given widget.
`void`	`setHadView()` Mark frame as viewed.
`void`	`setHeight(NumberType heightChars)` Set the HEIGHT Progress attribute.
`void`	`setHeightChars(double height)` Sets the height of the widget.
`void`	`setHeightChars(NumberType height)` Sets the height of the widget.
`void`	`setHeightPixels(int heightPixels)` Sets new value of HEIGHT-PIXELS attribute.
`void`	`setHeightPixels(NumberType heightPixels)` Sets new value of HEIGHT-PIXELS attribute.
`void`	`setHidden(boolean hidden)` Sets the HIDDEN writable attribute.
`void`	`setHidden(logical hidden)` Sets the HIDDEN writable attribute.
`void`	`setInsideSetup(boolean flag)` This method will be called by run-time when frame initialization is started and when frame initialization is finished.
`void`	`setKeepTabOrder(boolean keepTabOrder)` Sets the KEEP-TAB-ORDER option.
`void`	`setNoAutoValidate(boolean noAutoValidate)` Sets the NO-AUTO-VALIDATE option.
`void`	`setNoBox(boolean noBox)` Sets the NO-BOX option.
`void`	`setNoHide(boolean noHide)` Sets the NO-HIDE option.
`void`	`setNoLabels(boolean noLabels)` Sets the NO-LABELS option.
`void`	`setNoUnderline(boolean noUnderline)` Sets the NO-UNDERLINE option.
`void`	`setOverlay(boolean overlay)` Sets the OVERLAY option.
`void`	`setPageBottom(boolean pageBottom)` Sets the PAGE-BOTTOM option.
`void`	`setPageTop(boolean pageTop)` Sets the PAGE-TOP option.
`void`	`setParent(GenericWidget<?> widget)` Sets the PARENT option.
`void`	`setPfColor(Color color)` Sets the input (prompt-for) color.
`void`	`setPfColor(ColorSpec cs)` Sets the input (prompt-for) color.
`void`	`setRetain(int retain)` Sets the frame retain size.
`void`	`setRow(Accessor row)` Sets the frame row as a callback to read the current value stored in the given `Accessor`.
`void`	`setRow(double row)` Sets the row position for this frame (statically).
`void`	`setRow(NumberType row)` Sets the row position for this frame (statically).
`void`	`setRow(Resolvable row)` Sets the frame row as a callback to read the current value calculated by the given expression.
`(package private) void`	`setScreenBuffer(ScreenBuffer sb, boolean allow)` Sets a new ScreenBuffer for this frame.
`void`	`setScreenIO(boolean value)` Set the SCREEN-IO option of this frame.
`void`	`setScreenValue(GenericWidget<?> widget, character value)` Set the current value in the screen buffer of the backing data for the given widget.
`void`	`setScroll(int scroll)` Sets the frame scroll size.
`void`	`setScrollable(boolean scrollable)` Sets the SCROLLABLE option.
`void`	`setScrollable(logical scrollable)` Sets the SCROLLABLE option.
`void`	`setScrollbarVertical(boolean vert)` Sets the SCROLLBAR-VERTICAL option.
`void`	`setSensitive(boolean s)` Sets new value of SENSITIVE attribute.
`void`	`setSensitive(logical s)` Sets new value of SENSITIVE attribute.
`void`	`setSideLabels(boolean sideLabels)` Sets the SIDE-LABELS option.
`boolean`	`setStatement(UIStatement stmt)` Set the current UI statement in use for this frame.
`private void`	`setStaticWidgets(FrameElement[] data)` Set value of each static widget mentioned in the list.
`void`	`setStatisticsColumn(GenericWidget<?> widget)` Sets the widget which will be used to display the description for any given statistic that is being automatically aggregated by the `display(com.goldencode.p2j.util.handle)` processing.
`void`	`setStreamIO(boolean value)` Set the STREAM-IO option of this frame.
`private java.lang.Object`	`setter(int index, java.lang.Object value)` Sets a new value for the specified widget in the screen buffer.
`private java.lang.Object`	`setter(java.lang.String widgetName, java.lang.Object value)` Sets a new value for the specified widget in the screen buffer.
`void`	`setThreeD(boolean threeD)` Sets the THREE-D option.
`void`	`setTitle(character title)` Sets the frame title.
`void`	`setTitle(character title, ColorSpec titleColor)` Sets the frame title and title color.
`void`	`setTitle(java.lang.String title)` Sets the frame title.
`void`	`setTitle(java.lang.String title, ColorSpec titleColor)` Sets the frame title and title color.
`void`	`setTitleBgColor(long bgcolor)` Sets the TITLE-BGCOLOR writable attribute.
`void`	`setTitleColor(ColorSpec titleColor)` Sets the color for the frame title.
`void`	`setTitleDColor(long dcolor)` Sets the TITLE-DCOLOR writable attribute.
`void`	`setTitleFgColor(long fgcolor)` Sets the TITLE-FGCOLOR writable attribute.
`void`	`setTitleFont(long fontNum)` Set the TITLE-FONT attribute of this browse widget.
`void`	`setTopOnly(boolean topOnly)` Sets the TOP-ONLY option.
`void`	`setUnlessHidden(FrameElement[] data)` Enables a list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`setUnlessHidden(FrameElement[] data, handle hWin)` Enables a list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
`private static <T extends CommonFrame> void`	`setupFrame(T frame)` Invoke the frame's setup logic and set the batch flag to false.
`void`	`setUseText(boolean value)` Set the USE-TEXT option of this frame.
`void`	`setV6Frame(boolean v6frame)` Sets the V6FRAME option.
`void`	`setVisible(boolean visible)` Sets the VISIBLE attribute.
`void`	`setVisible(logical visible)` Sets the VISIBLE attribute.
`void`	`setWidth(NumberType widthChars)` Set the WIDTH Progress attribute.
`void`	`setWidthChars(double width)` Sets the width of the widget.
`void`	`setWidthChars(NumberType width)` Sets the width of the widget.
`void`	`setWidthPixels(int widthPixels)` Sets new value of WIDTH-PIXELS attribute.
`void`	`setWidthPixels(NumberType widthPixels)` Sets new value of WIDTH-PIXELS attribute.
`private void`	`setWorker(FrameElement[] widgets, EventList wait, boolean def, boolean windowClause, handle hWin)` Enables a list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`setX(int x)` Sets the horizontal position of the frame (Progress X attribute).
`void`	`setX(NumberType x)` Sets the horizontal position of the frame (Progress X attribute).
`void`	`setY(int y)` Sets the vertical position of the frame (Progress Y attribute).
`void`	`setY(NumberType y)` Sets the vertical position of the frame (Progress Y attribute).
`private void`	`showScreenBuffer(int idx)` This method will send the screen buffer for row at given index to be displayed by the client, only if no redirected output occurred.
`void`	`startEditingMode(FrameElement[] list, int type)` Marks the beginning of the editing block.
`void`	`startEditingMode(FrameElement[] list, int type, EventList wait)` Marks the beginning of the editing block with caller control over the exit conditions for the loop.
`void`	`stopEditingMode(FrameElement[] list, boolean normal, boolean cleanup)` Marks the end of the editing block when triggered by any abnormal exit from the block on the server.
`private java.util.List<FrameElement>`	`textGroup(FrameElement[] list)` Process list of frame elements and link widgets into text (word wrap) groups if necessary.
`private void`	`textUngroup(java.util.List<FrameElement> list)` Reset text grouping (word wrap mode).
`protected void`	`toBottom(GenericWidget<?> widget)` Moves the target widget to the bottom of its widgets list if it is in this list.
`java.lang.String`	`toString()` Provide description for GenericFrame instance.
`protected void`	`toTop(GenericWidget<?> widget)` Moves the target widget to the top of its widgets list if it is in this list.
`private BaseDataType`	`translateUnknown(BaseDataType value, ControlEntity<?> widget)` Ensure that any instance of the `unknown literal` is converted into the proper type as expected by the given widget.
`(package private) void`	`triggerEnter()` Mark beginning of trigger processing.
`(package private) void`	`triggerLeave()` Mark end of trigger processing.
`void`	`underline(GenericWidget<?>[] list)` Displays an underline for the specified field-level widgets of the frame.
`void`	`underline(int[] list)` Displays an underline for the specified field-level widgets of the frame.
`void`	`underline(Stream stream, GenericWidget<?>[] list)` Displays an underline for the specified field-level widgets of the frame.
`void`	`underline(Stream stream, int[] list)` Displays an underline for the specified field-level widgets of the frame.
`void`	`up()` Positions the cursor on a new line in a down frame.
`void`	`up(double lines)` Positions the cursor on a new line of the down frame.
`private void`	`up(int lines)` UP worker routine.
`private void`	`up(int lines, int id)` UP worker routine.
`void`	`up(NumberType lines)` Positions the cursor on a new line of the down frame.
`void`	`up(Stream out)` This method exists to support a valid form of the Progress `UP` statement which has no effect.
`void`	`up(Stream out, double lines)` If `lines` is a negative number, the absolute value of that number of new-lines will be written to the given stream.
`void`	`up(Stream out, NumberType lines)` If `lines` is a negative number, the absolute value of that number of new-lines will be written to the given stream.
`void`	`update(FrameElement[] data)` Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`update(FrameElement[] widgets, EventList wait)` Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`update(FrameElement[] data, EventList wait, handle hWin)` Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`update(FrameElement[] data, handle hWin)` Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`update(Stream in, FrameElement[] data)` For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set.
`void`	`update(Stream in, FrameElement[] data, handle hWin)` For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set.
`private void`	`updateDynamicBrowseTitle()` Update dynamic browse title.
`private void`	`updateDynamicContent()` This method should be called anytime the frame buffer is sent down to the thin client.
`protected void`	`updateDynamicTitle()` Update dynamic frame title.
`private void`	`updateFieldGroups(int lines, int currentRow, int down, int realstep)` This method actualizes field-groups of this frame in correspondance with the current iteration (DOWN/UP step).
`int[]`	`updateTabItemsList(int[] widgetIds, FieldGroup.UpdatesOp op)` Updates the current tab item list if KEEP-TAB-ORDER is not set.
`int[]`	`updateTabItemsList(java.util.List<GenericWidget<?>> widgets, FieldGroup.UpdatesOp op)` Updates the current tab item list if KEEP-TAB-ORDER is not set.
`void`	`updateUnlessHidden(FrameElement[] data)` Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
`void`	`updateUnlessHidden(FrameElement[] data, handle hWin)` Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
`private void`	`updateWorker(FrameElement[] widgets, EventList wait, boolean windowClause, handle hWin)` Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via `waitFor()`, after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
`private void`	`updateWorker(Stream in, FrameElement[] data, boolean windowClause, handle hWin)` /** For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set.
`(package private) boolean`	`valid()` Reports if this frame object is valid for use.
`logical`	`validate()` Executes the validation tests for every supported field-level widget in the frame (except the browse, which you must validate explicitly).
`logical`	`validateFields(boolean enabledOnly)` Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied.
`int[]`	`validIds(GenericWidget<?>[] list)` Create an array of all widgets in this frame that are in the given array.
`void`	`view()` Makes the frame visible.
`void`	`view(FrameElement[] data)` Makes visible specified widgets.
`private void`	`view(FrameElement[] data, boolean windowClause, handle hWin)` Makes widgets in frame visible.
`void`	`view(FrameElement[] data, handle hWin)` Makes widgets in frame visible.
`void`	`view(handle hWin)` Makes the frame visible.
`void`	`view(Stream out)` Writes the current screen-buffer contents to the given stream.
`void`	`view(Stream out, FrameElement[] data)` Writes the current screen-buffer contents to the given stream.
`void`	`view(Stream out, handle hWin)` Writes the current screen-buffer contents to the given stream.
`private void`	`viewWorker(Stream out, FrameElement[] data, boolean view, boolean windowClause, handle hWin)` Writes the current screen-buffer contents to the given stream.
`void`	`waitFor()` Waits for a default list of events.
`void`	`waitFor(EventList el)` Waits for specified list of events.
`void`	`waitFor(EventList el, GenericWidget<?> focusWidget)` Waits for specified list of events.
`void`	`waitFor(EventList el, GenericWidget<?> focusWidget, int seconds)` Waits for specified list of events.
`void`	`waitFor(EventList el, int seconds)` Waits for specified list of events.
`void`	`waitForNextKey()` Blocks until a next UI event is available (returns immediately if an event is already available).
`private GenericWidget<?>[]`	`widgetListFromFrameElements(FrameElement[] widgets)` Converts a frame element array into a array of widgets.
`private FieldGroup`	`wrapWidgetsToFieldGroup(boolean dynamic, GenericWidget<?>[] widgets, FieldGroup beforeFg)` Wraps widgets to the FieldGroup - pseudo-widget used as container of row widgets

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.ui.CommonFrame
setNoAttrSpace

Methods inherited from interface com.goldencode.p2j.util.IterableResource
getIteration

Methods inherited from interface com.goldencode.p2j.util.Finalizable
entry, initFailure, weight

- Field Detail
  - INVOKE_GET
```
private static final int INVOKE_GET
```
    proxy getter call
    
    See Also:
    
    Constant Field Values
  - INVOKE_SET
```
private static final int INVOKE_SET
```
    proxy setter call
    
    See Also:
    
    Constant Field Values
  - INVOKE_ACCESS
```
private static final int INVOKE_ACCESS
```
    proxy accessor call
    
    See Also:
    
    Constant Field Values
  - ENABLE_INPUT_REDIRECTED
```
private static final java.lang.String ENABLE_INPUT_REDIRECTED
```
    Error message for enable statement during input redirection.
    
    See Also:
    
    Constant Field Values
  - NO_INPUT_SOURCE_ATTEMPT
```
private static final java.lang.String NO_INPUT_SOURCE_ATTEMPT
```
    Error message for set/prompt-for statements in batch mode.
    
    See Also:
    
    Constant Field Values
  - NO_OUTPUT_DESTINATION_ATTEMPT
```
private static final java.lang.String NO_OUTPUT_DESTINATION_ATTEMPT
```
    Error message for output related statements in batch mode.
    
    See Also:
    
    Constant Field Values
  - LOG
```
private static final CentralLogger LOG
```
    logger
  - errHlp
```
private ErrorManager.ErrorHelper errHlp
```
    Context-local error state.
  - batch
```
private boolean batch
```
    batch modifications flag
  - configInstance
```
private java.lang.Object configInstance
```
    instance of the frame configuration implementation class
  - configClass
```
private java.lang.Class<?> configClass
```
    class of the frame configuration implementation class
  - frameName
```
private java.lang.String frameName
```
    legacy frame name as found in the 4GL with case-preserved.
  - frameId
```
private int frameId
```
    frame ID
  - n2w
```
private java.util.Map<java.lang.String,GenericWidget<?>> n2w
```
    Maps widget names to widget instances (from the frame definition).
  - n2n
```
private java.util.Map<java.lang.String,java.lang.String> n2n
```
    Maps converted widget names to original ones
  - n2h
```
private java.util.Map<java.lang.String,GenericWidget<?>> n2h
```
    Maps header widget names to widget instances (from the frame definition).
  - n2b
```
private java.util.Map<java.lang.String,GenericWidget<?>> n2b
```
    Maps background widget names to widget instances (from the frame definition).
  - widgets
```
private GenericWidget<?>[] widgets
```
    List of widgets in ID order.
  - headers
```
private FrameElement[] headers
```
    Frame headers.
  - frame
```
private FrameWidget frame
```
    frame config
  - frameDef
```
private ScreenDefinition frameDef
```
    frame definition
  - frameBuf
```
private ScreenBuffer frameBuf
```
    screen buffer for this frame
  - currentOp
```
private int currentOp
```
    Identifies type of editing block (PROMPT_FOR, SET or UPDATE).
  - editLock
```
private final java.lang.Object editLock
```
    Lock object for synchronization of shared editing block data.
  - statsColumn
```
private GenericWidget<?> statsColumn
```
    The widget used for displaying a statistic's description.
  - redirOut
```
private Stream redirOut
```
    Stream to which redirected aggregator element output is sent
  - aggregateHandler
```
private GenericFrame.AggregateHandler aggregateHandler
```
    The aggregate handler currently active for this frame
  - pendingUpDown
```
private int pendingUpDown
```
    Keeps state of the conditional DOWN and/or UP cursor movements. Can be set to {-1, 0, +1}. -1 means there is an outstanding request to move the cursor up. 0 means no outstanding requests. +1 means there is an outstanding request to move the cursor down.
  - dynDown
```
private Resolvable dynDown
```
    Callback expression for the number of iterations in a down frame.
  - dynColumn
```
private Resolvable dynColumn
```
    Callback expression for the frame column.
  - dynRow
```
private Resolvable dynRow
```
    Callback expression for the frame row.
  - dynTitle
```
private CharacterExpression dynTitle
```
    The registered storage for the current frame title.
  - hadView
```
private boolean hadView
```
    Set to true when frame is viewed first time.
  - textGroup
```
private java.util.List<FrameElement> textGroup
```
    List of widgets in text groups in current editing block.
  - scopeNesting
```
private int scopeNesting
```
    Nesting scope counter.
  - shared
```
private boolean shared
```
    Shared flame flag.
  - screenBufferCache
```
private java.util.Map<java.lang.Integer,ScreenBuffer> screenBufferCache
```
    A screen-buffer cache to be used with a down frame. key - a row number value - a ScreenBuffer instance
  - dynamicDown
```
private int dynamicDown
```
    Dynamic DOWN value.
  - fieldGroup
```
private FieldGroup fieldGroup
```
    The first field group in the frame (holds all non-header widgets).
  - currentFieldGroup
```
private FieldGroup currentFieldGroup
```
    The current field-group. Corresponds to CURRENT-ITERATION attribute
  - literalFieldGroup
```
private FieldGroup literalFieldGroup
```
    The field-group for the literal widget
  - rows2fg
```
private java.util.Map<java.lang.Integer,FieldGroup> rows2fg
```
    The mapping from row number to corresponding field-group
  - insideSetup
```
private boolean insideSetup
```
    Set to true when frame is initialized by appropriate Settable instance.
  - deferredAggregators
```
private FrameElement[] deferredAggregators
```
    List of aggregators, deferred to be registered on the first iteration.
  - canHide
```
private boolean canHide
```
    Can hide other frames.
  - afterDown
```
private boolean afterDown
```
    Set to true if last operation was DOWN.
  - afterUnderline
```
private boolean afterUnderline
```
    Set to true if last down() was internal underline() call.
  - hadCondition
```
private boolean hadCondition
```
    Track presence of condition during frame processing.
  - triggerActive
```
private int triggerActive
```
    Track implicit validation nesting.
  - finalCheck
```
private boolean finalCheck
```
    Final format check control.
  - silentFormatErrors
```
private boolean silentFormatErrors
```
    Second and subsequent formatting errors are suppressed.
  - formatFilter
```
private java.util.Set<java.lang.Integer> formatFilter
```
    Widget IDs stored in this map are not checked for formatting errors.
  - flushed
```
private boolean flushed
```
    Track frame data flushing in redirected mode.
  - sameViewDataRedirected
```
private boolean sameViewDataRedirected
```
    Track whether we change data from one iteration to another
  - currentStatement
```
private UIStatement currentStatement
```
    The current UI statement in use for this frame. null if no statement is in effect.
  - framePlacing
```
private boolean framePlacing
```
    Flag indicating we are inside a placeFrame() call.
  - defaultFrame
```
private boolean defaultFrame
```
    true for a default frame (a static frame without name)
- Constructor Detail
  - GenericFrame
```
protected GenericFrame()
```
    Default constructor; creates a new instance of a frame. This constructor is meant to be invoked by subclasses. To initialize the frame, the caller must invoke initialize(Class, Object, String).
- Method Detail
  - createFrame
```
public static <T extends CommonFrame> T createFrame(java.lang.Class<T> iface,
                                                    java.lang.String name)
```
    Creates new frame as a proxy object (as a local resource). This loads the static frame definition.
    
    Type Parameters:
    
    T - Frame interface type.
    
    Parameters:
    
    iface - The class of the interface definition.
    
    name - The frame name.
    
    Returns:
    
    The created frame.
  - createDynamicFrame
```
public static <T extends CommonFrame> T createDynamicFrame(java.lang.Class<T> iface,
                                                           FrameWidget frameWidget)
```
    Creates new dynamic frame as a proxy object (as a local resource). This loads the static frame definition.
    
    Type Parameters:
    
    T - Frame interface type.
    
    Parameters:
    
    iface - The class of the interface definition.
    
    frameWidget - The frame widget to be the base for new dynamic frame.
    
    Returns:
    
    The created frame.
  - createSharedFrame
```
public static <T extends CommonFrame> T createSharedFrame(java.lang.Class<T> iface,
                                                          java.lang.String name)
```
    Creates new frame as a proxy object and exports that new frame as a shared resource (non-global). This loads the static frame definition.
    
    Type Parameters:
    
    T - Frame interface type.
    
    Parameters:
    
    iface - The class of the interface definition.
    
    name - The frame name.
    
    Returns:
    
    The created frame.
  - importSharedFrame
```
public static <T extends CommonFrame> T importSharedFrame(java.lang.Class<T> iface,
                                                          java.lang.String name)
```
    Import an existing frame as a proxy object from the shared resource manager. Create a new proxy and copy the state of the retrieved, shared frame to this new proxy for temporary use, until the scope in which the new proxy is used ends. When the associated external procedure exits, the original frame definition will be restored, and any relevant state from the exiting scope will be copied back to it.
    
    Type Parameters:
    
    T - Frame interface type.
    
    Parameters:
    
    iface - The class of the interface definition.
    
    name - The frame name.
    
    Returns:
    
    The imported frame.
  - validateFields
```
public logical validateFields(boolean enabledOnly)
```
    Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied. This is used to check if a proposed update to an object will pass validation.
    
    Parameters:
    
    enabledOnly - If true, VALIDATE will check enabled fields only. Otherwise, the VALIDATE method validates all fields, whether enabled or not.
    
    Returns:
    
    true if the validation is successful.
  - getConfigInstance
```
private static java.lang.Object getConfigInstance(java.lang.Class<?> iface)
```
    Retrieve the frame definition class and create and return a new instance of this class. This method relies on the convention of storing the frame definition class in a static field of the frame interface, named "configClass". Reflection is used to retrieve that field and instantiate the object from it.
    
    Parameters:
    
    iface - Frame interface type.
    
    Returns:
    
    Instance of the frame definition class.
    
    Throws:
    
    java.lang.RuntimeException - if the configClass field does not exist, is inaccessible, or the class cannot be instantiated.
  - initializeNewFrame
```
private static <T extends CommonFrame> void initializeNewFrame(GenericFrame frame,
                                                               java.lang.Class<T> iface,
                                                               java.lang.String name,
                                                               FrameWidget frameWidget,
                                                               boolean dynamic)
```
    Initialize the frame and register it with the transaction manager.
    
    Type Parameters:
    
    T - Frame type.
    
    Parameters:
    
    frame - Frame to be initialized (also the proxy for the given interface).
    
    iface - The class of the interface definition.
    
    name - The frame name.
    
    frameWidget - The frame widget to be the base for new dynamic frame.
    
    dynamic - The flag to differentiate processing for static and dynamic frames.
  - isAbleToDisplayWindow
```
private boolean isAbleToDisplayWindow(handle hWin)
```
    Checks if the parameter - valid window handle.
    
    Parameters:
    
    hWin - Handle of window to display
    
    Returns:
    
    TRUE - if handle is valid, FALSE - otherwise
  - createFrameProxy
```
private static <T extends CommonFrame> T createFrameProxy(java.lang.Class<T> iface)
```
    Create and initialize a frame as a proxy object, loading the static frame definition.
    
    Type Parameters:
    
    T - Frame interface.
    
    Parameters:
    
    iface - The class of the interface definition.
    
    Returns:
    
    The created frame.
  - setupFrame
```
private static <T extends CommonFrame> void setupFrame(T frame)
```
    Invoke the frame's setup logic and set the batch flag to false.
    
    Type Parameters:
    
    T - Frame interface type.
    
    Parameters:
    
    frame - Frame proxy instance.
  - setStatement
```
public boolean setStatement(UIStatement stmt)
```
    Set the current UI statement in use for this frame.
    If currentStatement is already set, do nothing and return false. Otherwise return true.
    
    Parameters:
    
    stmt - The UI statement being executed.
    
    Returns:
    
    See above.
  - resetStatement
```
public void resetStatement()
```
    Set the currentStatement back to null.
  - getStatement
```
public UIStatement getStatement()
```
    Get the currentStatement.
    
    Returns:
    
    See above.
  - setInsideSetup
```
public void setInsideSetup(boolean flag)
```
    Description copied from interface: CommonFrame
    
    This method will be called by run-time when frame initialization is started and when frame initialization is finished.
    
    Specified by:
    
    setInsideSetup in interface CommonFrame
    
    Parameters:
    
    flag - true means start of initialization and false - end of initialization.
    
    See Also:
    
    CommonFrame.setInsideSetup(boolean)
  - isInsideSetup
```
public boolean isInsideSetup()
```
    Check if the frame is currently being initialized
    
    Specified by:
    
    isInsideSetup in interface CommonFrame
    
    Returns:
    
    See above.
  - _getName
```
public java.lang.String _getName()
```
    Get frame name.
    
    Returns:
    
    frame name.
  - _setName
```
public void _setName(java.lang.String name)
```
    Set frame name. Internal version.
    
    Parameters:
    
    name - The new name for the frame.
  - isShared
```
public boolean isShared()
```
    Check if frame is shared.
    
    Returns:
    
    true if frame is shared frame.
  - getRedirOut
```
public Stream getRedirOut()
```
    Getter for the redirOut field.
    
    Returns:
    
    the redirOut field.
  - registerHeader
```
public void registerHeader(FrameElement[] fe)
```
    Register header frame elements.
    This method corresponds to these Progress statements: FORM HEADER
    
    Specified by:
    
    registerHeader in interface CommonFrame
    
    Parameters:
    
    fe - Array of headers to register.
  - registerAccumulators
```
public void registerAccumulators(FrameElement[] fe)
```
    Register all the widgets which need accumulation with this frame.
    
    Specified by:
    
    registerAccumulators in interface CommonFrame
    
    Parameters:
    
    fe - The list of widgets that may need accumulation.
  - invoke
```
public java.lang.Object invoke(java.lang.Object proxy,
                               java.lang.reflect.Method method,
                               java.lang.Object[] args)
                        throws java.lang.Throwable
```
    This method acts as an interceptor which is called every time a method of the proxy object is invoked. It allows us to perform pre- and post-processing for these methods, and to delegate the regular work of the method to the backing implementation DMO.
    
    Specified by:
    
    invoke in interface java.lang.reflect.InvocationHandler
    
    Parameters:
    
    proxy - Proxy object upon which the intercepted method is invoked.
    
    method - Method to be invoked through reflection.
    
    args - Arguments, if any, to method.
    
    Returns:
    
    value returned from the invoked method.
    
    Throws:
    
    java.lang.Throwable - if an exception/error occurs upon the invocation target, or if any problem occurs during pre- or post-processing.
  - setV6Frame
```
public void setV6Frame(boolean v6frame)
```
    Sets the V6FRAME option.
    
    Specified by:
    
    setV6Frame in interface CommonFrame
    
    Parameters:
    
    v6frame - true if the option is set to ON.
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets the VISIBLE attribute.
    
    Specified by:
    
    setVisible in interface CommonFrame
    
    Parameters:
    
    visible - true if the attribute must be set to ON.
  - setVisible
```
public void setVisible(logical visible)
```
    Sets the VISIBLE attribute.
    
    Specified by:
    
    setVisible in interface CommonFrame
    
    Parameters:
    
    visible - true if the attribute must be set to ON.
  - _isVisible
```
public boolean _isVisible()
```
    Gets the VISIBLE attribute of the frame.
    
    Returns:
    
    true if the attribute is set to ON.
  - isVisible
```
public logical isVisible()
```
    Gets the VISIBLE attribute of the frame.
    
    Specified by:
    
    isVisible in interface CommonFrame
    
    Returns:
    
    PROGRESS true value if the attribute is set to ON.
  - isSensitive
```
public logical isSensitive()
```
    Queries the SENSITIVE attribute of this frame.
    
    Specified by:
    
    isSensitive in interface CommonFrame
    
    Returns:
    
    true if SENSITIVE is set.
  - setSensitive
```
public void setSensitive(logical s)
```
    Sets new value of SENSITIVE attribute.
    
    Specified by:
    
    setSensitive in interface CommonFrame
    
    Parameters:
    
    s - new value of SENSITIVE attribute
  - setSensitive
```
public void setSensitive(boolean s)
```
    Sets new value of SENSITIVE attribute.
    
    Specified by:
    
    setSensitive in interface CommonFrame
    
    Parameters:
    
    s - new value of SENSITIVE attribute
  - setHidden
```
public void setHidden(logical hidden)
```
    Sets the HIDDEN writable attribute.
    
    Specified by:
    
    setHidden in interface CommonFrame
    
    Parameters:
    
    hidden - The new value for the HIDDEN attribute.
  - setHidden
```
public void setHidden(boolean hidden)
```
    Sets the HIDDEN writable attribute.
    
    Specified by:
    
    setHidden in interface CommonFrame
    
    Parameters:
    
    hidden - The new value for the HIDDEN attribute.
  - isHidden
```
public logical isHidden()
```
    Queries the HIDDEN attribute of this frame.
    
    Specified by:
    
    isHidden in interface CommonFrame
    
    Returns:
    
    true if HIDDEN is set.
  - assignScreenValue
```
public void assignScreenValue(FrameElement data)
```
    Obtain the current value in the screen buffer for the given widget and assign this into the backing variable. If there is no value in the screen buffer (if it is null) no assignment will occur.
    
    Specified by:
    
    assignScreenValue in interface CommonFrame
    
    Parameters:
    
    data - Represents the variable to assign and the widget for which the screen value is to be retrieved.
  - asWidget
```
public FrameWidget asWidget()
```
    Get this frame as instance of GenericFrame.
    
    Specified by:
    
    asWidget in interface CommonFrame
    
    Returns:
    
    reference to this frame as GenericFrame instance.
  - asWidgetHandle
```
public handle asWidgetHandle()
```
    Get this frame wrapped in a handle.
    
    Specified by:
    
    asWidgetHandle in interface CommonFrame
    
    Returns:
    
    handle to this frame.
  - apply
```
public void apply(character event)
```
    Applies an event to the widget in focus.
    This method corresponds to these Progress statements: APPLY FRAME
    
    Specified by:
    
    apply in interface CommonFrame
    
    Parameters:
    
    event - event to be applied
  - apply
```
public void apply(java.lang.String event)
```
    Applies an event to the widget in focus.
    This method corresponds to these Progress statements: APPLY FRAME
    
    Specified by:
    
    apply in interface CommonFrame
    
    Parameters:
    
    event - event to be applied
  - apply
```
public void apply(integer eventCode)
```
    Applies an event to the widget in focus.
    This method corresponds to these Progress statements: APPLY FRAME
    
    Specified by:
    
    apply in interface CommonFrame
    
    Parameters:
    
    eventCode - event to be applied
  - apply
```
public void apply(double eventCode)
```
    Applies an event to the widget in focus.
    This method corresponds to these Progress statements: APPLY FRAME
    
    Specified by:
    
    apply in interface CommonFrame
    
    Parameters:
    
    eventCode - event to be applied
  - batch
```
public void batch(boolean on)
```
    Sets batching mode for frame modification.
    
    Specified by:
    
    batch in interface CommonFrame
    
    Parameters:
    
    on - true sets batching mode
  - isBatch
```
public boolean isBatch()
```
    Queries batching mode for frame modification.
    
    Returns:
    
    true if batching mode is in effect
  - batch
```
public void batch(boolean on,
                  boolean force)
```
    Sets batching mode for frame modification and optionally pushes the screen definition to the client.
    
    Parameters:
    
    on - true sets batching mode
    
    force - true to ensure that the screen definition will be synchronously pushed to the client. false to defer the push. This is only honored when on is false.
  - choose
```
public void choose(Choose c)
```
    Performs CHOOSE processing.
    This method corresponds to these Progress statements: CHOOSE
    
    Specified by:
    
    choose in interface CommonFrame
    
    Parameters:
    
    c - CHOOSE statement options
  - choose
```
public void choose(Choose c,
                   ColorSpec cs)
```
    Performs CHOOSE processing.
    This method corresponds to these Progress statements: CHOOSE COLOR
    
    Specified by:
    
    choose in interface CommonFrame
    
    Parameters:
    
    c - CHOOSE statement options
    
    cs - color specification for use with CHOOSE
  - clear
```
public void clear(boolean noPause)
```
    Clears the data and colors for all fill-in fields of the frame. For down frames, also clears side labels.
    This method corresponds to these Progress statements: CLEAR
    
    Specified by:
    
    clear in interface CommonFrame
    
    Parameters:
    
    noPause - true if NO-PAUSE option was used
  - clearAll
```
public void clearAll(boolean noPause)
```
    Clears all occurrences for the down frame and resets the current display position to the top of the frame.
    This method corresponds to these Progress statements: CLEAR ALL
    
    Specified by:
    
    clearAll in interface CommonFrame
    
    Parameters:
    
    noPause - true if NO-PAUSE option was used
  - currentIteration
```
public handle currentIteration()
```
    Conversion of CURRENT-ITERATION attribute (KW_CUR_ITER) of frame widget. Getter of CURRENT-ITERATION attribute.
    
    Specified by:
    
    currentIteration in interface IterableResource
    
    Returns:
    
    current value of CURRENT-ITERATION attribute.
  - setCurrentIteration
```
public void setCurrentIteration(handle newIter)
```
    Set the CURRENT-ITERATION widget handle for this frame. This attribute is writable only for frames.
    
    Specified by:
    
    setCurrentIteration in interface IterableResource
    
    Parameters:
    
    newIter - A handle for the current iteration of the frame.
  - line
```
public integer line()
```
    Get the current iteration number for down frame.
    
    Returns:
    
    The current iteration number.
  - getIteration
```
public handle getIteration(int level)
```
    Implements the GET-ITERATION() widget method.
    
    Specified by:
    
    getIteration in interface IterableResource
    
    Parameters:
    
    level - The level of the iteration to get.
    
    Returns:
    
    The handle of the iteration, field-group or buffer.
  - disable
```
public void disable()
```
    Disables input for all field-level widgets of the frame.
    This method corresponds to these Progress statements: DISABLE ALL
    
    Specified by:
    
    disable in interface CommonFrame
  - disableExcept
```
public void disableExcept(GenericWidget<?>[] xcpt)
```
    Disables input for all field-level widgets of the frame, except the specified ones.
    This method corresponds to these Progress statements: DISABLE ALL EXCEPT
    
    Specified by:
    
    disableExcept in interface CommonFrame
    
    Parameters:
    
    xcpt - Array ow widgets to be excluded from the operation.
  - disableExcept
```
public void disableExcept(GenericWidget<?> widget)
```
    Disables input for all field-level widgets of the frame, except the specified one.
    This method corresponds to these Progress statements: DISABLE ALL EXCEPT
    
    Specified by:
    
    disableExcept in interface CommonFrame
    
    Parameters:
    
    widget - Widgets which will be excluded from the operation.
  - disable
```
public void disable(GenericWidget<?>[] list)
```
    Disables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: DISABLE
    
    Specified by:
    
    disable in interface CommonFrame
    
    Parameters:
    
    list - The widgets to disable.
  - disable
```
public void disable(FrameElement[] list)
```
    Disables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: DISABLE
    
    Specified by:
    
    disable in interface CommonFrame
    
    Parameters:
    
    list - The widgets to disable.
  - disableUnlessHidden
```
public void disableUnlessHidden()
```
    Disables input for all field-level widgets of the frame.
    This method corresponds to this Progress statements: DISABLE ALL UNLESS-HIDDEN
    
    Specified by:
    
    disableUnlessHidden in interface CommonFrame
  - disableUnlessHidden
```
public void disableUnlessHidden(GenericWidget<?>[] list)
```
    Disables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: DISABLE UNLESS-HIDDEN
    
    Specified by:
    
    disableUnlessHidden in interface CommonFrame
    
    Parameters:
    
    list - The widgets to disable.
  - disableUnlessHidden
```
public void disableUnlessHidden(FrameElement[] list)
```
    Disables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: DISABLE UNLESS-HIDDEN
    
    Specified by:
    
    disableUnlessHidden in interface CommonFrame
    
    Parameters:
    
    list - The widgets to disable.
  - display
```
public void display(handle hWin)
```
    Displays a frame with no "data container" fields on the screen.
    As part of the processing, the frame marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    This method corresponds to these Progress statements: DISPLAY
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    hWin - A handle to the window where the frame is displayed.
  - display
```
public void display(BrowseWidget browse,
                    handle hWin)
```
    Refresh specified browse widget.
    This method corresponds to these Progress statements: DISPLAY WITH BROWSE
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    browse - A widget to refresh.
    
    hWin - A handle to the window where the frame is displayed.
  - display
```
public void display(Stream out,
                    handle hWin)
```
    Displays (writes) non-data-containing fields from the frame to the given stream.
    This method corresponds to these Progress statements: DISPLAY
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    hWin - A handle to the window where the frame is displayed.
  - display
```
public void display(FrameElement[] data,
                    handle hWin)
```
    Displays a list of fields from the frame on the screen. As part of this operation, the list of data values are copied to the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    data - The list of data (and associated widgets) which is to be displayed.
    
    hWin - A handle to the window where the frame is displayed.
  - displayUnlessHidden
```
public void displayUnlessHidden(FrameElement[] data,
                                handle hWin)
```
    Displays a list of fields from the frame on the screen. As part of this operation, the list of data values are copied to the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY UNLESS-HIDDEN
    
    Specified by:
    
    displayUnlessHidden in interface CommonFrame
    
    Parameters:
    
    data - The list of data (and associated widgets) which is to be displayed.
    
    hWin - A handle to the window where the frame is displayed.
  - display
```
public void display(Stream out,
                    FrameElement[] data,
                    handle hWin)
```
    Displays (writes) a list of fields from the frame on the given stream. As part of this operation, the list of data values are copied to the screen buffer.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    data - The list of data (and associated widgets) which is to be displayed.
    
    hWin - A handle to the window where the frame is displayed.
  - display
```
public void display()
```
    Displays a frame with no "data container" fields on the screen.
    As part of the processing, the frame marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    This method corresponds to these Progress statements: DISPLAY
    
    Specified by:
    
    display in interface CommonFrame
  - display
```
public void display(BrowseWidget browse)
```
    Refresh specified browse widget.
    This method corresponds to these Progress statements: DISPLAY WITH BROWSE
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    browse - A widget to refresh.
  - display
```
public void display(Stream out)
```
    Displays (writes) non-data-containing fields from the frame to the given stream.
    This method corresponds to these Progress statements: DISPLAY
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
  - display
```
public void display(FrameElement[] data)
```
    Displays a list of fields from the frame on the screen. As part of this operation, the list of data values are copied to the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    data - The list of data (and associated widgets) which is to be displayed.
  - display
```
public void display(Stream out,
                    FrameElement[] data)
```
    Displays (writes) a list of fields from the frame on the given stream. As part of this operation, the list of data values are copied to the screen buffer.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY
    
    Specified by:
    
    display in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    data - The list of data (and associated widgets) which is to be displayed.
  - displayUnlessHidden
```
public void displayUnlessHidden(FrameElement[] data)
```
    Displays a list of fields from the frame on the screen. As part of this operation, the list of data values are copied to the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY UNLESS-HIDDEN
    
    Specified by:
    
    displayUnlessHidden in interface CommonFrame
    
    Parameters:
    
    data - The list of data (and associated widgets) which is to be displayed.
  - displayUnlessHidden
```
public void displayUnlessHidden()
```
    Displays this frame (emulates a view) unless it is hidden.
    This method corresponds to these Progress statements: DISPLAY UNLESS-HIDDEN
    
    Specified by:
    
    displayUnlessHidden in interface CommonFrame
  - enable
```
public void enable(GenericWidget<?>[] list,
                   handle hWin)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE
    
    Specified by:
    
    enable in interface CommonFrame
    
    Parameters:
    
    list - The widgets to enable.
    
    hWin - A handle to the window where the frame is displayed.
  - enable
```
public void enable(FrameElement[] list,
                   handle hWin)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE
    
    Specified by:
    
    enable in interface CommonFrame
    
    Parameters:
    
    list - The widgets to enable.
    
    hWin - A handle to the window where the frame is displayed.
  - enableUnlessHidden
```
public void enableUnlessHidden(GenericWidget<?> widget)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
    
    Specified by:
    
    enableUnlessHidden in interface CommonFrame
    
    Parameters:
    
    widget - The widget to enable.
  - enableUnlessHidden
```
public void enableUnlessHidden(GenericWidget<?> widget,
                               handle hWin)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
    
    Specified by:
    
    enableUnlessHidden in interface CommonFrame
    
    Parameters:
    
    widget - The widget to enable.
    
    hWin - A handle to the window where the frame is displayed.
  - enableUnlessHidden
```
public void enableUnlessHidden(GenericWidget<?>[] list,
                               handle hWin)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
    
    Specified by:
    
    enableUnlessHidden in interface CommonFrame
    
    Parameters:
    
    list - The widgets to enable.
    
    hWin - A handle to the window where the frame is displayed.
  - enableUnlessHidden
```
public void enableUnlessHidden(GenericWidget<?>[] list)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
    
    Specified by:
    
    enableUnlessHidden in interface CommonFrame
    
    Parameters:
    
    list - The widgets to enable.
  - enableUnlessHidden
```
public void enableUnlessHidden()
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE ALL UNLESS-HIDDEN
    
    Specified by:
    
    enableUnlessHidden in interface CommonFrame
  - enableUnlessHidden
```
public void enableUnlessHidden(FrameElement[] list,
                               handle hWin)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
    
    Specified by:
    
    enableUnlessHidden in interface CommonFrame
    
    Parameters:
    
    list - The widgets to enable.
    
    hWin - A handle to the window where the frame is displayed.
  - enableUnlessHidden
```
public void enableUnlessHidden(FrameElement[] list)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
    
    Specified by:
    
    enableUnlessHidden in interface CommonFrame
    
    Parameters:
    
    list - The widgets to enable.
  - enableUnlessHiddenExcept
```
public void enableUnlessHiddenExcept(GenericWidget<?> widget)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL EXCEPT
    
    Specified by:
    
    enableUnlessHiddenExcept in interface CommonFrame
    
    Parameters:
    
    widget - The widget to enable.
  - enableUnlessHiddenExcept
```
public void enableUnlessHiddenExcept(GenericWidget<?> widget,
                                     handle hWin)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL EXCEPT
    
    Specified by:
    
    enableUnlessHiddenExcept in interface CommonFrame
    
    Parameters:
    
    widget - The widget to enable.
    
    hWin - A handle to the window where the frame is displayed.
  - enableUnlessHiddenExcept
```
public void enableUnlessHiddenExcept(GenericWidget<?>[] xcpt)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL EXCEPT
    
    Specified by:
    
    enableUnlessHiddenExcept in interface CommonFrame
    
    Parameters:
    
    xcpt - The widgets to enable.
  - enableUnlessHiddenExcept
```
public void enableUnlessHiddenExcept(GenericWidget<?>[] xcpt,
                                     handle hWin)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL EXCEPT
    
    Specified by:
    
    enableUnlessHiddenExcept in interface CommonFrame
    
    Parameters:
    
    xcpt - The widgets to enable.
    
    hWin - A handle to the window where the frame is displayed.
  - down
```
public void down()
```
    Positions the cursor on a new line in a down frame. This is a conditional call. Multiple conditional down() calls have the effect of a single down(1) call, which is delayed till the nearest terminal I/O operation and can be cancelled by a conditional up() call.
    Note that this call can be ignored in interactive mode if frame is not yet viewed at least once before this call. After first VIEW (explicit or implicit) hiding frame (either via HIDE statement or by changing VISIBLE attribute) does not affect behavior and calls to this method are honored. This corresponds to 4GL behavior.
    This method corresponds to these Progress statements: DOWN
    
    Specified by:
    
    down in interface CommonFrame
  - down
```
public void down(double lines)
```
    Positions the cursor on a new line in a down frame.
    This method corresponds to these Progress statements: DOWN n
    
    Specified by:
    
    down in interface CommonFrame
    
    Parameters:
    
    lines - number of iterations of the data to move down
  - down
```
public void down(NumberType lines)
```
    Positions the cursor on a new line in a down frame.
    This method corresponds to these Progress statements: DOWN n
    
    Specified by:
    
    down in interface CommonFrame
    
    Parameters:
    
    lines - number of iterations of the data to move down
  - down
```
public void down(Stream out)
```
    Writes a single new-line to the given stream.
    This method corresponds to these Progress statements: DOWN STREAM s
    
    Specified by:
    
    down in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
  - down
```
public void down(Stream out,
                 double lines)
```
    Writes lines number of new-lines to the given stream.
    This method corresponds to these Progress statements: DOWN STREAM s n
    
    Specified by:
    
    down in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    lines - Number of new-lines to output to the stream.
  - down
```
public void down(Stream out,
                 NumberType lines)
```
    Writes lines number of new-lines to the given stream.
    This method corresponds to these Progress statements: DOWN STREAM s n
    
    Specified by:
    
    down in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    lines - Number of new-lines to output to the stream.
  - enable
```
public void enable()
```
    Enables input for all field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE ALL
    
    Specified by:
    
    enable in interface CommonFrame
    
    Throws:
    
    ErrorConditionException - If the unnamed input is redirected and silent error mode is off.
  - enable
```
public void enable(handle hWin)
```
    Enables input for all field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE ALL IN WINDOW
    
    Specified by:
    
    enable in interface CommonFrame
    
    Parameters:
    
    hWin - A handle to the window where the frame is displayed.
  - enableExcept
```
public void enableExcept(GenericWidget<?>[] xcpt)
```
    Enables input for all field-level widgets of the frame, except the specified ones.
    This method corresponds to these Progress statements: ENABLE ALL
    
    Specified by:
    
    enableExcept in interface CommonFrame
    
    Parameters:
    
    xcpt - Array ow widgets to be excluded from the operation.
    
    Throws:
    
    ErrorConditionException - If the unnamed input is redirected and silent error mode is off.
  - enableExcept
```
public void enableExcept(GenericWidget<?>[] xcpt,
                         handle hWin)
```
    Enables input for all field-level widgets of the frame, except the specified ones.
    This method corresponds to these Progress statements: ENABLE ALL IN WINDOW
    
    Specified by:
    
    enableExcept in interface CommonFrame
    
    Parameters:
    
    xcpt - List of widgets which will not be enabled.
    
    hWin - A handle to the window where the frame is displayed.
  - enableExcept
```
public void enableExcept(GenericWidget<?>[] all,
                         GenericWidget<?>[] xcpt,
                         boolean windowClause,
                         handle hWin)
```
    Enables input for given field-level widgets of the frame, except the specified ones.
    This method corresponds to these Progress statements: ENABLE ALL IN WINDOW
    
    Parameters:
    
    all - List of widgets to be processed.
    
    xcpt - List of widgets which will not be enabled.
    
    windowClause - true if IN WINDOW clause is presented in ENABLE statement. false otherwise.
    
    hWin - A handle to the window where the frame is displayed.
  - enableExcept
```
public void enableExcept(GenericWidget<?> widget)
```
    Enables input for all field-level widgets of the frame, except the specified one.
    This method corresponds to these Progress statements: ENABLE ALL
    
    Specified by:
    
    enableExcept in interface CommonFrame
    
    Parameters:
    
    widget - Widget which will be excluded from the operation.
    
    Throws:
    
    ErrorConditionException - If the unnamed input is redirected and silent error mode is off.
  - enableExcept
```
public void enableExcept(GenericWidget<?> widget,
                         handle hWin)
```
    Enables input for all field-level widgets of the frame, except the specified one.
    This method corresponds to these Progress statements: ENABLE ALL IN WINDOW
    
    Specified by:
    
    enableExcept in interface CommonFrame
    
    Parameters:
    
    widget - Widget which will not be enabled.
    
    hWin - A handle to the window where the frame is displayed.
  - enable
```
public void enable(GenericWidget<?>[] list)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE
    
    Specified by:
    
    enable in interface CommonFrame
    
    Parameters:
    
    list - The widgets to enable.
    
    Throws:
    
    ErrorConditionException - If the unnamed input is redirected and silent error mode is off.
  - enable
```
public void enable(FrameElement[] list)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE
    
    Specified by:
    
    enable in interface CommonFrame
    
    Parameters:
    
    list - The widgets to enable.
    
    Throws:
    
    ErrorConditionException - If the unnamed input is redirected and silent error mode is off.
  - getScreenValue
```
public character getScreenValue(GenericWidget<?> widget)
```
    Obtain the current value in the screen buffer of the backing data for the given widget and return it as a character type. If there is no value in the screen buffer (if it is null which is the representation for an uninitialized value), then return the empty string.
    
    Specified by:
    
    getScreenValue in interface CommonFrame
    
    Parameters:
    
    widget - The widget for which the value is to be retrieved.
    
    Returns:
    
    The value as a character type or the empty string if the screen buffer value is uninitialized.
  - getScreenValue
```
public character getScreenValue(GenericWidget<?> widget,
                                boolean ignoreFormat)
```
    Obtain the current value in the screen buffer of the backing data for the given widget and return it as a character type. If there is no value in the screen buffer (if it is null which is the representation for an uninitialized value), then return the empty string.
    
    Parameters:
    
    widget - The widget for which the value is to be retrieved.
    
    ignoreFormat - Ignore the widget format to form return value.
    
    Returns:
    
    The value as a character type or the empty string if the screen buffer value is uninitialized.
  - setScreenValue
```
public void setScreenValue(GenericWidget<?> widget,
                           character value)
```
    Set the current value in the screen buffer of the backing data for the given widget. If the given value is null then this widget will be set to the uninitialized value.
    
    Specified by:
    
    setScreenValue in interface CommonFrame
    
    Parameters:
    
    widget - The widget for which the value is to be retrieved.
    
    value - The new value for the widget, use null to set the value as uninitialized.
  - parseScreenValue
```
public static <T extends BaseDataType> T parseScreenValue(java.lang.Class<T> type,
                                                          character value,
                                                          java.lang.String format)
                                                   throws DisplayFormatCheckException,
                                                          ErrorConditionException
```
    Parses screen value (i.e. the value assigned to SCREEN-VALUE) and returns the expected data type. The method handles string values in the normalized form as well as values containing fill chars as permitted by the format and the actual data type. TODO: some negative cases are not handled, see uast/format_fill_chars.p and the section "test case 3"
    
    Parameters:
    
    type - The expected value type.
    
    value - The input screen value.
    
    format - The widget format, may be null.
    
    Returns:
    
    Returns the parsed string value in the expected data type instance.
    
    Throws:
    
    ErrorConditionException - then the format provided is invalid
    
    DisplayFormatCheckException - then the format provided cannot be applied is not compatible with the type.
  - parseFieldValue
```
public static <T extends BaseDataType> T parseFieldValue(java.lang.Class<T> type,
                                                         character value,
                                                         java.lang.String format)
                                                  throws DisplayFormatCheckException,
                                                         ErrorConditionException
```
    Parses field value (i.e. the value assigned to FIELD-VALUE) and returns the expected data type. The method handles string values in the normalized form as well as values containing fill chars as permitted by the format and the actual data type. TODO: some negative cases are not handled, see uast/format_fill_chars.p and the section "test case 3"
    
    Parameters:
    
    type - The expected value type.
    
    value - The input screen value.
    
    format - The widget format, may be null.
    
    Returns:
    
    Returns the parsed string value in the expected data type instance.
    
    Throws:
    
    ErrorConditionException - then the format provided is invalid
    
    DisplayFormatCheckException - then the format provided cannot be applied is not compatible with the type.
  - parseValue
```
public static <T extends BaseDataType> T parseValue(java.lang.Class<T> type,
                                                    character value,
                                                    java.lang.String format,
                                                    boolean fieldValue)
                                             throws DisplayFormatCheckException,
                                                    ErrorConditionException
```
    Parses screen/field value (i.e. the value assigned to SCREEN-VALUE/FIELD-VALUE) and returns the expected data type. The method handles string values in the normalized form as well as values containing fill chars as permitted by the format and the actual data type. TODO: some negative cases are not handled, see uast/format_fill_chars.p and the section "test case 3"
    
    Parameters:
    
    type - The expected value type.
    
    value - The input screen value.
    
    format - The widget format, may be null.
    
    fieldValue - Indicates the parsing is for FIELD-VALUE
    
    Returns:
    
    Returns the parsed string value in the expected data type instance.
    
    Throws:
    
    ErrorConditionException - then the format provided is invalid
    
    DisplayFormatCheckException - then the format provided cannot be applied is not compatible with the type.
  - setFrame
```
public void setFrame(handle hFrame)
```
    Sets the containing frame instance.
    
    Specified by:
    
    setFrame in interface CommonFrame
    
    Parameters:
    
    hFrame - handle which is expected to contain a FrameWidget instance
  - setFrameValue
```
public void setFrameValue(int wid,
                          BaseDataType value)
```
    Set the current value in the screen buffer of the backing data for the given widget. If the given value is null then this widget will be set to the uninitialized value.
    
    Parameters:
    
    wid - The widget for which the value is to be set
    
    value - The new value for the widget, use null to set the value as uninitialized.
  - hide
```
public void hide(handle hWin)
```
    Makes the frame invisible with the default pause.
    This method corresponds to these Progress statements: HIDE FRAME
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    hWin - A handle to the window where the frame is displayed.
  - hide
```
public void hide(handle hWin,
                 boolean noPause)
```
    Makes the frame invisible.
    This method corresponds to these Progress statements: HIDE FRAME
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    hWin - A handle to the window where the frame is displayed.
    
    noPause - true if NO-PAUSE option was used
  - hide
```
public void hide(Stream out,
                 handle hWin,
                 boolean noPause)
```
    If the frame is a PAGE-TOP or PAGE-BOTTOM and the stream is paged, the frame is removed from the list of those used for the header or footer. Otherwise this is a no-operation.
    This method corresponds to these Progress statements: HIDE STREAM s FRAME
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    hWin - A handle to the window where the frame is displayed.
    
    noPause - true if NO-PAUSE option was used
  - hide
```
public void hide(FrameElement[] data,
                 handle hWin)
```
    Makes widgets in the frame invisible.
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    data - Array of widgets to hide.
    
    hWin - A handle to the window where the frame is displayed.
  - hide
```
public void hide(FrameElement[] data,
                 handle hWin,
                 boolean noPause)
```
    Makes widgets in the frame invisible.
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    data - Array of widgets to hide.
    
    hWin - A handle to the window where the frame is displayed.
    
    noPause - true if NO-PAUSE option was used
  - hide
```
public void hide()
```
    Makes the frame invisible with the default pause.
    This method corresponds to these Progress statements: HIDE FRAME
    
    Specified by:
    
    hide in interface CommonFrame
  - hide
```
public void hide(boolean noPause)
```
    Makes the frame invisible.
    This method corresponds to these Progress statements: HIDE FRAME
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    noPause - true if NO-PAUSE option was used
  - hide
```
public void hide(Stream out,
                 boolean noPause)
```
    If the frame is a PAGE-TOP or PAGE-BOTTOM and the stream is paged, the frame is removed from the list of those used for the header or footer. Otherwise this is a no-operation.
    This method corresponds to these Progress statements: HIDE STREAM s FRAME
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    noPause - true if NO-PAUSE option was used
  - nextPrompt
```
public void nextPrompt(GenericWidget<?> field)
```
    Specifies the field to be put in focus during the next input operation.
    This method corresponds to these Progress statements: NEXT-PROMPT
    
    Specified by:
    
    nextPrompt in interface CommonFrame
    
    Parameters:
    
    field - widget to be put in focus
  - promptFor
```
public void promptFor(FrameElement[] widgets,
                      handle hWin)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is not used at all.
    
    hWin - A handle to the window where the frame is displayed.
  - promptFor
```
public void promptFor(Stream in,
                      FrameElement[] widgets,
                      handle hWin)
```
    For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set. Data will not be copied to or from the user's variables.
    Any error during stream reading or data parsing will cause an error condition to be generated. Reaching the end of the stream will cause an end condition to be generated.
    Both the input stream and the current default output stream (if output is redirected) are checked. If both are set to echo mode, then after all stream input is done, the screen buffer's contents will be echoed to the current output destination using view(com.goldencode.p2j.util.handle). This will occur whether or not an error occurs during stream processing and data parsing.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    in - A stream instance which is open for reading.
    
    widgets - The list of widgets which are to receive input from the stream.
    
    hWin - A handle to the window where the frame is displayed.
  - promptFor
```
public void promptFor(FrameElement[] widgets,
                      EventList wait,
                      handle hWin)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is not used at all.
    
    wait - The list of events to treat as a GO event.
    
    hWin - A handle to the window where the frame is displayed.
  - promptFor
```
public void promptFor(GenericWidget<?>[] widgets,
                      handle hWin)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited.
    
    hWin - A handle to the window where the frame is displayed.
  - promptFor
```
public void promptFor(GenericWidget<?>[] widgets,
                      EventList wait,
                      handle hWin)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited.
    
    wait - The list of events to treat as a GO event.
    
    hWin - A handle to the window where the frame is displayed.
  - promptForUnlessHidden
```
public void promptForUnlessHidden(FrameElement[] widgets,
                                  handle hWin)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: PROMPT-FOR UNLESS-HIDDEN
    
    Specified by:
    
    promptForUnlessHidden in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is not used at all.
    
    hWin - A handle to the window where the frame is displayed.
  - promptForUnlessHidden
```
public void promptForUnlessHidden(GenericWidget<?>[] widgets,
                                  handle hWin)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: PROMPT-FOR UNLESS-HIDDEN
    
    Specified by:
    
    promptForUnlessHidden in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited.
    
    hWin - A handle to the window where the frame is displayed.
  - promptFor
```
public void promptFor(FrameElement[] widgets)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is not used at all.
  - promptFor
```
public void promptFor(Stream in,
                      FrameElement[] widgets)
```
    For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set. Data will not be copied to or from the user's variables.
    Any error during stream reading or data parsing will cause an error condition to be generated. Reaching the end of the stream will cause an end condition to be generated.
    Both the input stream and the current default output stream (if output is redirected) are checked. If both are set to echo mode, then after all stream input is done, the screen buffer's contents will be echoed to the current output destination using view(com.goldencode.p2j.util.handle). This will occur whether or not an error occurs during stream processing and data parsing.
    Any null entry in the array is silently ignored.
    Note that this method does change the LASTKEY value to 13 if input stream contains at least one character. If input stream is empty then END condition is triggered.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    in - A stream instance which is open for reading.
    
    widgets - The list of widgets which are to receive input from the stream.
  - promptFor
```
public void promptFor(FrameElement[] widgets,
                      EventList wait)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is not used at all.
    
    wait - The list of events to treat as a GO event.
  - promptFor
```
public void promptFor(GenericWidget<?>[] widgets)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited.
  - promptFor
```
public void promptFor(GenericWidget<?>[] widgets,
                      EventList wait)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Specified by:
    
    promptFor in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited.
    
    wait - The list of events to treat as a GO event.
  - promptForUnlessHidden
```
public void promptForUnlessHidden(FrameElement[] widgets)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: PROMPT-FOR UNLESS-HIDDEN
    
    Specified by:
    
    promptForUnlessHidden in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is not used at all.
  - promptForUnlessHidden
```
public void promptForUnlessHidden(GenericWidget<?>[] widgets)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: PROMPT-FOR UNLESS-HIDDEN
    
    Specified by:
    
    promptForUnlessHidden in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited.
  - scroll
```
public void scroll(boolean fromCurrent,
                   boolean upDown)
```
    Scrolls the lines of the down frame up or down.
    This method corresponds to these Progress statements: SCROLL
    The server-side screen buffer will be updated accordingly so it will map the right values for the rows.
    
    Specified by:
    
    scroll in interface CommonFrame
    
    Parameters:
    
    fromCurrent - true if FROM-CURRENT option was used
    
    upDown - true if scrolling up
  - set
```
public void set(FrameElement[] data,
                handle hWin)
```
    Enables a list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: SET
    
    Specified by:
    
    set in interface CommonFrame
    
    Parameters:
    
    data - The list of widgets which is to be edited. The data portion of these elements is only used on output (they are assigned to the values provided by the user).
    
    hWin - A handle to the window where the frame is displayed.
  - set
```
public void set(Stream in,
                FrameElement[] data,
                handle hWin)
```
    For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set. Data will be copied back from the screen buffer to the user's variables.
    Any error during stream reading or data parsing will cause an error condition to be generated. Reaching the end of the stream will cause an end condition to be generated.
    Both the input stream and the current default output stream (if output is redirected) are checked. If both are set to echo mode, then after all stream input is done, the screen buffer's contents will be echoed to the current output destination using view(com.goldencode.p2j.util.handle). This will occur whether or not an error occurs during stream processing and data parsing.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    This method corresponds to these Progress statements: SET
    
    Specified by:
    
    set in interface CommonFrame
    
    Parameters:
    
    in - A stream instance which is open for reading.
    
    data - The list of widgets which are to receive input from the stream.
    
    hWin - A handle to the window where the frame is displayed.
  - set
```
public void set(FrameElement[] widgets,
                EventList wait,
                handle hWin)
```
    Enables a list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: SET
    
    Specified by:
    
    set in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is only used on output (they are assigned to the values provided by the user).
    
    wait - The list of events to treat as a GO event.
    
    hWin - A handle to the window where the frame is displayed.
  - setUnlessHidden
```
public void setUnlessHidden(FrameElement[] data,
                            handle hWin)
```
    Enables a list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements. The UNLESS-HIDDEN version of the method.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: SET UNLESS-HIDDEN
    
    Specified by:
    
    setUnlessHidden in interface CommonFrame
    
    Parameters:
    
    data - The list of widgets which is to be edited. The data portion of these elements is only used on output (they are assigned to the values provided by the user).
    
    hWin - A handle to the window where the frame is displayed.
  - set
```
public void set(FrameElement[] data)
```
    Enables a list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: SET
    
    Specified by:
    
    set in interface CommonFrame
    
    Parameters:
    
    data - The list of widgets which is to be edited. The data portion of these elements is only used on output (they are assigned to the values provided by the user).
  - set
```
public void set(Stream in,
                FrameElement[] data)
```
    For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set. Data will be copied back from the screen buffer to the user's variables.
    Any error during stream reading or data parsing will cause an error condition to be generated. Reaching the end of the stream will cause an end condition to be generated.
    Both the input stream and the current default output stream (if output is redirected) are checked. If both are set to echo mode, then after all stream input is done, the screen buffer's contents will be echoed to the current output destination using view(com.goldencode.p2j.util.handle). This will occur whether or not an error occurs during stream processing and data parsing.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    Note that this method does change the LASTKEY value to 13 if input stream contains at least one character. If input stream is empty then END condition is triggered.
    This method corresponds to these Progress statements: SET
    
    Specified by:
    
    set in interface CommonFrame
    
    Parameters:
    
    in - A stream instance which is open for reading.
    
    data - The list of widgets which are to receive input from the stream.
  - set
```
public void set(FrameElement[] widgets,
                EventList wait)
```
    Enables a list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: SET
    
    Specified by:
    
    set in interface CommonFrame
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is only used on output (they are assigned to the values provided by the user).
    
    wait - The list of events to treat as a GO event.
  - setUnlessHidden
```
public void setUnlessHidden(FrameElement[] data)
```
    Enables a list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements. The UNLESS-HIDDEN version of the method.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: SET UNLESS-HIDDEN
    
    Specified by:
    
    setUnlessHidden in interface CommonFrame
    
    Parameters:
    
    data - The list of widgets which is to be edited. The data portion of these elements is only used on output (they are assigned to the values provided by the user).
  - up
```
public void up()
```
    Positions the cursor on a new line in a down frame. This is a conditional call. Multiple conditional up() calls have the effect of a single up(1) call, which is delayed till the nearest terminal I/O operation and can be cancelled by a conditional down() call.
    This method corresponds to these Progress statements: UP
    
    Specified by:
    
    up in interface CommonFrame
  - up
```
public void up(double lines)
```
    Positions the cursor on a new line of the down frame.
    This method corresponds to these Progress statements: UP n
    
    Specified by:
    
    up in interface CommonFrame
    
    Parameters:
    
    lines - number of iterations of the data to scroll up (positive) or down (negative).
  - up
```
public void up(NumberType lines)
```
    Positions the cursor on a new line of the down frame.
    This method corresponds to these Progress statements: UP n
    
    Specified by:
    
    up in interface CommonFrame
    
    Parameters:
    
    lines - number of iterations of the data to scroll up (positive) or down (negative).
  - up
```
public void up(Stream out)
```
    This method exists to support a valid form of the Progress UP statement which has no effect.
    This method corresponds to these Progress statements: UP STREAM s
    
    Specified by:
    
    up in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
  - up
```
public void up(Stream out,
               double lines)
```
    If lines is a negative number, the absolute value of that number of new-lines will be written to the given stream.
    This method corresponds to these Progress statements: UP STREAM s n
    
    Specified by:
    
    up in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    lines - If negative, the number of new-lines to output to the stream. Otherwise, this has no effect.
  - up
```
public void up(Stream out,
               NumberType lines)
```
    If lines is a negative number, the absolute value of that number of new-lines will be written to the given stream.
    This method corresponds to these Progress statements: UP STREAM s n
    
    Specified by:
    
    up in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    lines - If negative, the number of new-lines to output to the stream. Otherwise, this has no effect.
  - update
```
public void update(FrameElement[] data,
                   handle hWin)
```
    Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method uses display(com.goldencode.p2j.util.handle) and set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) to do its real work. The only difference is that the set is embedded inside a "hidden" TransactionManager block which handles undo/retry on error conditions and undo/leave on end conditions.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: UPDATE
    
    Specified by:
    
    update in interface CommonFrame
    
    Parameters:
    
    data - The list of data and widgets which is to be updated.
    
    hWin - A handle to the window where the frame is displayed.
  - update
```
public void update(Stream in,
                   FrameElement[] data,
                   handle hWin)
```
    For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set. The data passed in will be copied from the user's variables into the screen buffer. After the input is read from the stream into the screen buffer, that data will be copied back from the screen buffer to the user's variables.
    Any error during stream reading or data parsing will cause an error condition to be generated. Reaching the end of the stream will cause an end condition to be generated. Unlike the update version in this class which has a "hidden" retry block around the core "set" processing, this streams version has no such feature. Errors will be immediately seen by the caller.
    Both the input stream and the current default output stream (if output is redirected) are checked. If both are set to echo mode, then after all stream input is done, the screen buffer's contents will be echoed to the current output destination using view(com.goldencode.p2j.util.handle). This will occur whether or not an error occurs during stream processing and data parsing.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    This method corresponds to these Progress statements: UPDATE
    
    Specified by:
    
    update in interface CommonFrame
    
    Parameters:
    
    in - A stream instance which is open for reading.
    
    data - The list of widgets which are to receive input from the stream.
    
    hWin - A handle to the window where the frame is displayed.
  - update
```
public void update(FrameElement[] data,
                   EventList wait,
                   handle hWin)
```
    Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method uses display(com.goldencode.p2j.util.handle) and set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) to do its real work. The only difference is that the set is embedded inside a "hidden" TransactionManager block which handles undo/retry on error conditions and undo/leave on end conditions.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: UPDATE
    
    Specified by:
    
    update in interface CommonFrame
    
    Parameters:
    
    data - The list of data and widgets which is to be updated.
    
    wait - The list of events to treat as a GO event.
    
    hWin - A handle to the window where the frame is displayed.
  - updateUnlessHidden
```
public void updateUnlessHidden(FrameElement[] data,
                               handle hWin)
```
    Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method uses display(com.goldencode.p2j.util.handle) and set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) to do its real work. The only difference is that the set is embedded inside a "hidden" TransactionManager block which handles undo/retry on error conditions and undo/leave on end conditions.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: UPDATE UNLESS-HIDDEN
    
    Specified by:
    
    updateUnlessHidden in interface CommonFrame
    
    Parameters:
    
    data - The list of data and widgets which is to be updated.
    
    hWin - A handle to the window where the frame is displayed.
  - update
```
public void update(FrameElement[] data)
```
    Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method uses display(com.goldencode.p2j.util.handle) and set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) to do its real work. The only difference is that the set is embedded inside a "hidden" TransactionManager block which handles undo/retry on error conditions and undo/leave on end conditions.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: UPDATE
    
    Specified by:
    
    update in interface CommonFrame
    
    Parameters:
    
    data - The list of data and widgets which is to be updated.
  - update
```
public void update(Stream in,
                   FrameElement[] data)
```
    For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set. The data passed in will be copied from the user's variables into the screen buffer. After the input is read from the stream into the screen buffer, that data will be copied back from the screen buffer to the user's variables.
    Any error during stream reading or data parsing will cause an error condition to be generated. Reaching the end of the stream will cause an end condition to be generated. Unlike the update version in this class which has a "hidden" retry block around the core "set" processing, this streams version has no such feature. Errors will be immediately seen by the caller.
    Both the input stream and the current default output stream (if output is redirected) are checked. If both are set to echo mode, then after all stream input is done, the screen buffer's contents will be echoed to the current output destination using view(com.goldencode.p2j.util.handle). This will occur whether or not an error occurs during stream processing and data parsing.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    Note that this method does change the LASTKEY value to 13 if input stream contains at least one character. If input stream is empty then END condition is triggered.
    This method corresponds to these Progress statements: UPDATE
    
    Specified by:
    
    update in interface CommonFrame
    
    Parameters:
    
    in - A stream instance which is open for reading.
    
    data - The list of widgets which are to receive input from the stream.
  - update
```
public void update(FrameElement[] widgets,
                   EventList wait)
```
    Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method uses display(com.goldencode.p2j.util.handle) and set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) to do its real work. The only difference is that the set is embedded inside a "hidden" TransactionManager block which handles undo/retry on error conditions and undo/leave on end conditions.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: UPDATE
    
    Specified by:
    
    update in interface CommonFrame
    
    Parameters:
    
    widgets - The list of data and widgets which is to be updated.
    
    wait - The list of events to treat as a GO event.
  - updateUnlessHidden
```
public void updateUnlessHidden(FrameElement[] data)
```
    Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method uses display(com.goldencode.p2j.util.handle) and set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) to do its real work. The only difference is that the set is embedded inside a "hidden" TransactionManager block which handles undo/retry on error conditions and undo/leave on end conditions.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: UPDATE UNLESS-HIDDEN
    
    Specified by:
    
    updateUnlessHidden in interface CommonFrame
    
    Parameters:
    
    data - The list of data and widgets which is to be updated.
  - view
```
public void view(handle hWin)
```
    Makes the frame visible.
    This method corresponds to these Progress statements: VIEW FRAME
    
    Specified by:
    
    view in interface CommonFrame
    
    Parameters:
    
    hWin - A handle to the window where the frame is displayed.
  - view
```
public void view(FrameElement[] data,
                 handle hWin)
```
    Makes widgets in frame visible.
    
    Specified by:
    
    view in interface CommonFrame
    
    Parameters:
    
    data - The list of data and widgets which is to be viewed.
    
    hWin - A handle to the window where the frame is displayed.
  - view
```
public void view(Stream out,
                 handle hWin)
```
    Writes the current screen-buffer contents to the given stream.
    This method corresponds to these Progress statements: VIEW STREAM s FRAME
    
    Specified by:
    
    view in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    hWin - A handle to the window where the frame is displayed.
  - view
```
public void view()
```
    Makes the frame visible.
    This method corresponds to these Progress statements: VIEW FRAME
    
    Specified by:
    
    view in interface CommonFrame
  - view
```
public void view(FrameElement[] data)
```
    Makes visible specified widgets.
    
    Specified by:
    
    view in interface CommonFrame
    
    Parameters:
    
    data - Array of FrameElement instances which need to be made visible.
  - view
```
public void view(Stream out)
```
    Writes the current screen-buffer contents to the given stream.
    This method corresponds to these Progress statements: VIEW STREAM s FRAME
    
    Specified by:
    
    view in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
  - view
```
public void view(Stream out,
                 FrameElement[] data)
```
    Writes the current screen-buffer contents to the given stream.
    This method corresponds to these Progress statements: VIEW STREAM s FRAME
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    data - Array of FrameElement instances which need to be made visible.
  - prepareView
```
private int[] prepareView(FrameElement[] data)
```
    Makes visible specified widgets. Prepares those Ids for client call.
    
    Parameters:
    
    data - Array of FrameElement instances which need to be made visible.
    
    Returns:
    
    Ids of specified widgets.
  - viewWorker
```
private void viewWorker(Stream out,
                        FrameElement[] data,
                        boolean view,
                        boolean windowClause,
                        handle hWin)
```
    Writes the current screen-buffer contents to the given stream.
    This method corresponds to these Progress statements: VIEW [STREAM s] FRAME [IN WINDOW] and DISPLAY [STREAM s] ... [IN WINDOW].
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    data - Array of FrameElement instances which need to be made visible.
    
    view - true if the call is for VIEW, false for DISPLAY.
    
    windowClause - true if IN WINDOW clause is presented in ENABLE statement. false otherwise.
    
    hWin - A handle to the window where the frame is displayed. null means that LogicalTerminal method without hWin will be used.
  - display
```
private void display(Stream out,
                     FrameElement[] data,
                     boolean windowClause,
                     handle hWin)
```
    Displays (writes) a list of fields from the frame on the given stream. As part of this operation, the list of data values are copied to the screen buffer.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY ... [IN WINDOW].
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    data - The list of data (and associated widgets) which is to be displayed.
    
    windowClause - true if IN WINDOW clause is presented in ENABLE statement. false otherwise.
    
    hWin - A handle to the window where the frame is displayed.
  - enable
```
private void enable(GenericWidget<?>[] list,
                    boolean windowClause,
                    handle hWin)
```
    Enables input for the given field-level widgets of the frame.
    This method corresponds to these Progress statements: ENABLE
    
    Parameters:
    
    list - The widgets to enable.
    
    windowClause - true if IN WINDOW clause is presented in ENABLE statement. false otherwise.
    
    hWin - A handle to the window where the frame is displayed.
  - view
```
private void view(FrameElement[] data,
                  boolean windowClause,
                  handle hWin)
```
    Makes widgets in frame visible.
    
    Parameters:
    
    data - The list of data and widgets which is to be viewed.
    
    windowClause - true if IN WINDOW clause is presented in VIEW statement. false otherwise.
    
    hWin - A handle to the window where the frame is displayed.
  - frameCol
```
public decimal frameCol()
```
    Returns the column position of the left corner of the frame within its window.
    This method corresponds to the Progress built-in function FRAME-COL
    
    Specified by:
    
    frameCol in interface CommonFrame
    
    Returns:
    
    current value of the frame column.
  - frameDown
```
public integer frameDown()
```
    Returns the number of iterations in a down frame.
    This method corresponds to the Progress built-in function FRAME-DOWN
    
    Specified by:
    
    frameDown in interface CommonFrame
    
    Returns:
    
    current value of the frame DOWN value.
  - frameLine
```
public integer frameLine()
```
    Returns the current logical line number in a frame.
    This method corresponds to the Progress built-in function FRAME-LINE
    
    Specified by:
    
    frameLine in interface CommonFrame
    
    Returns:
    
    1-based ordinal of the current data iteration of the frame. If the frame is redirected to a stream or if the frame is not visible, then 0 is returned. If the frame is not a down frame then 1 will be returned.
  - frameRow
```
public decimal frameRow()
```
    Returns the row position of the upper-left corner of the frame within its window.
    This method corresponds to the Progress built-in function FRAME-ROW
    
    Specified by:
    
    frameRow in interface CommonFrame
    
    Returns:
    
    current value of the frame row.
  - setAttrSpace
```
public void setAttrSpace(boolean attr_space)
```
    Sets the ATTR-SPACE option.
    
    Specified by:
    
    setAttrSpace in interface CommonFrame
    
    Parameters:
    
    attr_space - true if the option is set to ON.
  - isCarefulPaint
```
public logical isCarefulPaint()
```
    Get the CAREFUL-PAINT attribute.
    
    Returns:
    
    true if the attribute is ON.
  - setCarefulPaint
```
public void setCarefulPaint(logical careful)
```
    Sets the CAREFUL-PAINTattribute.
    
    Parameters:
    
    careful - true if the attribute is set to ON.
  - setCarefulPaint
```
public void setCarefulPaint(boolean careful)
```
    Sets the CAREFUL-PAINTattribute.
    
    Parameters:
    
    careful - true if the attribute is set to ON.
  - setCentered
```
public void setCentered(boolean centered)
```
    Sets the CENTERED option.
    
    Specified by:
    
    setCentered in interface CommonFrame
    
    Parameters:
    
    centered - true if the option is set to ON.
  - setDColor
```
public void setDColor(Color color)
```
    Sets the display color.
    
    Specified by:
    
    setDColor in interface CommonFrame
    
    Parameters:
    
    color - color number
  - setDColor
```
public void setDColor(int color)
```
    Sets the display color.
    
    Specified by:
    
    setDColor in interface CommonFrame
    
    Parameters:
    
    color - color number
  - setPfColor
```
public void setPfColor(Color color)
```
    Sets the input (prompt-for) color.
    
    Specified by:
    
    setPfColor in interface CommonFrame
    
    Parameters:
    
    color - color number
  - setDColor
```
public void setDColor(ColorSpec cs)
```
    Sets the display color.
    
    Specified by:
    
    setDColor in interface CommonFrame
    
    Parameters:
    
    cs - color specification
  - setPfColor
```
public void setPfColor(ColorSpec cs)
```
    Sets the input (prompt-for) color.
    
    Specified by:
    
    setPfColor in interface CommonFrame
    
    Parameters:
    
    cs - color specification
  - getBgColor
```
public integer getBgColor()
```
    Get display color.
    
    Specified by:
    
    getBgColor in interface CommonFrame
    
    Returns:
    
    display color.
  - setBgColor
```
public void setBgColor(NumberType color)
```
    Sets the display color.
    
    Specified by:
    
    setBgColor in interface CommonFrame
    
    Parameters:
    
    color - color number
  - setBgColor
```
public void setBgColor(int color)
```
    Sets the display color.
    
    Specified by:
    
    setBgColor in interface CommonFrame
    
    Parameters:
    
    color - color number
  - getFgColor
```
public integer getFgColor()
```
    Get input (prompt-for) color.
    
    Specified by:
    
    getFgColor in interface CommonFrame
    
    Returns:
    
    input (prompt-for) color.
  - setFgColor
```
public void setFgColor(NumberType color)
```
    Sets the input (prompt-for) color.
    
    Specified by:
    
    setFgColor in interface CommonFrame
    
    Parameters:
    
    color - color number
  - setFgColor
```
public void setFgColor(int color)
```
    Sets the input (prompt-for) color.
    
    Specified by:
    
    setFgColor in interface CommonFrame
    
    Parameters:
    
    color - color number
  - getBgColorRgb
```
public integer getBgColorRgb()
```
    Get display color RGB option.
    
    Specified by:
    
    getBgColorRgb in interface CommonFrame
    
    Returns:
    
    display color RGB.
  - setBgColorRgb
```
public void setBgColorRgb(NumberType colorRgb)
```
    Sets the display color RGB option.
    
    Specified by:
    
    setBgColorRgb in interface CommonFrame
    
    Parameters:
    
    colorRgb - color RGB
  - setBgColorRgb
```
public void setBgColorRgb(int colorRgb)
```
    Sets the display color RGB option.
    
    Specified by:
    
    setBgColorRgb in interface CommonFrame
    
    Parameters:
    
    colorRgb - color number
  - getFgColorRgb
```
public integer getFgColorRgb()
```
    Get input (prompt-for) color RGB option.
    
    Specified by:
    
    getFgColorRgb in interface CommonFrame
    
    Returns:
    
    input (prompt-for) color RGB.
  - setFgColorRgb
```
public void setFgColorRgb(NumberType colorRgb)
```
    Sets the input (prompt-for) color RGB option.
    
    Specified by:
    
    setFgColorRgb in interface CommonFrame
    
    Parameters:
    
    colorRgb - color RGB
  - setFgColorRgb
```
public void setFgColorRgb(int colorRgb)
```
    Sets the input (prompt-for) color RGB option.
    
    Specified by:
    
    setFgColorRgb in interface CommonFrame
    
    Parameters:
    
    colorRgb - color RGB
  - setColumn
```
public void setColumn(Resolvable column)
```
    Sets the frame column as a callback to read the current value calculated by the given expression. This value is honored at the time that the frame is made visible (for the first time or after being hidden).
    
    Specified by:
    
    setColumn in interface CommonFrame
    
    Parameters:
    
    column - The expression to evaluate for the frame column.
  - setColumn
```
public void setColumn(Accessor column)
```
    Sets the frame column as a callback to read the current value stored in the given Accessor. This value is honored at the time that the frame is made visible (for the first time or after being hidden).
    
    Specified by:
    
    setColumn in interface CommonFrame
    
    Parameters:
    
    column - The instance variable to read for the frame column.
  - setColumn
```
public void setColumn(NumberType column)
```
    Sets the column position for this frame (statically).
    
    Specified by:
    
    setColumn in interface CommonFrame
    
    Parameters:
    
    column - The 1-based column number at which to start displaying the frame. This is converted to a 0-based column number for the internal runtime.
  - setColumn
```
public void setColumn(double column)
```
    Sets the column position for this frame (statically).
    
    Specified by:
    
    setColumn in interface CommonFrame
    
    Parameters:
    
    column - The 1-based column number at which to start displaying the frame. This is converted to a 0-based column number for the internal runtime.
  - getColumn
```
public decimal getColumn()
```
    Returns the column position of the upper-left corner of the frame within its window (in coordinates that are relative to the containing window).
    This method corresponds to the Progress FRAME:COLUMN attribute.
    
    Specified by:
    
    getColumn in interface CommonFrame
    
    Returns:
    
    The column position for the upper-left corner of the frame.
  - getRow
```
public decimal getRow()
```
    Returns the row position of the upper-left corner of the frame within its window (in coordinates that are relative to the containing window).
    This method corresponds to the Progress FRAME:ROW attribute.
    
    Specified by:
    
    getRow in interface CommonFrame
    
    Returns:
    
    The row position for the upper-left corner of the frame.
  - setColumns
```
public void setColumns(int columns)
```
    Sets the number of columns.
    
    Specified by:
    
    setColumns in interface CommonFrame
    
    Parameters:
    
    columns - number of columns
  - isDialogBox
```
public boolean isDialogBox()
```
    Get current state of VIEW-AS DIALOG-BOX option.
    
    Returns:
    
    true if config is a DialogBox config.
  - setDialogBox
```
public void setDialogBox(boolean dialogBox)
```
    Sets the VIEW-AS DIALOG-BOX option.
    
    Specified by:
    
    setDialogBox in interface CommonFrame
    
    Parameters:
    
    dialogBox - true if the option is set to ON.
  - setDown
```
public void setDown(Resolvable down)
```
    Sets the size of a DOWN frame as a callback to read the current value calculated by the given expression. This value is then honored at the time that the frame is made visible (for the first time or after being hidden).
    
    Specified by:
    
    setDown in interface CommonFrame
    
    Parameters:
    
    down - The expression to evaluate for the number of data iterations in the current (DOWN) frame.
  - setDown
```
public void setDown(Accessor down)
```
    Sets the size of a DOWN frame as a callback to read the current value stored in the given Accessor. This value is then honored at the time that the frame is made visible (for the first time or after being hidden).
    
    Specified by:
    
    setDown in interface CommonFrame
    
    Parameters:
    
    down - The simple instance variable to read for the number of data iterations in the current (DOWN) frame.
  - setDown
```
public void setDown(NumberType down)
```
    Sets the size of a DOWN frame (statically).
    
    Specified by:
    
    setDown in interface CommonFrame
    
    Parameters:
    
    down - The number of data iterations in the DOWN frame.
  - setDown
```
public void setDown(double down)
```
    Sets the size of a DOWN frame (statically).
    
    Specified by:
    
    setDown in interface CommonFrame
    
    Parameters:
    
    down - The number of data iterations in the DOWN frame.
  - setHeightChars
```
public void setHeightChars(double height)
```
    Sets the height of the widget.
    
    Specified by:
    
    setHeightChars in interface Sizeable
    
    Parameters:
    
    height - height of the widget
  - setHeightChars
```
public void setHeightChars(NumberType height)
```
    Sets the height of the widget.
    
    Specified by:
    
    setHeightChars in interface Sizeable
    
    Parameters:
    
    height - height of the widget
  - getHeightChars
```
public decimal getHeightChars()
```
    Returns the height of the widget.
    
    Specified by:
    
    getHeightChars in interface Sizeable
    
    Returns:
    
    height of the widget, retrieved from the FRAME:HEIGHT-CHARS attribute.
  - setHeightPixels
```
public void setHeightPixels(int heightPixels)
```
    Sets new value of HEIGHT-PIXELS attribute.
    
    Specified by:
    
    setHeightPixels in interface Sizeable
    
    Parameters:
    
    heightPixels - new value of WIDTH-PIXELS attribute
  - setHeightPixels
```
public void setHeightPixels(NumberType heightPixels)
```
    Sets new value of HEIGHT-PIXELS attribute.
    
    Specified by:
    
    setHeightPixels in interface Sizeable
    
    Parameters:
    
    heightPixels - new value of WIDTH-PIXELS attribute
  - getHeightPixels
```
public integer getHeightPixels()
```
    Returns the width of the widget in pixels. Corresponds Progress HEIGHT-PIXELS attribute.
    
    Specified by:
    
    getHeightPixels in interface Sizeable
    
    Returns:
    
    The width of the widget in pixels.
  - setKeepTabOrder
```
public void setKeepTabOrder(boolean keepTabOrder)
```
    Sets the KEEP-TAB-ORDER option.
    
    Specified by:
    
    setKeepTabOrder in interface CommonFrame
    
    Parameters:
    
    keepTabOrder - true if the option is set to ON.
  - setThreeD
```
public void setThreeD(boolean threeD)
```
    Sets the THREE-D option.
    
    Specified by:
    
    setThreeD in interface CommonFrame
    
    Parameters:
    
    threeD - true if the option is set to ON.
  - setDropTarget
```
public void setDropTarget(boolean dropTarget)
```
    Sets DROP-TARGET option.
    
    Specified by:
    
    setDropTarget in interface CommonFrame
    
    Parameters:
    
    dropTarget - true if the option is set to ON.
  - setNoBox
```
public void setNoBox(boolean noBox)
```
    Sets the NO-BOX option.
    
    Specified by:
    
    setNoBox in interface CommonFrame
    
    Parameters:
    
    noBox - true if the option is set to ON.
  - setNoHide
```
public void setNoHide(boolean noHide)
```
    Sets the NO-HIDE option.
    
    Specified by:
    
    setNoHide in interface CommonFrame
    
    Parameters:
    
    noHide - true if the option is set to ON.
  - setNoLabels
```
public void setNoLabels(boolean noLabels)
```
    Sets the NO-LABELS option.
    
    Specified by:
    
    setNoLabels in interface CommonFrame
    
    Parameters:
    
    noLabels - true if the option is set to ON.
  - setNoUnderline
```
public void setNoUnderline(boolean noUnderline)
```
    Sets the NO-UNDERLINE option.
    
    Specified by:
    
    setNoUnderline in interface CommonFrame
    
    Parameters:
    
    noUnderline - true if the option is set to ON.
  - setNoAutoValidate
```
public void setNoAutoValidate(boolean noAutoValidate)
```
    Sets the NO-AUTO-VALIDATE option.
    
    Specified by:
    
    setNoAutoValidate in interface CommonFrame
    
    Parameters:
    
    noAutoValidate - true if the option is set to ON.
  - setOverlay
```
public void setOverlay(boolean overlay)
```
    Sets the OVERLAY option.
    
    Specified by:
    
    setOverlay in interface CommonFrame
    
    Parameters:
    
    overlay - true if the option is set to ON.
  - getPageBottom
```
public boolean getPageBottom()
```
    Gets the PAGE-BOTTOM option.
    
    Returns:
    
    true if the option is set to ON.
  - setPageBottom
```
public void setPageBottom(boolean pageBottom)
```
    Sets the PAGE-BOTTOM option.
    
    Specified by:
    
    setPageBottom in interface CommonFrame
    
    Parameters:
    
    pageBottom - true if the option is set to ON.
  - getPageTop
```
public boolean getPageTop()
```
    Gets the PAGE-TOP option.
    
    Returns:
    
    true if the option is set to ON.
  - setPageTop
```
public void setPageTop(boolean pageTop)
```
    Sets the PAGE-TOP option.
    
    Specified by:
    
    setPageTop in interface CommonFrame
    
    Parameters:
    
    pageTop - true if the option is set to ON.
  - setParent
```
public void setParent(GenericWidget<?> widget)
```
    Sets the PARENT option.
    
    Specified by:
    
    setParent in interface CommonFrame
    
    Parameters:
    
    widget - New parent widget for frame.
  - getParentHandle
```
public handle getParentHandle()
```
    Get the PARENT option.
    
    Specified by:
    
    getParentHandle in interface CommonFrame
    
    Returns:
    
    handle object for the frame handle.
  - firstChild
```
public handle firstChild()
```
    Get the first child of the frame which will be the field group that contains all non-header widgets.
    
    Specified by:
    
    firstChild in interface CommonFrame
    
    Returns:
    
    The first field group.
  - hasFieldGroup
```
public boolean hasFieldGroup()
```
    Tests if the field group is initialized for this frame.
    
    Returns:
    
    True if its field group has been initialized.
  - wrapWidgetsToFieldGroup
```
private FieldGroup wrapWidgetsToFieldGroup(boolean dynamic,
                                           GenericWidget<?>[] widgets,
                                           FieldGroup beforeFg)
```
    Wraps widgets to the FieldGroup - pseudo-widget used as container of row widgets
    
    Parameters:
    
    dynamic - If true the created field group will be created as dynamic.
    
    widgets - Source widget list
    
    beforeFg - The right neighbor of the field-group been created or null if new field-group will be the last in the chain. If beforeFg is the first element in the chain the new BaseEntity will become the new first element in the chain.
    
    Returns:
    
    FieldGroup with specified widgets
  - setFieldGroupWidgets
```
private void setFieldGroupWidgets(FieldGroup fg,
                                  GenericWidget<?>[] widgets)
```
    Add the specified widgets to that FIELD-GROUP. All widgets will report that they are part of the specified group.
    
    Parameters:
    
    fg - The FIELD-GROUP.
    
    widgets - Source widget list
    
    See Also:
    
    for limitations.
  - checkFieldGroup
```
private void checkFieldGroup(GenericWidget<?> widget)
```
    Check the widget's FIELD-GROUP and log a message if is not part of CURRENT-ITERATION.
    
    Parameters:
    
    widget - The widget to check.
  - setRetain
```
public void setRetain(int retain)
```
    Sets the frame retain size.
    
    Specified by:
    
    setRetain in interface CommonFrame
    
    Parameters:
    
    retain - retain size
  - setRow
```
public void setRow(Resolvable row)
```
    Sets the frame row as a callback to read the current value calculated by the given expression. This value is honored at the time that the frame is made visible (for the first time or after being hidden).
    
    Specified by:
    
    setRow in interface CommonFrame
    
    Parameters:
    
    row - The expression to evaluate for the frame row.
  - setRow
```
public void setRow(Accessor row)
```
    Sets the frame row as a callback to read the current value stored in the given Accessor. This value is honored at the time that the frame is made visible (for the first time or after being hidden).
    
    Specified by:
    
    setRow in interface CommonFrame
    
    Parameters:
    
    row - The instance variable to read for the frame row.
  - setRow
```
public void setRow(NumberType row)
```
    Sets the row position for this frame (statically).
    
    Specified by:
    
    setRow in interface CommonFrame
    
    Parameters:
    
    row - The 1-based row number at which to start displaying the frame. This is converted to a 0-based row number for the internal runtime.
  - setRow
```
public void setRow(double row)
```
    Sets the row position for this frame (statically).
    
    Specified by:
    
    setRow in interface CommonFrame
    
    Parameters:
    
    row - The 1-based row number at which to start displaying the frame. This is converted to a 0-based row number for the internal runtime.
  - setScroll
```
public void setScroll(int scroll)
```
    Sets the frame scroll size.
    
    Specified by:
    
    setScroll in interface CommonFrame
    
    Parameters:
    
    scroll - scroll size
  - setScrollable
```
public void setScrollable(boolean scrollable)
```
    Sets the SCROLLABLE option.
    
    Specified by:
    
    setScrollable in interface CommonFrame
    
    Parameters:
    
    scrollable - true if the option is set to ON.
  - setScrollable
```
public void setScrollable(logical scrollable)
```
    Sets the SCROLLABLE option.
    
    Specified by:
    
    setScrollable in interface CommonFrame
    
    Parameters:
    
    scrollable - true if the option is set to ON.
  - setScrollbarVertical
```
public void setScrollbarVertical(boolean vert)
```
    Sets the SCROLLBAR-VERTICAL option.
    
    Specified by:
    
    setScrollbarVertical in interface CommonFrame
    
    Parameters:
    
    vert - true if the option is set to ON.
  - setSideLabels
```
public void setSideLabels(boolean sideLabels)
```
    Sets the SIDE-LABELS option.
    
    Specified by:
    
    setSideLabels in interface CommonFrame
    
    Parameters:
    
    sideLabels - true if the option is set to ON.
  - setFont
```
public void setFont(long fontNum)
```
    Set the FONT specification of this frame.
    
    Specified by:
    
    setFont in interface CommonFrame
    
    Parameters:
    
    fontNum - The font.
  - setFont
```
public void setFont(int64 fontNum)
```
    Set the FONT specification of this frame.
    
    Specified by:
    
    setFont in interface CommonFrame
    
    Parameters:
    
    fontNum - The font.
  - getFont
```
public integer getFont()
```
    Get the FONT specification of this frame.
    
    Specified by:
    
    getFont in interface CommonFrame
    
    Returns:
    
    See above.
  - getTitle
```
public character getTitle()
```
    Gets the frame title.
    
    Specified by:
    
    getTitle in interface CommonFrame
    
    Returns:
    
    The configured title text or unknown.
  - setTitle
```
public void setTitle(character title)
```
    Sets the frame title.
    
    Specified by:
    
    setTitle in interface CommonFrame
    
    Parameters:
    
    title - The title text to use.
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Sets the frame title.
    
    Specified by:
    
    setTitle in interface CommonFrame
    
    Parameters:
    
    title - The title text to use.
  - setTitle
```
public void setTitle(character title,
                     ColorSpec titleColor)
```
    Sets the frame title and title color.
    
    Specified by:
    
    setTitle in interface CommonFrame
    
    Parameters:
    
    title - The title text to use.
    
    titleColor - The overridden color for the title.
  - setTitle
```
public void setTitle(java.lang.String title,
                     ColorSpec titleColor)
```
    Sets the frame title and title color.
    
    Specified by:
    
    setTitle in interface CommonFrame
    
    Parameters:
    
    title - The title text to use.
    
    titleColor - The overridden color for the title.
  - setDynamicTitle
```
public void setDynamicTitle(BaseDataType title)
```
    Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
    The title's value will be read dynamically (as a callback to the given parameter). The value at the instant of this call is not the value that will necessarily be seen when the frame is viewed.
    
    Specified by:
    
    setDynamicTitle in interface CommonFrame
    
    Parameters:
    
    title - The simple variable or field reference that contains the title text to be used.
  - setDynamicTitle
```
public void setDynamicTitle(Accessor dyntitle)
```
    Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
    The title's value will be read dynamically (as a callback) using the given parameter. The value at the instant of this call is not the value that will necessarily be seen when the frame is viewed.
    
    Specified by:
    
    setDynamicTitle in interface CommonFrame
    
    Parameters:
    
    dyntitle - The simple variable or field reference that contains the title text to be used.
  - setDynamicTitle
```
public void setDynamicTitle(CharacterExpression title)
```
    Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
    The title's value will be read dynamically (as a callback) using the given parameter. The value at the instant of this call is not the value that will necessarily be seen when the frame is viewed.
    
    Specified by:
    
    setDynamicTitle in interface CommonFrame
    
    Parameters:
    
    title - The expression callback that generates the title text to be used.
  - setDynamicTitle
```
public void setDynamicTitle(BaseDataType title,
                            ColorSpec titleColor)
```
    Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
    The title's value will be read dynamically (as a callback to the given parameter). The value at the instant of this call is not the value that will necessarily be seen when the frame is viewed.
    
    Specified by:
    
    setDynamicTitle in interface CommonFrame
    
    Parameters:
    
    title - The simple variable or field reference that contains the title text to be used.
    
    titleColor - The overridden color for the title.
  - setDynamicTitle
```
public void setDynamicTitle(Accessor title,
                            ColorSpec titleColor)
```
    Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
    The title's value will be read dynamically (as a callback) using the given parameter. The value at the instant of this call is not the value that will necessarily be seen when the frame is viewed.
    
    Specified by:
    
    setDynamicTitle in interface CommonFrame
    
    Parameters:
    
    title - The simple variable or field reference that contains the title text to be used.
    
    titleColor - The overridden color for the title.
  - setDynamicTitle
```
public void setDynamicTitle(CharacterExpression title,
                            ColorSpec titleColor)
```
    Sets the frame title to be used when the frame is viewed for the first time or when the frame is viewed for the first time after being hidden.
    The title's value will be read dynamically (as a callback) using the given parameter. The value at the instant of this call is not the value that will necessarily be seen when the frame is viewed.
    
    Specified by:
    
    setDynamicTitle in interface CommonFrame
    
    Parameters:
    
    title - The expression callback that generates the title text to be used.
    
    titleColor - The overridden color for the title.
  - setTitleColor
```
public void setTitleColor(ColorSpec titleColor)
```
    Sets the color for the frame title.
    
    Specified by:
    
    setTitleColor in interface CommonFrame
    
    Parameters:
    
    titleColor - The overridden color for the title.
  - setTitleBgColor
```
public void setTitleBgColor(long bgcolor)
```
    Sets the TITLE-BGCOLOR writable attribute.
    
    Specified by:
    
    setTitleBgColor in interface CommonFrame
    
    Parameters:
    
    bgcolor - The new value for the TITLE-BGCOLOR attribute.
  - setTitleDColor
```
public void setTitleDColor(long dcolor)
```
    Sets the TITLE-DCOLOR writable attribute.
    
    Specified by:
    
    setTitleDColor in interface CommonFrame
    
    Parameters:
    
    dcolor - The new value for the TITLE-DCOLOR attribute.
  - setTitleFgColor
```
public void setTitleFgColor(long fgcolor)
```
    Sets the TITLE-FGCOLOR writable attribute.
    
    Specified by:
    
    setTitleFgColor in interface CommonFrame
    
    Parameters:
    
    fgcolor - The new value for the TITLE-FGCOLOR attribute.
  - setTitleFont
```
public void setTitleFont(long fontNum)
```
    Set the TITLE-FONT attribute of this browse widget.
    
    Specified by:
    
    setTitleFont in interface CommonFrame
    
    Parameters:
    
    fontNum - An entry in the font-table or unknown to refer the default font.
  - setTopOnly
```
public void setTopOnly(boolean topOnly)
```
    Sets the TOP-ONLY option.
    
    Specified by:
    
    setTopOnly in interface CommonFrame
    
    Parameters:
    
    topOnly - true if the option is set to ON.
  - setWidthChars
```
public void setWidthChars(double width)
```
    Sets the width of the widget.
    
    Specified by:
    
    setWidthChars in interface Sizeable
    
    Parameters:
    
    width - width of the widget
  - setWidth
```
public void setWidth(NumberType widthChars)
```
    Set the WIDTH Progress attribute. This attribute is an alias for WIDTH-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-SET(widget, "WIDTH") works properly.
    
    Specified by:
    
    setWidth in interface Sizeable
    
    Parameters:
    
    widthChars - The integer value for the new WIDTH value.
  - setWidthChars
```
public void setWidthChars(NumberType width)
```
    Sets the width of the widget.
    
    Specified by:
    
    setWidthChars in interface Sizeable
    
    Parameters:
    
    width - width of the widget
  - getWidthChars
```
public decimal getWidthChars()
```
    Returns the width of the widget.
    
    Specified by:
    
    getWidthChars in interface Sizeable
    
    Returns:
    
    width of the widget, retrieved from the FRAME:WIDTH-CHARS attribute.
  - getWidth
```
public decimal getWidth()
```
    Get the WIDTH Progress attribute. The value is equal to the current component char width. This attribute is an alias for WIDTH-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-QUERY(widget, "WIDTH") works properly.
    
    Specified by:
    
    getWidth in interface Sizeable
    
    Returns:
    
    The integer value of the WIDTH attribute.
  - getHeight
```
public decimal getHeight()
```
    Get the HEIGHT Progress attribute. The value is equal to the current component char height. This attribute is an alias for HEIGHT-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-QUERY(widget, "HEIGHT") works properly.
    
    Specified by:
    
    getHeight in interface Sizeable
    
    Returns:
    
    The integer value of the HEIGHT attribute.
  - setHeight
```
public void setHeight(NumberType heightChars)
```
    Set the HEIGHT Progress attribute. This attribute is an alias for HEIGHT-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-SET(widget, "HEIGHT") works properly.
    
    Specified by:
    
    setHeight in interface Sizeable
    
    Parameters:
    
    heightChars - The integer value for the new HEIGHT value.
  - getWidthPixels
```
public integer getWidthPixels()
```
    Returns the width of the widget in pixels. Corresponds Progress WIDTH-PIXELS attribute.
    
    Specified by:
    
    getWidthPixels in interface Sizeable
    
    Returns:
    
    The width of the widget in pixels.
  - setWidthPixels
```
public void setWidthPixels(NumberType widthPixels)
```
    Sets new value of WIDTH-PIXELS attribute.
    
    Specified by:
    
    setWidthPixels in interface Sizeable
    
    Parameters:
    
    widthPixels - new value of WIDTH-PIXELS attribute
  - setWidthPixels
```
public void setWidthPixels(int widthPixels)
```
    Sets new value of WIDTH-PIXELS attribute.
    
    Specified by:
    
    setWidthPixels in interface Sizeable
    
    Parameters:
    
    widthPixels - new value of WIDTH-PIXELS attribute
  - getX
```
public integer getX()
```
    Returns the horisontal position of the frame. Corresponds Progress X attribute.
    
    Specified by:
    
    getX in interface CommonFrame
    
    Returns:
    
    the horisontal position of the frame.
  - getY
```
public integer getY()
```
    Returns the vertical position of the frame. Corresponds Progress Y attribute.
    
    Specified by:
    
    getY in interface CommonFrame
    
    Returns:
    
    the vertical position of the frame.
  - setX
```
public void setX(NumberType x)
```
    Sets the horizontal position of the frame (Progress X attribute).
    
    Specified by:
    
    setX in interface CommonFrame
    
    Parameters:
    
    x - horizontal position to be set.
  - setX
```
public void setX(int x)
```
    Sets the horizontal position of the frame (Progress X attribute).
    
    Specified by:
    
    setX in interface CommonFrame
    
    Parameters:
    
    x - horizontal position to be set.
  - setY
```
public void setY(NumberType y)
```
    Sets the vertical position of the frame (Progress Y attribute).
    
    Specified by:
    
    setY in interface CommonFrame
    
    Parameters:
    
    y - vertical position to be set.
  - setY
```
public void setY(int y)
```
    Sets the vertical position of the frame (Progress Y attribute).
    
    Specified by:
    
    setY in interface CommonFrame
    
    Parameters:
    
    y - vertical position to be set.
  - setDefaultButtonOption
```
public void setDefaultButtonOption(GenericWidget<?> defaultButton)
```
    Sets the default button for this frame (an option in the frame phrase).
    
    Specified by:
    
    setDefaultButtonOption in interface CommonFrame
    
    Parameters:
    
    defaultButton - button widget that works as the default
  - setCancelButtonOption
```
public void setCancelButtonOption(GenericWidget<?> cancelButton)
```
    Sets the cancel button for this frame (an option in the frame phrase).
    
    Specified by:
    
    setCancelButtonOption in interface CommonFrame
    
    Parameters:
    
    cancelButton - button widget that receives the CHOOSE event when a user cancels the current frame or dialog box by pressing the ESC key.
  - setStatisticsColumn
```
public void setStatisticsColumn(GenericWidget<?> widget)
```
    Sets the widget which will be used to display the description for any given statistic that is being automatically aggregated by the display(com.goldencode.p2j.util.handle) processing.
    
    Specified by:
    
    setStatisticsColumn in interface CommonFrame
    
    Parameters:
    
    widget - The widget to use as the statistics column.
  - openScope
```
public void openScope()
```
    Notifies the frame about entering a new frame scope. This may occur more than once for a given frame due to retries or (more likely) due to a frame being scoped to a block that is nested inside a loop. In the case where this is a shared frame, this will be called more than once while a previous frame scope is still open.
    This method registers a callback for the block exit event. The callback finalizes the frame and all contained widgets.
    On block iterate or retry, frame state will also be maintained.
    
    Specified by:
    
    openScope in interface CommonFrame
  - finished
```
public void finished()
```
    Cleanup that must occur at the end of the block to which the frame is scoped.
    
    Specified by:
    
    finished in interface Finalizable
  - deleted
```
public void deleted()
```
    This is a no-op.
    
    Specified by:
    
    deleted in interface Finalizable
  - destroy
```
public void destroy()
```
    Final cleanups when frame completely leaves outer execute() scope (only occurs once for a frame, even if this is a shared frame which has nested openScope() invocations).
  - iterate
```
public void iterate()
```
    Provides a notification that the block whose scope in which the object is registered is about to iterate and attempt another pass. This provides an opportunity to preserve state from the previous pass and make preparations for the coming pass.
    
    Specified by:
    
    iterate in interface Finalizable
  - retry
```
public void retry()
```
    Provides a notification that the block whose scope in which the object is registered is about to retry and re-attempt the current iteration. This provides an opportunity to clear or reset state from the previous pass.
    
    Specified by:
    
    retry in interface Finalizable
  - startEditingMode
```
public void startEditingMode(FrameElement[] list,
                             int type)
```
    Marks the beginning of the editing block.
    
    Specified by:
    
    startEditingMode in interface CommonFrame
    
    Parameters:
    
    list - List of frame elements controlled by this editing block. This is used to ensure that the proper semantics of update or set are honored at editing block start (optionally copying data into the screen buffer, enabling widgets and view).
    
    type - Specifies if this editing block must operates like promptFor(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) (no copying to or from the screen buffer), set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) (no copying to the screen buffer) or update(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) (copying both directions). Use the constants PROMPT_FOR, SET and UPDATE to specify this parameter.
  - startEditingMode
```
public void startEditingMode(FrameElement[] list,
                             int type,
                             EventList wait)
```
    Marks the beginning of the editing block with caller control over the exit conditions for the loop.
    
    Specified by:
    
    startEditingMode in interface CommonFrame
    
    Parameters:
    
    list - List of frame elements controlled by this editing block. This is used to ensure that the proper semantics of update or set are honored at editing block start (optionally copying data into the screen buffer, enabling widgets and view).
    
    type - Specifies if this editing block must operates like promptFor(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) (no copying to or from the screen buffer), set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) (no copying to the screen buffer) or update(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) (copying both directions). Use the constants PROMPT_FOR, SET and UPDATE to specify this parameter.
    
    wait - List of events to wait for.
  - underline
```
public void underline(GenericWidget<?>[] list)
```
    Displays an underline for the specified field-level widgets of the frame. Does not permanently change the attributes for the given widgets!
    This method corresponds to these Progress statements: UNDERLINE
    
    Specified by:
    
    underline in interface CommonFrame
    
    Parameters:
    
    list - List of widgets.
  - underline
```
public void underline(int[] list)
```
    Displays an underline for the specified field-level widgets of the frame. Does not permanently change the attributes for the given widgets!
    This method corresponds to these Progress statements: UNDERLINE
    
    Specified by:
    
    underline in interface CommonFrame
    
    Parameters:
    
    list - List of widget ids.
  - underline
```
public void underline(Stream stream,
                      GenericWidget<?>[] list)
```
    Displays an underline for the specified field-level widgets of the frame. Does not permanently change the attributes for the given widgets!
    This method corresponds to these Progress statements: UNDERLINE
    
    Specified by:
    
    underline in interface CommonFrame
    
    Parameters:
    
    stream - An explicit stream which will be used for the output.
    
    list - List of widgets.
  - underline
```
public void underline(Stream stream,
                      int[] list)
```
    Displays an underline for the specified field-level widgets of the frame. Does not permanently change the attributes for the given widgets!
    This method corresponds to these Progress statements: UNDERLINE
    
    Specified by:
    
    underline in interface CommonFrame
    
    Parameters:
    
    stream - An explicit stream which will be used for the output.
    
    list - List of widget ids.
  - waitFor
```
public void waitFor()
```
    Waits for a default list of events.
    This method corresponds to the Progress statement:
    WAIT-FOR
    
    Specified by:
    
    waitFor in interface CommonFrame
  - waitFor
```
public void waitFor(EventList el)
```
    Waits for specified list of events.
    This method corresponds to the Progress statement:
    WAIT-FOR
    
    Specified by:
    
    waitFor in interface CommonFrame
    
    Parameters:
    
    el - List of events to wait for.
  - waitFor
```
public void waitFor(EventList el,
                    GenericWidget<?> focusWidget)
```
    Waits for specified list of events.
    This method corresponds to the Progress statement:
    WAIT-FOR FOCUS widget
    
    Specified by:
    
    waitFor in interface CommonFrame
    
    Parameters:
    
    el - List of events to wait for.
    
    focusWidget - Widget which is in focus.
  - waitFor
```
public void waitFor(EventList el,
                    int seconds)
```
    Waits for specified list of events.
    This method corresponds to the Progress statement:
    WAIT-FOR PAUSE n
    
    Specified by:
    
    waitFor in interface CommonFrame
    
    Parameters:
    
    el - List of events to wait for.
    
    seconds - Time to wait for event.
  - waitFor
```
public void waitFor(EventList el,
                    GenericWidget<?> focusWidget,
                    int seconds)
```
    Waits for specified list of events.
    This method corresponds to the Progress statement:
    WAIT-FOR FOCUS widget PAUSE n
    
    Specified by:
    
    waitFor in interface CommonFrame
    
    Parameters:
    
    el - List of events to wait for.
    
    focusWidget - Widget which is in focus.
    
    seconds - Time to wait for event.
  - waitForNextKey
```
public void waitForNextKey()
```
    Blocks until a next UI event is available (returns immediately if an event is already available).
    
    Specified by:
    
    waitForNextKey in interface CommonFrame
  - cleanNonTabItems
```
public void cleanNonTabItems()
```
    Remove from the list of tab items the items that became non-tab items.
    
    Specified by:
    
    cleanNonTabItems in interface CommonFrame
  - stopEditingMode
```
public void stopEditingMode(FrameElement[] list,
                            boolean normal,
                            boolean cleanup)
```
    Marks the end of the editing block when triggered by any abnormal exit from the block on the server. This method does NOT need to be called if the exit is naturally triggered via continueEditing(com.goldencode.p2j.ui.FrameElement[], boolean). This method allows the client's state to be cleaned up in the abnormal termination case.
    
    Parameters:
    
    list - List of frame elements controlled by this editing block. This is used to ensure that the proper semantics of update or set are honored at editing block exit (disabling widgets and assigning data back).
    
    normal - true if this was triggered as the result of the natural pending GO exit from the editing block (if this was the result of a call to continueEditing(com.goldencode.p2j.ui.FrameElement[], boolean)). false if this was due to an abnormal exit and the client's state needs cleanup.
    
    cleanup - true if the client side cleanup is needed.
  - continueEditing
```
public boolean continueEditing(FrameElement[] list,
                               boolean hadNext)
```
    Checks to see whether a pending GO event is about to end the editing block.
    
    Specified by:
    
    continueEditing in interface CommonFrame
    
    Parameters:
    
    list - List of frame elements controlled by this editing block. This is used to ensure that the proper semantics of update or set are honored at editing block exit (disabling widgets and assigning data back).
    
    hadNext - true if the executing business logic executed a NEXT statement causing the editing block to iterate. This will result in clearing any current GO-PENDING condition. This is passed as a parameter here so that a separate trip down to the client is not needed to process the editing block iteration state update.
    
    Returns:
    
    true if there is no GO-PENDING and the editing mode continues.
  - validate
```
public logical validate()
```
    Executes the validation tests for every supported field-level widget in the frame (except the browse, which you must validate explicitly). Corresponds Progress VALIDATE method.
    
    Specified by:
    
    validate in interface CommonFrame
    
    Returns:
    
    true if validation was successful.
  - setColors
```
public void setColors(ColorSpec display,
                      ColorSpec prompt,
                      GenericWidget<?>[] widgets)
```
    Sets custom colors for output fields, input fields, or both in all specified widgets.
    This method corresponds to these Progress statements:
    COLOR DISPLAY [PROMPT]
    COLOR PROMPT
    
    Specified by:
    
    setColors in interface CommonFrame
    
    Parameters:
    
    display - A color specification for regular output or null if no change is required.
    
    prompt - A color specification for input or null if no change is required.
    
    widgets - Array of target widgets. All elements must be in the same frame.
  - setColors
```
public void setColors(ColorSpec display,
                      ColorSpec prompt,
                      GenericWidget<?> widget)
```
    Sets custom colors for the given output field, input field, or both.
    This method corresponds to these Progress statements:
    COLOR DISPLAY [PROMPT]
    COLOR PROMPT
    
    Specified by:
    
    setColors in interface CommonFrame
    
    Parameters:
    
    display - A color specification for regular output or null if no change is required.
    
    prompt - A color specification for input or null if no change is required.
    
    widget - The target widget.
  - valid
```
boolean valid()
```
    Reports if this frame object is valid for use.
    The validity of the frame object is determined solely by being in scope.
    
    Returns:
    
    true if we are valid (can be used).
  - getFrameId
```
public int getFrameId()
```
    Gets the unique numeric ID of this frame.
    
    Specified by:
    
    getFrameId in interface CommonFrame
    
    Returns:
    
    frame ID
  - getFrameBufferRaw
```
public ScreenBuffer getFrameBufferRaw()
```
    Gets the screen buffer reference for this frame, without any update to dynamic content.
    
    Returns:
    
    The screen buffer reference.
  - getFrameBuffer
```
public ScreenBuffer getFrameBuffer(boolean force)
```
    Gets the differential screen buffer of this frame.
    
    Parameters:
    
    force - Flag indicating if the screen buffer is resolved regardless if was changed or not.
    
    Returns:
    
    The screen buffer modifications.
  - getFrameWidget
```
public FrameWidget getFrameWidget()
```
    Gets the frame widget of this frame.
    
    Returns:
    
    FrameWidget
  - getSelection
```
public int[] getSelection(GenericWidget<?> widget)
```
    Request indexes of selected items in RadioSet, ComboBox or SelectionList widgets.
    
    Parameters:
    
    widget - Widget for which request should be performed.
    
    Returns:
    
    array of 0-based indexes of selected items or null if specified widget does not exists or does not support such a request.
  - getName
```
public java.lang.String getName(GenericWidget<?> widget)
```
    Get widget name for the given widget.
    
    Parameters:
    
    widget - Widget to look name for.
    
    Returns:
    
    Widget name.
  - getOriginalName
```
public java.lang.String getOriginalName(GenericWidget<?> widget)
```
    Get original widget name for the given widget.
    
    Parameters:
    
    widget - Widget to look name for.
    
    Returns:
    
    original widget name.
  - getValidationSet
```
public java.util.Set<GenericWidget<?>> getValidationSet()
```
    Gets a set of widgets of this frame that require validation.
    
    Returns:
    
    a Set of widgets, which may be empty.
  - setHadView
```
public void setHadView()
```
    Mark frame as viewed.
  - isViewed
```
public boolean isViewed()
```
    Get state of internal flag which is set to true if frame was viewed at client at least once.
    
    Returns:
    
    true if frame was viewed.
  - isCanHide
```
public boolean isCanHide()
```
    Check if frame can hide other frames.
    
    Returns:
    
    true if frame can hide other frames.
  - moveAfterTabItem
```
public boolean moveAfterTabItem(GenericWidget<?> widget)
```
    This method implements MOVE-AFTER-TAB function.
    
    Specified by:
    
    moveAfterTabItem in interface CommonFrame
    
    Parameters:
    
    widget - Widget reference.
    
    Returns:
    
    true if operation was successful.
  - convertScreenValue
```
public java.lang.Object convertScreenValue(java.lang.Class<?> dataType,
                                           java.lang.Object value,
                                           java.lang.String format)
```
    Convert given value into proper form for further conversion onto SCREEN-VALUE.
    In cases when dataType is character and the value is a logical value, then the result will be the logical value formatted using the given format.
    
    Parameters:
    
    dataType - Desired data type.
    
    value - Source value to convert from.
    
    format - The widget's format. Currently used only for logical values.
    
    Returns:
    
    Converted value.
  - hideWorker
```
void hideWorker(boolean noPause,
                boolean hidden)
```
    A worker to perform frame hide. This is possible in two ways: via the HIDE statement or by setting the frame's attribute. The hidden flag will be set to true if frame is hidden by setting the frame's HIDDEN attribute to true. Otherwise, it is assumed a HIDE statement is in effect.
    
    Parameters:
    
    noPause - true if NO-PAUSE option was used
    
    hidden - true if HIDDEN attribute was set to true.
  - getScopeNesting
```
int getScopeNesting()
```
    Get the current scope nesting.
    
    Returns:
    
    The scopeNesting value.
  - frameDelete
```
void frameDelete()
```
    Delete this frame, if is not dynamic and its associated instantiated procedure no longer exists.
  - frameCleanup
```
void frameCleanup()
```
    Cleanup this frame, as it was deleted.
  - triggerEnter
```
void triggerEnter()
```
    Mark beginning of trigger processing.
  - triggerLeave
```
void triggerLeave()
```
    Mark end of trigger processing.
  - pushScreenDefinition
```
void pushScreenDefinition()
```
    Conditionally pushes the screen definition instance down to the client. If modifications are currently being batched, no action is taken. Otherwise, a new screen definition is built and sent to the client.
    When the screen definition is built, a method of LogicalTerminal is called to send it down to the client.
  - pushScreenDefinition
```
void pushScreenDefinition(boolean force)
```
    Conditionally pushes the screen definition instance down to the client. If modifications are currently being batched, no action is taken. Otherwise, a new screen definition is built and sent to the client.
    When the screen definition is built, a method of LogicalTerminal is called to send it down to the client.
    
    Parameters:
    
    force - true to ensure that the screen definition will be synchronously pushed to the client. false to defer the push.
  - setScreenBuffer
```
void setScreenBuffer(ScreenBuffer sb,
                     boolean allow)
```
    Sets a new ScreenBuffer for this frame.
    
    Parameters:
    
    sb - new ScreenBuffer for this frame
    
    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.
  - getWidgetId
```
int getWidgetId(java.lang.String widgetName)
```
    Returns -1 if the widget name is invalid or null, otherwise it returns the assigned widget ID.
    
    Parameters:
    
    widgetName - A widget name.
    
    Returns:
    
    The numeric ID assigned to the widget or -1 if no such widget exists.
  - getWidgetId
```
int getWidgetId(GenericWidget<?> widget)
```
    Returns -1 if the widget is invalid or null, otherwise it returns the assigned widget ID.
    
    Parameters:
    
    widget - A widget instance in the frame.
    
    Returns:
    
    The numeric ID assigned to the widget or -1 if no such widget exists.
  - getFrameWidgetId
```
int getFrameWidgetId(GenericWidget<?> widget)
```
    Returns -1 if the widget is invalid, otherwise it returns the assigned widget ID.
    
    Parameters:
    
    widget - A widget instance in the frame.
    
    Returns:
    
    The numeric ID assigned to the widget or -1 if no such widget exists.
  - getWidgetForId
```
GenericWidget<?> getWidgetForId(int id)
```
    Looks up the widget by its ID.
    
    Parameters:
    
    id - The numeric ID assigned to the widget.
    
    Returns:
    
    The associated widget instance or null if a widget by that ID does not exist in this frame.
  - getWindowId
```
int getWindowId()
```
    Get an ID of window owning this frame or -1 when there is no owning window.
    
    Returns:
    
    See above.
  - getHeaderWidgetForId
```
GenericWidget<?> getHeaderWidgetForId(int id)
```
    Looks up the header widget by its ID.
    
    Parameters:
    
    id - The numeric ID assigned to the header widget.
    
    Returns:
    
    The associated header widget instance or null if a widget by that ID does not exist in this frame.
  - setCondition
```
void setCondition()
```
    Let frame know that there was a condition during frame processing.
  - getField
```
static boolean getField(Stream in,
                        Accessor data,
                        ScreenBuffer frameBuf,
                        GenericWidget<?> wid,
                        java.lang.String fmt,
                        boolean assign)
                 throws EndConditionException,
                        ErrorConditionException
```
    Read the next field from the given stream using any whitespace as the delimiter and validate the data against the widget's format string before assigning the data into the screen-buffer and back to the user's variable. Screen-buffer and widget processing can be bypassed by passing null for these values and in this case, the stream reading will not operate upon any of the user interface state.
    If the current line buffer is empty, a new line will be read from the stream.
    In the following conditions, no assignment will be made:
    - a field is requested after the entire line has already been processed
    - an unquoted hyphen is used as the contents of the field AND the delimiter is NOT a hyphen (the index is still incremented past the field)
    - the first char of a field starts with a double quote but there is no closing quote (the index is incremented to the end of the buffer)
    After all field reads for a given line are complete, Stream.resetCurrentLine must be called to enable input for the next line. Otherwise, all subsequent reads will continue trying to read from the current line. This will result in reading data left on the current line or reading nothing if the line has already been fully read. Stream.resetCurrentLine notifies the stream environment that it should move to processing the next line.
    This method is used to implement the non-interactive field level input reading for SET, UPDATE and PROMPT-FOR 4GL language statements.
    Parameters:
    
    in - The input stream from which to read.
    
    data - The variable to process. If null, then the field must be read but the data should be discarded.
    
    frameBuf - The frame buffer to update. Should be null if there is no frame buffer to update.
    
    wid - The widget to process. Should be null if the data parameter is null or if there is no associated widget.
    
    fmt - Format string to use for validation. If null obtain it from the widget (if specified) or use the default for the data type if there is no widget.
    
    assign - true if the read data should be assigned back to the caller's data instance.
    
    Returns:
    
    true if no error occurred, false if further processing should be aborted due to a failure in this method.
    
    Throws:
    
    EndConditionException
    
    ErrorConditionException
  - addWidget
```
void addWidget(GenericWidget<?> widget)
```
    Adding new widget to the current frame. This is the "inverted" version of the widget.setFrame().
    
    Parameters:
    
    widget - The widget to be added to current frame.
  - removeWidget
```
public void removeWidget(GenericWidget<?> widget)
```
    Remove the specified widget from this frame.
    
    Parameters:
    
    widget - The widget to remove.
  - addDynamicWidget
```
void addDynamicWidget(GenericWidget<?> dynWidget)
```
    Adding new dynamic widget to the current frame.
    
    Parameters:
    
    dynWidget - The widget to be added to current frame.
  - deleteDynamicWidget
```
void deleteDynamicWidget(GenericWidget<?> dynWidget)
```
    Removing dynamic widget from the current frame.
    
    Parameters:
    
    dynWidget - The widget to be deleted from the current frame.
  - deleteDynamicWidget
```
void deleteDynamicWidget(GenericWidget<?> dynWidget,
                         boolean pushScreenDefinitions)
```
    Removing dynamic widget from the current frame.
    
    Parameters:
    
    dynWidget - The widget to be deleted from the current frame.
    
    pushScreenDefinitions - true to push screen definitions, false to avoid pushing in order to prevent recursive invocations.
  - placeFrame
```
void placeFrame()
```
    Place the frame.
  - getDynamicWidgetName
```
private java.lang.String getDynamicWidgetName(GenericWidget<?> dynWidget)
```
    Construct the string name for dynamic widget based on unique ID number.
    
    Parameters:
    
    dynWidget - The widget the name will be generated to.
    
    Returns:
    
    The String for dynamic widget name in string form of "ID".
  - resetFrameBuf
```
private void resetFrameBuf()
```
    Reset frame buffer. Make sure that static widgets are not reset if frame was not displayed yet.
    NOTE: Current approach assumes that frame is either, at least once displayed or not displayed but only static widgets are assigned. This may result to differences in behavior with Progress when regular (non-static) widget is updated, frame is reset and only then is displayed.
  - promptForWorker
```
private void promptForWorker(GenericWidget<?>[] widgets,
                             EventList wait,
                             boolean windowClause,
                             handle hWin)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Parameters:
    
    widgets - The list of widgets which is to be edited.
    
    wait - The list of events to treat as a GO event.
    
    windowClause - true if windowClause is presented in DISPLAY stmt. false otherwise
    
    hWin - A handle to the window where the frame is displayed.
  - promptForWorker
```
private void promptForWorker(FrameElement[] widgets,
                             EventList wait,
                             boolean windowClause,
                             handle hWin)
```
    Enables a list of widgets from the frame on the screen, shifts into input blocking mode via waitFor() and after the user's edits are complete the list of widgets are disabled. No data is copied to or from the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: PROMPT-FOR
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is not used at all.
    
    wait - The list of events to treat as a GO event.
    
    windowClause - true if windowClause is presented in DISPLAY stmt. false otherwise
    
    hWin - A handle to the window where the frame is displayed.
  - updateWorker
```
private void updateWorker(Stream in,
                          FrameElement[] data,
                          boolean windowClause,
                          handle hWin)
```
    /** For each entry in the widget array, the input stream will be read and the widget's associated field in the screen buffer will be set. The data passed in will be copied from the user's variables into the screen buffer. After the input is read from the stream into the screen buffer, that data will be copied back from the screen buffer to the user's variables.
    Any error during stream reading or data parsing will cause an error condition to be generated. Reaching the end of the stream will cause an end condition to be generated. Unlike the update version in this class which has a "hidden" retry block around the core "set" processing, this streams version has no such feature. Errors will be immediately seen by the caller.
    Both the input stream and the current default output stream (if output is redirected) are checked. If both are set to echo mode, then after all stream input is done, the screen buffer's contents will be echoed to the current output destination using view(com.goldencode.p2j.util.handle). This will occur whether or not an error occurs during stream processing and data parsing.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    Note that this method does change the LASTKEY value to 13 if input stream contains at least one character. If input stream is empty then END condition is triggered.
    This method corresponds to these Progress statements: UPDATE
    
    Parameters:
    
    in - A stream instance which is open for reading.
    
    data - The list of widgets which are to receive input from the stream.
    
    windowClause - true if windowClause is presented in DISPLAY stmt. false otherwise
    
    hWin - A handle to the window where the frame is displayed.
  - updateWorker
```
private void updateWorker(FrameElement[] widgets,
                          EventList wait,
                          boolean windowClause,
                          handle hWin)
```
    Copies data from the frame elements to each corresponding widget, then enables the list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets are disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method uses display(com.goldencode.p2j.util.handle) and set(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) to do its real work. The only difference is that the set is embedded inside a "hidden" TransactionManager block which handles undo/retry on error conditions and undo/leave on end conditions.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: UPDATE
    
    Parameters:
    
    widgets - The list of data and widgets which is to be updated.
    
    wait - The list of events to treat as a GO event.
    
    windowClause - true if windowClause is presented in DISPLAY stmt. false otherwise
    
    hWin - A handle to the window where the frame is displayed.
  - setWorker
```
private void setWorker(FrameElement[] widgets,
                       EventList wait,
                       boolean def,
                       boolean windowClause,
                       handle hWin)
```
    Enables a list of widgets, shifts into input blocking mode via waitFor(), after the user's edits are complete the list of widgets is disabled and the edited data is copied from the screen buffer to the listed frame elements.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    The assignment honors any EmbeddedAssignment instances in the frame element list, in the order in which they appear. Otherwise, these do not affect the user interface processing in any way.
    If the unnamed input is redirected, this method will redirect its own execution to the stream form. In such a case, all interactive processing is bypassed.
    This method corresponds to these Progress statements: SET
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is only used on output (they are assigned to the values provided by the user).
    
    wait - The list of events to treat as a GO event.
    
    def - true means that default values will be used if screen buffer does not contain updated values.
    
    windowClause - true if windowClause is presented in DISPLAY stmt. false otherwise
    
    hWin - A handle to the window where the frame is displayed.
  - frameLineWorker
```
private int frameLineWorker()
```
    Returns the current logical line number in a frame.
    This method corresponds to the Progress built-in function FRAME-LINE
    Returns:
    1-based ordinal of the current data iteration of the frame. If the frame is redirected to a stream or if the frame is not visible, then 0 is returned. If the frame is not a down frame then 1 will be returned. Can return the value outside of the frame. For example for this sequence of calls for 4-down frame:
    down(3). // postions on the 4th row down(). // +1 down(1). // in downWorker this method returns 5
    this method will return 5. It also confroms to FRAME-LINE behavior.
  - processAggregates
```
private void processAggregates(FrameElement[] fe,
                               boolean accumulate)
```
    Processes any aggregator elements in the given array of frame elements. The first time this method is invoked within a particular display loop, an AggregateHandler instance is created. This instance is stored in an instance member, which is cleared when the display loop is terminated. Each time this method is invoked, the handler is requested to accumulate data in all of the associated Accumulator instances (if any) associated with the given frame elements.
    
    Parameters:
    
    fe - The list of widgets that may need accumulation.
    
    accumulate - Flag indicating if accumulation should be performed. If false, the widgets which have aggregators will be registered with this frame.
  - isPageElement
```
boolean isPageElement(Stream out)
```
    Reports if this frame is a page element (a header or footer). This is only true in the case that the output stream is paged AND this frame is marked as a page-top (header) or a page-bottom (footer).
    
    Parameters:
    
    out - The output destination.
    
    Returns:
    
    true if this is a header or footer.
  - isRedirected
```
boolean isRedirected()
```
    Reports if the unnamed stream is redirected at this time.
    
    Returns:
    
    true if the unnamed stream is redirected
  - isRealized
```
boolean isRealized()
```
    Reports if the frame was already realized.
    
    Returns:
    
    true if the frame was realized
  - isOutRedirected
```
boolean isOutRedirected()
```
    Reports if there is a cached output stream for use with redirecting the output from aggregation.
    
    Returns:
    
    true if aggregation output is redirected
  - isOutTerm
```
boolean isOutTerm()
```
    Check if output stream is a terminal.
    
    Returns:
    
    true if output stream is terminal.
  - finishConfigProcessing
```
void finishConfigProcessing()
```
    Finish the config processing for this frame.
    This includes registering the active configuration for each new widget, and synchronizing the widget configuration with the actual widget state.
  - initialize
```
private void initialize(java.lang.Class<?> configClass,
                        java.lang.Object configInstance,
                        java.lang.String frameName)
```
    Full initialization processing.
    
    Parameters:
    
    configClass - The class of the configuration implementation class.
    
    configInstance - The instance of the configuration implementation class.
    
    frameName - The frame name.
  - coreInitialize
```
private boolean coreInitialize(java.lang.Class<?> configClass,
                               java.lang.Object configInstance,
                               java.lang.String frameName,
                               boolean dynamic)
```
    Core initialization processing. This stores both the legacy 4GL with case preserved as well as the internal frame name, which is modified to be all lowercase. This allows for easier case-insensive frame comparisons, as well as being compatible with the 4GL FRAME-NAME attribute, which corresponds to the first use of a frame's name.
    
    Parameters:
    
    configClass - The class of the configuration implementation class.
    
    configInstance - The instance of the configuration implementation class.
    
    frameName - The frame name
    
    dynamic - Flags the dynamic frame preparation.
    
    Returns:
    
    true on success. If initialization could not be done (E.g. because the new frame definition does not match the master frame) the method returns false.
  - initBackgroundGroup
```
private void initBackgroundGroup()
```
    Create BACKGROUND field group for the frame and add background widgets to it, if any.
  - initLiteralFG
```
private FieldGroup initLiteralFG()
```
    Literal field group initialization procedure. Used to return literal group to initial state after modifications.
    
    Returns:
    
    The literal field group for given frame.
  - createLiteralWidget
```
private LiteralWidget createLiteralWidget(GenericWidget<?> widget,
                                          java.lang.String txt)
```
    Create a LITERAL widget to be added to the literalFieldGroup.
    
    Parameters:
    
    widget - The widget from which the LABEL is resolved - is null for the separator.
    
    txt - The text for the LITERAL widget.
    
    Returns:
    
    A new LITERAL widget which dispatches the SCREEN-VALUE to the associated widget's LABEL, or uses the passed text for the separator LITERAL.
  - initializeEmptyFrame
```
private void initializeEmptyFrame(java.lang.Class<?> configClass,
                                  java.lang.Object configInstance,
                                  FrameWidget frameWidget)
```
    Full initialization processing for empty frame. Used for dynamic frame preparation.
    
    Parameters:
    
    configClass - The class of the configuration implementation class.
    
    configInstance - The instance of the configuration implementation class.
    
    frameWidget - The frame widget to use as the base for new generic frame.
  - processStreamInput
```
private void processStreamInput(Stream in,
                                FrameElement[] wids,
                                boolean assign,
                                boolean windowClause,
                                handle hWin)
                         throws EndConditionException,
                                ErrorConditionException
```
    Drive the input stream reading process, where each frame element in the list resolves to the read of a field from the stream, a bypass of the field in the stream or an embedded assignment. This is an alternative process to the traditional promptFor(com.goldencode.p2j.ui.FrameElement[], com.goldencode.p2j.util.handle) processing. In particular, while the screen buffer is modified during this processing, the state of the UI is not otherwise modified. This is just a way to redirect input from a stream and read that input from user interface specific APIs.
    Note that this method does change the LASTKEY value to 13 if input stream contains at least one character. If input stream is empty then END condition is triggered.
    
    Parameters:
    
    in - The input stream from which to read.
    
    wids - The variables and widgets to process. Any null elements and widget only elements are ignored.
    
    assign - true if the read data should be assigned back to the caller's data instance.
    
    windowClause - true if windowClause is presented in DISPLAY stmt. false otherwise
    
    hWin - A handle to the window where the frame is displayed.
    
    Throws:
    
    EndConditionException
    
    ErrorConditionException
  - getWidget
```
private GenericWidget<?> getWidget(java.lang.String widgetName,
                                   int op,
                                   int numArgs,
                                   java.lang.Object index)
```
    Core widget accessor processing, which handles the various widget name forms and the lookup of the widget including proper processing of array elements.
    This method handles name processing in both the J2SE-compatible form as well as the "simplified" naming that always decapitalizes the first letter of all widget names.
    This method also handles the case when one widget represents entire array of widgets.
    
    Parameters:
    
    widgetName - The base name of the widget to lookup, taken directly from the proxy method name.
    
    op - The type of the operation (get, set or accessor).
    
    numArgs - The number of arguments passed to the proxy handler.
    
    index - The index of an array element or null if no array processing is needed.
    
    Returns:
    
    The widget by that name or null if no widget can be found by that name.
  - getWidgetByName
```
private GenericWidget<?> getWidgetByName(java.lang.String name)
```
    Simple helper to lookup a widget by a given name.
    
    Parameters:
    
    name - The case-sensitive widget name to retrieve.
    
    Returns:
    
    The widget by that name or null if no widget can be found by that name.
  - getter
```
private java.lang.Object getter(java.lang.String widgetName,
                                java.lang.Class<?> dataType)
```
    Returns the current screen value of the specified widget.
    Parameters:
    
    widgetName - The widget name.
    dataType - The widget data type; a class representing one of the following widget data types:
    
    character;
    integer;
    decimal;
    logical;
    date.
    Returns:
    Object currently in the screen buffer as the value of the widget or one of these defaults, if no value has been set:
    
    character - "";
    integer - 0;
    decimal - 0;
    logical - no (false);
    date - ? (unknown).
  - getter
```
java.lang.Object getter(int widgetId,
                        java.lang.Class<?> dataType,
                        boolean defaults,
                        boolean validate)
```
    Returns the current screen value of the specified widget.
    Parameters:
    
    widgetId - The widget ID.
    dataType - The widget data type; a class representing one of the following widget data types:
    
    character;
    integer;
    decimal;
    logical;
    date.
    defaults - true if a default value should be returned when the field is uninitialized in the screen buffer.
    
    validate - Perform validation.
    
    Returns:
    Object currently in the screen buffer as the value of the widget or one of these defaults, if no value has been set:
    
    character - "";
    integer - 0;
    decimal - 0;
    logical - no (false);
    date - ? (unknown).
  - enableFinalFormatCheck
```
private void enableFinalFormatCheck()
```
    Enable format check at the end of input loop.
  - setter
```
private java.lang.Object setter(java.lang.String widgetName,
                                java.lang.Object value)
```
    Sets a new value for the specified widget in the screen buffer.
    
    Parameters:
    
    widgetName - widget name
    
    value - An object representing the widget value. Since this code is called from the Java Reflection API, any time a primitive (e.g. int) is passed, Reflection automatically wraps it in an Object of the correct type (e.g. Integer). Thus it is safe to always expect the value to be an Object.
    
    Returns:
    
    null to comply with void
  - setter
```
private java.lang.Object setter(int index,
                                java.lang.Object value)
```
    Sets a new value for the specified widget in the screen buffer.
    
    Parameters:
    
    index - The widget ID.
    
    value - An object representing the widget value. Since this code is called from the Java Reflection API, any time a primitive (e.g. int) is passed, Reflection automatically wraps it in an Object of the correct type (e.g. Integer). Thus it is safe to always expect the value to be an Object.
    
    Returns:
    
    null to comply with void
  - generateWidgetName
```
private java.lang.String generateWidgetName(java.lang.String base,
                                            int op,
                                            java.lang.Object index)
                                     throws java.lang.RuntimeException
```
    Generate an indexed widget name from a simple base name and a numeric object that represents the index. This method converts the numeric object into a string using simple integer based formatting and then concatenates this to the base name.
    
    Parameters:
    
    base - The widget's base name.
    
    op - The type of the method name (getter/setter/accessor). Only used for error text.
    
    index - The number to convert into a string representation.
    
    Returns:
    
    The resulting name.
    
    Throws:
    
    java.lang.RuntimeException - If the index object is not a supported numeric object.
  - indexAsString
```
private java.lang.String indexAsString(java.lang.Object index)
```
    Takes a numeric type (NumberType, Integer or Double) and converts this into a string that can be used as a name component for a widget getter/setter/accessor.
    
    Parameters:
    
    index - The number to convert into a string representation.
    
    Returns:
    
    The resulting string or null if the type is not one of the supported numeric types.
  - translateUnknown
```
private BaseDataType translateUnknown(BaseDataType value,
                                      ControlEntity<?> widget)
```
    Ensure that any instance of the unknown literal is converted into the proper type as expected by the given widget.
    The unknown literal is represented by the class unknown which is a subclass of BaseDataType. This is only used to represent the literal and it needs to be converted to the proper type for use by the widget.
    This must not be confused with a BaseDataType such as an integer which is set to the unknown value. Such cases are not literals. Note that this method's purpose is to convert the literal form into the proper non-literal type.
    
    Parameters:
    
    value - The value to be converted if necessary.
    
    widget - The widget being processed.
    
    Returns:
    
    The original value if the type is not unknown or an instance of the proper type (set as unknown value) otherwise.
  - copyToScreenBuffer
```
private void copyToScreenBuffer(FrameElement[] data)
```
    Set each value in the screen buffer for each widget using the widget id as the index. Please note that assign only, widget only and null entries in the array are ignored.
    
    Parameters:
    
    data - The list of elements to copy into the screen buffer.
  - setStaticWidgets
```
private void setStaticWidgets(FrameElement[] data)
```
    Set value of each static widget mentioned in the list.
    
    Parameters:
    
    data - The list of elements.
  - updateDynamicContent
```
private void updateDynamicContent()
```
    This method should be called anytime the frame buffer is sent down to the thin client.
    The latest header values will be obtained and stored in the header map. Any subsequent display on the client will reflect the latest headers.
    Any dynamic down value that has been registered will be queried and stored in the frame buffer at this time. The user of the frame may have changed this value at any time. We read the latest value from the accessor (the delegated access to this variable) and if it is positive it is stored in the screen buffer directly. Any non-positive value is stored as 0. If there is no registered dynamic down value, then this processing is bypassed completely.
    Any dynamic title expression that has been registered will be evaluated and the result will be stored in the frame buffer. If there is no registered dynamic title expression, then this processing is bypassed completely.
    There is no counterpart to this method upon return from the client since headers and dynamic down values can never be edited, they are only sent down to the client (one way rather than bidirectional).
  - updateDynamicBrowseTitle
```
private void updateDynamicBrowseTitle()
```
    Update dynamic browse title.
  - updateDynamicTitle
```
protected void updateDynamicTitle()
```
    Update dynamic frame title.
  - textGroup
```
private java.util.List<FrameElement> textGroup(FrameElement[] list)
```
    Process list of frame elements and link widgets into text (word wrap) groups if necessary. Resulting set of widgets is returned as list for use by other methods.
    
    Parameters:
    
    list - Array of FrameElement instances.
    
    Returns:
    
    List of frame elements which refer widgets linked into text groups. All frame elements are placed in one list regardless from group.
  - textUngroup
```
private void textUngroup(java.util.List<FrameElement> list)
```
    Reset text grouping (word wrap mode).
    
    Parameters:
    
    list - List of FrameElement instances.
  - copyFromScreenBuffer
```
private void copyFromScreenBuffer(FrameElement[] data,
                                  boolean defaults,
                                  boolean calledBySet)
```
    Get the value in the screen buffer for each widget using the widget id as the index, then assign this back to the variable from the caller. Please note that widget only and null entries in the array are ignored.
    This method honors EmbeddedAssignment elements in the proper order in the array.
    
    Parameters:
    
    data - The list of elements to copy from the screen buffer.
    
    defaults - true means that default values will be used if screen buffer does not contain updated values.
    
    calledBySet - The true value indicates that the current screen operation is SET, otherwise the current screen operation is UPDATE.
  - makeFrameEnable
```
private void makeFrameEnable()
```
    Makes the frame and all its field-level widgets enabled and visible.
  - makeFrameEnableImpl
```
private boolean makeFrameEnableImpl()
```
    Makes the frame and all its field-level widgets enabled and visible.
    
    Returns:
    
    the flag indicating whether pushScreenDefinition() must be called upon return from the method.
  - finishSetup
```
private void finishSetup(boolean withHidden,
                         boolean recursive)
```
    Finish initialization for all widgets in the frame: GenericWidget.finishSetup() is called for each widget.
    
    Parameters:
    
    withHidden - If true then GenericWidget.finishSetup() is called for hidden widgets too. If false, only visible widgets are affected.
    
    recursive - If true then this function is recursively called for the child frames (if withHidden if false, only visible child frames are affected).
  - makeFrameVisible
```
private void makeFrameVisible()
```
    Makes the frame and all its field-level widgets visible.
  - validIds
```
public int[] validIds(GenericWidget<?>[] list)
```
    Create an array of all widgets in this frame that are in the given array.
    
    Parameters:
    
    list - The widgets to include in the resulting list.
    
    Returns:
    
    The list of remaining ids or null if no ids were included.
  - getStaticWidgetIds
```
public int[] getStaticWidgetIds(boolean headerWidgetsIncluded)
```
    Create an array of widgets in this frame that are static including possible header ones.
    
    Parameters:
    
    headerWidgetsIncluded - If true header widgets will be included.
    
    Returns:
    
    The list of widget ids for this frame.
  - hide
```
public void hide(FrameElement[] data)
```
    Makes widgets in the frame invisible.
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    data - Array of widgets to hide.
  - hide
```
public void hide(FrameElement[] data,
                 boolean noPause)
```
    Makes widgets in the frame invisible.
    
    Specified by:
    
    hide in interface CommonFrame
    
    Parameters:
    
    data - Array of widgets to hide.
    
    noPause - true if NO-PAUSE option was used
  - refreshDown
```
void refreshDown(int down)
```
    Refresh current DOWN value.
    
    Parameters:
    
    down - New DOWN value reported by client.
  - resetFlushed
```
void resetFlushed()
```
    Reset 'flushed' flag. This means that frame need to be flushed manually if there is an unexpected exit from loop.
  - isFlushed
```
boolean isFlushed()
```
    Return true if frame content was flushed since last VIEW.
    
    Returns:
    
    true if frame was flushed.
  - displayUnlessHidden
```
private void displayUnlessHidden(FrameElement[] data,
                                 boolean windowClause,
                                 handle hWin)
```
    Displays a list of fields from the frame on the screen. As part of this operation, the list of data values are copied to the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY UNLESS-HIDDEN data [IN WINDOW].
    
    Parameters:
    
    data - The list of data (and associated widgets) which is to be displayed.
    
    windowClause - true if windowClause is presented in DISPLAY stmt. false otherwise
    
    hWin - A handle to the window where the frame is displayed.
  - displayWorker
```
private void displayWorker(FrameElement[] data,
                           boolean windowClause,
                           handle hWin)
```
    Displays a list of fields from the frame on the screen. As part of this operation, the list of data values are copied to the screen buffer.
    As part of the processing, the frame and each listed widget will be marked as visible. The frame will be brought to the top of the Z-order and refreshed.
    Any null entry in the array is silently ignored.
    This method corresponds to these Progress statements: DISPLAY data [IN WINDOW].
    
    Parameters:
    
    data - The list of data (and associated widgets) which is to be displayed.
    
    windowClause - true if windowClause is presented in DISPLAY stmt. false otherwise
    
    hWin - A handle to the window where the frame is displayed.
  - remainingIds
```
private int[] remainingIds(GenericWidget<?>[] xcpt)
```
    Create an array of all widgets in this frame that are NOT in the given array.
    
    Parameters:
    
    xcpt - The widgets to exclude from the resulting list.
    
    Returns:
    
    The list of remaining ids or null if all ids were excluded.
  - remainingIds
```
private int[] remainingIds(GenericWidget<?>[] all,
                           GenericWidget<?>[] xcpt)
```
    Create an array of given widgets in this frame that are NOT in the given array.
    
    Parameters:
    
    all - The widgets to be processed.
    
    xcpt - The widgets to exclude from the resulting list.
    
    Returns:
    
    The list of remaining ids or null if all ids were excluded.
  - idSetToArray
```
private int[] idSetToArray(java.util.Set<java.lang.Integer> widgetIds)
```
    Converts the given set of Integer values into an array of primitive int.
    
    Parameters:
    
    widgetIds - The set of ids to convert.
    
    Returns:
    
    The int[] or null if there are no ids in the set.
  - idsFromWidgets
```
private int[] idsFromWidgets(GenericWidget<?>[] widgets)
```
    Converts a widget array into an array of widget IDs.
    
    Parameters:
    
    widgets - array of widgets which is to be edited.
    
    Returns:
    
    The array of widget IDs.
  - widgetListFromFrameElements
```
private GenericWidget<?>[] widgetListFromFrameElements(FrameElement[] widgets)
```
    Converts a frame element array into a array of widgets. Any nodes that are assignment only result in a null entry in the array.
    
    Parameters:
    
    widgets - The list of widgets which is to be edited. The data portion of these elements is not used at all.
    
    Returns:
    
    The array of widgets.
  - errorOnRedirectedInput
```
private boolean errorOnRedirectedInput(int num,
                                       java.lang.String txt)
```
    Raise an error condition with the given error number and text IF unnamed input has been redirected. If silent error mode is enabled, any error condition will be logged and this method will return.
    
    Parameters:
    
    num - Error number.
    
    txt - Error text.
    
    Returns:
    
    true if in silent error mode and an error was raise. false if the unnamed input is not redirected.
    
    Throws:
    
    ErrorConditionException - If the unnamed input is redirected and silent error mode is off.
  - errorOnBatchModeEnable
```
private boolean errorOnBatchModeEnable(int num,
                                       java.lang.String txt)
```
    Raise an error condition with the given error number and text IF unnamed input has been redirected. If silent error mode is enabled, any error condition will be logged and this method will return.
    
    Parameters:
    
    num - Error number.
    
    txt - Error text.
    
    Returns:
    
    true if in silent error mode and an error was raise. false if the unnamed input is not redirected.
    
    Throws:
    
    ErrorConditionException - If the unnamed input is redirected and silent error mode is off.
  - errorOnBatchModeSetPrompt
```
private boolean errorOnBatchModeSetPrompt(int num,
                                          java.lang.String txt)
```
    Raise an error condition with the given error number and text IF unnamed input has been redirected. If silent error mode is enabled, any error condition will be logged and this method will return.
    
    Parameters:
    
    num - Error number.
    
    txt - Error text.
    
    Returns:
    
    true if in silent error mode and an error was raise. false if the unnamed input is not redirected.
    
    Throws:
    
    ErrorConditionException - If the unnamed input is redirected and silent error mode is off.
  - conditionalUpDown
```
private void conditionalUpDown()
```
    Executes delayed conditional cursor movement.
  - conditionalUpDown
```
private void conditionalUpDown(boolean force)
```
    Executes delayed conditional cursor movement.
    
    Parameters:
    
    force - If the pending up/down is processed immediately.
  - downWorker
```
private void downWorker(int lines,
                        boolean cond)
```
    DOWN worker routine for the unnamed stream, redirected or not.
    
    Parameters:
    
    lines - Number of lines to scroll down.
    
    cond - true means conditional down; lines is assumed to be 1
  - showScreenBuffer
```
private void showScreenBuffer(int idx)
```
    This method will send the screen buffer for row at given index to be displayed by the client, only if no redirected output occurred.
    All widgets state must be set to changed so they will be updated.
    
    Parameters:
    
    idx - The index of the line to be shown to the screen by the client. The client MUST be positioned to the right row.
  - downWorker
```
private void downWorker(int lines,
                        int id,
                        boolean cond,
                        boolean endOut)
```
    DOWN worker routine for named streams.
    For a named stream, UP statements have no effect on the FRAME-LINE index or on the screen buffer. DOWN statements will advance to the next row (even past the FRAME-DOWN row) and will reset the screen buffer.
    
    Parameters:
    
    lines - Number of lines to scroll down.
    
    id - The stream ID to which the terminal will be redirected during this processing or -1 if no temporary redirection is needed.
    
    cond - true means conditional down; lines is assumed to be 1
    
    endOut - true to force any pending PUT or EXPORT output to be ended for the given stream (so long as that stream is not the terminal).
  - up
```
private void up(int lines)
```
    UP worker routine.
    
    Parameters:
    
    lines - Number of lines to scroll up.
  - up
```
private void up(int lines,
                int id)
```
    UP worker routine.
    
    Parameters:
    
    lines - Number of lines to scroll up.
    
    id - The stream ID to which the terminal will be redirected during this processing or -1 if no temporary redirection is needed.
  - getRemoteStreamId
```
int getRemoteStreamId(Stream out)
```
    Dereferences the given stream to find and return the remote stream ID.
    
    Parameters:
    
    out - The stream (may be a StreamWrapper that has had a RemoteStream assigned OR it may be a RemoteStream instance). If null or any wrapped reference is null, then the result will be treated as referencing the terminal and a -1 will be returned.
    
    Returns:
    
    The remote stream ID.
  - addScreenBufferToCache
```
private void addScreenBufferToCache(ScreenBuffer buff,
                                    int row)
```
    Adds a screen buffer instance to the cache for the specified row.
    
    Parameters:
    
    buff - The buffer to be added to the cache.
    
    row - The 1-based row to which this buffer corresponds to.
  - getScreenBufferFromCache
```
private ScreenBuffer getScreenBufferFromCache(int row)
```
    Gets the screen buffer associated for this row. If there is no screen buffer associated with this row, then the method will return a new empty buffer.
    
    Parameters:
    
    row - The 1-based row for which to get the current screen buffer.
    
    Returns:
    
    The buffer associated with this row.
  - removeHiddenWidgets
```
private GenericWidget<?>[] removeHiddenWidgets(GenericWidget<?>[] inputList)
```
    Removes the widgets with hidden attribute value set as TRUE.
    
    Parameters:
    
    inputList - The widgets to process.
    
    Returns:
    
    The array of the GenericWidget<?> values with HIDDEN attrubute is FALSE.
  - removeHiddenWidgets
```
public static FrameElement[] removeHiddenWidgets(FrameElement[] inputList)
```
    Removes the widgets with hidden attribute value set as TRUE.
    
    Parameters:
    
    inputList - The widgets to process.
    
    Returns:
    
    The array of the GenericWidget values with HIDDEN attribute is FALSE.
  - restoreWidgetRegistry
```
private void restoreWidgetRegistry()
```
    Restores the widget registry for static content of this frame based on header and non-header widget info.
  - toString
```
public java.lang.String toString()
```
    Provide description for GenericFrame instance.
    
    Overrides:
    
    toString in class java.lang.Object
    
    See Also:
    
    Object.toString()
  - displayAndDown
```
public void displayAndDown()
```
    Support for the DISPLAY followed by the DOWN combination.
    
    Specified by:
    
    displayAndDown in interface CommonFrame
  - displayAndDown
```
public void displayAndDown(FrameElement[] data)
```
    Support for the DISPLAY followed by the DOWN combination.
    
    Specified by:
    
    displayAndDown in interface CommonFrame
    
    Parameters:
    
    data - The list of data (and associated widgets) which is to be displayed.
  - displayUnlessHiddenAndDown
```
public void displayUnlessHiddenAndDown(FrameElement[] data)
```
    Support for the DISPLAY UNLESS HIDDEN followed by the DOWN combination.
    
    Specified by:
    
    displayUnlessHiddenAndDown in interface CommonFrame
    
    Parameters:
    
    data - The list of data (and associated widgets) which is to be displayed.
  - displayUnlessHiddenAndDown
```
public void displayUnlessHiddenAndDown()
```
    Support for the DISPLAY UNLESS HIDDEN followed by the DOWN combination.
    
    Specified by:
    
    displayUnlessHiddenAndDown in interface CommonFrame
    
    See Also:
    
    displayUnlessHidden()
  - displayAndDown
```
public void displayAndDown(Stream out)
```
    Support for the DISPLAY STREAM ... followed by the DOWN STREAM.. combination.
    
    Specified by:
    
    displayAndDown in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
  - displayAndDown
```
public void displayAndDown(Stream out,
                           FrameElement[] data)
```
    Support for the DISPLAY STREAM ... followed by the DOWN STREAM.. combination.
    
    Specified by:
    
    displayAndDown in interface CommonFrame
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    data - The list of data (and associated widgets) which is to be displayed.
  - sendWidgetScreenValue
```
private void sendWidgetScreenValue(FrameElement[] data)
```
    Set the screen-value for each widget in the given list, if is not hidden.
    
    Parameters:
    
    data - The list of data (and associated widgets).
  - displayAndDownWorker
```
private void displayAndDownWorker(Stream out,
                                  FrameElement[] data)
```
    Support for the DISPLAY STREAM ... followed by the DOWN STREAM.. combination.
    
    Parameters:
    
    out - A stream instance which is open for writing.
    
    data - The list of data (and associated widgets) which is to be displayed.
  - getHWND
```
public integer getHWND()
```
    Gets the integer value of the window containing the widget.
    
    Specified by:
    
    getHWND in interface CommonFrame
    
    Returns:
    
    The integer value, which will be the same as the frame ID.
  - getNextTabItem
```
public handle getNextTabItem()
```
    Getting the NEXT-TAB-ITEM attribute.
    
    Specified by:
    
    getNextTabItem in interface CommonFrame
    
    Returns:
    
    nothing.
  - getPreviousTabItem
```
public handle getPreviousTabItem()
```
    Getting the PREV-TAB-ITEM attribute.
    
    Specified by:
    
    getPreviousTabItem in interface CommonFrame
    
    Returns:
    
    nothing.
  - setFrameHandle
```
public void setFrameHandle(handle hFrame)
```
    Sets "parent" frame for this frame. TODO implement client-side logic
    
    Specified by:
    
    setFrameHandle in interface CommonFrame
    
    Parameters:
    
    hFrame - The handle of the frame that will be a "parent" frame.
  - getFrameHandle
```
public handle getFrameHandle()
```
    Gets "parent" frame for this frame. TODO implement client-side logic
    
    Specified by:
    
    getFrameHandle in interface CommonFrame
    
    Returns:
    
    The handle of the parent frame.
  - setStreamIO
```
public void setStreamIO(boolean value)
```
    Set the STREAM-IO option of this frame.
    
    Specified by:
    
    setStreamIO in interface CommonFrame
    
    Parameters:
    
    value - true if the STREAM-IO option is present.
  - setScreenIO
```
public void setScreenIO(boolean value)
```
    Set the SCREEN-IO option of this frame.
    
    Specified by:
    
    setScreenIO in interface CommonFrame
    
    Parameters:
    
    value - true if the SCREEN-IO option is present.
  - setUseText
```
public void setUseText(boolean value)
```
    Set the USE-TEXT option of this frame.
    
    Specified by:
    
    setUseText in interface CommonFrame
    
    Parameters:
    
    value - true if the USE-TEXT option is present.
  - getFieldGroup
```
FieldGroup getFieldGroup()
```
    Returns the frame's field group.
    
    Returns:
    
    See above.
  - deleteFieldGroups
```
void deleteFieldGroups()
```
    Delete all field-groups created for this frame.
  - printFieldGroups
```
private void printFieldGroups(int lines)
```
    This method prints field-groups of the frame and is needed only for debugging purposes. Here is a sample output (each triplet group is for a distinct call):
```
 3
  gr1 [null, gr2]     gr2 [gr1, gr3]     gr3 [gr2, gr4]     gr4 [gr3, gr5]     gr5 [gr4, UN]
 1 -> gr5, 
 
 3
  gr1 [null, gr2]     gr2 [gr1, gr3]     gr3 [gr2, gr4]     gr4 [gr3, gr5]     gr5 [gr4, UN]
 1 -> gr5, 2 -> gr1, 
 
 3
  gr1 [null, gr2]     gr2 [gr1, gr3]     gr3 [gr2, gr4]     gr4 [gr3, gr5]     gr5 [gr4, UN]
 1 -> gr5, 2 -> gr1, 3 -> gr2, 
 
```
    Here are groups of several triplets of strings. The first line in a triplet is a number of lines to step. Can be < 0. The second row displays field groups, each with its neighbors in square brackets: [left, right]. The third row is a mapping from the row number to field-group, only for rows with an associated field-group.
    Parameters:
    
    lines - Number of lines to step. Can be <0 (UP statement) or >0 (DOWN statement).
  - updateFieldGroups
```
private void updateFieldGroups(int lines,
                               int currentRow,
                               int down,
                               int realstep)
```
    This method actualizes field-groups of this frame in correspondance with the current iteration (DOWN/UP step). For the cases DOWN-SIZE != 1 this method will iterate steps one by one as it would be several DOWN/UP 1 statements.
    
    Parameters:
    
    lines - Number of lines to step. Can be <0 (UP statement) or >0 (DOWN statement).
    
    currentRow - The valid current line in this frame (after current step).
    
    down - Frame down size.
    
    realstep - Current step in the internal iteration for cases DOWN-SIZE != 1. For example for DOWN 5 values of this parameter will be 5, 4, 3, 2, 1, 0
  - isFGAssigned
```
private boolean isFGAssigned(handle groupHandle)
```
    This method checks if the specified field-group is used for some row in this frame.
    
    Parameters:
    
    groupHandle - Handle of specified field-group.
    
    Returns:
    
    true - if field-group is associated with some row in this frame false - otherwise.
  - getFGRow
```
private java.lang.Integer getFGRow(handle groupHandle)
```
    This method searches the frame row for specified field-group. TODO: use bidirectional map
    
    Parameters:
    
    groupHandle - Handle of specified field-group.
    
    Returns:
    
    row number - if field-group is associated with some row in this frame null - otherwise.
    
    Throws:
    
    java.lang.IllegalArgumentException - if groupHandle is invalid or is not FieldGroup handle.
  - allWidgets
```
private java.util.List<GenericWidget<?>> allWidgets()
```
    Get all the widgets associated with this frame.
    
    Returns:
    
    See above.
  - getTabItemsList
```
public int[] getTabItemsList()
```
    Gets the current tab item list.
    
    Returns:
    
    The current tab item list
  - updateTabItemsList
```
public int[] updateTabItemsList(int[] widgetIds,
                                FieldGroup.UpdatesOp op)
```
    Updates the current tab item list if KEEP-TAB-ORDER is not set.
    
    Parameters:
    
    widgetIds - The widget ids listed in the enable, update, set, prompt-for statements
    
    op - The current tab item list rearranging operation
    
    Returns:
    
    The updated tab item list
  - updateTabItemsList
```
public int[] updateTabItemsList(java.util.List<GenericWidget<?>> widgets,
                                FieldGroup.UpdatesOp op)
```
    Updates the current tab item list if KEEP-TAB-ORDER is not set.
    
    Parameters:
    
    widgets - The widgets listed in the enable, update, set, prompt-for statements
    
    op - The current tab item list rearranging operation
    
    Returns:
    
    The updated tab item list
  - toTop
```
protected void toTop(GenericWidget<?> widget)
```
    Moves the target widget to the top of its widgets list if it is in this list.
    
    Parameters:
    
    widget - The target widget
  - toBottom
```
protected void toBottom(GenericWidget<?> widget)
```
    Moves the target widget to the bottom of its widgets list if it is in this list.
    
    Parameters:
    
    widget - The target widget
  - createFieldGroup
```
private void createFieldGroup()
```
    Creates and initializes the new field group and returns it.
  - isEmptyFormat
```
private static boolean isEmptyFormat(java.lang.String s,
                                     java.lang.String ignoredTokens)
```
    Utility method used by parseScreenValue() method to identify the empty screen values. This are NOT unknown values but are displayed as such in a date/time/-tz fill-in widget.
    
    Parameters:
    
    s - The string to pe assigned to SCREEN-VALUE attribute.
    
    ignoredTokens - The ignored tokens specific to this data type. These may occur in any combination and all their occurrences are ignored.
    
    Returns:
    
    true when the string to be set as SCREEN-VALUE is equivalent to empty string.
  - downInt
```
private void downInt()
```
    Positions the cursor on a new line in a down frame. This is a conditional call. Multiple conditional down() calls have the effect of a single down(1) call, which is delayed till the nearest terminal I/O operation and can be cancelled by a conditional up() call.
    Note that this call can be ignored in interactive mode if frame is not yet viewed at least once before this call. After first VIEW (explicit or implicit) hiding frame (either via HIDE statement or by changing VISIBLE attribute) does not affect behavior and calls to this method are honored. This corresponds to 4GL behavior.
    This method corresponds to these Progress statements: DOWN
  - initScreenDefinition
```
private void initScreenDefinition()
```
    Unconditionally initializes the frame's screen definition.

Class GenericFrame

Nested Class Summary

Field Summary

Fields inherited from interface com.goldencode.p2j.ui.CommonFrame

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.ui.CommonFrame

Methods inherited from interface com.goldencode.p2j.util.IterableResource

Methods inherited from interface com.goldencode.p2j.util.Finalizable

Field Detail

INVOKE_GET

INVOKE_SET

INVOKE_ACCESS

ENABLE_INPUT_REDIRECTED

NO_INPUT_SOURCE_ATTEMPT

NO_OUTPUT_DESTINATION_ATTEMPT

LOG

errHlp

batch

configInstance

configClass

frameName

frameId

n2w

n2n

n2h

n2b

widgets

headers

frame

frameDef

frameBuf

currentOp

editLock

statsColumn

redirOut

aggregateHandler

pendingUpDown

dynDown

dynColumn

dynRow

dynTitle

hadView

textGroup

scopeNesting

shared

screenBufferCache

dynamicDown

fieldGroup

currentFieldGroup

literalFieldGroup

rows2fg

insideSetup

deferredAggregators

canHide

afterDown

afterUnderline

hadCondition

triggerActive

finalCheck

silentFormatErrors

formatFilter

flushed

sameViewDataRedirected

currentStatement

framePlacing

defaultFrame

Constructor Detail

GenericFrame

Method Detail

createFrame

createDynamicFrame

createSharedFrame

importSharedFrame

validateFields

getConfigInstance

initializeNewFrame

isAbleToDisplayWindow

createFrameProxy