FrameGuiImpl (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.Frame<GuiOutputManager>
    - - com.goldencode.p2j.ui.client.gui.FrameGuiImpl

All Implemented Interfaces:

HasDynamicLayout, Container<GuiOutputManager>, StreamableWidget, Widget<GuiOutputManager>, WidgetWithConfig<FrameConfig>, ConfigOwner<FrameConfig>, CloseListener, PageBreakListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

AbstractFileChooserDialog, ColorChooserGuiImpl, ColorIndexChooserGuiImpl, FontChooserGuiImpl, InputDialog
```
public class FrameGuiImpl
extends Frame<GuiOutputManager>
implements StreamableWidget, HasDynamicLayout
```
A Frame is a top-level window with a title and a border.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class FrameGuiImpl.GuiFrameScrollContainer
The implementation of frame's scrollable container.
- Nested classes/interfaces inherited from class com.goldencode.p2j.ui.client.Frame
  Frame.FrameScrollContainer

Nested Classes
Modifier and Type	Class and Description
`protected class`	`FrameGuiImpl.GuiFrameScrollContainer` The implementation of frame's scrollable container.

Field Summary

Fields
Modifier and Type	Field and Description
`private CoordinatesConversion`	`cc` Coordinate converter
`private static int`	`DEFAULT_MINIMAL_SIZE_IN_PIXELS` The frame's minimal size given in pixels.
`private double`	`defaultMinimalHeight` The default minimal height of the empty frame.
`private double`	`defaultMinimalWidth` The default minimal width of the empty frame.
`private DynamicLayoutIntegration`	`dynamicLayout` Enabler of dynamic layout.
`private BorderedPanelGuiImpl`	`frameTitle` Panel for the frame's title.
`private GuiColorResolver`	`gc` Color resolver
`private GuiColorResolver`	`gct` Title color resolver
`private GuiDriver`	`gd` Screen driver
`private GuiFontResolver`	`gf` Font resolver - frame title.
`private LineBorderGuiImpl`	`lineBorder` Cached line border.
`private GuiOutputManager`	`screen` Output manager

Fields inherited from class com.goldencode.p2j.ui.client.Frame
chooseHandler, configUpdateActive, contentPane, currentStatement, cursor, down, downBody, EXTRA_DLG_PIXELS, frameScroll, headersHeight, headersOutput, lastRow, needPause, nonbody, originalHeightChars, paintable, positionChanged, redirected, savedTabOrder, sizeChanged, skipMoveToTop, startRow, touched, trailingSkips, underline, underlinedRow, verticalStepBoxed

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

Constructor Summary

Constructors
Constructor and Description

FrameGuiImpl(WidgetId id, FrameConfig cfg)
Special constructor used to restore component using given configuration.

Constructors
Constructor and Description
`FrameGuiImpl(WidgetId id, FrameConfig cfg)` Special constructor used to restore component using given configuration.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activateDirectManipulation()` Activates direct manipulation engine for this widget.
`private void`	`activateHorizontalBarQuirk()` Activate the horizontal scrollbar 4GL bug for all ancestor frames, except the root one.
`protected double`	`adjustMinSize(double minWidthOrHeight, boolean isHeight)` Adjusts the minimum frame width or height value depending on the current min value and the presense of the box within the frame.
`protected double`	`adjustWidth(double width, double screenWidth, double regionWidth)` Adjust frame width.
`void`	`afterConfigUpdate(FrameConfig beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`protected void`	`calculateHeight(Dimension d, double delta)` Calculate frame height.
`protected double`	`calculateHeightDelta()` Calculate frame height delta.
`protected double`	`captionHeight()` Get the frame's caption height, in character units.
`protected Colors`	`compareColors(BaseConfig config, Colors colors)` Compare colors.
`private void`	`configContentPanels()` Configure frame scroll pane
`private void`	`configScrollPane()` Configure frame scroll pane
`Widget<?>`	`convertToStreamable()` Convert this widget instance to its streamable equivalent.
`protected MouseHoverAction`	`createMouseHoverAction()` Create handler for processing mouse hover events
`protected SensitiveScrollContainer<GuiOutputManager>`	`createScrollContainer()` Creates the frame's scroll container.
`void`	`deactivateDirectManipulation()` Deactivates direct manipulation engine for this widget.
`Widget<GuiOutputManager>`	`defaultFocus()` Get default focusable widget.
`void`	`destroy()` Destroy this widget.
`protected void`	`doLayoutWorker(boolean suppressDrawing)` Process frame layout.
`void`	`draw(Point origin, Dimension size)` Draw the peer container.
`protected boolean`	`drawDownFrame(Point top, boolean redir)` Draw the body of a down frame.
`private void`	`drawGrid()` Draws frame grid before the frame content painting.
`private void`	`drawResizeAnchors(int xr, int yr, int wr, int hr)` Draws the 8 resize anchors within the given rectangle area.
`protected void`	`drawUnderline(Widget<GuiOutputManager> comp)` Draw underline for specified widget.
`private void`	`drawWidgetsSelectionStatus()` Updates the status of the selected widgets.
`Widget<GuiOutputManager>`	`findMouseSource(NativePoint p)` Find the widget positioned just bellow the specified mouse position (in physical units).
`protected Rectangle`	`frameContentBounds()` Get the bounds of the frame's content.
`(package private) GuiColorResolver`	`getColorResolver()` Returns the color resolver in effect.
`java.util.Optional<MousePtrWrapper>`	`getCustomMousePointer()` Get the current custom mouse pointer if it is set
`Dimension`	`getDialogDecorationCharSize()` Returns the size of the decoration elements for dialog-box.
`DynamicLayoutIntegration<GuiOutputManager>`	`getDynamicLayout()` Returns the dynamic layout widget integration implementation.
`(package private) ColorRgb`	`getFrameBgColor()` Get the color used to draw the frame background.
`(package private) ColorRgb`	`getFrameFgColor()` Get the color used to draw the frame text.
`double`	`getLabelHeight(java.lang.String labelText, LabeledWidget<GuiOutputManager> widget, boolean topLabel)` Compute the label height in character units.
`double`	`getLabelWidth(java.lang.String label, LabeledWidget<GuiOutputManager> widget)` Compute the label width in character units, depending on the current font.
`protected Dimension`	`getMaxFrameSize()` The method returns the maximum frame size according to the virtual size of the enclosing frame or according to the workspace size of its parent window.
`NativePoint`	`getMousePosition()` Returns current mouse cursor position relative to the this widget.
`NativePoint`	`getPortableMouseEventCoordinates(NativePoint point)` Get a point to represent the LAST-EVENT:X and LAST-EVENT:Y coordinates.
`NativeRectangle`	`getResizeRectangle()` Gets the rectangle defining the 8 resize handles for frame widget.
`double`	`getRowDelta()` Get a delta which is added between frames, when their Y coordinate is automatically computed.
`private ScrollPaneGuiImpl.ShowBars`	`getShowBars()` Calculates scroll bars visibility.
`int`	`getTitleHeight()` Gets the frame title height in pixel units or O if no title.
`boolean`	`hasBox()` The method returns `true` when the frame should have a box around.
`void`	`initialize(WidgetId id, FrameConfig wcfg)` 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.
`boolean`	`isDirectManipulationRequired()` Checks if direct manipulation feature must be installed or removed in GUI mode.
`private boolean`	`isDirectManipulationRequired(AbstractWidget w)` Checks if direct manipulation feature must be installed or removed in GUI mode for a widget inside of a frame.
`boolean`	`isDroppable()` Checks if the given widget is able to be the target of the drop operation.
`boolean`	`isRootFrame()` Check if this frame is the root frame (is parented directly to a window).
`private boolean`	`isShowInOverlay()` Checks if the frame is displayed in an overlay window.
`boolean`	`isSrollBarEmbedded(ScrollBar<?> sbToTest)` Tests if the given scroll bar is a part of this frame or standalone.
`Point`	`location()` Get frame location relative to container.
`protected int[]`	`mouseActions()` Determine the mouse actions processed by this widget.
`boolean`	`moveToTop()` Moves this frame to the top of other widgets in the Tab ordering.
`boolean`	`moveToTop(boolean ignoreKeepZorder)` Moves this frame to the top of other widgets in the Tab ordering.
`private void`	`notifyDriverWidgets()` Notify all driver widgets that the frame's state has changed.
`protected void`	`onFromVisibleToHidden()` Process transition from visible to hidden state.
`NativePoint`	`physicalLocation()` Get frame physical location relative to container, expressed in units native to UI type.
`boolean`	`processCancelButton()` Processing for cancel button in a frame.
`boolean`	`processDefaultButton(KeyInput event)` Processing for default button in a frame, based on an event.
`boolean`	`processDefaultButton(KeyInput event, boolean recursive)` Processing for default button in a frame, based on an event source.
`void`	`processDirectManipulationEvent(DirectManipulationEvent event)` Process direct manipulation event.
`void`	`realizeFrame(boolean realize)` Realize the frame, only if it's not yet realized.
`private void`	`repaintCaption()` Raise a `PaintEvent` for the frame's title, as needed.
`protected void`	`resetColors(BaseConfig config)` Reset colors.
`private static int`	`resolveLabelFont(LabeledWidget<GuiOutputManager> lwidget)` Resolves the effective font for a label of the supplied labeled widget.
`void`	`setFocus(Widget<GuiOutputManager> focus)` Set focus to specified widget.
`void`	`setHidden(boolean hidden)` Tracks the hidden state of the widget.
`void`	`setOuterSize(double width, double height)` Sets the size of the peer container.
`void`	`setSensitiveForUIB(boolean sensitive)` Sets direct manipulation sensitive flag value for this widget in UIB mode.
`void`	`setVisible(boolean visible)` Handle change of frame visibility.
`boolean`	`supportsCustomMousePointer()` Check if the widget supports LOAD-MOUSE-POINTER() method
`private void`	`updateScrollPaneSize()` Updates frame scroll pane size with possible frame title.

Methods inherited from class com.goldencode.p2j.ui.client.Frame
addWidget, adjustDown, adjustDown, allFramesVisible, applyConfig, arrangeToInteract, arrangeToStream, attachToWindow, calcDefaultFocus, calculateFrameRect, calculateWidthDelta, canSetColumn, canSetHeightChars, canSetRow, canSetWidthChars, clear, clearCurrent, clearWorker, clipping, config, copyState, currentFocus, detach, doLayout, doLayout, draw, enableAllWidgets, enabledWidgetsByList, enterChoose, fixNonBody, forceBox, getBorderBottomChars, getBorderLeftChars, getBorderRightChars, getBorderTopChars, getChooseData, getChooseHelp, getContentPane, getCursor, getDown, getDownConfigs, getField, getField, getFirstEnabledWidget, getFirstFocusableId, getFirstFocusableId, getFixedHeight, getFocusId, getFrameRegion, getFrameValue, getFrameValue, getInnerSize, getIterationHeight, getIterationIds, getLeadingSkipSize, getMinHeight, getNextEnabledWidget, getOriginalHeightChars, getRootFrame, getSavedDimension, getScopeNesting, getSelectedField, getSelectedWidget, getStreamId, getTrailingSkipSize, getValues, getZOrderClass, hasAnyEnabled, hasDefaultButton, hasEditors, hasEnabled, hasHeaders, hasParentFrame, hasSavedState, hasTitle, initializeWidget, isActive, isAlive, isAllClear, isAttrSpace, isAutoplacing, isCanHide, isCanHideOthers, isCanWipeScreen, isChanged, isChooseActive, isConfigUpdateActive, isCurrentTouched, isDelayedRepaint, isDialog, isDown, isDownCalculated, isDynamic, isExplicitHide, isFixedWidth, isFocusAttractor, isFocusReset, isForcedRefresh, isForcePause, isForceWipeScreen, isHonorNextConditionalDown, isInChoose, isInScope, isInternalGo, isLabels, isLastWidget, isLastWidget, isLeftMostWidget, isNeedPause, isNeedReset, isNoHide, isPendingFixedDown, isPendingUnderline, isPlacedForRedirected, isRedirected, isRightMostWidget, isSideLabels, isStreamed, isThreeD, isTopFrame, isViewed, isVisibilityChanged, isWithHeaders, leaveChoose, markAsStreamed, markChanged, moveAboveWidget, moveBelowWidget, moveCursor, moveToBottom, moveWidgetBeforeTabItem, needClearRow, notifyClose, notifyPageBreak, notifyUnbind, placeAtTop, placed, placeToWindow, placeToWindow, postponePlace, postponeSetVisible, postprocess, postprocessConfig, prepareIteration, preprocess, preventFocusWhenMouseDownEventDefined, previousFocus, processFrameMnemonic, processKeyEvent, rearrangeEditors, relayout, relocateComponent, repaint, repaintCurrent, repaintUninitialized, requestFocus, reset, resetAll, resetAutoplacing, resetChanged, resetForcedRefresh, resetNeedPause, resetPlacementQuirk, resetWidget, resolveWidgetId, restore, restoreEditors, restoreInitialTabOrder, scroll, setAlive, setAllClear, setAttrSpace, setBodyVisible, setBox, setCanHide, setCanHideOthers, setCanWipeScreen, setChooseAt, setColumns, setCurrentStatement, setCursor, setDelayedRepaint, setDown, setDynCol, setDynRow, setExplicitHide, setFocusAttractor, setFocusId, setFocusReset, setForcePause, setForceWipeScreen, setFormatCheck, setHeight, setHonorNextConditionalDown, setInnerSize, setInScope, setLabels, setLayout, setNeedPause, setNeedPauseDirect, setNeedReset, setNonBodyVisible, setPaintable, setPendingFixedDown, setPendingUnderline, setProtected, setRedirected, setSavedDimension, setScopeNesting, setSensitive, setSize, setSkipMoveToTop, setState, setTabItemList, setTabItemList, setValue, setValue, setViewed, setVisibilityChanged, setWidth, shortName, switchLabelsEmptyMode, thisAndAncestryVisible, toString, touchBody, touchRow, unbind, underline, updateInnerSize, view

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer
add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipRectangle, currentFocus, cycleFocus, deregisterSelectedWidget, dimension, dumpCurrentWidgets, dumpWidgets, endSizeChange, firstFocus, focus, focusTraversable, 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, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, replace, requestFocus, requestFocus, setFocusInt, setIgnoreFocus, setInsets, setPhysicalDimensionInt, setSize, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged, width

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

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.StreamableWidget
convertToStreamable

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, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, defaultMousePtr, displayPhysicalLocation, drawCaret, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, hasFocus, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isTotallyObscured, isVisible, isVisible, maySwitchFocus, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, processEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setEnabled, setHighlighted, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setState, setWindow, show, startTrigger, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue, window

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
  - DEFAULT_MINIMAL_SIZE_IN_PIXELS
```
private static final int DEFAULT_MINIMAL_SIZE_IN_PIXELS
```
    The frame's minimal size given in pixels. This value seems to be hard coded into the 4GL. Based on testing, this value does not change when the default font size is changed.
    
    See Also:
    
    Constant Field Values
  - gd
```
private GuiDriver gd
```
    Screen driver
  - screen
```
private GuiOutputManager screen
```
    Output manager
  - cc
```
private CoordinatesConversion cc
```
    Coordinate converter
  - gc
```
private GuiColorResolver gc
```
    Color resolver
  - gct
```
private GuiColorResolver gct
```
    Title color resolver
  - gf
```
private GuiFontResolver gf
```
    Font resolver - frame title.
  - frameTitle
```
private BorderedPanelGuiImpl frameTitle
```
    Panel for the frame's title.
  - lineBorder
```
private LineBorderGuiImpl lineBorder
```
    Cached line border.
  - defaultMinimalWidth
```
private final double defaultMinimalWidth
```
    The default minimal width of the empty frame.
  - defaultMinimalHeight
```
private final double defaultMinimalHeight
```
    The default minimal height of the empty frame.
  - dynamicLayout
```
private DynamicLayoutIntegration dynamicLayout
```
    Enabler of dynamic layout.
- Constructor Detail
  - FrameGuiImpl
```
public FrameGuiImpl(WidgetId id,
                    FrameConfig cfg)
```
    Special constructor used to restore component using given configuration.
    Call initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.FrameConfig) to finish the widget initialization.
    
    Parameters:
    
    id - The widget's ID.
    
    cfg - Configuration data.
- Method Detail
  - convertToStreamable
```
public Widget<?> convertToStreamable()
```
    Convert this widget instance to its streamable equivalent.
    
    Specified by:
    
    convertToStreamable in interface StreamableWidget
    
    Returns:
    
    This widget's streamable equivalent.
  - getLabelWidth
```
public double getLabelWidth(java.lang.String label,
                            LabeledWidget<GuiOutputManager> widget)
```
    Compute the label width in character units, depending on the current font.
    
    Specified by:
    
    getLabelWidth in class Frame<GuiOutputManager>
    
    Parameters:
    
    label - The label text.
    
    widget - The widgeth to which the label belongs.
    
    Returns:
    
    See above.
  - getLabelHeight
```
public double getLabelHeight(java.lang.String labelText,
                             LabeledWidget<GuiOutputManager> widget,
                             boolean topLabel)
```
    Compute the label height in character units.
    
    Specified by:
    
    getLabelHeight in class Frame<GuiOutputManager>
    
    Parameters:
    
    labelText - The label text.
    
    widget - The widget to which the label belongs.
    
    topLabel - Flag identifying that the label is shown above the widget.
    
    Returns:
    
    See above.
  - getRowDelta
```
public double getRowDelta()
```
    Get a delta which is added between frames, when their Y coordinate is automatically computed.
    
    Specified by:
    
    getRowDelta in class Frame<GuiOutputManager>
    
    Returns:
    
    A row height in char units computed by substracting 1 pixel from the FontManager.getPixelsPerRow(com.goldencode.p2j.ui.client.driver.ScreenDriver<?>) value.
  - location
```
public Point location()
```
    Get frame location relative to container.
    
    Specified by:
    
    location in interface Widget<GuiOutputManager>
    
    Overrides:
    
    location in class Frame<GuiOutputManager>
    
    Returns:
    
    relative frame location.
  - physicalLocation
```
public NativePoint physicalLocation()
```
    Get frame physical location relative to container, expressed in units native to UI type.
    
    Specified by:
    
    physicalLocation in interface Widget<GuiOutputManager>
    
    Overrides:
    
    physicalLocation in class Frame<GuiOutputManager>
    
    Returns:
    
    relative frame location.
  - initialize
```
public void initialize(WidgetId id,
                       FrameConfig wcfg)
```
    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<FrameConfig>
    
    Overrides:
    
    initialize in class Frame<GuiOutputManager>
    
    Parameters:
    
    id - The widget's ID.
    
    wcfg - The config used to initialize this widget.
  - setVisible
```
public void setVisible(boolean visible)
```
    Handle change of frame visibility.
    Also, all driver widgets are notified if the visible state has changed.
    
    Specified by:
    
    setVisible in interface Widget<GuiOutputManager>
    
    Overrides:
    
    setVisible in class Frame<GuiOutputManager>
    
    Parameters:
    
    visible - New visibility state. true- show frame, false- hide frame.
  - setHidden
```
public void setHidden(boolean hidden)
```
    Tracks the hidden state of the widget.
    Also, all driver widgets are notified if the hidden state has changed.
    
    Specified by:
    
    setHidden in interface Widget<GuiOutputManager>
    
    Overrides:
    
    setHidden in class Frame<GuiOutputManager>
    
    Parameters:
    
    hidden - New hidden state.
  - getDialogDecorationCharSize
```
public Dimension getDialogDecorationCharSize()
```
    Returns the size of the decoration elements for dialog-box. It includes the window border total size from both sides and the size of the dialog title.
    
    Overrides:
    
    getDialogDecorationCharSize in class Frame<GuiOutputManager>
    
    Returns:
    
    See above.
  - getColorResolver
```
GuiColorResolver getColorResolver()
```
    Returns the color resolver in effect.
    
    Returns:
    
    See above.
  - doLayoutWorker
```
protected void doLayoutWorker(boolean suppressDrawing)
```
    Process frame layout.
    
    Overrides:
    
    doLayoutWorker in class Frame<GuiOutputManager>
    
    Parameters:
    
    suppressDrawing - If true then drawing is suppressed even if frame is visible.
  - realizeFrame
```
public void realizeFrame(boolean realize)
```
    Realize the frame, only if it's not yet realized. It has been overridden in order to set the default size for an empty frame according to the Progress 4GL GUI look and feel.
    
    Overrides:
    
    realizeFrame in class Frame<GuiOutputManager>
    
    Parameters:
    
    realize - Flag indicating if the frame should be realized.
  - isDroppable
```
public boolean isDroppable()
```
    Checks if the given widget is able to be the target of the drop operation.
    
    Specified by:
    
    isDroppable in interface Widget<GuiOutputManager>
    
    Returns:
    
    TRUE if this widget can be droppable at this time, FALSE otherwise.
  - activateDirectManipulation
```
public void activateDirectManipulation()
```
    Activates direct manipulation engine for this widget.
    
    Overrides:
    
    activateDirectManipulation in class AbstractWidget<GuiOutputManager>
  - deactivateDirectManipulation
```
public void deactivateDirectManipulation()
```
    Deactivates direct manipulation engine for this widget.
    
    Overrides:
    
    deactivateDirectManipulation in class AbstractWidget<GuiOutputManager>
  - isDirectManipulationRequired
```
public boolean isDirectManipulationRequired()
```
    Checks if direct manipulation feature must be installed or removed in GUI mode. If config is updating in a way that stops using direct manipulation it must be removed from system. Different widgets can use different criteria to make this decision.
    
    Overrides:
    
    isDirectManipulationRequired in class AbstractWidget<GuiOutputManager>
    
    Returns:
    
    TRUE if direct manipulation is need to be installed, FALSE if direct manipulation is need to be removed.
  - setSensitiveForUIB
```
public void setSensitiveForUIB(boolean sensitive)
```
    Sets direct manipulation sensitive flag value for this widget in UIB mode.
    
    Specified by:
    
    setSensitiveForUIB in interface Widget<GuiOutputManager>
    
    Overrides:
    
    setSensitiveForUIB in class AbstractWidget<GuiOutputManager>
    
    Parameters:
    
    sensitive - The new value for the flag.
  - mouseActions
```
protected int[] mouseActions()
```
    Determine the mouse actions processed by this widget.
    
    Overrides:
    
    mouseActions in class AbstractWidget<GuiOutputManager>
    
    Returns:
    
    See above.
  - getFrameBgColor
```
ColorRgb getFrameBgColor()
```
    Get the color used to draw the frame background.
    
    Returns:
    
    See above.
  - getFrameFgColor
```
ColorRgb getFrameFgColor()
```
    Get the color used to draw the frame text.
    
    Returns:
    
    See above.
  - draw
```
public void draw(Point origin,
                 Dimension size)
```
    Draw the peer container. The methods calls the draw() method for ScrollPane instance for the peer container. In addition the required clipping rectangle is calculated for ChildFrame containers because they must be rendered inside the parent container.
    Drawing for the redirected terminal differs. Labels/headers are drawn only once per page, instead of the usual once per frame.
    
    Specified by:
    
    draw in class Frame<GuiOutputManager>
    
    Parameters:
    
    origin - The coordinate of the upper-left corner for peer container in character units.
    
    size - The size of the peer container in character units.
  - moveToTop
```
public boolean moveToTop()
```
    Moves this frame to the top of other widgets in the Tab ordering.
    
    Specified by:
    
    moveToTop in interface Widget<GuiOutputManager>
    
    Overrides:
    
    moveToTop in class Frame<GuiOutputManager>
    
    Returns:
    
    true if operation was successful and false otherwise.
  - moveToTop
```
public boolean moveToTop(boolean ignoreKeepZorder)
```
    Moves this frame to the top of other widgets in the Tab ordering.
    
    Overrides:
    
    moveToTop in class Frame<GuiOutputManager>
    
    Parameters:
    
    ignoreKeepZorder - The flag indicating ignore Z-order keep value for frames.
    
    Returns:
    
    true if operation was successful and false otherwise.
  - destroy
```
public void destroy()
```
    Destroy this widget.
    
    Specified by:
    
    destroy in interface Widget<GuiOutputManager>
    
    Overrides:
    
    destroy in class Frame<GuiOutputManager>
  - calculateHeight
```
protected void calculateHeight(Dimension d,
                               double delta)
```
    Calculate frame height.
    
    Overrides:
    
    calculateHeight in class Frame<GuiOutputManager>
    
    Parameters:
    
    d - Frame dimensions.
    
    delta - Height delta.
  - adjustMinSize
```
protected double adjustMinSize(double minWidthOrHeight,
                               boolean isHeight)
```
    Adjusts the minimum frame width or height value depending on the current min value and the presense of the box within the frame.
    
    Specified by:
    
    adjustMinSize in class Frame<GuiOutputManager>
    
    Parameters:
    
    minWidthOrHeight - The size value to be adjusted.
    
    isHeight - TRUE if the size value is height, FALSE if width.
    
    Returns:
    
    GUI dependent new width or height value.
  - drawDownFrame
```
protected boolean drawDownFrame(Point top,
                                boolean redir)
```
    Draw the body of a down frame.
    
    Overrides:
    
    drawDownFrame in class Frame<GuiOutputManager>
    
    Parameters:
    
    top - The location from where to start drawing.
    
    redir - Flag indicating if redirected mode is active.
    
    Returns:
    
    true if the screen needs to be synchronized.
  - findMouseSource
```
public Widget<GuiOutputManager> findMouseSource(NativePoint p)
```
    Find the widget positioned just bellow the specified mouse position (in physical units). Each container should search for own widgets. Because widgets are relative positioned inside containers the container physical position is adjusted before search.
    
    Specified by:
    
    findMouseSource in interface Widget<GuiOutputManager>
    
    Overrides:
    
    findMouseSource in class AbstractContainer<GuiOutputManager>
    
    Parameters:
    
    p - The mouse physical location.
    
    Returns:
    
    A widget over which the mouse is positioned or null if none found.
  - getPortableMouseEventCoordinates
```
public NativePoint getPortableMouseEventCoordinates(NativePoint point)
```
    Get a point to represent the LAST-EVENT:X and LAST-EVENT:Y coordinates. For frames, these represents a point relative to the frame's top-left corner (excluding title).
    
    Overrides:
    
    getPortableMouseEventCoordinates in class AbstractWidget<GuiOutputManager>
    
    Parameters:
    
    point - The point (relative to the window's top-left corner) for which the coordinates for the portable mouse events are needed.
    
    Returns:
    
    A point representing the coordinates of a mouse-portable event or null if such an event can't be raised.
  - processDefaultButton
```
public boolean processDefaultButton(KeyInput event)
```
    Processing for default button in a frame, based on an event.
    
    Overrides:
    
    processDefaultButton in class Frame<GuiOutputManager>
    
    Parameters:
    
    event - The event which can determine an action for the default button.
    
    Returns:
    
    TRUE if event be re-routed to default button, FALSE otherwise.
  - processDefaultButton
```
public boolean processDefaultButton(KeyInput event,
                                    boolean recursive)
```
    Processing for default button in a frame, based on an event source. This can be called recursive to find a default button in children frames.
    
    Overrides:
    
    processDefaultButton in class Frame<GuiOutputManager>
    
    Parameters:
    
    event - The event which c determine an action for the default button.
    
    recursive - true to search in the family frame tree for a frame with default button. false to try only the current frame.
    
    Returns:
    
    TRUE if event be re-routed to default button (not necessarily to this frame default button if recursive was set), FALSE otherwise.
  - processCancelButton
```
public boolean processCancelButton()
```
    Processing for cancel button in a frame.
    
    Overrides:
    
    processCancelButton in class Frame<GuiOutputManager>
    
    Returns:
    
    TRUE if event be re-routed to cancel button, FALSE otherwise.
  - afterConfigUpdate
```
public void afterConfigUpdate(FrameConfig 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<FrameConfig>
    
    Overrides:
    
    afterConfigUpdate in class Frame<GuiOutputManager>
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - setOuterSize
```
public void setOuterSize(double width,
                         double height)
```
    Sets the size of the peer container. This is the visible size of the container and can not be the same as the inner size if the container is scrollable.
    
    Overrides:
    
    setOuterSize in class Frame<GuiOutputManager>
    
    Parameters:
    
    width - The new width of the container in character units.
    
    height - The new height of the container in character units.
  - hasBox
```
public boolean hasBox()
```
    The method returns true when the frame should have a box around. Note that the returned value may differ from FrameConfig.box as for example dialog boxes do not draw a box even when BOX set to true.
    
    Overrides:
    
    hasBox in class Frame<GuiOutputManager>
    
    Returns:
    
    See above.
  - supportsCustomMousePointer
```
public boolean supportsCustomMousePointer()
```
    Check if the widget supports LOAD-MOUSE-POINTER() method
    
    Specified by:
    
    supportsCustomMousePointer in interface Widget<GuiOutputManager>
    
    Overrides:
    
    supportsCustomMousePointer in class AbstractWidget<GuiOutputManager>
    
    Returns:
    
    true if the widget supports LOAD-MOUSE-POINTER() method
  - getCustomMousePointer
```
public java.util.Optional<MousePtrWrapper> getCustomMousePointer()
```
    Get the current custom mouse pointer if it is set
    
    Specified by:
    
    getCustomMousePointer in interface Widget<GuiOutputManager>
    
    Overrides:
    
    getCustomMousePointer in class AbstractWidget<GuiOutputManager>
    
    Returns:
    
    the current custom mouse pointer if it is set
  - processDirectManipulationEvent
```
public void processDirectManipulationEvent(DirectManipulationEvent event)
```
    Process direct manipulation event.
    
    Specified by:
    
    processDirectManipulationEvent in interface Widget<GuiOutputManager>
    
    Overrides:
    
    processDirectManipulationEvent in class AbstractWidget<GuiOutputManager>
    
    Parameters:
    
    event - Event to process.
  - getResizeRectangle
```
public NativeRectangle getResizeRectangle()
```
    Gets the rectangle defining the 8 resize handles for frame widget.
    
    Returns:
    
    See above.
  - getTitleHeight
```
public int getTitleHeight()
```
    Gets the frame title height in pixel units or O if no title.
    
    Returns:
    
    See above.
  - isSrollBarEmbedded
```
public boolean isSrollBarEmbedded(ScrollBar<?> sbToTest)
```
    Tests if the given scroll bar is a part of this frame or standalone.
    
    Parameters:
    
    sbToTest - Scroll bar instance to test.
    
    Returns:
    
    TRUE if a part of the frame scrolling container, FALSE otherwise.
  - createMouseHoverAction
```
protected MouseHoverAction createMouseHoverAction()
```
    Create handler for processing mouse hover events
    
    Overrides:
    
    createMouseHoverAction in class AbstractWidget<GuiOutputManager>
    
    Returns:
    
    handler for processing mouse hover events
  - adjustWidth
```
protected double adjustWidth(double width,
                             double screenWidth,
                             double regionWidth)
```
    Adjust frame width.
    
    Overrides:
    
    adjustWidth in class Frame<GuiOutputManager>
    
    Parameters:
    
    width - Input width.
    
    screenWidth - Screen width.
    
    regionWidth - Parent frame region width.
    
    Returns:
    
    adjusted width.
  - drawUnderline
```
protected void drawUnderline(Widget<GuiOutputManager> comp)
```
    Draw underline for specified widget.
    
    Specified by:
    
    drawUnderline in class Frame<GuiOutputManager>
    
    Parameters:
    
    comp - The base component to draw underline for.
  - resetColors
```
protected void resetColors(BaseConfig config)
```
    Reset colors.
    
    Specified by:
    
    resetColors in class Frame<GuiOutputManager>
    
    Parameters:
    
    config - Widget configuration.
  - compareColors
```
protected Colors compareColors(BaseConfig config,
                               Colors colors)
```
    Compare colors. This method must be implemented in subclasses and provide specific implementation as follow:
    ChUI implementation must compare dcolor and pfcolor.
    GUI implementation must compare bgcolor and fgcolor.
    
    Specified by:
    
    compareColors in class Frame<GuiOutputManager>
    
    Parameters:
    
    config - Widget configuration.
    
    colors - Colors to be compared.
    
    Returns:
    
    The colors structure after comparison.
  - calculateHeightDelta
```
protected double calculateHeightDelta()
```
    Calculate frame height delta.
    
    Overrides:
    
    calculateHeightDelta in class Frame<GuiOutputManager>
    
    Returns:
    
    height delta.
  - getMaxFrameSize
```
protected Dimension getMaxFrameSize()
```
    The method returns the maximum frame size according to the virtual size of the enclosing frame or according to the workspace size of its parent window.
    
    Overrides:
    
    getMaxFrameSize in class Frame<GuiOutputManager>
    
    Returns:
    
    See above.
  - setFocus
```
public void setFocus(Widget<GuiOutputManager> focus)
```
    Set focus to specified widget.
    Post a repaint for the frame's title, too, to update the frame focus state.
    
    Specified by:
    
    setFocus in interface Container<GuiOutputManager>
    
    Overrides:
    
    setFocus in class AbstractContainer<GuiOutputManager>
    
    Parameters:
    
    focus - Widget to set focus on.
  - getDynamicLayout
```
public DynamicLayoutIntegration<GuiOutputManager> getDynamicLayout()
```
    Returns the dynamic layout widget integration implementation.
    
    Specified by:
    
    getDynamicLayout in interface HasDynamicLayout
    
    Returns:
    
    see above
  - defaultFocus
```
public Widget<GuiOutputManager> defaultFocus()
```
    Get default focusable widget.
    
    Specified by:
    
    defaultFocus in interface Container<GuiOutputManager>
    
    Overrides:
    
    defaultFocus in class AbstractContainer<GuiOutputManager>
    
    Returns:
    
    default focusable widget.
  - getMousePosition
```
public NativePoint getMousePosition()
```
    Returns current mouse cursor position relative to the this widget. The method is only supported in GUI mode.
    
    Specified by:
    
    getMousePosition in interface Widget<GuiOutputManager>
    
    Overrides:
    
    getMousePosition in class AbstractWidget<GuiOutputManager>
    
    Returns:
    
    mouse cursor position, never null.
  - isRootFrame
```
public boolean isRootFrame()
```
    Check if this frame is the root frame (is parented directly to a window).
    
    Overrides:
    
    isRootFrame in class Frame<GuiOutputManager>
    
    Returns:
    
    See above.
  - frameContentBounds
```
protected Rectangle frameContentBounds()
```
    Get the bounds of the frame's content.
    
    Specified by:
    
    frameContentBounds in class Frame<GuiOutputManager>
    
    Returns:
    
    See above.
  - repaintCaption
```
private void repaintCaption()
```
    Raise a PaintEvent for the frame's title, as needed.
  - captionHeight
```
protected double captionHeight()
```
    Get the frame's caption height, in character units.
    
    Overrides:
    
    captionHeight in class Frame<GuiOutputManager>
    
    Returns:
    
    See above.
  - onFromVisibleToHidden
```
protected void onFromVisibleToHidden()
```
    Process transition from visible to hidden state.
    
    Overrides:
    
    onFromVisibleToHidden in class Frame<GuiOutputManager>
  - createScrollContainer
```
protected SensitiveScrollContainer<GuiOutputManager> createScrollContainer()
```
    Creates the frame's scroll container.
    
    Overrides:
    
    createScrollContainer in class Frame<GuiOutputManager>
    
    Returns:
    
    Returns an instance of SensitiveScrollContainer.
  - isDirectManipulationRequired
```
private boolean isDirectManipulationRequired(AbstractWidget w)
```
    Checks if direct manipulation feature must be installed or removed in GUI mode for a widget inside of a frame. Different widgets can use different criteria to make this decision.
    
    Returns:
    
    TRUE if direct manipulation is need to be installed, FALSE if direct manipulation is need to be removed.
  - resolveLabelFont
```
private static int resolveLabelFont(LabeledWidget<GuiOutputManager> lwidget)
```
    Resolves the effective font for a label of the supplied labeled widget.
    
    Parameters:
    
    lwidget - A labeled widget reference.
    
    Returns:
    
    See above.
  - configScrollPane
```
private void configScrollPane()
```
    Configure frame scroll pane
  - getShowBars
```
private ScrollPaneGuiImpl.ShowBars getShowBars()
```
    Calculates scroll bars visibility.
    
    Returns:
    
    Returns one of the expected visibility values.
  - configContentPanels
```
private void configContentPanels()
```
    Configure frame scroll pane
  - activateHorizontalBarQuirk
```
private void activateHorizontalBarQuirk()
```
    Activate the horizontal scrollbar 4GL bug for all ancestor frames, except the root one.
  - updateScrollPaneSize
```
private void updateScrollPaneSize()
```
    Updates frame scroll pane size with possible frame title.
  - drawGrid
```
private void drawGrid()
```
    Draws frame grid before the frame content painting. This method is calling from the BorderedPanelGuiImpl painting routine after background refresh but before widgets drawings context.
  - drawWidgetsSelectionStatus
```
private void drawWidgetsSelectionStatus()
```
    Updates the status of the selected widgets.
  - drawResizeAnchors
```
private void drawResizeAnchors(int xr,
                               int yr,
                               int wr,
                               int hr)
```
    Draws the 8 resize anchors within the given rectangle area.
    
    Parameters:
    
    xr - X starting point for rectangular area.
    
    yr - Y starting point for rectangular area.
    
    wr - The width for rectangular area.
    
    hr - The height for rectangular area.
  - notifyDriverWidgets
```
private void notifyDriverWidgets()
```
    Notify all driver widgets that the frame's state has changed.
  - isShowInOverlay
```
private boolean isShowInOverlay()
```
    Checks if the frame is displayed in an overlay window.
    
    Returns:
    
    true if the window is a dialog or the configuration allows displaying in an overlay window, false otherwise.

Class FrameGuiImpl

Nested Class Summary

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

Field Summary

Fields inherited from class com.goldencode.p2j.ui.client.Frame

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

Constructor Summary

Method Summary

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

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.StreamableWidget

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

DEFAULT_MINIMAL_SIZE_IN_PIXELS

gd

screen

cc

gc

gct

gf

frameTitle

lineBorder

defaultMinimalWidth

defaultMinimalHeight

dynamicLayout

Constructor Detail

FrameGuiImpl

Method Detail

convertToStreamable

getLabelWidth

getLabelHeight

getRowDelta

location

physicalLocation

initialize

setVisible

setHidden

getDialogDecorationCharSize

getColorResolver

doLayoutWorker

realizeFrame

isDroppable

activateDirectManipulation

deactivateDirectManipulation

isDirectManipulationRequired

setSensitiveForUIB

mouseActions

getFrameBgColor

getFrameFgColor

draw

moveToTop

moveToTop

destroy

calculateHeight

adjustMinSize

drawDownFrame

findMouseSource

getPortableMouseEventCoordinates

processDefaultButton

processDefaultButton

processCancelButton

afterConfigUpdate

setOuterSize

hasBox

supportsCustomMousePointer

getCustomMousePointer

processDirectManipulationEvent

getResizeRectangle

getTitleHeight

isSrollBarEmbedded

createMouseHoverAction

adjustWidth

drawUnderline

resetColors