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

Type Parameters:

O - the output manager

All Superinterfaces:

java.util.EventListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener

All Known Subinterfaces:

AlertBox<O>, Container<O>, GuiWindow, Label<O>, LabeledWidget<O>, MenuElement<O>, MenuStructure<O>, ScrollableWidget<O>

All Known Implementing Classes:

AbstractButton, AbstractContainer, AbstractFileChooserDialog, AbstractScrollBar, AbstractWidget, ActivexFrame, AlertBoxGuiImpl, AlertBoxGuiImpl.ButtonsPanel, AlertBoxGuiImpl.MessagePanel, AlertBoxImpl, ArrowsWidget, BorderedPanel, BorderedPanelGuiImpl, BorderedPanelImpl, Browse, BrowseColumn, BrowseColumnGuiImpl, BrowseConfirmPanel, BrowseFilterEntryField, BrowseGuiImpl, BrowseGuiImpl.ColumnSetContainer, BrowseGuiImpl.ColumnsScrollPane, BrowseGuiImpl.GearButton, BrowseImpl, BrowsePopupMenu, Button, ButtonGuiImpl, ButtonImpl, ButtonListGuiImpl, ButtonListGuiImpl.GroupButton, ButtonListGuiImpl.Item, ButtonListGuiImpl.Items, ButtonListGuiImpl.ItemsControl, CalendarGuiImpl, CalendarGuiImpl.DateTimeContent, CalendarPopup, CaptionButton, ClientDrivenLabel, ColorChooserGuiImpl, ColorIndexChooserGuiImpl, ColorSampleButton, ComboBox, ComboBoxGuiImpl, ComboBoxImpl, ContentThumbView, ContentThumbView.ContentIcon, DefaultList, DetailsThumbView, DetailsThumbView.DetailsIcon, DialogBoxWindow, DirDialogGuiImpl, DirDialogGuiImpl.Folder, DirDialogGuiImpl.FolderTree, DirDialogImpl, DriverWidgetHost, DropDown, DropDownGuiImpl, DropDownImpl, Editor, EditorGuiImpl, EditorGuiImpl.EditorContent, EditorGuiImpl.EditorScrollContainer, EditorImpl, EditorPopupGuiImpl, EmptyThumbView, EntryFieldGuiImpl, FileDialogGuiImpl, FileDialogGuiImpl.Folder, FileDialogGuiImpl.FolderTree, FileDialogGuiImpl.NavigationPane, FileDialogGuiImpl.ToolsPane, FileDialogImpl, FileThumb, FillIn, FillInGuiImpl, FillInImpl, FixedSizeContainer, FontChooserGuiImpl, FontChooserGuiImpl.Preview, Frame, Frame.FrameScrollContainer, FrameChuiImpl, FrameGuiImpl, FrameGuiImpl.GuiFrameScrollContainer, FrameOverlay, GamutPicker, GenericContainer, GenericWidget, GuiButton, HScrollBar, HtmlBrowserGuiImpl, Hyperlink, Image, ImageGuiImpl, ImageListGuiImpl, InputDialog, LabeledDataContainer, LabeledPanel, LabelGuiImpl, LabelImpl, LightweightWidget, LineEditor, ListThumbView, ListThumbView.ListItem, LuminosityPicker, MediumIconsThumbView, MediumIconsThumbView.MediumIcon, Menu, MenuChuiImpl, MenuGuiImpl, MenuItem, MenuItemChuiImpl, MenuItemGuiImpl, MenuOverlayWindow, MessageAreaGuiImpl, MessageAreaImpl, MessageLine, ModalWindow, NativeScrollContainer, OuterFrame, OverlayWindow, PrintSetupDialog, PrintSetupDialog.ButtonsPanel, ProgressBarGuiImpl, RadioButton, RadioButtonGuiImpl, RadioButtonImpl, RadioSet, RadioSetGuiImpl, Rect, RectangleGuiImpl, RectangleImpl, ScrollableContainer, ScrollableList, ScrollableListGuiImpl, ScrollableListImpl, ScrollableSelectionListGuiImpl, ScrollBar, ScrollBarGuiButton, ScrollBarGuiImpl, ScrollContainer, ScrollPane, ScrollPaneGuiImpl, ScrollPaneImpl, ScrollPopupGuiImpl, SelectionList, SelectionListBody, SelectionListBodyGuiImpl, SelectionListBodyImpl, SelectionListGuiImpl, SelectionListImpl, SensitiveScrollContainer, Separator, SeparatorImpl, SignatureClientGuiImpl, SimpleImageButton, SimpleLabel, Skip, SkipGuiImpl, SkipImpl, Slider, SliderGuiImpl, SmallIconsThumbView, SmallIconsThumbView.SmallIcon, Space, SpreadsheetGuiImpl, StatusLine, StatusLineGuiImpl, StatusLineImpl, SubMenu, SubMenuChuiImpl, SubMenuGuiImpl, SubMenuGuiImpl.SubMenuBody, TabSetGuiImpl, TabSetGuiImpl.TabSetItem, TempContainer, Text, TextCell, TextGuiImpl, TextImpl, TilesThumbView, TilesThumbView.TileIcon, TitledWindow, ToggleBox, ToggleBoxGuiImpl, ToggleBoxImpl, ToolTip, TopLevelWindow, TreeBodyGuiImpl, TreeGuiImpl, TreeGuiImpl.TreeEditor, TreeListBodyGuiImpl, TreeListCaption, TreeListCaptionItem, TreeListGuiImpl, TreeViewBodyGuiImpl, TreeViewGuiImpl, Viewport, VScrollBar, Window, WindowChuiImpl, WindowGuiImpl, WindowTitleBar, WindowTitleBar.WindowIcon, WindowTitleBar.WindowTitle, WindowTitlePopupGuiImpl, WindowWorkSpace
```
public interface Widget<O extends OutputManager<?>>
extends java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener
```
Common interface implemented by all widgets.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`acceptsEscAsAnyKey()` Flag indicating if this widget can accept ESC key for any key event.
`default boolean`	`acceptTrigger(int eventCode)` Tests if the target event can be triggered or not.
`void`	`addFocusListener(FocusListener listener)` Add focus listener.
`void`	`addKeyListener(KeyListener listener)` Add key listener.
`TitledWindow<O>`	`ancestor()` Get ancestor window for this widget.
`WidgetId`	`ancestorId()` Get the ID of the ancestor window for this widget.
`Rectangle`	`bounds()` Get widget bounding rectangle.
`default boolean`	`canMovetoTop()` Flag indicating if this widget can be moved to top by a DISPLAY statement when WINDOW:KEEP-FRAME-Z-ORDER flag is set.
`boolean`	`clearWidget()` Clear widget state on CLEAR FRAME call for the parent frame.
`default void`	`completeTrigger(int eventCode)` Manages the internal state after the trigger is finished.
`<W extends WidgetConfig> W`	`config()` Get externalizable widget config which can be used to restore widget state after via network.
`default java.util.Optional<MousePtrWrapper>`	`defaultMousePtr()` Get default mouse pointer for this widget
`void`	`destroy()` Destroy this widget.
`Dimension`	`dimension()` Get widget dimension.
`NativePoint`	`displayPhysicalLocation()` Get display location of widget in screen coordinates.
`void`	`draw()` Draw widget.
`void`	`drawCaret()` Draw caret.
`java.util.Optional<Frame<?>>`	`enclosingFrame()` Get the enclosing FRAME if it exists
`default boolean`	`enforceDefaultMousePtr()` Check if the default mouse pointer should be used regardless of the parent settings
`Widget<O>`	`findMouseSource(NativePoint p)` Find the widget positioned just bellow the specified mouse position (in physical units).
`boolean`	`focusTraversable()` Check if widget is focus traversable.
`boolean`	`forceCursorOnFocus()` Check if widget needs in cursor to be on when having the input focus.
`void`	`forceVisibility(boolean visibility)` Force widget visibility change without associated repainting.
`NativeRectangle`	`getActualBounds()` Get the widget's actual bounds
`java.util.Optional<MousePtrWrapper>`	`getCustomMousePointer()` Get the current custom mouse pointer if it is set
`MousePtrWrapper`	`getEffectiveMousePointer()` Get the current effective custom mouse pointer
`WidgetId`	`getId()` Widget ID.
`default WidgetId`	`getIdForTrigger()` Widget ID.
`default Widget<O>`	`getLegacyWidget()` The method returns the legacy widget representing this possibly virtual widget.
`java.util.Optional<MousePtrWrapper>`	`getLoadedMousePointer()` Get the loaded custom mouse pointer if it is set
`int`	`getMenuMouse()` Get the value of the MENU-MOUSE attribute
`org.roaringbitmap.RoaringBitmap`	`getMouseActions()` Get the mouse actions on which this widget can respond.
`NativePoint`	`getMousePosition()` Returns current mouse cursor position relative to the this widget.
`java.lang.String`	`getSelectedText()` Obtain any selected text in the widget for copying to the clipboard.
`byte`	`getState()` Gets the current state of this component's data.
`default Widget<O>`	`getTriggerWidget()` For some virtual widgets, the widget where triggers are checked is different (i.e.
`default Widget<?>`	`getTriggerWidget(int evtCode, boolean isKey)` Complex legacy widgets are usually assembled from multiple individual widget classes.
`Rectangle`	`getVisiblePart()` Gets the sub-rectangle which should be visible.
`ZOrderClass`	`getZOrderClass()` Get the Z-Order class
`default boolean`	`hasFocus()` Check if widget has focus.
`boolean`	`hasFocus(boolean recurse)` Check if widget has focus.
`boolean`	`hasTooltip()` Check if widget has tooltip.
`double`	`height()` Get widget height.
`boolean`	`hidden()` Get current hidden state.
`void`	`hide()` Hide widget.
`boolean`	`highlighted()` Get current highlighted state.
`default boolean`	`ignoreEnable()` Some widgets can ignore an ENABLE statement (like read-only, hidden TEXT).
`double`	`initialHeight()` Get initial widget height in character units.
`double`	`initialWidth()` Get initial widget width in character units.
`Insets`	`insets()` Get widget insets.
`default boolean`	`isCurrent()` The method returns true if the widget is set as current in its parent container.
`boolean`	`isCurrent(boolean recurse)` The method returns true if the widget is set as current in its parent container or containers.
`default boolean`	`isDirectManipulable()` Check the direct manipulation capability of the widget.
`default boolean`	`isDirectManipulationActive()` Check if direct manipulation is active for this widget.
`default boolean`	`isDirectManipulationActiveOrInUIB()` Check if direct manipulation is active for this or widget is in UIB mode.
`boolean`	`isDisplayed()` Check if widget is displayed.
`default boolean`	`isDroppable()` Checks if the given widget is able to be the target of the drop operation.
`boolean`	`isEnabled()` Check if widget is enabled.
`boolean`	`isFocusable()` Checks whether this widget can receive focus generally.
`boolean`	`isHeader()` Check if widget is part of a header.
`default boolean`	`isInitialValueLayout()` Reports if the initial height/width of the widget should take precedence in the frame layout algorithm.
`default boolean`	`isLegacyFocus()` Returns a flag marking the widget as subject to legacy focus handling.
`default boolean`	`isProcessProgressEvent(Event event)` Called by the `ThinClient` during event processing.
`boolean`	`isRealized()` Check if widget is realized.
`boolean`	`isRepaintDisabled()` Returns true when the widget repaint is disabled.
`boolean`	`isRMBEntrySupported()` Check if this widget gains ENTRY event when right/middle mouse button is clicked.
`boolean`	`isTabStop()` Check the value of the TAB-STOP attribute
`boolean`	`isThreeD()` If the method returns `true` the widget should be represented with 3D visuals.
`boolean`	`isTotallyObscured()` Check if widget is totally obscured.
`boolean`	`isVisible()` Check if widget is visible.
`boolean`	`isVisible(boolean recursive)` Check if widget is visible.
`Point`	`location()` Get widget location relative to container.
`default boolean`	`maySwitchFocus()` Some widgets (like scroll bars) react on user input (like mouse click), but don't steal focus from currently focused widget.
`Dimension`	`minimumSize()` Get widget minimum size.
`boolean`	`moveToBottom()` Move the widget to the bottom in z-order
`boolean`	`moveToTop()` Move the widget to the top in z-order
`java.lang.String`	`name()` Get widget name.
`boolean`	`navigable()` Returns `true` only if this widget is navigable.
`void`	`oleDrag()` Start an OLE drag/drop event with the given control as the source.
`default Container<O>`	`parent()` Get widget parent.
`Container<O>`	`parent(boolean system)` Get widget parent.
`<T extends Widget<O>> T`	`parent(java.lang.Class<T> clazz)` Get widget parent of the specified type.
`<T> T`	`parentObject(java.lang.Class<T> clazz)` Get widget parent of the specified type.
`<T extends Widget<O>> T`	`parentOrSelf(java.lang.Class<T> clazz)` Get this or widget parent of the specified type.
`<T> T`	`parentOrSelfObject(java.lang.Class<T> clazz)` Get this or widget parent of the specified type.
`NativeRectangle`	`physicalBounds()` Determine the physical bounds, relative to screen, expressed in units native to UI type.
`NativeDimension`	`physicalDimension()` Get widget physical dimension, expressed in units native to UI type.
`NativePoint`	`physicalLocation()` Get widget physical location relative to container, expressed in units native to UI type.
`void`	`postprocessConfig()` Additional processing required when widget configuration is updated AFTER the frame layout has been performed.
`boolean`	`preventFocusWhenMouseDownEventDefined()` Test if this widget must prevent receiving focus on mouse-down event.
`void`	`processDirectManipulationEvent(DirectManipulationEvent event)` Process direct manipulation event.
`void`	`processEvent(Event evt)` Process event and dispatch it to specific method.
`void`	`processFocusEvent(FocusEvent event)` Process focus event.
`void`	`processKeyEvent(KeyInput event)` Process key event.
`void`	`processKeyListeners(KeyInput event)` Process key listeners.
`boolean`	`processMnemonic(int key)` Process the given key, if this widget's mnemonic matches the key.
`boolean`	`raiseLegacyMouseEvents()` Check if the widget implementation can raise legacy, 4GL-style, mouse events.
`default void`	`refreshWidget()` Refresh widget.
`void`	`registerWidgetListener(WidgetListener l)` Register a widget state listener for this widget.
`void`	`repaint()` Request widget repainting.
`void`	`repaint(NativeRectangle rect)` Request repainting of the area occupied by widget.
`void`	`repaint(Rectangle ur)` Request repainting of the area occupied by widget.
`default void`	`requestFocus()` Request focus.
`default void`	`requestFocus(boolean force)` Request focus.
`void`	`requestFocus(boolean force, boolean mouse)` Request focus.
`void`	`requestSync()` Request screen synchronization.
`void`	`resizeTo(NativePoint origin, NativeDimension size, boolean raise)` Resize the widget to the specified dimensions.
`int`	`resolvePopupMenuId()` Returns the popup menu effective for this widget.
`O`	`screen()` Get access to `OutputManager` instance.
`Point`	`screenLocation()` Get absolute location of widget in screen coordinates.
`NativePoint`	`screenPhysicalLocation()` Get absolute location of widget in screen coordinates.
`void`	`setDirectManipulationActive(boolean isActive)` Sets direct manipulation active flag value for this widget.
`void`	`setEnabled(boolean enabled)` Enable/disable widget.
`void`	`setHidden(boolean hidden)` Tracks the hidden state of the widget.
`void`	`setHighlighted(boolean highlighted)` Tracks the highlighted state of the widget.
`void`	`setLocation(double x, double y)` Set widget relative location.
`void`	`setLocation(Point origin)` Set widget relative location.
`void`	`setMousePointer(int windowId, MousePtrWrapper ptr)` Set the custom mouse pointer
`void`	`setMousePointer(MousePtrWrapper ptr)` Set the custom mouse pointer
`void`	`setParent(Container<O> container)` Set widget parent.
`void`	`setPhysicalLocation(int x, int y)` Set widget relative physical location.
`void`	`setSensitiveForUIB(boolean sensitive)` Sets direct manipulation sensitive flag value for this widget in UIB mode.
`void`	`setState(byte state)` Stores the new state of the component's data.
`void`	`setVisible(boolean visible)` Hide/show widget.
`default void`	`setWindow(Window<?> w)` Set a window associated with this widget.
`void`	`show()` Show widget.
`default void`	`startTrigger(int eventCode)` Manages the internal state before the trigger is started.
`boolean`	`supportsCustomMousePointer()` Check if the widget supports LOAD-MOUSE-POINTER() method
`default boolean`	`systemFocusGrabbed()` Check if this widget grabs the system focus.
`TopLevelWindow<O>`	`topLevelWindow()` Get ancestor TopLevelWindow for this widget.
`void`	`unrealize()` Unrealize this widget.
`void`	`unregisterWidgetListener(WidgetListener l)` Unregister a widget state listener for this widget.
`default boolean`	`validateDisplayValue()` Performs format validation of the widget value being entered, i.e.
`void`	`widgetStateChanged()` Notification that this widget's state has changed (visibility, sensitivity, z-order).
`double`	`width()` Get widget width in character units.
`Window<O>`	`window()` Get ancestor Window for this widget.

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

- Method Detail
  - getId
```
WidgetId getId()
```
    Widget ID.
    
    Returns:
    
    see above.
  - getIdForTrigger
```
default WidgetId getIdForTrigger()
```
    Widget ID. Extended version if ID substitution is required. Some widgets might substitute the original ID with alternative version if trigger was registerd for alternative widget ID but should be fired with this widget. It is not happening in normal condition so override this can take place in very specific cases.
    
    Returns:
    
    see above.
  - screen
```
O screen()
```
    Get access to OutputManager instance.
    
    Returns:
    
    reference to OutputManager.
  - addFocusListener
```
void addFocusListener(FocusListener listener)
```
    Add focus listener.
    
    Parameters:
    
    listener - Listener to add.
  - addKeyListener
```
void addKeyListener(KeyListener listener)
```
    Add key listener.
    
    Parameters:
    
    listener - Listener to add.
  - ancestor
```
TitledWindow<O> ancestor()
```
    Get ancestor window for this widget.
    
    Returns:
    
    ancestor window.
  - window
```
Window<O> window()
```
    Get ancestor Window for this widget. This method must be called only for widgets that are already attached to Window.
    
    Returns:
    
    ancestor Window.
    
    Throws:
    
    java.lang.IllegalStateException - When this widget is not attached to window.
  - topLevelWindow
```
TopLevelWindow<O> topLevelWindow()
```
    Get ancestor TopLevelWindow for this widget. This method must be called only for widgets that are already attached to a TopLevelWindow.
    
    Returns:
    
    ancestor TopLevelWindow.
    
    Throws:
    
    java.lang.IllegalStateException - When this widget is not attached to a top-level window.
  - ancestorId
```
WidgetId ancestorId()
```
    Get the ID of the ancestor window for this widget.
    
    Returns:
    
    ancestor window ID.
  - bounds
```
Rectangle bounds()
```
    Get widget bounding rectangle.
    
    Returns:
    
    bounding rectangle.
  - insets
```
Insets insets()
```
    Get widget insets.
    
    Returns:
    
    widget insets.
  - dimension
```
Dimension dimension()
```
    Get widget dimension.
    
    Returns:
    
    widget dimension.
  - physicalDimension
```
NativeDimension physicalDimension()
```
    Get widget physical dimension, expressed in units native to UI type.
    
    Returns:
    
    widget dimension.
  - isDisplayed
```
boolean isDisplayed()
```
    Check if widget is displayed.
    
    Returns:
    
    true if widget is displayed.
  - isRealized
```
boolean isRealized()
```
    Check if widget is realized.
    
    Returns:
    
    true if widget is realized.
  - draw
```
void draw()
```
    Draw widget.
  - drawCaret
```
void drawCaret()
```
    Draw caret.
  - isEnabled
```
boolean isEnabled()
```
    Check if widget is enabled.
    
    Returns:
    
    true if widget is enabled.
  - focusTraversable
```
boolean focusTraversable()
```
    Check if widget is focus traversable.
    
    Returns:
    
    true if widget is focus traversable.
  - forceVisibility
```
void forceVisibility(boolean visibility)
```
    Force widget visibility change without associated repainting.
    
    Parameters:
    
    visibility - New visibility state.
  - hasFocus
```
default boolean hasFocus()
```
    Check if widget has focus.
    Effectively calls hasFocus(boolean) with true argument.
    
    Returns:
    
    true if widget has focus.
  - hasFocus
```
boolean hasFocus(boolean recurse)
```
    Check if widget has focus.
    When true is passed as the argument the method considers this widget focused when all the parent widgets up to the top-level window are current and the widget itself is a leaf node of the widget tree. When false is passed as the argument the method considers this widget focused when all the parent widgets up to the top-level window are current but the widget itself does not have to be a leaf node.
    
    Parameters:
    
    recurse - see above
    
    Returns:
    
    true if widget has focus.
  - isLegacyFocus
```
default boolean isLegacyFocus()
```
    Returns a flag marking the widget as subject to legacy focus handling. The value is used by focus manager and adjusts its logic accordingly.
    
    Returns:
    
    See above.
  - systemFocusGrabbed
```
default boolean systemFocusGrabbed()
```
    Check if this widget grabs the system focus.
    
    Returns:
    
    true if this widget grabs the system focus.
  - isCurrent
```
default boolean isCurrent()
```
    The method returns true if the widget is set as current in its parent container.
    
    Returns:
    
    see above.
  - isCurrent
```
boolean isCurrent(boolean recurse)
```
    The method returns true if the widget is set as current in its parent container or containers. When false is passed in the recurse parameter only the parent container is considered, otherwise all the containers up the widget tree are considered.
    
    Parameters:
    
    recurse - Allows recursive mode. See above.
    
    Returns:
    
    see above.
  - height
```
double height()
```
    Get widget height.
    
    Returns:
    
    widget height.
  - initialHeight
```
double initialHeight()
```
    Get initial widget height in character units. The initial height is that which is set during frame setup for static widgets. This means it was hard coded in the original static definition of the widget in in the 4GL source code.
    
    Returns:
    
    widget height.
  - hidden
```
boolean hidden()
```
    Get current hidden state.
    
    Returns:
    
    hidden state.
  - hide
```
void hide()
```
    Hide widget.
  - highlighted
```
boolean highlighted()
```
    Get current highlighted state.
    
    Returns:
    
    highlighted state.
  - location
```
Point location()
```
    Get widget location relative to container.
    
    Returns:
    
    relative widget location.
  - minimumSize
```
Dimension minimumSize()
```
    Get widget minimum size.
    
    Returns:
    
    widget minimum size.
  - name
```
java.lang.String name()
```
    Get widget name.
    
    Returns:
    
    widget name.
  - parent
```
default Container<O> parent()
```
    Get widget parent.
    
    Returns:
    
    widget parent.
  - parent
```
Container<O> parent(boolean system)
```
    Get widget parent.
    
    Parameters:
    
    system - Set to true to search the system-level widget hierarchy. See BaseEntity.setSystemParent(GenericWidget) for more info.
    
    Returns:
    
    widget parent.
  - parent
```
<T extends Widget<O>> T parent(java.lang.Class<T> clazz)
```
    Get widget parent of the specified type.
    
    Parameters:
    
    clazz - The parent type to return.
    
    Returns:
    
    widget parent.
  - parentObject
```
<T> T parentObject(java.lang.Class<T> clazz)
```
    Get widget parent of the specified type.
    
    Parameters:
    
    clazz - The parent type to return.
    
    Returns:
    
    widget parent.
  - parentOrSelf
```
<T extends Widget<O>> T parentOrSelf(java.lang.Class<T> clazz)
```
    Get this or widget parent of the specified type.
    
    Parameters:
    
    clazz - The type to return.
    
    Returns:
    
    widget parent or this.
  - parentOrSelfObject
```
<T> T parentOrSelfObject(java.lang.Class<T> clazz)
```
    Get this or widget parent of the specified type.
    
    Parameters:
    
    clazz - The type to return.
    
    Returns:
    
    widget parent or this.
  - processFocusEvent
```
void processFocusEvent(FocusEvent event)
```
    Process focus event.
    
    Parameters:
    
    event - Event to process.
  - processKeyEvent
```
void processKeyEvent(KeyInput event)
```
    Process key event.
    
    Parameters:
    
    event - Key event to process.
  - processDirectManipulationEvent
```
void processDirectManipulationEvent(DirectManipulationEvent event)
```
    Process direct manipulation event.
    
    Parameters:
    
    event - Event to process.
  - isDirectManipulable
```
default boolean isDirectManipulable()
```
    Check the direct manipulation capability of the widget.
    
    Returns:
    
    TRUE if the widget is able to be directly manipulated, FALSE otherwise.
  - isDirectManipulationActive
```
default boolean isDirectManipulationActive()
```
    Check if direct manipulation is active for this widget.
    
    Returns:
    
    true if direct manipulation is active false if not.
  - setDirectManipulationActive
```
void setDirectManipulationActive(boolean isActive)
```
    Sets direct manipulation active flag value for this widget.
    
    Parameters:
    
    isActive - The new value for the flag.
  - isDirectManipulationActiveOrInUIB
```
default boolean isDirectManipulationActiveOrInUIB()
```
    Check if direct manipulation is active for this or widget is in UIB mode.
    
    Returns:
    
    true if direct manipulation is active false if not.
  - setSensitiveForUIB
```
void setSensitiveForUIB(boolean sensitive)
```
    Sets direct manipulation sensitive flag value for this widget in UIB mode.
    
    Parameters:
    
    sensitive - The new value for the flag.
  - processKeyListeners
```
void processKeyListeners(KeyInput event)
```
    Process key listeners.
    
    Parameters:
    
    event - Keyboard event.
  - repaint
```
void repaint()
```
    Request widget repainting.
  - repaint
```
void repaint(Rectangle ur)
```
    Request repainting of the area occupied by widget. Only the given update rectangle will be repainted (note that it is clipped by all parent containers). No event is posted if the widget itself or any of the parent containers are hidden.
    
    Parameters:
    
    ur - The update rectangle (relative to the origin of its parent Container) which will be repainted. Note that it is clipped by all parent containers.
  - repaint
```
void repaint(NativeRectangle rect)
```
    Request repainting of the area occupied by widget. Only the given update rectangle will be repainted (note that it is clipped by all parent containers). No event is posted if the widget itself or any of the parent containers are hidden.
    
    Parameters:
    
    rect - The update rectangle (relative to the origin of its parent Container) which will be repainted. Note that it is clipped by all parent containers.
  - requestFocus
```
default void requestFocus()
```
    Request focus.
  - requestFocus
```
default void requestFocus(boolean force)
```
    Request focus.
    
    Parameters:
    
    force - When true the method will set focus on this widget unconditionally.
  - requestFocus
```
void requestFocus(boolean force,
                  boolean mouse)
```
    Request focus.
    
    Parameters:
    
    force - When true the method will set focus on this widget unconditionally.
    
    mouse - If true then the focus request was caused by a mouse event.
  - requestSync
```
void requestSync()
```
    Request screen synchronization.
  - screenLocation
```
Point screenLocation()
```
    Get absolute location of widget in screen coordinates.
    
    Returns:
    
    absolute widget location.
  - screenPhysicalLocation
```
NativePoint screenPhysicalLocation()
```
    Get absolute location of widget in screen coordinates. The result is in native units.
    
    Returns:
    
    absolute widget location.
  - displayPhysicalLocation
```
NativePoint displayPhysicalLocation()
```
    Get display location of widget in screen coordinates. The result is in native units.
    
    Returns:
    
    display widget location.
  - setEnabled
```
void setEnabled(boolean enabled)
```
    Enable/disable widget.
    
    Parameters:
    
    enabled - New enabled state.
  - setHidden
```
void setHidden(boolean hidden)
```
    Tracks the hidden state of the widget.
    
    Parameters:
    
    hidden - New hidden state.
  - setHighlighted
```
void setHighlighted(boolean highlighted)
```
    Tracks the highlighted state of the widget.
    
    Parameters:
    
    highlighted - New highlighted state.
  - setLocation
```
void setLocation(double x,
                 double y)
```
    Set widget relative location.
    
    Parameters:
    
    x - Widget X.
    
    y - Widget Y.
  - setLocation
```
void setLocation(Point origin)
```
    Set widget relative location.
    
    Parameters:
    
    origin - Location to set.
  - setParent
```
void setParent(Container<O> container)
```
    Set widget parent.
    
    Parameters:
    
    container - Parent to set.
  - setVisible
```
void setVisible(boolean visible)
```
    Hide/show widget.
    
    Parameters:
    
    visible - New visible state.
  - setWindow
```
default void setWindow(Window<?> w)
```
    Set a window associated with this widget.
    
    Parameters:
    
    w - The given window associated with this widget
  - startTrigger
```
default void startTrigger(int eventCode)
```
    Manages the internal state before the trigger is started.
    
    Parameters:
    
    eventCode - The event code
  - completeTrigger
```
default void completeTrigger(int eventCode)
```
    Manages the internal state after the trigger is finished.
    
    Parameters:
    
    eventCode - The event code
  - acceptTrigger
```
default boolean acceptTrigger(int eventCode)
```
    Tests if the target event can be triggered or not.
    
    Parameters:
    
    eventCode - The target events code
    
    Returns:
    
    True if the target event can be triggered, otherwise false.
  - show
```
void show()
```
    Show widget.
  - isTotallyObscured
```
boolean isTotallyObscured()
```
    Check if widget is totally obscured.
    
    Returns:
    
    true if widget is totally obscured.
  - isVisible
```
boolean isVisible()
```
    Check if widget is visible.
    
    Returns:
    
    true if widget is visible.
  - isVisible
```
boolean isVisible(boolean recursive)
```
    Check if widget is visible.
    
    Parameters:
    
    recursive - false behaves as isVisible(), otherwise the method returns true only when the parent's call to isVisible(true) returns true.
    
    Returns:
    
    true if widget is visible.
  - isHeader
```
boolean isHeader()
```
    Check if widget is part of a header.
    
    Returns:
    
    true if widget is part of header.
  - forceCursorOnFocus
```
boolean forceCursorOnFocus()
```
    Check if widget needs in cursor to be on when having the input focus.
    
    Returns:
    
    true if cursor is required.
  - width
```
double width()
```
    Get widget width in character units.
    
    Returns:
    
    widget width.
  - initialWidth
```
double initialWidth()
```
    Get initial widget width in character units. The initial width is that which is set during frame setup for static widgets. This means it was hard coded in the original static definition of the widget in in the 4GL source code.
    
    Returns:
    
    widget width.
  - processEvent
```
void processEvent(Event evt)
```
    Process event and dispatch it to specific method.
    
    Parameters:
    
    evt - Event to process.
  - config
```
<W extends WidgetConfig> W config()
```
    Get externalizable widget config which can be used to restore widget state after via network. Note that only very limited set of widgets actually have config.
    
    Type Parameters:
    
    W - Config type.
    
    Returns:
    
    Reference to widget config.
  - isFocusable
```
boolean isFocusable()
```
    Checks whether this widget can receive focus generally.
    
    Returns:
    
    true if this widget can be focused under certain conditions. false if, and only if, this widget can never receive focus.
  - setPhysicalLocation
```
void setPhysicalLocation(int x,
                         int y)
```
    Set widget relative physical location.
    
    Parameters:
    
    x - Widget physical X.
    
    y - Widget physical Y.
  - physicalLocation
```
NativePoint physicalLocation()
```
    Get widget physical location relative to container, expressed in units native to UI type.
    
    Returns:
    
    relative widget location.
  - physicalBounds
```
NativeRectangle physicalBounds()
```
    Determine the physical bounds, relative to screen, expressed in units native to UI type.
    
    Returns:
    
    See above.
  - findMouseSource
```
Widget<O> findMouseSource(NativePoint p)
```
    Find the widget positioned just bellow the specified mouse position (in physical units).
    
    Parameters:
    
    p - The mouse physical location.
    
    Returns:
    
    A widget over which the mouse is positioned or null if none found.
  - destroy
```
void destroy()
```
    Destroy this widget.
  - resizeTo
```
void resizeTo(NativePoint origin,
              NativeDimension size,
              boolean raise)
```
    Resize the widget to the specified dimensions.
    
    Parameters:
    
    origin - The top-left window corner new position.
    
    size - The new window size.
    
    raise - Flag indicating if the 4GL WINDOW-RESIZED event needs to be raised.
  - registerWidgetListener
```
void registerWidgetListener(WidgetListener l)
```
    Register a widget state listener for this widget.
    
    Parameters:
    
    l - The widget state listener.
  - unregisterWidgetListener
```
void unregisterWidgetListener(WidgetListener l)
```
    Unregister a widget state listener for this widget.
    
    Parameters:
    
    l - The widget state listener.
  - getState
```
byte getState()
```
    Gets the current state of this component's data.
    
    Returns:
    
    The state of this widget's data (for example ScreenBuffer.UNINITIALIZED).
  - getSelectedText
```
java.lang.String getSelectedText()
```
    Obtain any selected text in the widget for copying to the clipboard.
    
    Returns:
    
    The selected text or null if there is no selected text or if the widget type does not support clipboard operations.
  - getVisiblePart
```
Rectangle getVisiblePart()
```
    Gets the sub-rectangle which should be visible.
    
    Returns:
    
    The sub-rectangle which should be visible
  - setState
```
void setState(byte state)
```
    Stores the new state of the component's data.
    
    Parameters:
    
    state - The new state (for example ScreenBuffer.CHANGED).
  - raiseLegacyMouseEvents
```
boolean raiseLegacyMouseEvents()
```
    Check if the widget implementation can raise legacy, 4GL-style, mouse events.
    
    Returns:
    
    true if a mouse action on this widget will raise legacy, 4GL-style, mouse events.
  - postprocessConfig
```
void postprocessConfig()
```
    Additional processing required when widget configuration is updated AFTER the frame layout has been performed.
  - isTabStop
```
boolean isTabStop()
```
    Check the value of the TAB-STOP attribute
    
    Returns:
    
    the value of the attribute or true if not applicable
  - moveToTop
```
boolean moveToTop()
```
    Move the widget to the top in z-order
    
    Returns:
    
    true if operation was successful
  - moveToBottom
```
boolean moveToBottom()
```
    Move the widget to the bottom in z-order
    
    Returns:
    
    true if operation was successful
  - getZOrderClass
```
ZOrderClass getZOrderClass()
```
    Get the Z-Order class
    
    Returns:
    
    Z-Order class of the widget
  - getMenuMouse
```
int getMenuMouse()
```
    Get the value of the MENU-MOUSE attribute
    
    Returns:
    
    the value of the attribute
  - getMouseActions
```
org.roaringbitmap.RoaringBitmap getMouseActions()
```
    Get the mouse actions on which this widget can respond.
    This is compatible with the AWT mouse event codes and P2J specific MouseEvt actions.
    
    Returns:
    
    The mouse actions.
  - isThreeD
```
boolean isThreeD()
```
    If the method returns true the widget should be represented with 3D visuals.
    
    Returns:
    
    see above.
  - navigable
```
boolean navigable()
```
    Returns true only if this widget is navigable.
    
    Returns:
    
    true if widget is navigable.
  - setMousePointer
```
void setMousePointer(MousePtrWrapper ptr)
```
    Set the custom mouse pointer
    
    Parameters:
    
    ptr - the custom mouse pointer
  - setMousePointer
```
void setMousePointer(int windowId,
                     MousePtrWrapper ptr)
```
    Set the custom mouse pointer
    
    Parameters:
    
    windowId - the window's ID
    
    ptr - the custom mouse pointer
  - getLoadedMousePointer
```
java.util.Optional<MousePtrWrapper> getLoadedMousePointer()
```
    Get the loaded custom mouse pointer if it is set
    
    Returns:
    
    the loaded custom mouse pointer if it is set
  - getCustomMousePointer
```
java.util.Optional<MousePtrWrapper> getCustomMousePointer()
```
    Get the current custom mouse pointer if it is set
    
    Returns:
    
    the current custom mouse pointer if it is set
  - getEffectiveMousePointer
```
MousePtrWrapper getEffectiveMousePointer()
```
    Get the current effective custom mouse pointer
    
    Returns:
    
    the current effective custom mouse pointer
  - enclosingFrame
```
java.util.Optional<Frame<?>> enclosingFrame()
```
    Get the enclosing FRAME if it exists
    
    Returns:
    
    the enclosing FRAME if it exists
  - supportsCustomMousePointer
```
boolean supportsCustomMousePointer()
```
    Check if the widget supports LOAD-MOUSE-POINTER() method
    
    Returns:
    
    true if the widget supports LOAD-MOUSE-POINTER() method
  - defaultMousePtr
```
default java.util.Optional<MousePtrWrapper> defaultMousePtr()
```
    Get default mouse pointer for this widget
    
    Returns:
    
    MousePtr or Optional.empty() if one is inherited from the enclosing frame
  - enforceDefaultMousePtr
```
default boolean enforceDefaultMousePtr()
```
    Check if the default mouse pointer should be used regardless of the parent settings
    
    Returns:
    
    true if the default mouse pointer should always be used
  - getActualBounds
```
NativeRectangle getActualBounds()
```
    Get the widget's actual bounds
    
    Returns:
    
    widget's actual bounds
  - isRMBEntrySupported
```
boolean isRMBEntrySupported()
```
    Check if this widget gains ENTRY event when right/middle mouse button is clicked.
    
    Returns:
    
    true if this widget gains ENTRY event when right/middle mouse button is clicked.
  - unrealize
```
void unrealize()
```
    Unrealize this widget.
  - clearWidget
```
boolean clearWidget()
```
    Clear widget state on CLEAR FRAME call for the parent frame.
    
    Returns:
    
    true on success. false if CLEAR cannot be applied to this widget, e.g. if it is static text.
  - getLegacyWidget
```
default Widget<O> getLegacyWidget()
```
    The method returns the legacy widget representing this possibly virtual widget. If this is already a legacy widget it is returned.
    The default implementation walks up the widget tree starting at this. The first enumerated widget returning false from WidgetId.virtualWidget(WidgetId) is returned.
    
    Returns:
    
    A non-virtual widget reference, or null if none found.
  - getTriggerWidget
```
default Widget<O> getTriggerWidget()
```
    For some virtual widgets, the widget where triggers are checked is different (i.e. entry field for a combo-box must route the trigger check to the combo-box, and not the associated fill-in).
    
    Returns:
    
    The widget which must process the triggers.
  - processMnemonic
```
boolean processMnemonic(int key)
```
    Process the given key, if this widget's mnemonic matches the key.
    
    Parameters:
    
    key - The pressed mnemonic key code.
    
    Returns:
    
    true if this widget accepted this mnemonic key. Not enabled or not visible widget will not accept it.
  - isDroppable
```
default boolean isDroppable()
```
    Checks if the given widget is able to be the target of the drop operation.
    
    Returns:
    
    TRUE if this widget can be droppable at this time, FALSE otherwise.
  - isRepaintDisabled
```
boolean isRepaintDisabled()
```
    Returns true when the widget repaint is disabled. This method is needed to support the WINDOW:DISABLE-REDRAW attribute.
    
    Returns:
    
    See above.
  - resolvePopupMenuId
```
int resolvePopupMenuId()
```
    Returns the popup menu effective for this widget.
    
    Returns:
    
    Popup menu id or -1 if no menu is found.
  - maySwitchFocus
```
default boolean maySwitchFocus()
```
    Some widgets (like scroll bars) react on user input (like mouse click), but don't steal focus from currently focused widget. This method should be overriden by such widgets.
    
    Returns:
    
    Returns true if the widget may steal focus from currently focused widget, false otherwise.
  - widgetStateChanged
```
void widgetStateChanged()
```
    Notification that this widget's state has changed (visibility, sensitivity, z-order).
  - getTriggerWidget
```
default Widget<?> getTriggerWidget(int evtCode,
                                   boolean isKey)
```
    Complex legacy widgets are usually assembled from multiple individual widget classes. Events may be handled by any of the individual widget class which itself may be a virtual widget with no representation in the legacy code. An example is a COMBO-BOX widget, where the scroll panel is a virtual widget with its own event handling. The virtual widget may or may not invoke a legacy trigger as a result of an input event.
    This method solves the cases where multiple widget classes make up a legacy widget and one of the widget class causes a trigger to be invoked. This method returns the widget that should server as the source of the triggered event. This widget must always be a non-virtual widget. The method may also return null which prevents triggering of the legacy event.
    
    Parameters:
    
    evtCode - The event being triggered.
    
    isKey - Whether the event being triggered is a real key.
    
    Returns:
    
    see above.
  - refreshWidget
```
default void refreshWidget()
```
    Refresh widget.
  - oleDrag
```
void oleDrag()
```
    Start an OLE drag/drop event with the given control as the source.
  - ignoreEnable
```
default boolean ignoreEnable()
```
    Some widgets can ignore an ENABLE statement (like read-only, hidden TEXT).
    This implementation always returns false.
    
    Returns:
    
    true if the ENABLE statement must ignore it.
  - getMousePosition
```
NativePoint getMousePosition()
```
    Returns current mouse cursor position relative to the this widget. The method is only supported in GUI mode.
    
    Returns:
    
    mouse cursor position, never null.
  - isInitialValueLayout
```
default boolean isInitialValueLayout()
```
    Reports if the initial height/width of the widget should take precedence in the frame layout algorithm. The initial height/width is that which is set during frame setup for static widgets. This means it was hard coded in the original static definition of the widget in in the 4GL source code.
    
    Returns:
    
    true if the initial values control layout.
  - preventFocusWhenMouseDownEventDefined
```
boolean preventFocusWhenMouseDownEventDefined()
```
    Test if this widget must prevent receiving focus on mouse-down event. The default is true.
    
    Returns:
    
    see above.
  - validateDisplayValue
```
default boolean validateDisplayValue()
```
    Performs format validation of the widget value being entered, i.e. the value not yet part of the widget's screen buffer.
    
    Returns:
    
    true if the display value conforms to the widgets format, false otherwise.
  - canMovetoTop
```
default boolean canMovetoTop()
```
    Flag indicating if this widget can be moved to top by a DISPLAY statement when WINDOW:KEEP-FRAME-Z-ORDER flag is set.
    
    Returns:
    
    Always false.
  - isProcessProgressEvent
```
default boolean isProcessProgressEvent(Event event)
```
    Called by the ThinClient during event processing. Depending on the method result the legacy event processing on the input event will or will not be conducted (by calling ThinClient.processProgressEvent(com.goldencode.p2j.ui.client.event.Event)). When the method returns true the legacy event processing will be conducted. The default implementation returns true.
    
    Parameters:
    
    event - The event to check.
    
    Returns:
    
    See above.
  - acceptsEscAsAnyKey
```
default boolean acceptsEscAsAnyKey()
```
    Flag indicating if this widget can accept ESC key for any key event.
    
    Returns:
    
    Always true.
  - hasTooltip
```
boolean hasTooltip()
```
    Check if widget has tooltip.
    
    Returns:
    
    true if widget has tooltip.

Interface Widget<O extends OutputManager<?>>

Method Summary

Methods inherited from interface java.awt.event.MouseListener

Methods inherited from interface java.awt.event.MouseMotionListener

Methods inherited from interface java.awt.event.MouseWheelListener

Method Detail

getId

getIdForTrigger

screen

addFocusListener

addKeyListener

ancestor

window

topLevelWindow

ancestorId

bounds

insets

dimension

physicalDimension

isDisplayed

isRealized

draw

drawCaret

isEnabled

focusTraversable

forceVisibility

hasFocus

hasFocus

isLegacyFocus

systemFocusGrabbed

isCurrent

isCurrent

height

initialHeight

hidden

hide

highlighted

location

minimumSize

name

parent

parent

parent

parentObject

parentOrSelf

parentOrSelfObject

processFocusEvent

processKeyEvent

processDirectManipulationEvent

isDirectManipulable

isDirectManipulationActive

setDirectManipulationActive

isDirectManipulationActiveOrInUIB

setSensitiveForUIB

processKeyListeners

repaint

repaint

repaint

requestFocus

requestFocus

requestFocus

requestSync

screenLocation

screenPhysicalLocation

displayPhysicalLocation

setEnabled

setHidden

setHighlighted

setLocation

setLocation

setParent

setVisible

setWindow

startTrigger

completeTrigger

acceptTrigger

show

isTotallyObscured

isVisible

isVisible