public interface CommonFrame extends IterableResource, Sizeable
Modifier and Type | Field and Description |
---|---|
static int |
NONE
No operation currently in process.
|
static int |
PROMPT_FOR
Prompt-for operation currently in process.
|
static int |
SET
Set operation currently in process.
|
static int |
UPDATE
Update operation currently in process.
|
Modifier and Type | Method and Description |
---|---|
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
GenericWidget . |
handle |
asWidgetHandle()
Get this frame wrapped in a handle.
|
void |
batch(boolean onOff)
Sets batching mode for frame modification.
|
void |
choose(Choose c)
Performs CHOOSE processing.
|
void |
choose(Choose c,
ColorSpec cs)
Performs CHOOSE processing.
|
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.
|
boolean |
continueEditing(FrameElement[] list,
boolean hadNext)
Checks to see whether a pending GO event is about to end the editing block.
|
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.
|
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 ...
|
void |
displayUnlessHidden(FrameElement[] data)
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(FrameElement[] data)
Support for the DISPLAY UNLESS HIDDEN followed by the DOWN combination.
|
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. |
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.
|
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<?>[] 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.
|
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<?>[] list)
Enables input for the given field-level widgets of the frame.
|
void |
enableUnlessHiddenExcept(GenericWidget<?>[] list,
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.
|
handle |
firstChild()
Get the first child of the frame which will be the field group that
contains all non-header widgets.
|
decimal |
frameCol()
Returns the column position of the left corner of the frame within its
window.
|
integer |
frameDown()
Returns the number of iterations in a down frame.
|
integer |
frameLine()
Returns the current logical line number in a down frame.
|
decimal |
frameRow()
Returns the row position of the upper-left corner of the frame within
its window.
|
integer |
getBgColor()
Get display color.
|
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).
|
integer |
getFgColor()
Get input (prompt-for) color.
|
integer |
getFont()
Get the FONT specification of this frame.
|
handle |
getFrameHandle()
Gets "parent" frame for this frame.
|
int |
getFrameId()
Gets the unique numeric ID of this frame.
|
integer |
getHWND()
Gets the integer handle value of the window containing the widget.
|
handle |
getNextTabItem()
Getting the NEXT-TAB-ITEM attribute.
|
handle |
getParentHandle()
Get the PARENT option.
|
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).
|
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 |
getTitle()
Gets the frame title.
|
integer |
getTitleFont()
Get the font for the frame title.
|
NumberType |
getX()
Returns the horizontal position of the frame.
|
integer |
getY()
Returns the vertical position of the 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.
|
logical |
isHidden()
Gets the HIDDEN attribute of the frame.
|
boolean |
isInsideSetup()
Check if the frame is currently being initialized
|
logical |
isSensitive()
Gets the SENSITIVE attribute of the frame.
|
logical |
isVisible()
Gets the VISIBLE attribute of the frame.
|
boolean |
moveAfterTab(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 block scope.
|
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. |
void |
registerAccumulators(FrameElement[] fe)
Register all the widgets which need accumulation with this frame.
|
void |
registerHeader(FrameElement[] fe)
Register header frame elements.
|
void |
scroll(boolean fromCurrent,
boolean upDown)
Scrolls the lines of the down frame up or down.
|
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[] data,
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[] data,
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 |
setCancelButtonOption(GenericWidget<?> cancelButton)
Sets the cancel button for this frame (an option in the frame phrase).
|
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.
|
void |
setDColor(Color color)
Sets the display color.
|
void |
setDColor(ColorSpec 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 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(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 |
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 |
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.
|
default void |
setNoAttrSpace(boolean no_attr_space)
Sets the NO-ATTR-SPACE 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 color)
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.
|
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.
|
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() processing. |
void |
setStreamIO(boolean value)
Set the STREAM-IO option of this frame.
|
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 |
setTitleColor(ColorSpec titleColor)
Sets the color for the frame title.
|
void |
setTitleFont(int64 fontNum)
Sets the font for the frame title.
|
void |
setTitleFont(long fontNum)
Sets the font for the frame title.
|
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. |
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 option.
|
void |
setVisible(logical visible)
Sets the VISIBLE option.
|
void |
setX(NumberType x)
Sets the horizontal position of the frame (Progress X
attribute).
|
void |
setY(NumberType y)
Sets the vertical position of the frame (Progress Y
attribute).
|
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 |
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 of the down frame.
|
void |
up(double lines)
Positions the cursor on a new line of the down frame.
|
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[] data,
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.
|
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. |
logical |
validate()
Executes the validation tests for every supported field-level widget
in the frame (except the browse, which you must validate explicitly).
|
void |
view()
Makes the frame visible.
|
void |
view(FrameElement[] list)
Makes widgets in frame visible.
|
void |
view(FrameElement[] list,
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,
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()
Conditionally blocks until a next UI event is available.
|
currentIteration, setCurrentIteration
getHeightChars, getHeightPixels, getWidthChars, getWidthPixels, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels
static final int NONE
static final int PROMPT_FOR
static final int SET
static final int UPDATE
FrameWidget asWidget()
GenericWidget
.GenericWidget
instance.handle asWidgetHandle()
int getFrameId()
logical isVisible()
true
if the attribute is set to ON.logical isHidden()
true
if the attribute is set to ON.logical isSensitive()
true
if the attribute is set to ON.void assignScreenValue(FrameElement data)
null
) no assignment will occur.data
- Represents the variable to assign and the widget for which
the screen value is to be retrieved.void apply(character event)
This method corresponds to these Progress statements: APPLY FRAME
event
- event to be appliedvoid apply(java.lang.String event)
This method corresponds to these Progress statements: APPLY FRAME
event
- event to be appliedvoid apply(integer eventCode)
This method corresponds to these Progress statements: APPLY FRAME
eventCode
- event to be appliedvoid apply(double eventCode)
This method corresponds to these Progress statements: APPLY FRAME
eventCode
- event to be appliedvoid batch(boolean onOff)
onOff
- true
sets batching modevoid choose(Choose c)
This method corresponds to these Progress statements: CHOOSE
c
- CHOOSE statement optionsvoid choose(Choose c, ColorSpec cs)
This method corresponds to these Progress statements: CHOOSE COLOR
c
- CHOOSE statement optionscs
- color specification for use with CHOOSEvoid clear(boolean noPause)
This method corresponds to these Progress statements: CLEAR
noPause
- true
if NO-PAUSE option was usedvoid clearAll(boolean noPause)
This method corresponds to these Progress statements: CLEAR ALL
noPause
- true
if NO-PAUSE option was usedvoid disable()
This method corresponds to these Progress statements: DISABLE ALL
void disableExcept(GenericWidget<?>[] xcpt)
This method corresponds to these Progress statements: DISABLE ALL EXCEPT
xcpt
- List of widgets which will not be enabled.void disableExcept(GenericWidget<?> widget)
This method corresponds to these Progress statements: DISABLE ALL EXCEPT
widget
- Widget which will not be enabled.void disable(GenericWidget<?>[] list)
This method corresponds to these Progress statements: DISABLE
list
- The widgets to disable.void disable(FrameElement[] list)
This method corresponds to these Progress statements: DISABLE
list
- The widgets to disable.void disableUnlessHidden()
This method corresponds to these Progress statements: DISABLE ALL UNLESS-HIDDEN
void disableUnlessHidden(GenericWidget<?>[] list)
This method corresponds to these Progress statements: DISABLE UNLESS-HIDDEN
list
- The widgets to disable.void disableUnlessHidden(FrameElement[] list)
This method corresponds to these Progress statements: DISABLE UNLESS-HIDDEN
list
- The widgets to disable.void display()
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
void display(BrowseWidget browse)
This method corresponds to these Progress statements: DISPLAY WITH BROWSE
browse
- A widget to refresh.void display(Stream out)
This method corresponds to these Progress statements: DISPLAY
out
- A stream instance which is open for writing.void display(FrameElement[] data)
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
- The list of data (and associated widgets) which is to be
displayed.void displayUnlessHidden(FrameElement[] data)
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
- The list of data (and associated widgets) which is to be
displayed.void display(Stream out, FrameElement[] data)
Any null
entry in the array is silently ignored.
This method corresponds to these Progress statements: DISPLAY
out
- A stream instance which is open for writing.data
- The list of data (and associated widgets) which is to be
displayed.void display(handle hWin)
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
hWin
- A handle to the window where the frame is displayed.void display(BrowseWidget browse, handle hWin)
This method corresponds to these Progress statements: DISPLAY WITH BROWSE
browse
- A widget to refresh.hWin
- A handle to the window where the frame is displayed.void display(Stream out, handle hWin)
This method corresponds to these Progress statements: DISPLAY
out
- A stream instance which is open for writing.hWin
- A handle to the window where the frame is displayed.void display(FrameElement[] data, handle hWin)
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
- The list of data (and associated widgets) which is to be
displayed.hWin
- A handle to the window where the frame is displayed.void displayUnlessHidden(FrameElement[] data, handle hWin)
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
- The list of data (and associated widgets) which is to be
displayed.hWin
- A handle to the window where the frame is displayed.void display(Stream out, FrameElement[] data, handle hWin)
Any null
entry in the array is silently ignored.
This method corresponds to these Progress statements: DISPLAY
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.void down()
This method corresponds to these Progress statements: DOWN
void down(double lines)
This method corresponds to these Progress statements: DOWN n
lines
- number of iterations of the data to move downvoid down(NumberType lines)
This method corresponds to these Progress statements: DOWN n
lines
- number of iterations of the data to move downvoid down(Stream out)
This method corresponds to these Progress statements: DOWN STREAM s
out
- A stream instance which is open for writing.void down(Stream out, double lines)
lines
number of new-lines to the given stream.
This method corresponds to these Progress statements: DOWN STREAM s n
out
- A stream instance which is open for writing.lines
- Number of new-lines to output to the stream.void down(Stream out, NumberType lines)
lines
number of new-lines to the given stream.
This method corresponds to these Progress statements: DOWN STREAM s n
out
- A stream instance which is open for writing.lines
- Number of new-lines to output to the stream.void enable()
This method corresponds to these Progress statements: ENABLE ALL
void enableExcept(GenericWidget<?>[] xcpt)
This method corresponds to these Progress statements: ENABLE ALL
xcpt
- List of widgets which will not be enabled.void enableExcept(GenericWidget<?> widget)
This method corresponds to these Progress statements: ENABLE ALL
widget
- Widget which will not be enabled.void enable(GenericWidget<?>[] list)
This method corresponds to these Progress statements: ENABLE
list
- The widgets to enable.void enable(FrameElement[] list)
This method corresponds to these Progress statements: ENABLE
list
- The widgets to enable.void enableUnlessHidden()
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL
void enableUnlessHidden(FrameElement[] list)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
list
- The widgets to enable.void enable(handle hWin)
This method corresponds to these Progress statements: ENABLE ALL
hWin
- A handle to the window where the frame is displayed.void enableExcept(GenericWidget<?>[] xcpt, handle hWin)
This method corresponds to these Progress statements: ENABLE ALL
xcpt
- List of widgets which will not be enabled.hWin
- A handle to the window where the frame is displayed.void enableExcept(GenericWidget<?> widget, handle hWin)
This method corresponds to these Progress statements: ENABLE ALL
widget
- Widget which will not be enabled.hWin
- A handle to the window where the frame is displayed.void enable(GenericWidget<?>[] list, handle hWin)
This method corresponds to these Progress statements: ENABLE
list
- The widgets to enable.hWin
- A handle to the window where the frame is displayed.void enableUnlessHidden(GenericWidget<?> widget)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
widget
- The widget to enable.void enableUnlessHidden(GenericWidget<?> widget, handle hWin)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
widget
- The widget to enable.hWin
- A handle to the window where the frame is displayed.void enableUnlessHidden(GenericWidget<?>[] list)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
list
- The widgets to enable.void enableUnlessHidden(GenericWidget<?>[] list, handle hWin)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
list
- The widgets to enable.hWin
- A handle to the window where the frame is displayed.void enableUnlessHiddenExcept(GenericWidget<?> widget)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL EXCEPT
widget
- The widget to enable.void enableUnlessHiddenExcept(GenericWidget<?> widget, handle hWin)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL EXCEPT
widget
- The widget to enable.hWin
- A handle to the window where the frame is displayed.void enableUnlessHiddenExcept(GenericWidget<?>[] list)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL EXCEPT
list
- The widgets to enable.void enableUnlessHiddenExcept(GenericWidget<?>[] list, handle hWin)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN ALL EXCEPT
list
- The widgets to enable.hWin
- A handle to the window where the frame is displayed.void enable(FrameElement[] list, handle hWin)
This method corresponds to these Progress statements: ENABLE
list
- The widgets to enable.hWin
- A handle to the window where the frame is displayed.void enableUnlessHidden(FrameElement[] list, handle hWin)
This method corresponds to these Progress statements: ENABLE UNLESS-HIDDEN
list
- The widgets to enable.hWin
- A handle to the window where the frame is displayed.character getScreenValue(GenericWidget<?> widget)
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.widget
- The widget for which the value is to be retrieved.character
type or the empty
string if the screen buffer value is uninitialized.void setScreenValue(GenericWidget<?> widget, character value)
null
then this
widget will be set to the uninitialized value.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.void hide()
This method corresponds to these Progress statements: HIDE FRAME
void hide(boolean noPause)
This method corresponds to these Progress statements: HIDE FRAME
noPause
- true
if NO-PAUSE option was usedvoid hide(Stream out, boolean noPause)
This method corresponds to these Progress statements: HIDE STREAM s FRAME
out
- A stream instance which is open for writing.noPause
- true
if NO-PAUSE option was usedvoid hide(FrameElement[] data)
data
- Array of widgets to hide.void hide(FrameElement[] data, boolean noPause)
data
- Array of widgets to hide.noPause
- true
if NO-PAUSE option was usedvoid hide(handle hWin)
This method corresponds to these Progress statements: HIDE FRAME
hWin
- A handle to the window where the frame is displayed.void hide(handle hWin, boolean noPause)
This method corresponds to these Progress statements: HIDE FRAME
hWin
- A handle to the window where the frame is displayed.noPause
- true
if NO-PAUSE option was usedvoid hide(Stream out, handle hWin, boolean noPause)
This method corresponds to these Progress statements: HIDE STREAM s FRAME
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 usedvoid hide(FrameElement[] data, handle hWin)
data
- Array of widgets to hide.hWin
- A handle to the window where the frame is displayed.void hide(FrameElement[] data, handle hWin, boolean noPause)
data
- Array of widgets to hide.hWin
- A handle to the window where the frame is displayed.noPause
- true
if NO-PAUSE option was usedvoid nextPrompt(GenericWidget<?> field)
This method corresponds to these Progress statements: NEXT-PROMPT
field
- widget to be put in focusvoid promptFor(FrameElement[] widgets)
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
widgets
- The list of widgets which is to be edited. The data portion
of these elements is not used at all.void promptFor(Stream in, FrameElement[] widgets)
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()
. 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
in
- A stream instance which is open for reading.widgets
- The list of widgets which are to receive input from the
stream.void promptFor(FrameElement[] widgets, EventList wait)
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
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.void promptFor(GenericWidget<?>[] widgets)
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
widgets
- The list of widgets which is to be edited.void promptFor(GenericWidget<?>[] widgets, EventList wait)
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
widgets
- The list of widgets which is to be edited.wait
- The list of events to treat as a GO
event.void promptFor(FrameElement[] widgets, handle hWin)
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
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.void promptFor(Stream in, FrameElement[] widgets, handle hWin)
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()
. 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
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.void promptFor(FrameElement[] widgets, EventList wait, handle hWin)
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
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.void promptFor(GenericWidget<?>[] widgets, handle hWin)
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
widgets
- The list of widgets which is to be edited.hWin
- A handle to the window where the frame is displayed.void promptFor(GenericWidget<?>[] widgets, EventList wait, handle hWin)
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
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.void registerHeader(FrameElement[] fe)
This method corresponds to these Progress statements: FORM HEADER
fe
- Array of headers to register.void promptForUnlessHidden(FrameElement[] widgets)
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
widgets
- The list of widgets which is to be edited. The data portion of these elements is
not used at all.void promptForUnlessHidden(GenericWidget<?>[] widgets)
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
widgets
- The list of widgets which is to be edited.void promptForUnlessHidden(GenericWidget<?>[] widgets, handle hWin)
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
widgets
- The list of widgets which is to be edited.hWin
- A handle to the window where the frame is displayed.void promptForUnlessHidden(FrameElement[] widgets, handle hWin)
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
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.void registerAccumulators(FrameElement[] fe)
fe
- The list of widgets that may need accumulation.void scroll(boolean fromCurrent, boolean upDown)
This method corresponds to these Progress statements: SCROLL
fromCurrent
- true
if FROM-CURRENT option was usedupDown
- true
if scrolling upvoid set(FrameElement[] data)
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
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).void set(Stream in, FrameElement[] data)
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()
. 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
in
- A stream instance which is open for reading.data
- The list of widgets which are to receive input from the
stream.void set(FrameElement[] data, EventList wait)
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
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).wait
- The list of events to treat as a GO
event.void set(FrameElement[] data, handle hWin)
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
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.void set(Stream in, FrameElement[] data, handle hWin)
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()
. 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
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.void set(FrameElement[] data, EventList wait, handle hWin)
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
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).wait
- The list of events to treat as a GO
event.hWin
- A handle to the window where the frame is displayed.void setUnlessHidden(FrameElement[] data)
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
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).void setUnlessHidden(FrameElement[] data, handle hWin)
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
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.void up()
This method corresponds to these Progress statements: UP
void up(double lines)
This method corresponds to these Progress statements: UP n
lines
- number of iterations of the data to scroll up (positive) or
down (negative).void up(NumberType lines)
This method corresponds to these Progress statements: UP n
lines
- number of iterations of the data to scroll up (positive) or
down (negative).void up(Stream out)
UP
statement which has no effect.
This method corresponds to these Progress statements: UP STREAM s
out
- A stream instance which is open for writing.void up(Stream out, double lines)
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
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.void up(Stream out, NumberType lines)
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
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.void update(FrameElement[] data)
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()
and set(com.goldencode.p2j.ui.FrameElement[])
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
data
- The list of data and widgets which is to be updated.void update(Stream in, FrameElement[] data)
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()
. 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
in
- A stream instance which is open for reading.data
- The list of widgets which are to receive input from the
stream.void update(FrameElement[] data, EventList wait)
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()
and set(com.goldencode.p2j.ui.FrameElement[])
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
data
- The list of data and widgets which is to be updated.wait
- The list of events to treat as a GO
event.void update(FrameElement[] data, handle hWin)
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()
and set(com.goldencode.p2j.ui.FrameElement[])
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
data
- The list of data and widgets which is to be updated.hWin
- A handle to the window where the frame is displayed.void update(Stream in, FrameElement[] data, handle hWin)
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()
. 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
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.void update(FrameElement[] data, EventList wait, handle hWin)
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()
and set(com.goldencode.p2j.ui.FrameElement[])
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
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.void updateUnlessHidden(FrameElement[] data)
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()
and set(com.goldencode.p2j.ui.FrameElement[])
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
data
- The list of data and widgets which is to be updated.void updateUnlessHidden(FrameElement[] data, handle hWin)
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()
and set(com.goldencode.p2j.ui.FrameElement[])
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
data
- The list of data and widgets which is to be updated.hWin
- A handle to the window where the frame is displayed.void view()
This method corresponds to these Progress statements: VIEW FRAME
void view(FrameElement[] list)
list
- The list of data and widgets which is to be viewed.void view(Stream out)
This method corresponds to these Progress statements: VIEW STREAM s FRAME
out
- A stream instance which is open for writing.void view(handle hWin)
This method corresponds to these Progress statements: VIEW FRAME
hWin
- A handle to the window where the frame is displayed.void view(FrameElement[] list, handle hWin)
list
- The list of data and widgets which is to be viewed.hWin
- A handle to the window where the frame is displayed.void view(Stream out, handle hWin)
This method corresponds to these Progress statements: VIEW STREAM s FRAME
out
- A stream instance which is open for writing.hWin
- A handle to the window where the frame is displayed.decimal frameCol()
This method corresponds to the Progress built-in function FRAME-COL
integer frameDown()
This method corresponds to the Progress built-in function FRAME-DOWN
integer frameLine()
This method corresponds to the Progress built-in function FRAME-LINE
decimal frameRow()
This method corresponds to the Progress built-in function FRAME-ROW
void setAttrSpace(boolean attr_space)
attr_space
- true
if the option is set to ON.default void setNoAttrSpace(boolean no_attr_space)
no_attr_space
- true
if the option is set to ON.void setCentered(boolean centered)
centered
- true
if the option is set to ON.void setColors(ColorSpec display, ColorSpec prompt, GenericWidget<?>[] widgets)
This method corresponds to these Progress statements:
COLOR DISPLAY [PROMPT]
COLOR PROMPT
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.void setColors(ColorSpec display, ColorSpec prompt, GenericWidget<?> widget)
This method corresponds to these Progress statements:
COLOR DISPLAY [PROMPT]
COLOR PROMPT
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.void setDColor(Color color)
color
- color numbervoid setPfColor(Color color)
color
- color numbervoid setDColor(ColorSpec color)
color
- color numbervoid setPfColor(ColorSpec color)
color
- color numberinteger getBgColor()
void setBgColor(int color)
color
- color numbervoid setBgColor(NumberType color)
color
- color numberinteger getFgColor()
void setFgColor(int color)
color
- color numbervoid setFgColor(NumberType color)
color
- color numbervoid setColumn(Resolvable column)
column
- The expression to evaluate for the frame column.void setColumn(Accessor column)
Accessor
. This value is honored at the time that
the frame is made visible (for the first time or after being hidden).column
- The instance variable to read for the frame column.void setColumn(NumberType column)
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.void setColumn(double column)
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.decimal getColumn()
This method corresponds to the Progress FRAME:COLUMN
attribute.
decimal getRow()
This method corresponds to the Progress FRAME:ROW
attribute.
void setColumns(int columns)
columns
- number of columnsvoid setDialogBox(boolean dialogBox)
dialogBox
- true
if the option is set to ON.void setDown(Resolvable down)
down
- The expression to evaluate for the number of data iterations
in the current (DOWN) frame.void setDown(Accessor down)
Accessor
. This value is then honored
at the time that the frame is made visible (for the first time or after
being hidden).down
- The simple instance variable to read for the number of data
iterations in the current (DOWN) frame.void setDown(NumberType down)
down
- The number of data iterations in the DOWN frame.void setDown(double down)
down
- The number of data iterations in the DOWN frame.void setFrameHandle(handle hFrame)
hFrame
- The handle of the frame that will be a "parent" frame.handle getFrameHandle()
void setKeepTabOrder(boolean keepTabOrder)
keepTabOrder
- true
if the option is set to ON.void setThreeD(boolean threeD)
threeD
- true
if the option is set to ON.void setDropTarget(boolean dropTarget)
dropTarget
- true
if the option is set to ON.void setNoBox(boolean noBox)
noBox
- true
if the option is set to ON.void setNoHide(boolean noHide)
noHide
- true
if the option is set to ON.void setNoLabels(boolean noLabels)
noLabels
- true
if the option is set to ON.void setNoUnderline(boolean noUnderline)
noUnderline
- true
if the option is set to ON.void setNoAutoValidate(boolean noAutoValidate)
noAutoValidate
- true
if the option is set to ON.void setOverlay(boolean overlay)
overlay
- true
if the option is set to ON.void setPageBottom(boolean pageBottom)
pageBottom
- true
if the option is set to ON.void setPageTop(boolean pageTop)
pageTop
- true
if the option is set to ON.void setParent(GenericWidget<?> widget)
widget
- New parent widget for frame.handle getParentHandle()
handle firstChild()
void setRetain(int retain)
retain
- retain sizevoid setRow(Resolvable row)
row
- The expression to evaluate for the frame row.void setRow(Accessor row)
Accessor
. This value is honored at the time that the
frame is made visible (for the first time or after being hidden).row
- The instance variable to read for the frame row.void setRow(NumberType row)
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.void setRow(double row)
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.void setScroll(int scroll)
scroll
- scroll sizevoid setScrollable(boolean scrollable)
scrollable
- true
if the option is set to ON.void setScrollable(logical scrollable)
scrollable
- true
if the option is set to ON.void setScrollbarVertical(boolean vert)
vert
- true
if the option is set to ON.void setSideLabels(boolean sideLabels)
sideLabels
- true
if the option is set to ON.character getTitle()
unknown
.void setTitle(character title)
title
- The title text to use.void setTitle(java.lang.String title)
title
- The title text to use.void setTitle(character title, ColorSpec titleColor)
title
- The title text to use.titleColor
- The overridden color for the title.void setTitle(java.lang.String title, ColorSpec titleColor)
title
- The title text to use.titleColor
- The overridden color for the title.void setDynamicTitle(Accessor title)
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.
title
- The simple variable or field reference that contains the
title text to be used.void setDynamicTitle(BaseDataType title)
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.
title
- The simple variable or field reference that contains the
title text to be used.void setDynamicTitle(CharacterExpression title)
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.
title
- The expression callback that generates the title text to be
used.void setDynamicTitle(BaseDataType title, ColorSpec titleColor)
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.
title
- The simple variable or field reference that contains the
title text to be used.titleColor
- The overridden color for the title.void setDynamicTitle(Accessor title, ColorSpec titleColor)
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.
title
- The simple variable or field reference that contains the
title text to be used.titleColor
- The overridden color for the title.void setDynamicTitle(CharacterExpression title, ColorSpec titleColor)
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.
title
- The expression callback that generates the title text to be
used.titleColor
- The overridden color for the title.void setFrame(handle hFrame)
hFr = frame f:handle.?
hFrame
- handle which is expected to contain a FrameWidget
instancevoid setTitleFont(long fontNum)
fontNum
- An entry in the font-table.void setTitleFont(int64 fontNum)
fontNum
- An entry in the font-table.integer getTitleFont()
void setTitleColor(ColorSpec titleColor)
titleColor
- The overridden color for the title.void setTopOnly(boolean topOnly)
topOnly
- true
if the option is set to ON.void setV6Frame(boolean v6frame)
v6frame
- true
if the option is set to ON.void setVisible(boolean visible)
visible
- true
if the option is set to ON.void setVisible(logical visible)
visible
- true
if the option is set to ON.void setSensitive(logical s)
s
- new value of SENSITIVE attributevoid setSensitive(boolean s)
s
- new value of SENSITIVE attributevoid setHidden(logical hidden)
hidden
- The new value for the HIDDEN attribute.void setHidden(boolean hidden)
hidden
- The new value for the HIDDEN attribute.NumberType getX()
integer getY()
void setX(NumberType x)
x
- horizontal position to be set.void setY(NumberType y)
y
- vertical position to be set.void setDefaultButtonOption(GenericWidget<?> defaultButton)
defaultButton
- button widget that works as the defaultvoid setCancelButtonOption(GenericWidget<?> cancelButton)
cancelButton
- button widget that receives the CHOOSE event when a user cancels the current frame
or dialog box by pressing the ESC key.void setStatisticsColumn(GenericWidget<?> widget)
display()
processing.widget
- The widget to use as the statistics column.void openScope()
This method should use the notification to register a callback for the block exit event. The callback should finalize the frame and all contained widgets.
void startEditingMode(FrameElement[] list, int type)
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[])
(no copying to or from the screen buffer),
set(com.goldencode.p2j.ui.FrameElement[])
(no copying to the screen buffer) or
update(com.goldencode.p2j.ui.FrameElement[])
(copying both directions). Use the constants
PROMPT_FOR, SET and UPDATE to specify this parameter.void startEditingMode(FrameElement[] list, int type, EventList wait)
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[])
(no copying to or from the screen buffer),
set(com.goldencode.p2j.ui.FrameElement[])
(no copying to the screen buffer) or
update(com.goldencode.p2j.ui.FrameElement[])
(copying both directions). Use the constants
PROMPT_FOR, SET and UPDATE to specify this parameter.wait
- List of events to wait for.void underline(GenericWidget<?>[] list)
This method corresponds to these Progress statements: UNDERLINE
list
- List of widgets.void underline(int[] list)
This method corresponds to these Progress statements: UNDERLINE
list
- List of widget ids.void underline(Stream stream, GenericWidget<?>[] list)
This method corresponds to these Progress statements: UNDERLINE
stream
- An explicit stream which will be used for the output.list
- List of widgets.void underline(Stream stream, int[] list)
This method corresponds to these Progress statements: UNDERLINE
stream
- An explicit stream which will be used for the output.list
- List of widget ids.void waitFor()
This method corresponds to the Progress statement:
WAIT-FOR
void waitFor(EventList el)
This method corresponds to the Progress statement:
WAIT-FOR
el
- List of events to wait for.void waitFor(EventList el, GenericWidget<?> focusWidget)
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget
el
- List of events to wait for.focusWidget
- Widget which is in focus.void waitFor(EventList el, int seconds)
This method corresponds to the Progress statement:
WAIT-FOR PAUSE n
el
- List of events to wait for.seconds
- Time to wait for event.void waitFor(EventList el, GenericWidget<?> focusWidget, int seconds)
This method corresponds to the Progress statement:
WAIT-FOR FOCUS widget PAUSE n
el
- List of events to wait for.focusWidget
- Widget which is in focus.seconds
- Time to wait for event.void waitForNextKey()
boolean continueEditing(FrameElement[] list, boolean hadNext)
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.true
if there is no GO-PENDING
and the editing mode
continues.void setInsideSetup(boolean flag)
flag
- true
means start of initialization and
false
- end of initialization.boolean isInsideSetup()
boolean moveAfterTab(GenericWidget<?> widget)
widget
- Widget reference.true
if operation was successful.logical validate()
true
if validation was successful.integer getHWND()
handle getNextTabItem()
void setFont(long fontNum)
fontNum
- The font.void setFont(int64 fontNum)
fontNum
- The font.integer getFont()
void setStreamIO(boolean value)
value
- true
if the STREAM-IO option is present.void setScreenIO(boolean value)
value
- true
if the SCREEN-IO option is present.void setUseText(boolean value)
value
- true
if the USE-TEXT option is present.void displayAndDown()
void displayAndDown(Stream out)
out
- A stream instance which is open for writing.void displayAndDown(FrameElement[] data)
data
- The list of data (and associated widgets) which is to be
displayed.void displayAndDown(Stream out, FrameElement[] data)
out
- A stream instance which is open for writing.data
- The list of data (and associated widgets) which is to be
displayed.void displayUnlessHiddenAndDown(FrameElement[] data)
data
- The list of data (and associated widgets) which is to be
displayed.