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

java.lang.Object
- com.goldencode.p2j.ui.client.widget.AbstractWidget<O>
- - com.goldencode.p2j.ui.client.widget.AbstractContainer<O>
  - - com.goldencode.p2j.ui.client.widget.TitledWindow<O>
    - - com.goldencode.p2j.ui.client.widget.OuterFrame<O>
      - com.goldencode.p2j.ui.client.TopLevelWindow<O>
        
        com.goldencode.p2j.ui.client.Window<O>

All Implemented Interfaces:

Container<O>, Widget<O>, WidgetWithConfig<WindowConfig>, ConfigOwner<WindowConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

WindowChuiImpl, WindowGuiImpl
```
public abstract class Window<O extends OutputManager<?>>
extends TopLevelWindow<O>
implements WidgetWithConfig<WindowConfig>
```
A Window is a single CHUI workspace for frames and dialogs. TODO A substantial amount of the insert mode processing may eventually move to the ChUI-specific classes, but remains there until the editing widgets and formatting classes have been reworked.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Window.StatusData` Status data container.
`private static class`	`Window.WorkArea` Stores common data for all windows, relating to the state of the current context.

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.TopLevelWindow
TopLevelWindow.IconDataType

Field Summary

Fields
Modifier and Type	Field and Description
`private boolean`	`autoCleared` `true` if automatic message clearing occurred during trigger processing.
`private boolean`	`clearMessage` Flag to force message clearing on the next MESSAGE stmt.
`protected WindowConfig`	`config` Window attributes container.
`protected BorderedPanel<O>`	`contentPane` Inner content pane.
`private java.lang.String`	`defaultMessage` Status message displayed when application is running
`protected java.lang.String`	`helpText` Last help text.
`private java.lang.String`	`inputMessage` Status message displayed when input operation is active.
`static int`	`INSERT_MODE_INS` The mode when the next char is inserted into current caret position.
`static int`	`INSERT_MODE_OFF` This is the default value for insert mode, means it is not used.
`static int`	`INSERT_MODE_OVR` Insert mode when the next typed char replaces the current one.
`static java.lang.String`	`INSERT_TEXT` "Insert " text message (with 1 space of padding on right).
`protected boolean`	`insertInAmbiguousState` If `true` then insert mode is ON while insert indicator is into OFF state.
`protected int`	`insertMode` Global variable to store the current insertion mode.
`protected boolean`	`isRunning` `true` if initialization has been performed.
`protected Menu<O>`	`menubar` Menubar
`protected MessageArea<O>`	`messageArea` Message-area for this window.
`private boolean`	`messageNeedPause` Separate pause before hide flag for messages.
`private boolean`	`putScreenPerformed` Determines whether any output has been performed using PUT SCREEN statement after the last call of HIDE ALL.
`static int`	`RESERVED_LINES` Number of reserved lines at the bottom of the screen.
`static int`	`ST_DEFAULT` Default status type
`static int`	`ST_HELP` Help status type.
`static int`	`ST_INPUT` Status type: INPUT
`protected StatusLine<O>`	`statusLine` Renders status info text.
`private int`	`statusType` Current status type.
`protected boolean`	`suspend` Suspend mode active flag.
`protected java.lang.Object`	`suspendLock` Synchronization lock for suspend processing.
`private int`	`tinyInputLine` message line number where tiny input frame is placed
`protected java.util.Set<Widget<O>>`	`vislist` Components that must be visible when interactive mode is restored.
`private static ContextLocal<Window.WorkArea>`	`wa` Stores context-local state variables.

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget
listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Window(WidgetId id)` Constructs the single Window instance by calling superclass constructor, setting the current layout to null and performing the window initialization with creation of a CHARVA frame without borders.
`protected`	`Window(WidgetId id, WindowConfig wcfg)` Construct a window widget based on a specific configuration.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFrame(Widget<O> widget, double row, double column)` Adds the frame to the window at the specified position.
`void`	`afterConfigUpdate(WindowConfig beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`TitledWindow<O>`	`ancestor()` A window's ancestor is itself.
`void`	`clearPutScreenInMessageArea(int line)` Force clearing of any temp-texts inside the message area or on the specific line in the message area.
`void`	`clearScreenDirectly(boolean framesToHide)` Perform direct screen cleanup.
`WindowConfig`	`config()` Provide access to the attributes stored in the widget.
`static void`	`disableSpecial()` Disables the "special components" (status line, insert mode indicator, message lines, temp text components) and stores a list of all currently visible top-level components (which are then set invisible before this method completes).
`void`	`displayMessage(java.lang.String[] content, Color cs, int ndx)` Display specified message lines.
`void`	`draw()` Draw all the components in this window, and request the keyboard focus.
`void`	`drawStatusLine(java.lang.String message, boolean noLengthLimit)` Draw status line.
`static void`	`enableSpecial()` Enables the "special components" (status line, insert mode indicator, message lines, temp text components) and restores visibility to the list of all previously visible top-level components.
`Container<O>`	`getContentPane()` Get window content pane.
`java.lang.String`	`getDefaultMessage()` Get the default status message.
`java.lang.String`	`getHelpText()` Get the last help text.
`java.lang.String`	`getInputMessage()` Get the input status message.
`static int`	`getInsertMode()` The static function to get the global insert mode value.
`protected int`	`getInsMode()` Get the global insert mode value.
`Menu<O>`	`getMenubar()` Get the `Menu` widget assigned to this window as MENUBAR.
`MessageArea<O>`	`getMessageArea()` Get the message area widget associated with this window.
`Color[]`	`getMessageColor()` Get colors of message area.
`abstract Rectangle`	`getMessageLineRectangle(int line)` Get messages area rectangle by message line index.
`java.lang.String[]`	`getMessageText()` Get content of message area.
`WidgetLocationRef`	`getRelativeTo()` Returns the widget location relativity.
`StatusLine<O>`	`getStatusArea()` Get the status area widget associated with this window.
`abstract Rectangle`	`getStatusLineRectangle()` Get status area rectangle.
`java.lang.String`	`getStatusText()` Get content of status line.
`int`	`getStatusType()` Get current status type.
`int`	`getTinyInputLine()` Obtain the message area line number being used by the currently active MESSAGE SET/UPDATE.
`Widget<O>[]`	`getWidgets()` Get widgets array from first available window.
`boolean`	`hideAllFrames()` Hide all frames.
`void`	`hideMessage(boolean noPause)` Hides all messages displayed in the message area.
`private void`	`hideRedirectedFrames()` Hides all redirected frames that are visible.
`protected void`	`init()` Initialize window
`void`	`initialize(WidgetId id, WindowConfig cfg)` Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
`static boolean`	`isInsertInAmbiguousState()` Returns `true` if insert mode is ON while insert indicator is into OFF state).
`boolean`	`isMessageNeedPause()` Is a pause needed for messages.
`boolean`	`isMessageNull()` Determines if the message lines are empty.
`private boolean`	`isMessageTextNull()` Determines if the message lines are empty.
`boolean`	`isRepaintDisabled()` Returns true if the widget repaint is disabled.
`static boolean`	`isRunning()` Checks to see whether the windowing environment is up.
`boolean`	`isThreeD()` If the method returns `true` the widget should be represented with 3D visuals.
`boolean`	`isTinyInputActive()` Reports if the user is in a tiny input editing session (MESSAGE SET/UPDATE).
`void`	`message(java.lang.String message)` Renders the specified message into the message line.
`MessageReturnValue`	`message(java.lang.String text, boolean set, BaseDataType var, boolean auto, java.lang.String format, Color cs, java.lang.String[] stack)` Displays a message and sets or updates a character variable using a specified format for the temporary FillIn widget.
`int`	`message(java.lang.String message, Color cs)` Renders the specified message into the message line.
`int`	`message(java.lang.String message, Color cs, boolean clear, java.lang.String[] stack)` Renders the specified message into the message line.
`private void`	`messageClearWorker()` Message line clear worker.
`static void`	`popStatus(int cnt)` Restore current status type and text from stack.
`protected java.lang.String`	`processStatusMessage(java.lang.String message)` Process the given status message - if a `null` value is received, it will default either to the `helpText`, the `inputMessage` or the `defaultMessage`, depending on the input mode being active or not.
`static void`	`pushConfig(WindowConfig cfg)` Merge current settings with new ones for default static window.
`static void`	`pushStatus(int cnt)` Save current status type and text in stack.
`protected void`	`reset()` Reset Window instance state.
`protected void`	`resetHelp()` Performs UI specific reset for help status line text.
`static void`	`resume()` Resumes normal drawing (exits suspend mode which was set using `suspend`).
`void`	`setAutoCleared(boolean autoCleared)` Set if automatic clearing is needed for trigger processing.
`void`	`setClearMessage(boolean clearMessage)` Set if clearing needed on next message statement.
`void`	`setHelp(java.lang.String text)` Set help text.
`static void`	`setInsertInAmbiguousState()` Sets the flag that indicates that insert is in an ambiguous state (i.e.
`static void`	`setInsertMode(int insertMode)` The static function to set up the global insert mode value.
`static void`	`setInsertMode(int insertMode, boolean force)` The static function to set up the global insert mode value.
`protected abstract void`	`setInsMode(int insMode, boolean force)` The private function to set up the global insert mode value.
`void`	`setMessageNeedPause(boolean messageNeedPause)` Set true if pause needed for messages.
`void`	`setMessageText(java.lang.String[] message, Color[] cs)` Shows the new message text.
`void`	`setMessageText(java.lang.String[] msg, Color[] cs, boolean force)` Set message main worker routine.
`void`	`setPutScreenPerformed(boolean putScreenPerformed)` Set true if output has been performed using PUT SCREEN after the last call of HIDE ALL.
`protected abstract void`	`setStatusLineText(java.lang.String status, boolean noLengthLimit)` Set the contents of the status line.
`void`	`setStatusType(int statusType)` Set current status type.
`protected void`	`setVisibility(boolean visibility)` Enables / Disables the "special components" (status line, insert mode indicator, message lines, temp text components) and restores visibility to the list of all previously visible top-level components.
`private void`	`showRedirectedFrames()` Restores visibility of all redirected frames.
`private int`	`splitMessage(java.lang.String message, Color cs)` Split long message and display it piece by piece.
`void`	`status(java.lang.String message)` Renders the specified message into the status line.
`void`	`status(java.lang.String message, boolean noLengthLimit)` Renders the specified message into the status line.
`void`	`statusDefault(java.lang.String text, boolean noLengthLimit)` Specifies a new default status message for the running procedure when not in INPUT mode (when editing).
`void`	`statusInput(java.lang.String text)` Specifies a new status message used when the user interface is blocked on input.
`private void`	`statusInt(java.lang.String status, boolean noLengthLimit)` Updates the status line area with the given text.
`static void`	`suspend()` Suspends drawing except for the status line.
`MessageReturnValue`	`tinyInput(java.lang.String text, int row, BaseDataType var, java.lang.String format, boolean auto, boolean set)` Perform complete input operation: create fill-in widget, process user input and return result.
`Window<O>`	`window()` A window's "window" is itself.

Methods inherited from class com.goldencode.p2j.ui.client.widget.OuterFrame
drawInt

Methods inherited from class com.goldencode.p2j.ui.client.widget.TitledWindow
destroy, destroyWidgets, findMouseSource, focusTraversable, getWorkspaceSize, getZOrderClass, hasFocus, hasTitle, hasTitlebar, hide, isDisplayed, isModal, processEvent, processKeyEvent, setTitle, show, title, toString

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer
add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, currentFocus, cycleFocus, deregisterSelectedWidget, detach, dimension, doLayout, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, hasFocusable, height, insets, lastFocus, minimumSize, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, nextFocus, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, prevFocus, reflectAncestorChange, registerSelectedWidget, remove, removeContainerStateListener, replace, requestFocus, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setSize, setTabItemList, setWidth, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged, width

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget
_setHidden, _setVisible, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestorId, autoResize, clear, clearWidget, clipRectangle, clipWith, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, drawCaret, enable, enableTooltip, enclosingFrame, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getDefaultEvent, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, hasFocus, hasTooltip, hidden, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isEnabled, isHeader, isMouseDrag, isRealized, isRMBEntrySupported, isScreenLocationCached, isTabStop, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseActions, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, screen, screenDimension, screenHeight, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized

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.client.widget.Container
widgetsAsList

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget
acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestorId, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, hasFocus, hasTooltip, hidden, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDroppable, isEnabled, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRMBEntrySupported, isTabStop, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, requestFocus, requestSync, resizeTo, resolvePopupMenuId, screen, setDirectManipulationActive, setEnabled, setHidden, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, startTrigger, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue

Methods inherited from interface java.awt.event.MouseListener
mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener
mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener
mouseWheelMoved

- Field Detail
  - ST_HELP
```
public static final int ST_HELP
```
    Help status type.
    
    See Also:
    
    Constant Field Values
  - ST_DEFAULT
```
public static final int ST_DEFAULT
```
    Default status type
    
    See Also:
    
    Constant Field Values
  - ST_INPUT
```
public static final int ST_INPUT
```
    Status type: INPUT
    
    See Also:
    
    Constant Field Values
  - INSERT_MODE_OFF
```
public static final int INSERT_MODE_OFF
```
    This is the default value for insert mode, means it is not used.
    
    See Also:
    
    Constant Field Values
  - INSERT_MODE_INS
```
public static final int INSERT_MODE_INS
```
    The mode when the next char is inserted into current caret position.
    
    See Also:
    
    Constant Field Values
  - INSERT_MODE_OVR
```
public static final int INSERT_MODE_OVR
```
    Insert mode when the next typed char replaces the current one.
    
    See Also:
    
    Constant Field Values
  - RESERVED_LINES
```
public static final int RESERVED_LINES
```
    Number of reserved lines at the bottom of the screen. TODO: the usage of this is reversed: the screen dimensions need to be set without the message/status area in mind, as HEIGHT-CHARS attr doesn't need to include these.
    
    See Also:
    
    Constant Field Values
  - INSERT_TEXT
```
public static final java.lang.String INSERT_TEXT
```
    "Insert " text message (with 1 space of padding on right).
    
    See Also:
    
    Constant Field Values
  - wa
```
private static final ContextLocal<Window.WorkArea> wa
```
    Stores context-local state variables.
  - contentPane
```
protected BorderedPanel<O extends OutputManager<?>> contentPane
```
    Inner content pane.
  - messageArea
```
protected MessageArea<O extends OutputManager<?>> messageArea
```
    Message-area for this window.
  - statusLine
```
protected StatusLine<O extends OutputManager<?>> statusLine
```
    Renders status info text.
  - menubar
```
protected Menu<O extends OutputManager<?>> menubar
```
    Menubar
  - suspend
```
protected boolean suspend
```
    Suspend mode active flag.
  - suspendLock
```
protected java.lang.Object suspendLock
```
    Synchronization lock for suspend processing.
  - config
```
protected WindowConfig config
```
    Window attributes container.
  - isRunning
```
protected boolean isRunning
```
    true if initialization has been performed.
  - insertMode
```
protected int insertMode
```
    Global variable to store the current insertion mode.
  - insertInAmbiguousState
```
protected boolean insertInAmbiguousState
```
    If true then insert mode is ON while insert indicator is into OFF state.
  - putScreenPerformed
```
private boolean putScreenPerformed
```
    Determines whether any output has been performed using PUT SCREEN statement after the last call of HIDE ALL.
  - vislist
```
protected java.util.Set<Widget<O extends OutputManager<?>>> vislist
```
    Components that must be visible when interactive mode is restored.
  - helpText
```
protected java.lang.String helpText
```
    Last help text.
  - defaultMessage
```
private java.lang.String defaultMessage
```
    Status message displayed when application is running
  - inputMessage
```
private java.lang.String inputMessage
```
    Status message displayed when input operation is active.
  - statusType
```
private int statusType
```
    Current status type.
  - tinyInputLine
```
private int tinyInputLine
```
    message line number where tiny input frame is placed
  - clearMessage
```
private boolean clearMessage
```
    Flag to force message clearing on the next MESSAGE stmt.
  - autoCleared
```
private boolean autoCleared
```
    true if automatic message clearing occurred during trigger processing.
  - messageNeedPause
```
private boolean messageNeedPause
```
    Separate pause before hide flag for messages. true means pause is due.
- Constructor Detail
  - Window
```
protected Window(WidgetId id)
```
    Constructs the single Window instance by calling superclass constructor, setting the current layout to null and performing the window initialization with creation of a CHARVA frame without borders.
    
    Parameters:
    
    id - The widget's ID.
  - Window
```
protected Window(WidgetId id,
                 WindowConfig wcfg)
```
    Construct a window widget based on a specific configuration.
    Call initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.WindowConfig) to finish the widget initialization.
    
    Parameters:
    
    id - The widget's ID.
    
    wcfg - Window configuration.
- Method Detail
  - initialize
```
public void initialize(WidgetId id,
                       WindowConfig cfg)
```
    Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
    This API is called after the widget is created and added to the registry.
    
    Specified by:
    
    initialize in interface WidgetWithConfig<WindowConfig>
    
    Parameters:
    
    id - The widget's ID.
    
    cfg - The config used to initialize this widget.
  - getRelativeTo
```
public WidgetLocationRef getRelativeTo()
```
    Returns the widget location relativity.
    
    Specified by:
    
    getRelativeTo in class TopLevelWindow<O extends OutputManager<?>>
    
    Returns:
    
    See above.
  - getMessageText
```
public java.lang.String[] getMessageText()
```
    Get content of message area.
    
    Returns:
    
    Array of two String instances with message area content.
  - getMessageColor
```
public Color[] getMessageColor()
```
    Get colors of message area.
    
    Returns:
    
    Array of two String instances with message area content.
  - isMessageNull
```
public boolean isMessageNull()
```
    Determines if the message lines are empty.
    
    Returns:
    
    true if the message line is empty.
  - setInsertMode
```
public static void setInsertMode(int insertMode)
```
    The static function to set up the global insert mode value. The possible values for insert mode:
    - INSERT_MODE_OFF means the value is not important and turned off.
    - INSERT_MODE_INS the mode when the chars are inserted at the specified position.
    - INSERT_MODE_OVR the mode of replacing the current char with the new one
    Parameters:
    
    insertMode - New integer value for insert mode.
  - setClearMessage
```
public void setClearMessage(boolean clearMessage)
```
    Set if clearing needed on next message statement.
    
    Parameters:
    
    clearMessage - true if clearing is needed, false otherwise.
  - setAutoCleared
```
public void setAutoCleared(boolean autoCleared)
```
    Set if automatic clearing is needed for trigger processing.
    
    Parameters:
    
    autoCleared - true if auto clearing is needed, false otherwise.
  - isMessageNeedPause
```
public boolean isMessageNeedPause()
```
    Is a pause needed for messages.
    
    Returns:
    
    See above.
  - setMessageNeedPause
```
public void setMessageNeedPause(boolean messageNeedPause)
```
    Set true if pause needed for messages.
    
    Parameters:
    
    messageNeedPause - true if pause is needed, false otherwise.
  - setPutScreenPerformed
```
public void setPutScreenPerformed(boolean putScreenPerformed)
```
    Set true if output has been performed using PUT SCREEN after the last call of HIDE ALL.
    
    Parameters:
    
    putScreenPerformed - true if PUT SCREEN was used, false otherwise.
  - setInsertMode
```
public static void setInsertMode(int insertMode,
                                 boolean force)
```
    The static function to set up the global insert mode value. The possible values for insert mode:
    - INSERT_MODE_OFF means the value is not important and turned off.
    - INSERT_MODE_INS the mode when the chars are inserted at the specified position.
    - INSERT_MODE_OVR the mode of replacing the current char with the new one
    Parameters:
    
    insertMode - New integer value for insert mode.
    
    force - Whether we have to repaint the indicator even if the new mode is the same as the old one.
  - getInsertMode
```
public static int getInsertMode()
```
    The static function to get the global insert mode value.
    
    Returns:
    
    The integer value for the global insert mode flag.
    
    See Also:
    
    for possible return values.
  - setInsertInAmbiguousState
```
public static void setInsertInAmbiguousState()
```
    Sets the flag that indicates that insert is in an ambiguous state (i.e. insert mode is ON while insert indicator is into OFF state).
  - setHelp
```
public void setHelp(java.lang.String text)
```
    Set help text. When the request comes from a widget which is part of an ongoing CHOOSE, the help text is overridden with whatever was supplied for the CHOOSE operation.
    
    Parameters:
    
    text - Text for help string or null, which indicates the default status message has to be restored
  - isInsertInAmbiguousState
```
public static boolean isInsertInAmbiguousState()
```
    Returns true if insert mode is ON while insert indicator is into OFF state).
    
    Returns:
    
    See above.
  - isRunning
```
public static boolean isRunning()
```
    Checks to see whether the windowing environment is up.
    
    Returns:
    
    true if the windowing environment is up.
  - disableSpecial
```
public static void disableSpecial()
```
    Disables the "special components" (status line, insert mode indicator, message lines, temp text components) and stores a list of all currently visible top-level components (which are then set invisible before this method completes). This is part of the switching of the client to the redirected mode.
  - enableSpecial
```
public static void enableSpecial()
```
    Enables the "special components" (status line, insert mode indicator, message lines, temp text components) and restores visibility to the list of all previously visible top-level components. This is part of the switching of the client to the interactive mode.
  - suspend
```
public static void suspend()
```
    Suspends drawing except for the status line. Resume using resume() method.
  - resume
```
public static void resume()
```
    Resumes normal drawing (exits suspend mode which was set using suspend).
  - pushConfig
```
public static void pushConfig(WindowConfig cfg)
```
    Merge current settings with new ones for default static window. For dynamic windows dynamic create or update registry.
    
    Parameters:
    
    cfg - New configuration data.
  - pushStatus
```
public static void pushStatus(int cnt)
```
    Save current status type and text in stack.
    
    Parameters:
    
    cnt - How many times state should be saved in stack.
  - popStatus
```
public static void popStatus(int cnt)
```
    Restore current status type and text from stack.
    
    Parameters:
    
    cnt - How many elements should be popped from stack.
  - getStatusLineRectangle
```
public abstract Rectangle getStatusLineRectangle()
```
    Get status area rectangle.
    
    Returns:
    
    Instance of Rectangle which describes the status area in screen coordinates.
  - getMessageLineRectangle
```
public abstract Rectangle getMessageLineRectangle(int line)
```
    Get messages area rectangle by message line index.
    
    Parameters:
    
    line - message line specification: either 0-based line number for specific line or -1 for the whole message area.
    
    Returns:
    
    Instance of Rectangle which describes the message area in screen coordinates.
  - init
```
protected void init()
```
    Initialize window
  - setStatusLineText
```
protected abstract void setStatusLineText(java.lang.String status,
                                          boolean noLengthLimit)
```
    Set the contents of the status line. This method is private and called at service level by another static public method within the class. The status line output is truncated to a maximum of 63 characters, only if the noLengthLimit flag is not set.
    
    Parameters:
    
    status - The new string to be displayed inside the status line area.
    
    noLengthLimit - flag indicating the status message should not be trimmed
  - ancestor
```
public TitledWindow<O> ancestor()
```
    A window's ancestor is itself.
    
    Specified by:
    
    ancestor in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    ancestor in class TopLevelWindow<O extends OutputManager<?>>
    
    Returns:
    
    This window instance.
  - window
```
public Window<O> window()
```
    A window's "window" is itself.
    
    Specified by:
    
    window in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    window in class TopLevelWindow<O extends OutputManager<?>>
    
    Returns:
    
    This window instance.
  - getMenubar
```
public Menu<O> getMenubar()
```
    Get the Menu widget assigned to this window as MENUBAR.
    
    Returns:
    
    See above.
  - getMessageArea
```
public MessageArea<O> getMessageArea()
```
    Get the message area widget associated with this window.
    
    Returns:
    
    See above.
  - getHelpText
```
public java.lang.String getHelpText()
```
    Get the last help text.
    
    Returns:
    
    See above.
  - getStatusType
```
public int getStatusType()
```
    Get current status type.
    
    Returns:
    
    See above.
  - setStatusType
```
public void setStatusType(int statusType)
```
    Set current status type.
    
    Parameters:
    
    statusType - new statusType - one of 3 constant values.
  - getStatusText
```
public java.lang.String getStatusText()
```
    Get content of status line.
    
    Returns:
    
    Status line content.
  - getDefaultMessage
```
public java.lang.String getDefaultMessage()
```
    Get the default status message.
    
    Returns:
    
    See above.
  - getInputMessage
```
public java.lang.String getInputMessage()
```
    Get the input status message.
    
    Returns:
    
    See above.
  - getStatusArea
```
public StatusLine<O> getStatusArea()
```
    Get the status area widget associated with this window.
    
    Returns:
    
    See above.
  - status
```
public void status(java.lang.String message)
```
    Renders the specified message into the status line.
    
    Parameters:
    
    message - The message body to be rendered.
  - status
```
public void status(java.lang.String message,
                   boolean noLengthLimit)
```
    Renders the specified message into the status line. The message is trimmed only if the noLengthLimit flag is not set.
    The method is a no-op when the status area is not displayed for this window.
    
    Parameters:
    
    message - The message body to be rendered.
    
    noLengthLimit - flag indicating the status message should not be trimmed
  - statusDefault
```
public void statusDefault(java.lang.String text,
                          boolean noLengthLimit)
```
    Specifies a new default status message for the running procedure when not in INPUT mode (when editing).
    This method is used to display a status message, which is trimmed to 63 chars only if the noLengthLimit flag is not set.
    
    Parameters:
    
    text - The new status message. null is the equivalent of the empty string.
    
    noLengthLimit - flag indicating the status message should not be trimmed
  - statusInput
```
public void statusInput(java.lang.String text)
```
    Specifies a new status message used when the user interface is blocked on input.
    This method corresponds to the Progress statement STATUS INPUT text.
    
    Parameters:
    
    text - The new status message. null is the equivalent of the empty string.
  - getContentPane
```
public Container<O> getContentPane()
```
    Get window content pane.
    
    Specified by:
    
    getContentPane in class TopLevelWindow<O extends OutputManager<?>>
    
    Returns:
    
    content pane.
  - getWidgets
```
public Widget<O>[] getWidgets()
```
    Get widgets array from first available window.
    
    Returns:
    
    array of the widgets belonging to the resolved windows.
  - config
```
public WindowConfig config()
```
    Provide access to the attributes stored in the widget.
    
    Specified by:
    
    config in interface Widget<O extends OutputManager<?>>
    
    Specified by:
    
    config in interface ConfigOwner<WindowConfig>
    
    Overrides:
    
    config in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    Reference to attribute container.
  - addFrame
```
public void addFrame(Widget<O> widget,
                     double row,
                     double column)
```
    Adds the frame to the window at the specified position.
    
    Overrides:
    
    addFrame in class TopLevelWindow<O extends OutputManager<?>>
    
    Parameters:
    
    widget - The handle of the frame to be added to the window.
    
    row - The row number for the upper-left frame corner.
    
    column - The column number for the upper-left frame corner.
  - draw
```
public void draw()
```
    Draw all the components in this window, and request the keyboard focus.
    If in suspend mode, only draw the status line. This mode can be set via suspend.
    
    Specified by:
    
    draw in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    draw in class OuterFrame<O extends OutputManager<?>>
  - drawStatusLine
```
public void drawStatusLine(java.lang.String message,
                           boolean noLengthLimit)
```
    Draw status line.
    
    Parameters:
    
    message - Message to display.
    
    noLengthLimit - flag indicating the status message should not be trimmed
  - setMessageText
```
public void setMessageText(java.lang.String[] message,
                           Color[] cs)
```
    Shows the new message text.
    This is a no-op when this window doesn't have the message area displayed.
    
    Parameters:
    
    message - Array of two text message which need to be displayed inside the message area.
    
    cs - Array of two color specifications.
  - setMessageText
```
public void setMessageText(java.lang.String[] msg,
                           Color[] cs,
                           boolean force)
```
    Set message main worker routine.
    This is a no-op when this window doesn't have the message area displayed.
    
    Parameters:
    
    msg - Message text array.
    
    cs - Message color array.
    
    force - true means force redisplaying of messages even if message text is already null.
  - tinyInput
```
public MessageReturnValue tinyInput(java.lang.String text,
                                    int row,
                                    BaseDataType var,
                                    java.lang.String format,
                                    boolean auto,
                                    boolean set)
```
    Perform complete input operation: create fill-in widget, process user input and return result.
    
    Parameters:
    
    text - The message text.
    
    row - Message row in which operation will be performed.
    
    var - Source variable.
    
    format - Format which will be used for variable.
    
    auto - Fill-in AUTO-RETURN flag.
    
    set - true for SET, false for UPDATE.
    
    Returns:
    
    The result of the input operation if the operation finished successfully, otherwise null.
  - isTinyInputActive
```
public boolean isTinyInputActive()
```
    Reports if the user is in a tiny input editing session (MESSAGE SET/UPDATE).
    
    Returns:
    
    true if tiny input is active.
  - getTinyInputLine
```
public int getTinyInputLine()
```
    Obtain the message area line number being used by the currently active MESSAGE SET/UPDATE.
    
    Returns:
    
    The message area line being edited.
  - message
```
public void message(java.lang.String message)
```
    Renders the specified message into the message line.
    
    Parameters:
    
    message - The message body to be rendered.
  - message
```
public int message(java.lang.String message,
                   Color cs)
```
    Renders the specified message into the message line.
    
    Parameters:
    
    message - The message body to be rendered.
    
    cs - color specification.
    
    Returns:
    
    Message line number used to display message.
  - message
```
public int message(java.lang.String message,
                   Color cs,
                   boolean clear,
                   java.lang.String[] stack)
```
    Renders the specified message into the message line.
    
    Parameters:
    
    message - The message body to be rendered.
    
    cs - color specification.
    
    clear - If true then the line(s) on which the message will be displayed, will be cleared first.
    
    stack - Progress stack trace. This can be null.
    
    Returns:
    
    Message line number used to display message.
  - message
```
public MessageReturnValue message(java.lang.String text,
                                  boolean set,
                                  BaseDataType var,
                                  boolean auto,
                                  java.lang.String format,
                                  Color cs,
                                  java.lang.String[] stack)
```
    Displays a message and sets or updates a character variable using a specified format for the temporary FillIn widget.
    This method corresponds to the Progress statement
    MESSAGE SET/UPDATE variable AUTO-RETURN FORMAT
    
    Parameters:
    
    text - Text to be displayed.
    
    set - true for SET, false for UPDATE, not used if var parameter is null.
    
    var - The variable to set or update. null means no set or update will occur.
    
    auto - true if the AUTO-RETURN option is specified. This is only valid if var is not null.
    
    format - The format specification to use for the set or update. This is only valid if var is not null.
    
    cs - The color specification to use for the text.
    
    stack - Progress stack trace. This can be null.
    
    Returns:
    
    The result of the input operation if input parameter var is not null and operation finished successfully and/or if any key was pressed during editing/pausing. If no pause occurred and there was no input (editing) in process, then null will be returned.
  - clearPutScreenInMessageArea
```
public void clearPutScreenInMessageArea(int line)
```
    Force clearing of any temp-texts inside the message area or on the specific line in the message area.
    
    Parameters:
    
    line - Message line specification: either 0-based line number for specific line or -1 for the whole message area.
  - clearScreenDirectly
```
public void clearScreenDirectly(boolean framesToHide)
```
    Perform direct screen cleanup.
    
    Parameters:
    
    framesToHide - true if there are any frames to hide.
  - hideAllFrames
```
public boolean hideAllFrames()
```
    Hide all frames.
    
    Returns:
    
    true if at least one frame was hidden.
  - hideMessage
```
public void hideMessage(boolean noPause)
```
    Hides all messages displayed in the message area. If pausing is in effect, the standard message "Press space bar to continue" is displayed on the status line and the user is required to press a key.
    This method corresponds to the Progress statement
    HIDE MESSAGE [NO_PAUSE]
    
    Parameters:
    
    noPause - true if no pause is required before hiding messages
  - afterConfigUpdate
```
public void afterConfigUpdate(WindowConfig beforeUpdate)
```
    The method is called after the configuration associated with the implementor changes. The parameter points to a reference representing the original configuration state. This reference can be used to detect what configuration fields changed and so optimize any processing related to the configuration change.
    
    Specified by:
    
    afterConfigUpdate in interface ConfigOwner<WindowConfig>
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - isThreeD
```
public boolean isThreeD()
```
    If the method returns true the widget should be represented with 3D visuals.
    
    Specified by:
    
    isThreeD in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    isThreeD in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    see above.
  - isRepaintDisabled
```
public boolean isRepaintDisabled()
```
    Returns true if the widget repaint is disabled. This method is needed to support the WINDOW:DISABLE-REDRAW attribute.
    This implementation always returns false. This is to ensure that all the child widgets except window workspace are not affected with WINDOW:DISABLE-REDRAW. In other words when WINDOW:DISABLE-REDRAW is set to TRUE the window's title bar, window message and status areas still must redraw.
    
    Specified by:
    
    isRepaintDisabled in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    isRepaintDisabled in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    See above.
  - processStatusMessage
```
protected java.lang.String processStatusMessage(java.lang.String message)
```
    Process the given status message - if a null value is received, it will default either to the helpText, the inputMessage or the defaultMessage, depending on the input mode being active or not.
    
    Parameters:
    
    message - The status message.
    
    Returns:
    
    The processed message.
  - reset
```
protected void reset()
```
    Reset Window instance state. This initialization code is common for both ChUI and GUI. This code MUST be called from subclasses.
  - setVisibility
```
protected void setVisibility(boolean visibility)
```
    Enables / Disables the "special components" (status line, insert mode indicator, message lines, temp text components) and restores visibility to the list of all previously visible top-level components. This is part of the switching of the client to the interactive mode.
    
    Parameters:
    
    visibility - true enable false disable.
  - setInsMode
```
protected abstract void setInsMode(int insMode,
                                   boolean force)
```
    The private function to set up the global insert mode value.
    
    Parameters:
    
    insMode - New integer value for insert mode.
    
    force - Whether we have to repaint the indicator even if the new mode is the same as the old one.
  - getInsMode
```
protected int getInsMode()
```
    Get the global insert mode value.
    
    Returns:
    
    The integer value for the global insert mode flag.
  - resetHelp
```
protected void resetHelp()
```
    Performs UI specific reset for help status line text. Default action is to clean up.
  - isMessageTextNull
```
private boolean isMessageTextNull()
```
    Determines if the message lines are empty.
    
    Returns:
    
    true if the message line is empty.
  - messageClearWorker
```
private void messageClearWorker()
```
    Message line clear worker.
  - displayMessage
```
public void displayMessage(java.lang.String[] content,
                           Color cs,
                           int ndx)
```
    Display specified message lines.
    
    Parameters:
    
    content - Message lines.
    
    cs - Color specification.
    
    ndx - Message index.
  - splitMessage
```
private int splitMessage(java.lang.String message,
                         Color cs)
```
    Split long message and display it piece by piece.
    
    Parameters:
    
    message - Message to split.
    
    cs - Color specification.
    
    Returns:
    
    Index of last displayed message line.
  - statusInt
```
private void statusInt(java.lang.String status,
                       boolean noLengthLimit)
```
    Updates the status line area with the given text. The status line output is truncated to a maximum of 63 characters, only if the noLengthLimit flag is not set.
    
    Parameters:
    
    status - The new string to be displayed inside the status line area.
    
    noLengthLimit - flag indicating the status message should not be trimmed
  - hideRedirectedFrames
```
private void hideRedirectedFrames()
```
    Hides all redirected frames that are visible. All frames being made hidden are stored in a list. This action is part of switching of the terminal back to the interactive mode.
  - showRedirectedFrames
```
private void showRedirectedFrames()
```
    Restores visibility of all redirected frames. This action is part of switching of the terminal to the redirected mode.
    If the terminal has ever been switched to the redirected mode and then back, all redirected frames have been hidden during the back switch to the interactive mode. Now those frames have to be made visible again.

Class Window<O extends OutputManager<?>>

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.TopLevelWindow

Field Summary

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.ui.client.TopLevelWindow

Methods inherited from class com.goldencode.p2j.ui.client.widget.OuterFrame

Methods inherited from class com.goldencode.p2j.ui.client.widget.TitledWindow

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Container

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget

Methods inherited from interface java.awt.event.MouseListener

Methods inherited from interface java.awt.event.MouseMotionListener

Methods inherited from interface java.awt.event.MouseWheelListener

Field Detail

ST_HELP

ST_DEFAULT

ST_INPUT

INSERT_MODE_OFF

INSERT_MODE_INS

INSERT_MODE_OVR

RESERVED_LINES

INSERT_TEXT

wa

contentPane

messageArea

statusLine

menubar

suspend

suspendLock

config

isRunning

insertMode

insertInAmbiguousState

putScreenPerformed

vislist

helpText

defaultMessage

inputMessage

statusType

tinyInputLine

clearMessage

autoCleared

messageNeedPause

Constructor Detail

Window

Window

Method Detail

initialize

getRelativeTo

getMessageText

getMessageColor

isMessageNull

setInsertMode

setClearMessage

setAutoCleared

isMessageNeedPause

setMessageNeedPause

setPutScreenPerformed

setInsertMode

getInsertMode

setInsertInAmbiguousState

setHelp

isInsertInAmbiguousState

isRunning

disableSpecial

enableSpecial

suspend

resume

pushConfig

pushStatus

popStatus

getStatusLineRectangle

getMessageLineRectangle

init

setStatusLineText