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

java.lang.Object
- com.goldencode.p2j.ui.client.widget.AbstractWidget<O>

Type Parameters:

O - the output manager

All Implemented Interfaces:

Widget<O>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

AbstractButton, AbstractContainer, ActivexFrame, CalendarGuiImpl.DateTimeContent, ComboBox, DefaultList, FontChooserGuiImpl.Preview, Hyperlink, Image, LightweightWidget, MenuItem, MessageAreaImpl, ProgressBarGuiImpl, Rect, Separator, SimpleLabel, Skip, Slider, Space, StatusLine, TreeBodyGuiImpl, TreeListCaptionItem
```
public abstract class AbstractWidget<O extends OutputManager<?>>
extends java.lang.Object
implements Widget<O>
```
Base widget class.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.Map<java.lang.Class<?>,java.lang.ref.WeakReference<Container<?>>>`	`ancestorCache` The previously computed ancestor cache.
`private boolean`	`directManipulationActive` Flag indicating the direct manipulation handler registration.
`private boolean`	`enabled` Widget enabled flag.
`private boolean`	`firstEnabledDisabled` Flag to keep track if the call to setEnabled() is doing for the first time.
`private java.util.ArrayList<FocusListener>`	`focusListeners` Storage for focus listeners.
`private boolean`	`hidden` Widget hidden flag.
`private boolean`	`highlighted` Widget highlighted flag.
`protected Insets`	`insets` Widget insets
`private boolean`	`isOleDragDrop` Is an OLE Drag&Drop operation
`private java.util.ArrayList<KeyListener>`	`keyListeners` Storage for key listeners.
`protected java.util.ArrayList<WidgetListener>`	`listeners` List of listeners which require notifications about the state of this widget.
`protected Point`	`location` Widget origin (upper left corner) relative to container expressed in character cell units.
`protected static CentralLogger`	`LOG` Logger.
`private org.roaringbitmap.RoaringBitmap`	`mouseActions` A set of mouse actions on which this widget can react.
`private MouseHoverAction`	`mouseHoverAction` Mouse hover event handler
`protected java.util.Optional<MousePtrWrapper>`	`mousePtr` Custom mouse pointer
`protected NativeInsets`	`nativeInsets` Widget native insets
`private java.lang.ref.WeakReference<Container<O>>`	`parent` Reference to parent container.
`protected NativePoint`	`physicalLocation` Widget physical origin (upper left corner) relative to container.
`private boolean`	`popupKeyListnrAdded` `true` if and only if `Menu.PopupKeyListener` was added to this widget.
`private O`	`screen` Reference to screen.
`private Point`	`screenLocation` The cached value of `screenLocation()`.
`private NativePoint`	`screenPhysicalLocation` The cached value of `screenPhysicalLocation()`.
`private boolean`	`sensitiveInDirectManipulation` Flag to keep widget sensitivity value in UIB or direct manipulation modes.
`private boolean`	`tooltipActive` Flag indicating if the widget's TOOLTIP can be activated.
`private boolean`	`visible` Widget visible flag.
`private java.lang.ref.WeakReference<Window<O>>`	`window` The cached widget's window.

Constructor Summary

Constructors
Constructor and Description

AbstractWidget()
Constructor

Constructors
Constructor and Description
`AbstractWidget()` Constructor

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`private void`	`_setEnabled(boolean enabled)` Update the `enabled` flag in the configuration and in the widget's state.
`void`	`_setHidden(boolean hidden)` Update the `hidden` flag in the configuration and in the widget's state.
`void`	`_setVisible(boolean visible)` Update the `visible` flag in the configuration and in the widget's state.
`void`	`activateDirectManipulation()` Activates direct manipulation engine for this widget.
`void`	`addFocusListener(FocusListener listener)` Add focus listener.
`void`	`addKeyListener(KeyListener listener)` Add key listener.
`<C extends WidgetConfig> void`	`afterConfigUpdateBase(C beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`TitledWindow<O>`	`ancestor()` Get ancestor window for this widget.
`WidgetId`	`ancestorId()` Get the ID of the ancestor window for this widget.
`protected <C extends WidgetConfig> void`	`autoResize(C beforeUpdate)` Invoke auto-resize logic if needed
`Rectangle`	`bounds()` Get widget bounding rectangle.
`void`	`clear(Point origin, Dimension size, Color color)` Determine the widget's window and clear specified area of the screen.
`boolean`	`clearWidget()` Clear widget state on CLEAR FRAME call for the parent frame.
`protected NativeRectangle`	`clipRectangle()` Build widget clipped rectangle.
`static NativeRectangle`	`clipRectangle(NativePoint origin, NativeDimension dimension)` Build clipped rectangle for given coordinates.
`void`	`clipWith(Rectangle rect)` Determine the widget's window and add a new clipping rectangle to the bitmap.
`<W extends WidgetConfig> W`	`config()` Get externalizable widget config which can be used to restore widget state after via network.
`protected static void`	`copyColors(BaseConfig source, BaseConfig target)` Copy the bg/fg colors from the source config to the target config.
`protected void`	`copyState(Widget<?> w)` Copy the widget state from the specified source widget to this instance.
`protected MouseHoverAction`	`createMouseHoverAction()` Create handler for processing mouse hover events
`void`	`deactivateDirectManipulation()` Deactivates direct manipulation engine for this widget.
`void`	`debug(java.lang.String message)` Utility method for debugging, can be used to include information from the server-side to the client-side log
`void`	`destroy()` Destroy this widget.
`abstract Dimension`	`dimension()` Get widget dimension.
`protected void`	`disable()` Disable widget.
`void`	`disableTooltip()` Disable the `tooltipActive` flag and reset the `mouseActions`, so they will be rebuilt next time this widget is processed to be sent to the JS web driver.
`NativePoint`	`displayPhysicalLocation()` Get display location of widget in screen coordinates.
`private void`	`doTriggerContainerStateRedrawEnabled(AbstractContainer<O> c)` Calls `AbstractContainer.triggerContainerStateRedrawEnabled()` on the supplied container and all containers recursively down the widget tree.
`abstract void`	`draw()` Draw widget.
`void`	`drawCaret()` Draw caret.
`protected void`	`enable()` Enable widget.
`void`	`enableTooltip()` Enable the `tooltipActive` flag and reset the `mouseActions`, so they will be rebuilt next time this widget is processed to be sent to the JS web driver.
`java.util.Optional<Frame<?>>`	`enclosingFrame()` Get the enclosing FRAME if it exists
`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
`ScreenBitmap`	`getAndResetBitmap()` Determine the widget's window, get a copy of the current screen bitmap and reset clipping entirely.
`ScreenBitmap`	`getAndSetBitmap(Rectangle rect)` Determine the widget's window, get a copy of the current screen bitmap and clip output further so it is guaranteed not to go outside of the provided rectangle.
`ScreenBitmap`	`getBitmapCopy()` Determine the widget's window and get a copy of the current screen bitmap.
`Point`	`getCachedScreenLocation()` Get the cached value of `screenLocation()`.
`NativePoint`	`getCachedScreenPhysicalLocation()` Get the cached value of `screenPhysicalLocation()`.
`java.util.Optional<MousePtrWrapper>`	`getCustomMousePointer()` Get the current custom mouse pointer if it is set
`int`	`getDefaultEvent(KeyInput key, boolean inEditingBlock)` Get the default event associated for this widget and the given key.
`MousePtrWrapper`	`getEffectiveMousePointer()` Get the current effective custom mouse pointer
`WidgetId`	`getId()` Widget ID.
`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.
`NativePoint`	`getPortableMouseEventCoordinates(NativePoint point)` Get a point to represent the LAST-EVENT:X and LAST-EVENT:Y coordinates.
`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.
`int`	`getTextHeight(java.lang.String txt, int font)` Compute the text height using `FontManager.getTextHeight(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, int, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>)`.
`private int`	`getTextHeight(java.lang.String txt, int font, boolean useNative)` Compute the height of the given text, using the specified font in the widget's window.
`int`	`getTextHeightNative(java.lang.String txt, FontDetails font)` Compute the text height using `GuiDriver.getTextHeight(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>)`.
`int`	`getTextHeightNative(java.lang.String txt, int font)` Compute the text height using `GuiDriver.getTextHeight(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>)`.
`int`	`getTextWidth(java.lang.String txt, FontDetails font)` Compute the text width using `FontManager.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, com.goldencode.p2j.ui.client.FontDetails, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>)`.
`private int`	`getTextWidth(java.lang.String txt, FontDetails font, boolean useNative)` Compute the width of the given text, using the specified font in the widget's window.
`private int`	`getTextWidth(java.lang.String txt, FontDetails font, int fontNum, boolean useNative)` Compute the width of the given text, using the specified font in the widget's window.
`int`	`getTextWidth(java.lang.String txt, int font)` Compute the text width using `FontManager.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, com.goldencode.p2j.ui.client.FontDetails, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>)`.
`private int`	`getTextWidth(java.lang.String txt, int font, boolean useNative)` Compute the width of the given text, using the specified font in the widget's window.
`int`	`getTextWidthNative(java.lang.String txt, FontDetails font)` Compute the text width using `GuiDriver.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>)`.
`int`	`getTextWidthNative(java.lang.String txt, int font)` Compute the text width using `GuiDriver.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>)`.
`Rectangle`	`getVisiblePart()` Gets the sub-rectangle which should be visible.
`ZOrderClass`	`getZOrderClass()` Get the Z-Order class
`boolean`	`hasFocus(boolean recurse)` Check if widget has focus.
`boolean`	`hasTooltip()` Check if widget has tooltip.
`abstract double`	`height()` Get widget height.
`boolean`	`hidden()` Get current hidden state.
`void`	`hide()` Hide widget.
`boolean`	`highlighted()` Get current highlighted state.
`boolean`	`ignoreAction(int action)` Check if the given event needs to be ignored, as it can't be treated by the widget.
`double`	`initialHeight()` Get initial widget height in character units.
`double`	`initialWidth()` Get initial widget width in character units.
`Insets`	`insets()` Get widget insets.
`boolean`	`isCurrent(boolean recurse)` The method returns true if the widget is set as current in its parent container or containers.
`boolean`	`isDirectManipulationActive()` Check if direct manipulation is active for this widget.
`boolean`	`isDirectManipulationActiveOrInUIB()` Check if direct manipulation is active for this or widget is in UIB mode.
`protected boolean`	`isDirectManipulationCapable()` Checks if direct manipulation feature can be used for this widget.
`boolean`	`isDirectManipulationRequired()` Checks if direct manipulation feature must be installed or removed in GUI mode.
`boolean`	`isDisplayed()` Check if widget is displayed.
`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.
`protected boolean`	`isMouseDrag(java.awt.event.MouseEvent e)` Check for drag operation.
`boolean`	`isRealized()` The default implementation delegates to WidgetConfig if it has one, otherwise return false.
`boolean`	`isRepaintDisabled()` Returns true if the widget repaint is disabled.
`boolean`	`isRMBEntrySupported()` Check if this widget gains ENTRY event when right/middle mouse button is clicked.
`boolean`	`isScreenLocationCached()` Check if either `screenLocation` or `screenPhysicalLocation` contains a cached value.
`boolean`	`isTabStop()` Check the value of the TAB-STOP attribute
`private boolean`	`isTheSameFrame(Container<O> frameToTest)` Checks if the given container is the same frame as the current one.
`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.
`boolean`	`manageSystemActions()` Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
`abstract Dimension`	`minimumSize()` Get widget minimum size.
`protected int[]`	`mouseActions()` Sub-classes will override this to return a list of mouse actions on which the widget responds.
`void`	`mouseClicked(java.awt.event.MouseEvent e)` Notification of a mouse clicked event occurred for this widget.
`void`	`mouseDragged(java.awt.event.MouseEvent e)` Notification of a mouse dragged event occurred for this widget.
`void`	`mouseEntered(java.awt.event.MouseEvent e)` Notification of a mouse entered event occurred for this widget.
`void`	`mouseExited(java.awt.event.MouseEvent e)` Notification of a mouse exited event occurred for this widget.
`void`	`mouseMoved(java.awt.event.MouseEvent e)` Notification of a mouse moved event occurred for this widget.
`void`	`mousePressed(java.awt.event.MouseEvent e)` Notification of a mouse pressed event occurred for this widget.
`void`	`mouseReleased(java.awt.event.MouseEvent e)` Notification of a mouse released event occurred for this widget.
`void`	`mouseWheelMoved(java.awt.event.MouseWheelEvent e)` Notification of a mouse wheel moved event occurred for this widget.
`boolean`	`moveToBottom()` Moves this widget to the bottom of other widgets in the z-ordering.
`boolean`	`moveToTop()` Moves this widget to the top of other widgets in the z-ordering.
`java.lang.String`	`name()` Get widget name.
`boolean`	`navigable()` Returns `true` only if this widget is navigable.
`protected void`	`oleDoDrop(java.awt.event.MouseEvent e)` Called when an automatic OLE Drop operation is ended.
`void`	`oleDrag()` Start an OLE drag/drop event with the given control as the source.
`protected void`	`oleDragging(java.awt.event.MouseEvent e)` Called on OLE Dragging.
`protected boolean`	`oleStartDragging(java.awt.event.MouseEvent e)` Called when an automatic OLE Drag operation is started.
`protected void`	`onOleDragging(java.awt.event.MouseEvent e, Widget<?> widget)` Called when OLE Dragging.
`protected void`	`onOleDropEnd(java.awt.event.MouseEvent e, Widget<?> widget)` Called when a OLE Drop operation is ended.
`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.
`protected Point`	`prepParentLocation(Widget<?> parent)` Trick, that lets to correct parent location in cases, when it needed, for example for menus.
`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.
`protected void`	`processKeyEventForSelectableWidget(KeyInput event)` Process key event for selectable widgets.
`void`	`processKeyListeners(KeyInput event)` Process key listeners.
`boolean`	`processMnemonic(int key)` Process the given key, if this widget's mnemonic matches the key.
`protected boolean`	`processMnemonicImpl(int key, MnemonicTrait m)` Common code to process the specific mnemonic key by this widget.
`void`	`processSystemKey(KeyInput key)` Process the action associated with the given key in an independent drawing bracket.
`boolean`	`raiseLegacyMouseEvents()` Check if the widget implementation can raise legacy, 4GL-style, mouse events.
`void`	`reflectAncestorChange()` Called when any of the widget's ancestors gets re-assigned.
`void`	`reflectLocationChanged()` Called when the widget's location changes.
`protected void`	`reflectSizeChanged()` Reflects the size change of the widget by invoking the "sizeChanged" method on all registered WidgetDimensionsListener listeners.
`private void`	`reflectVisibilityChanged()` Reflects the visibility change of the widget by invoking the 'visibilityChanged' method on the registered listeners of type 'WidgetVisibilityListener'.
`void`	`refresh(Rectangle rect)` Determine the widget's window and mark a rectangle as needing repainting.
`void`	`registerWidgetListener(WidgetListener l)` Register a widget state listener for this widget.
`void`	`repaint()` Request widget repainting.
`void`	`repaint(NativeRectangle rect)` Request widget repainting.
`void`	`repaint(Rectangle ur)` Request widget repainting.
`private void`	`repaintEventParentContainer(DirectManipulationEvent event)` Repaint parent container from DirectManipulationEvent event.
`void`	`requestFocus(boolean force, boolean mouse)` Request focus.
`void`	`requestSync()` Request screen synchronization.
`void`	`resetBitmap()` Determine the widget's window and reset the screen bitmap.
`void`	`resizeTo(NativePoint origin, NativeDimension size, boolean raise)` Resize the widget to the specified dimensions.
`int`	`resolveFont()` This API is responsible for resolving the widget's font.
`int`	`resolvePopupMenuId()` Returns the popup menu effective for this widget.
`int`	`resolveTitleFont()` This API is responsible for resolving the font associated with this widget's title.
`O`	`screen()` Get access to `OutputManager` instance.
`Dimension`	`screenDimension()` Determine the widget's window and get the screen dimensions.
`double`	`screenHeight()` Determine the widget's window and get the number of rows on the screen.
`Point`	`screenLocation()` Get absolute location of widget in screen coordinates.
`NativePoint`	`screenPhysicalLocation()` Get absolute location of widget in screen coordinates.
`double`	`screenWidth()` Determine the widget's window and get the number of columns on the screen.
`void`	`setBitmap(ScreenBitmap bitmap)` Determine the widget's window and restore the bitmap to a previous state.
`void`	`setCachedScreenLocation(Point p)` Set the cached value for `screenLocation()`, in `screenLocation`.
`void`	`setCachedScreenPhysicalLocation(NativePoint p)` Set the cached value for `screenPhysicalLocation()`, in `screenPhysicalLocation`.
`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.
`protected void`	`setPhysicalDimensionInt(int width, int height)` Set widget physical dimension.
`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.
`void`	`setWindow(Window<?> w)` Set a window.
`void`	`show()` Show widget.
`Menu<O>`	`showPopupMenu(java.awt.event.MouseEvent e, java.lang.Runnable dismissHandler)` The method shows the popup menu for this widget.
`boolean`	`supportsCustomMousePointer()` Check if the widget supports LOAD-MOUSE-POINTER() method
`void`	`sync()` Determine the widget's window and synchronize output with physical terminal.
`TopLevelWindow<O>`	`topLevelWindow()` Get ancestor `TopLevelWindow` for this widget, if the widget is attached to a window.
`java.lang.String`	`toString()` Returns a string representation of the object.
`NativePoint`	`translate(java.awt.event.MouseEvent evt)` Translate mouse position relative to this widget.
`protected void`	`triggerLocationChanged()` Triggers the location changed event for the widget.
`void`	`unrealize()` Unrealize this widget.
`void`	`unregisterWidgetListener(WidgetListener l)` Unregister a widget state listener for this widget.
`protected <C extends WidgetConfig> void`	`updateSizeWorker(C beforeUpdate)` Instructs the widget that its size may have changed.
`protected void`	`updateSystemParent(BaseConfig bcBefore)` Updates system parent with new ID came from server.
`protected void`	`widgetRealized()` Fired when the widget becomes realized.
`void`	`widgetStateChanged()` Notification that this widget's state has changed (visibility, sensitivity, z-order).
`abstract double`	`width()` Get widget width.
`Window<O>`	`window()` Get ancestor Window for this widget.

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.Widget
acceptsEscAsAnyKey, acceptTrigger, canMovetoTop, completeTrigger, defaultMousePtr, enforceDefaultMousePtr, getIdForTrigger, getLegacyWidget, getTriggerWidget, getTriggerWidget, hasFocus, ignoreEnable, isCurrent, isDirectManipulable, isDroppable, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, maySwitchFocus, parent, refreshWidget, requestFocus, requestFocus, startTrigger, systemFocusGrabbed, validateDisplayValue

- Field Detail
  - LOG
```
protected static final CentralLogger LOG
```
    Logger.
  - listeners
```
protected java.util.ArrayList<WidgetListener> listeners
```
    List of listeners which require notifications about the state of this widget.
  - enabled
```
private boolean enabled
```
    Widget enabled flag.
  - firstEnabledDisabled
```
private boolean firstEnabledDisabled
```
    Flag to keep track if the call to setEnabled() is doing for the first time.
  - hidden
```
private boolean hidden
```
    Widget hidden flag.
  - highlighted
```
private boolean highlighted
```
    Widget highlighted flag.
  - visible
```
private boolean visible
```
    Widget visible flag. This field is needed only for instances without config.
  - focusListeners
```
private java.util.ArrayList<FocusListener> focusListeners
```
    Storage for focus listeners.
  - keyListeners
```
private java.util.ArrayList<KeyListener> keyListeners
```
    Storage for key listeners.
  - parent
```
private java.lang.ref.WeakReference<Container<O extends OutputManager<?>>> parent
```
    Reference to parent container.
  - window
```
private java.lang.ref.WeakReference<Window<O extends OutputManager<?>>> window
```
    The cached widget's window. Gets reset by reflectAncestorChange().
  - ancestorCache
```
private java.util.Map<java.lang.Class<?>,java.lang.ref.WeakReference<Container<?>>> ancestorCache
```
    The previously computed ancestor cache. Gets reset by reflectAncestorChange().
  - popupKeyListnrAdded
```
private boolean popupKeyListnrAdded
```
    true if and only if Menu.PopupKeyListener was added to this widget.
  - screen
```
private O extends OutputManager<?> screen
```
    Reference to screen.
  - mouseActions
```
private org.roaringbitmap.RoaringBitmap mouseActions
```
    A set of mouse actions on which this widget can react.
  - location
```
protected Point location
```
    Widget origin (upper left corner) relative to container expressed in character cell units.
  - physicalLocation
```
protected NativePoint physicalLocation
```
    Widget physical origin (upper left corner) relative to container. expressed in units native to UI type.
  - insets
```
protected Insets insets
```
    Widget insets
  - nativeInsets
```
protected NativeInsets nativeInsets
```
    Widget native insets
  - mousePtr
```
protected java.util.Optional<MousePtrWrapper> mousePtr
```
    Custom mouse pointer
  - mouseHoverAction
```
private MouseHoverAction mouseHoverAction
```
    Mouse hover event handler
  - directManipulationActive
```
private boolean directManipulationActive
```
    Flag indicating the direct manipulation handler registration.
  - screenLocation
```
private Point screenLocation
```
    The cached value of screenLocation().
  - screenPhysicalLocation
```
private NativePoint screenPhysicalLocation
```
    The cached value of screenPhysicalLocation().
  - isOleDragDrop
```
private boolean isOleDragDrop
```
    Is an OLE Drag&Drop operation
  - tooltipActive
```
private boolean tooltipActive
```
    Flag indicating if the widget's TOOLTIP can be activated.
  - sensitiveInDirectManipulation
```
private boolean sensitiveInDirectManipulation
```
    Flag to keep widget sensitivity value in UIB or direct manipulation modes.
- Constructor Detail
  - AbstractWidget
```
public AbstractWidget()
```
    Constructor
- Method Detail
  - copyColors
```
protected static void copyColors(BaseConfig source,
                                 BaseConfig target)
```
    Copy the bg/fg colors from the source config to the target config.
    
    Parameters:
    
    source - The source config.
    
    target - The target config.
  - getId
```
public WidgetId getId()
```
    Widget ID.
    
    Specified by:
    
    getId in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    see above.
  - screen
```
public O screen()
```
    Get access to OutputManager instance.
    
    Specified by:
    
    screen in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    reference to OutputManager.
  - addFocusListener
```
public void addFocusListener(FocusListener listener)
```
    Add focus listener.
    
    Specified by:
    
    addFocusListener in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    listener - Listener to add.
  - addKeyListener
```
public void addKeyListener(KeyListener listener)
```
    Add key listener.
    
    Specified by:
    
    addKeyListener in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    listener - Listener to add.
  - ancestor
```
public TitledWindow<O> ancestor()
```
    Get ancestor window for this widget.
    
    Specified by:
    
    ancestor in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    ancestor window.
  - ancestorId
```
public WidgetId ancestorId()
```
    Get the ID of the ancestor window for this widget.
    
    Specified by:
    
    ancestorId in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    ancestor window ID or null if no valid ancestor exists.
  - window
```
public Window<O> window()
```
    Get ancestor Window for this widget. This method must be called only for widgets that are already attached to Window.
    
    Specified by:
    
    window in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    ancestor Window.
    
    Throws:
    
    java.lang.IllegalStateException - When this widget is not attached to window.
  - topLevelWindow
```
public TopLevelWindow<O> topLevelWindow()
```
    Get ancestor TopLevelWindow for this widget, if the widget is attached to a window.
    This will return null if widget is not yet attached to a top level window or is already detached from it. This can happen during normal steps in a widget's lifecycle such as creation or destruction.
    
    Specified by:
    
    topLevelWindow in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    The ancestor window or null if not currently attached.
  - bounds
```
public Rectangle bounds()
```
    Get widget bounding rectangle.
    
    Specified by:
    
    bounds in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    bounding rectangle.
  - insets
```
public Insets insets()
```
    Get widget insets.
    
    Specified by:
    
    insets in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget insets.
  - dimension
```
public abstract Dimension dimension()
```
    Get widget dimension.
    
    Specified by:
    
    dimension in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget dimension.
  - physicalDimension
```
public NativeDimension physicalDimension()
```
    Get widget physical dimension, expressed in units native to UI type.
    
    Specified by:
    
    physicalDimension in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget dimension.
  - isDisplayed
```
public boolean isDisplayed()
```
    Check if widget is displayed.
    Only widget which does not delegate to the parent is TitledWindow, with the exception of MenuItemGuiImpl. For this case, we avoid delegating and up the tree and just check the window parent for common case. Other cases (like MenuItemGuiImpl will still rely on the parent delegation.
    
    Specified by:
    
    isDisplayed in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget is displayed.
  - isRealized
```
public boolean isRealized()
```
    The default implementation delegates to WidgetConfig if it has one, otherwise return false.
    
    Specified by:
    
    isRealized in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if config().realized is true.
  - draw
```
public abstract void draw()
```
    Draw widget.
    
    Specified by:
    
    draw in interface Widget<O extends OutputManager<?>>
  - drawCaret
```
public void drawCaret()
```
    Draw caret.
    
    Specified by:
    
    drawCaret in interface Widget<O extends OutputManager<?>>
  - isEnabled
```
public boolean isEnabled()
```
    Check if widget is enabled.
    
    Specified by:
    
    isEnabled in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget is enabled.
  - focusTraversable
```
public boolean focusTraversable()
```
    Check if widget is focus traversable.
    
    Specified by:
    
    focusTraversable in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget is focus traversable.
  - navigable
```
public boolean navigable()
```
    Returns true only if this widget is navigable.
    
    Specified by:
    
    navigable in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget is navigable.
  - forceVisibility
```
public void forceVisibility(boolean visibility)
```
    Force widget visibility change without associated repainting.
    
    Specified by:
    
    forceVisibility in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    visibility - New visibility state.
  - hasFocus
```
public 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.
    
    Specified by:
    
    hasFocus in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    recurse - see above
    
    Returns:
    
    true if widget has focus.
  - isCurrent
```
public 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.
    
    Specified by:
    
    isCurrent in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    recurse - Allows recursive mode. See above.
    
    Returns:
    
    see above.
  - height
```
public abstract double height()
```
    Get widget height.
    
    Specified by:
    
    height in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget height.
  - hidden
```
public boolean hidden()
```
    Get current hidden state.
    
    Specified by:
    
    hidden in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    hidden state.
  - hide
```
public void hide()
```
    Hide widget.
    
    Specified by:
    
    hide in interface Widget<O extends OutputManager<?>>
  - highlighted
```
public boolean highlighted()
```
    Get current highlighted state.
    
    Specified by:
    
    highlighted in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    highlighted state.
  - location
```
public Point location()
```
    Get widget location relative to container.
    The method always returns a valid location. If a component has not been assigned location explicitly, the method returns the default location 0,0.
    
    Specified by:
    
    location in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    relative widget location.
  - physicalLocation
```
public NativePoint physicalLocation()
```
    Get widget physical location relative to container, expressed in units native to UI type.
    The method always returns a valid location. If a component has not been assigned location explicitly, the method returns the default location 0,0.
    The value returned by the method is in native (also called physical) units. Native units should not be used by the layout logic but only by the output subsystems.
    
    Specified by:
    
    physicalLocation in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    relative widget location.
  - minimumSize
```
public abstract Dimension minimumSize()
```
    Get widget minimum size.
    
    Specified by:
    
    minimumSize in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget minimum size.
  - name
```
public java.lang.String name()
```
    Get widget name.
    
    Specified by:
    
    name in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget name.
  - parent
```
public Container<O> parent(boolean system)
```
    Get widget parent.
    
    Specified by:
    
    parent in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    system - Set to true to search the system-level widget hierarchy. See BaseEntity.setSystemParent(com.goldencode.p2j.ui.GenericWidget) for more info.
    
    Returns:
    
    widget parent.
  - parent
```
public final <T extends Widget<O>> T parent(java.lang.Class<T> clazz)
```
    Get widget parent of the specified type.
    This method is final as it caches the intermediate value in ancestorCache. Any future sub-implementation must take this into account.
    
    Specified by:
    
    parent in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    clazz - The parent type to return.
    
    Returns:
    
    widget parent.
  - parentObject
```
public <T> T parentObject(java.lang.Class<T> clazz)
```
    Get widget parent of the specified type.
    This method is final as it caches the intermediate value in ancestorCache. Any future sub-implementation must take this into account.
    
    Specified by:
    
    parentObject in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    clazz - The parent type to return.
    
    Returns:
    
    widget parent.
  - parentOrSelf
```
public <T extends Widget<O>> T parentOrSelf(java.lang.Class<T> clazz)
```
    Get this or widget parent of the specified type.
    
    Specified by:
    
    parentOrSelf in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    clazz - The type to return.
    
    Returns:
    
    widget parent or this.
  - parentOrSelfObject
```
public <T> T parentOrSelfObject(java.lang.Class<T> clazz)
```
    Get this or widget parent of the specified type.
    
    Specified by:
    
    parentOrSelfObject in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    clazz - The type to return.
    
    Returns:
    
    widget parent or this.
  - processFocusEvent
```
public void processFocusEvent(FocusEvent event)
```
    Process focus event.
    
    Specified by:
    
    processFocusEvent in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    event - Event to process.
  - processKeyEvent
```
public void processKeyEvent(KeyInput event)
```
    Process key event.
    
    Specified by:
    
    processKeyEvent in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    event - Key event to process.
  - processKeyEventForSelectableWidget
```
protected void processKeyEventForSelectableWidget(KeyInput event)
```
    Process key event for selectable widgets. For selectable widgets process only sensitive widget allows to handke keys. All other cases makes events marked as consumed and will not be processed further.
    
    Parameters:
    
    event - Key event to process.
  - processKeyListeners
```
public void processKeyListeners(KeyInput event)
```
    Process key listeners.
    
    Specified by:
    
    processKeyListeners in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    event - Keyboard event.
  - processDirectManipulationEvent
```
public void processDirectManipulationEvent(DirectManipulationEvent event)
```
    Process direct manipulation event.
    
    Specified by:
    
    processDirectManipulationEvent in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    event - Event to process.
  - repaintEventParentContainer
```
private void repaintEventParentContainer(DirectManipulationEvent event)
```
    Repaint parent container from DirectManipulationEvent event. If container is a nested frame, selectable and selected repaint also the parent frame.
    
    Parameters:
    
    event - Direct manipulation event.
  - repaint
```
public void repaint()
```
    Request widget repainting.
    
    Specified by:
    
    repaint in interface Widget<O extends OutputManager<?>>
  - repaint
```
public void repaint(Rectangle ur)
```
    Request widget repainting. 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.
    
    Specified by:
    
    repaint in interface Widget<O extends OutputManager<?>>
    
    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
```
public void repaint(NativeRectangle rect)
```
    Request widget repainting. 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.
    
    Specified by:
    
    repaint in interface Widget<O extends OutputManager<?>>
    
    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
```
public void requestFocus(boolean force,
                         boolean mouse)
```
    Request focus. This implementation ignores the force parameter as it always sets focus unconditionally.
    
    Specified by:
    
    requestFocus in interface Widget<O extends OutputManager<?>>
    
    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
```
public void requestSync()
```
    Request screen synchronization.
    
    Specified by:
    
    requestSync in interface Widget<O extends OutputManager<?>>
  - screenLocation
```
public Point screenLocation()
```
    Get absolute location of widget in screen coordinates.
    
    Specified by:
    
    screenLocation in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    absolute widget location.
  - screenPhysicalLocation
```
public NativePoint screenPhysicalLocation()
```
    Get absolute location of widget in screen coordinates. The result is in native units.
    
    Specified by:
    
    screenPhysicalLocation in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    absolute widget location.
  - displayPhysicalLocation
```
public NativePoint displayPhysicalLocation()
```
    Get display location of widget in screen coordinates. The result is in native units.
    
    Specified by:
    
    displayPhysicalLocation in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    display widget location.
  - getCachedScreenLocation
```
public final Point getCachedScreenLocation()
```
    Get the cached value of screenLocation().
    
    Returns:
    
    The cached screenLocation. null means no value is cached.
  - getCachedScreenPhysicalLocation
```
public final NativePoint getCachedScreenPhysicalLocation()
```
    Get the cached value of screenPhysicalLocation().
    
    Returns:
    
    The cached screenPhysicalLocation. null means no value is cached.
  - setCachedScreenLocation
```
public final void setCachedScreenLocation(Point p)
```
    Set the cached value for screenLocation(), in screenLocation.
    
    Parameters:
    
    p - The computed location.
  - setCachedScreenPhysicalLocation
```
public final void setCachedScreenPhysicalLocation(NativePoint p)
```
    Set the cached value for screenPhysicalLocation(), in screenPhysicalLocation.
    
    Parameters:
    
    p - The computed location.
  - isScreenLocationCached
```
public final boolean isScreenLocationCached()
```
    Check if either screenLocation or screenPhysicalLocation contains a cached value.
    
    Returns:
    
    true if either of screenLocation or screenPhysicalLocation is not-null.
  - reflectLocationChanged
```
public void reflectLocationChanged()
```
    Called when the widget's location changes. This allows the subclasses to react on this, for example by notifying the driver.
  - reflectAncestorChange
```
public void reflectAncestorChange()
```
    Called when any of the widget's ancestors gets re-assigned. It will clear all cached values (ancestorCache and window).
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Enable/disable widget.
    
    Specified by:
    
    setEnabled in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    enabled - New enabled state.
  - setHidden
```
public void setHidden(boolean hidden)
```
    Tracks the hidden state of the widget.
    
    Specified by:
    
    setHidden in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    hidden - New hidden state.
  - setHighlighted
```
public void setHighlighted(boolean highlighted)
```
    Tracks the highlighted state of the widget.
    
    Specified by:
    
    setHighlighted in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    highlighted - New highlighted state.
  - setLocation
```
public void setLocation(double x,
                        double y)
```
    Set widget relative location. The x value corresponds to COLUMN while y value corresponds to ROW 4GL attribute. Note however that the values are expected to be 0-based.
    
    Specified by:
    
    setLocation in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    x - Widget X.
    
    y - Widget Y.
  - setLocation
```
public void setLocation(Point origin)
```
    Set widget relative location.
    
    Specified by:
    
    setLocation in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    origin - Location to set.
  - setPhysicalLocation
```
public void setPhysicalLocation(int x,
                                int y)
```
    Set widget relative physical location.
    
    Specified by:
    
    setPhysicalLocation in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    x - Widget physical X.
    
    y - Widget physical Y.
  - copyState
```
protected void copyState(Widget<?> w)
```
    Copy the widget state from the specified source widget to this instance.
    
    Parameters:
    
    w - The source widget which state needs to be copied.
  - setPhysicalDimensionInt
```
protected void setPhysicalDimensionInt(int width,
                                       int height)
```
    Set widget physical dimension.
    
    Parameters:
    
    width - Widget physical width.
    
    height - Widget physical height.
  - physicalBounds
```
public NativeRectangle physicalBounds()
```
    Determine the physical bounds, relative to screen, expressed in units native to UI type.
    
    Specified by:
    
    physicalBounds in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    See above.
  - resizeTo
```
public void resizeTo(NativePoint origin,
                     NativeDimension size,
                     boolean raise)
```
    Resize the widget to the specified dimensions.
    
    Specified by:
    
    resizeTo in interface Widget<O extends OutputManager<?>>
    
    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.
  - setParent
```
public final void setParent(Container<O> container)
```
    Set widget parent.
    
    Specified by:
    
    setParent in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    container - Parent to set.
  - setVisible
```
public void setVisible(boolean visible)
```
    Hide/show widget.
    
    Specified by:
    
    setVisible in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    visible - New visible state.
  - setWindow
```
public void setWindow(Window<?> w)
```
    Set a window.
    
    Specified by:
    
    setWindow in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    w - The window
  - show
```
public void show()
```
    Show widget.
    
    Specified by:
    
    show in interface Widget<O extends OutputManager<?>>
  - isTotallyObscured
```
public boolean isTotallyObscured()
```
    Check if widget is totally obscured.
    
    Specified by:
    
    isTotallyObscured in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget is totally obscured.
  - isVisible
```
public boolean isVisible()
```
    Check if widget is visible.
    
    Specified by:
    
    isVisible in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget is visible.
  - isVisible
```
public boolean isVisible(boolean recursive)
```
    Check if widget is visible.
    
    Specified by:
    
    isVisible in interface Widget<O extends OutputManager<?>>
    
    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
```
public boolean isHeader()
```
    Check if widget is part of a header.
    
    Specified by:
    
    isHeader in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget is part of header.
  - forceCursorOnFocus
```
public boolean forceCursorOnFocus()
```
    Check if widget needs in cursor to be on when having the input focus. By default this method always returns true so it needs to be overwritten if other return value is required for particular widget implementation class.
    
    Specified by:
    
    forceCursorOnFocus in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true as the default value.
  - width
```
public abstract double width()
```
    Get widget width.
    
    Specified by:
    
    width in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget width.
  - initialWidth
```
public 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.
    
    Specified by:
    
    initialWidth in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget width.
  - initialHeight
```
public 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.
    
    Specified by:
    
    initialHeight in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget height.
  - disable
```
protected void disable()
```
    Disable widget.
  - enable
```
protected void enable()
```
    Enable widget.
  - updateSizeWorker
```
protected <C extends WidgetConfig> void updateSizeWorker(C beforeUpdate)
```
    Instructs the widget that its size may have changed. The widget updates its state from the associated config instance. It is the responsibility of the caller to call this method only after the config size is set with the new values.
    This implementation uses the supplied config instance to detect whether size has changed. If null is passed in the method does nothing.
    
    Type Parameters:
    
    C - Widget config type.
    
    Parameters:
    
    beforeUpdate - BaseConfig reference or null.
  - autoResize
```
protected <C extends WidgetConfig> void autoResize(C beforeUpdate)
```
    Invoke auto-resize logic if needed
    
    Type Parameters:
    
    C - Widget config type.
    
    Parameters:
    
    beforeUpdate - BaseConfig reference or null.
  - processMnemonic
```
public boolean processMnemonic(int key)
```
    Process the given key, if this widget's mnemonic matches the key. Widgets which can handle mnemonics will override this method.
    
    Specified by:
    
    processMnemonic in interface Widget<O extends OutputManager<?>>
    
    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. Returns false by default.
  - processMnemonicImpl
```
protected final boolean processMnemonicImpl(int key,
                                            MnemonicTrait m)
```
    Common code to process the specific mnemonic key by this widget.
    
    Parameters:
    
    key - The pressed mnemonic key code.
    
    m - The element with mnemonic behavior.
    
    Returns:
    
    true if this widget accepted this mnemonic key. Not enabled or not visible widget will not accept it.
  - processEvent
```
public void processEvent(Event evt)
```
    Process event and dispatch it to specific method.
    
    Specified by:
    
    processEvent in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    evt - Event to process.
  - config
```
public <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. By default widget has no config.
    
    Specified by:
    
    config in interface Widget<O extends OutputManager<?>>
    
    Type Parameters:
    
    W - Config type.
    
    Returns:
    
    Reference to widget config.
  - isFocusable
```
public boolean isFocusable()
```
    Checks whether this widget can receive focus generally.
    
    Specified by:
    
    isFocusable in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if this widget can be focused under certain conditions. false if, and only if, this widget can never receive focus.
  - resolveTitleFont
```
public int resolveTitleFont()
```
    This API is responsible for resolving the font associated with this widget's title. This can be one of the default fonts, a special system font, or an entry in the font-table.
    
    Returns:
    
    See above.
  - resolveFont
```
public int resolveFont()
```
    This API is responsible for resolving the widget's font. This can be one of the default fonts, a special system font, or an entry in the font-table.
    
    Returns:
    
    See above.
  - findMouseSource
```
public Widget<O> findMouseSource(NativePoint p)
```
    Find the widget positioned just bellow the specified mouse position (in physical units).
    
    Specified by:
    
    findMouseSource in interface Widget<O extends OutputManager<?>>
    
    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 mouse portable events, these represent:
    - If the widget is attached to a frame, then is a point relative to the frame's top-left corner (excluding title).
    - If the widget is a window component, then is a point relative to the window's workspace top-left corner
    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.
  - mouseDragged
```
public void mouseDragged(java.awt.event.MouseEvent e)
```
    Notification of a mouse dragged event occurred for this widget. No-op by default.
    
    Specified by:
    
    mouseDragged in interface java.awt.event.MouseMotionListener
    
    Parameters:
    
    e - The mouse event.
  - mouseMoved
```
public void mouseMoved(java.awt.event.MouseEvent e)
```
    Notification of a mouse moved event occurred for this widget. No-op by default.
    
    Specified by:
    
    mouseMoved in interface java.awt.event.MouseMotionListener
    
    Parameters:
    
    e - The mouse event.
  - mouseClicked
```
public void mouseClicked(java.awt.event.MouseEvent e)
```
    Notification of a mouse clicked event occurred for this widget.
    In GUI mode, if the widget has a popup-menu attached, it will display it.
    
    Specified by:
    
    mouseClicked in interface java.awt.event.MouseListener
    
    Parameters:
    
    e - The mouse event.
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Notification of a mouse pressed event occurred for this widget. No-op by default.
    
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
    
    Parameters:
    
    e - The mouse event.
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    Notification of a mouse released event occurred for this widget. No-op by default.
    
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
    
    Parameters:
    
    e - The mouse event.
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e)
```
    Notification of a mouse entered event occurred for this widget. No-op by default.
    
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
    
    Parameters:
    
    e - The mouse event.
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e)
```
    Notification of a mouse exited event occurred for this widget. No-op by default.
    
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
    
    Parameters:
    
    e - The mouse event.
  - mouseWheelMoved
```
public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)
```
    Notification of a mouse wheel moved event occurred for this widget. No-op by default.
    
    Specified by:
    
    mouseWheelMoved in interface java.awt.event.MouseWheelListener
    
    Parameters:
    
    e - The mouse event.
  - destroy
```
public void destroy()
```
    Destroy this widget. Notify all listeners about the widget being destroyed.
    
    Specified by:
    
    destroy in interface Widget<O extends OutputManager<?>>
  - registerWidgetListener
```
public void registerWidgetListener(WidgetListener l)
```
    Register a widget state listener for this widget.
    
    Specified by:
    
    registerWidgetListener in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    l - The widget state listener.
  - unregisterWidgetListener
```
public void unregisterWidgetListener(WidgetListener l)
```
    Unregister a widget state listener for this widget.
    
    Specified by:
    
    unregisterWidgetListener in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    l - The widget state listener.
  - translate
```
public NativePoint translate(java.awt.event.MouseEvent evt)
```
    Translate mouse position relative to this widget. Widget location is relative to container on which is layout. The mouse position is relative to window content pane which is the mouse listener. This function translate mouse position coordinates relative to the widget.
    
    Parameters:
    
    evt - Mouse event.
    
    Returns:
    
    see above.
  - getState
```
public byte getState()
```
    Gets the current state of this component's data.
    
    Specified by:
    
    getState in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    The state of this widget's data (for example ScreenBuffer.UNINITIALIZED).
  - getVisiblePart
```
public Rectangle getVisiblePart()
```
    Gets the sub-rectangle which should be visible.
    
    Specified by:
    
    getVisiblePart in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    The sub-rectangle which should be visible
  - setState
```
public void setState(byte state)
```
    Stores the new state of the component's data.
    
    Specified by:
    
    setState in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    state - The new state (for example ScreenBuffer.CHANGED).
  - clipRectangle
```
public static NativeRectangle clipRectangle(NativePoint origin,
                                            NativeDimension dimension)
```
    Build clipped rectangle for given coordinates.
    
    Parameters:
    
    origin - Physical location.
    
    dimension - Physical dimension.
    
    Returns:
    
    see above.
  - resolvePopupMenuId
```
public int resolvePopupMenuId()
```
    Returns the popup menu effective for this widget. This implementation only considers the @POPUP-MENU@ attribute. In native 4GL popup menus can be overriden, when widgets overlap and both define a popup menu, the one higher in the z-order takes precedence.
    
    Specified by:
    
    resolvePopupMenuId in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    Popup menu id or -1 if no menu is found.
  - clipRectangle
```
protected NativeRectangle clipRectangle()
```
    Build widget clipped rectangle.
    
    Returns:
    
    see above.
  - isRepaintDisabled
```
public boolean isRepaintDisabled()
```
    Returns true if the widget repaint is disabled. This method is needed to support the WINDOW:DISABLE-REDRAW attribute.
    
    Specified by:
    
    isRepaintDisabled in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    See above.
  - _setEnabled
```
private void _setEnabled(boolean enabled)
```
    Update the enabled flag in the configuration and in the widget's state.
    
    Parameters:
    
    enabled - The widget's enabled state.
  - createMouseHoverAction
```
protected MouseHoverAction createMouseHoverAction()
```
    Create handler for processing mouse hover events
    
    Returns:
    
    handler for processing mouse hover events
  - _setVisible
```
public void _setVisible(boolean visible)
```
    Update the visible flag in the configuration and in the widget's state.
    
    Parameters:
    
    visible - The widget's visible state.
  - _setHidden
```
public void _setHidden(boolean hidden)
```
    Update the hidden flag in the configuration and in the widget's state.
    
    Parameters:
    
    hidden - The widget's hidden state.
  - raiseLegacyMouseEvents
```
public boolean raiseLegacyMouseEvents()
```
    Check if the widget implementation can raise legacy, 4GL-style, mouse events.
    
    Specified by:
    
    raiseLegacyMouseEvents in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    Always true.
  - sync
```
public void sync()
```
    Determine the widget's window and synchronize output with physical terminal.
    
    See Also:
    
    OutputManager.sync(int)
  - refresh
```
public void refresh(Rectangle rect)
```
    Determine the widget's window and mark a rectangle as needing repainting.
    
    Parameters:
    
    rect - rectangle to mark for repainting
    
    See Also:
    
    OutputManager.refresh(int, Rectangle)
  - clear
```
public void clear(Point origin,
                  Dimension size,
                  Color color)
```
    Determine the widget's window and clear specified area of the screen.
    
    Parameters:
    
    origin - Upper left corner of the area to clear.
    
    size - Dimensions of the area.
    
    color - Color.
    
    See Also:
    
    OutputManager.clear(int, NativePoint, NativeDimension, Color)
  - getAndResetBitmap
```
public ScreenBitmap getAndResetBitmap()
```
    Determine the widget's window, get a copy of the current screen bitmap and reset clipping entirely. All screen positions become available for output. The previous state can be restored using setBitmap() method.
    
    Returns:
    
    a copy of the current screen bitmap.
    
    See Also:
    
    OutputManager.getAndResetBitmap(int)
  - resetBitmap
```
public void resetBitmap()
```
    Determine the widget's window and reset the screen bitmap.
    
    See Also:
    
    OutputManager.resetBitmap(int)
  - getAndSetBitmap
```
public ScreenBitmap getAndSetBitmap(Rectangle rect)
```
    Determine the widget's window, get a copy of the current screen bitmap and clip output further so it is guaranteed not to go outside of the provided rectangle.
    
    Parameters:
    
    rect - The extra clipping rectangle. null has no effect on clipping.
    
    Returns:
    
    a copy of the current screen bitmap.
    
    See Also:
    
    OutputManager.getAndSetBitmap(int, Rectangle)
  - getBitmapCopy
```
public ScreenBitmap getBitmapCopy()
```
    Determine the widget's window and get a copy of the current screen bitmap.
    
    Returns:
    
    a copy of the current screen bitmap.
    
    See Also:
    
    OutputManager.getBitmapCopy(int)
  - setBitmap
```
public void setBitmap(ScreenBitmap bitmap)
```
    Determine the widget's window and restore the bitmap to a previous state.
    
    Parameters:
    
    bitmap - The bitmap instance to set as the output primitive's bitmap.
    
    See Also:
    
    OutputManager.setBitmap(int, ScreenBitmap)
  - clipWith
```
public void clipWith(Rectangle rect)
```
    Determine the widget's window and add a new clipping rectangle to the bitmap. If the rectangle is null, fill the entire bitmap with true values. Else, if the bitmap was just reset, fill it with false values and set the clipping region to true.
    
    Parameters:
    
    rect - The clipping rectangle to be added.
    
    See Also:
    
    OutputManager.clipWith(int, Rectangle)
  - screenHeight
```
public double screenHeight()
```
    Determine the widget's window and get the number of rows on the screen.
    
    Returns:
    
    The number of rows (lines of characters).
  - getTextWidthNative
```
public int getTextWidthNative(java.lang.String txt,
                              int font)
```
    Compute the text width using GuiDriver.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>).
    
    Parameters:
    
    txt - The text.
    
    font - The font index in the font table.
    
    Returns:
    
    The text width.
    
    See Also:
    
    getTextWidth(String, int, boolean)
  - getTextWidthNative
```
public int getTextWidthNative(java.lang.String txt,
                              FontDetails font)
```
    Compute the text width using GuiDriver.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>).
    
    Parameters:
    
    txt - The text.
    
    font - The font details.
    
    Returns:
    
    The text width.
    
    See Also:
    
    getTextWidth(String, FontDetails, boolean)
  - getTextHeightNative
```
public int getTextHeightNative(java.lang.String txt,
                               FontDetails font)
```
    Compute the text height using GuiDriver.getTextHeight(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>).
    
    Parameters:
    
    txt - The text.
    
    font - The font details.
    
    Returns:
    
    The text height.
  - getTextWidth
```
public int getTextWidth(java.lang.String txt,
                        int font)
```
    Compute the text width using FontManager.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, com.goldencode.p2j.ui.client.FontDetails, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>).
    
    Parameters:
    
    txt - The text.
    
    font - The font index in the font table.
    
    Returns:
    
    The text width.
    
    See Also:
    
    getTextWidth(String, int, boolean)
  - getTextWidth
```
public int getTextWidth(java.lang.String txt,
                        FontDetails font)
```
    Compute the text width using FontManager.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, com.goldencode.p2j.ui.client.FontDetails, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>).
    
    Parameters:
    
    txt - The text.
    
    font - The font details.
    
    Returns:
    
    The text width.
    
    See Also:
    
    getTextWidth(String, int, boolean)
  - getTextHeightNative
```
public int getTextHeightNative(java.lang.String txt,
                               int font)
```
    Compute the text height using GuiDriver.getTextHeight(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>).
    
    Parameters:
    
    txt - The text.
    
    font - The font index in the font table.
    
    Returns:
    
    The text height.
    
    See Also:
    
    getTextHeight(String, int, boolean)
  - getTextHeight
```
public int getTextHeight(java.lang.String txt,
                         int font)
```
    Compute the text height using FontManager.getTextHeight(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, int, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>).
    
    Parameters:
    
    txt - The text.
    
    font - The font index in the font table.
    
    Returns:
    
    The text height.
    
    See Also:
    
    getTextHeight(String, int, boolean)
  - screenWidth
```
public double screenWidth()
```
    Determine the widget's window and get the number of columns on the screen.
    
    Returns:
    
    The number of columns (in characters).
  - screenDimension
```
public Dimension screenDimension()
```
    Determine the widget's window and get the screen dimensions.
    
    Returns:
    
    screen dimension.
  - manageSystemActions
```
public boolean manageSystemActions()
```
    Check if the current widget can manage non-global system actions on its own, and not via the enclosing event loop.
    
    Returns:
    
    true if the widget has its own event management. false by default.
  - getSelectedText
```
public java.lang.String getSelectedText()
```
    Obtain any selected text in the widget for copying to the clipboard.
    
    Specified by:
    
    getSelectedText in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    The selected text or null if there is no selected text or if the widget type does not support clipboard operations.
  - getDefaultEvent
```
public int getDefaultEvent(KeyInput key,
                           boolean inEditingBlock)
```
    Get the default event associated for this widget and the given key.
    
    Parameters:
    
    key - The current key.
    
    inEditingBlock - true if EDITING mode is active.
    
    Returns:
    
    The action code for the widget's default event.
  - processSystemKey
```
public void processSystemKey(KeyInput key)
```
    Process the action associated with the given key in an independent drawing bracket.
    This must be called only in the context of widget-level event processing.
    
    Parameters:
    
    key - The key to be processed.
  - ignoreAction
```
public boolean ignoreAction(int action)
```
    Check if the given event needs to be ignored, as it can't be treated by the widget.
    
    Parameters:
    
    action - The event code.
    
    Returns:
    
    See above.
  - afterConfigUpdateBase
```
public <C extends WidgetConfig> void afterConfigUpdateBase(C 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.
    
    Type Parameters:
    
    C - Widget config type.
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - isDirectManipulationActive
```
public boolean isDirectManipulationActive()
```
    Check if direct manipulation is active for this widget.
    
    Specified by:
    
    isDirectManipulationActive in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if direct manipulation is active false if not.
  - setDirectManipulationActive
```
public void setDirectManipulationActive(boolean isActive)
```
    Sets direct manipulation active flag value for this widget.
    
    Specified by:
    
    setDirectManipulationActive in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    isActive - The new value for the flag.
  - isDirectManipulationActiveOrInUIB
```
public boolean isDirectManipulationActiveOrInUIB()
```
    Check if direct manipulation is active for this or widget is in UIB mode.
    
    Specified by:
    
    isDirectManipulationActiveOrInUIB in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if direct manipulation is active false if not.
  - activateDirectManipulation
```
public void activateDirectManipulation()
```
    Activates direct manipulation engine for this widget.
  - deactivateDirectManipulation
```
public void deactivateDirectManipulation()
```
    Deactivates direct manipulation engine for this widget.
  - isDirectManipulationCapable
```
protected boolean isDirectManipulationCapable()
```
    Checks if direct manipulation feature can be used for this widget. Only GUI mode can be used with the feature and not with all widget types.
    
    Returns:
    
    TRUE if direct manipulation is available, FALSE otherwise.
  - 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.
    
    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<O extends OutputManager<?>>
    
    Parameters:
    
    sensitive - The new value for the flag.
  - widgetRealized
```
protected void widgetRealized()
```
    Fired when the widget becomes realized.
  - debug
```
public void debug(java.lang.String message)
```
    Utility method for debugging, can be used to include information from the server-side to the client-side log
    
    Parameters:
    
    message - String parameter
  - isTabStop
```
public boolean isTabStop()
```
    Check the value of the TAB-STOP attribute
    
    Specified by:
    
    isTabStop in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    the value of the attribute or true if not applicable
  - postprocessConfig
```
public void postprocessConfig()
```
    Additional processing required when widget configuration is updated AFTER the frame layout has been performed.
    
    Specified by:
    
    postprocessConfig in interface Widget<O extends OutputManager<?>>
  - moveToBottom
```
public boolean moveToBottom()
```
    Moves this widget to the bottom of other widgets in the z-ordering.
    
    Specified by:
    
    moveToBottom in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if operation was successful and false otherwise.
  - moveToTop
```
public boolean moveToTop()
```
    Moves this widget to the top of other widgets in the z-ordering.
    
    Specified by:
    
    moveToTop in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if operation was successful and false otherwise.
  - getZOrderClass
```
public ZOrderClass getZOrderClass()
```
    Get the Z-Order class
    
    Specified by:
    
    getZOrderClass in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    Z-Order class of the widget
  - getMenuMouse
```
public int getMenuMouse()
```
    Get the value of the MENU-MOUSE attribute
    
    Specified by:
    
    getMenuMouse in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    the value of the attribute
  - getMouseActions
```
public org.roaringbitmap.RoaringBitmap getMouseActions()
```
    Get the mouse actions on which this widget can respond.
    
    Specified by:
    
    getMouseActions in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    The mouseActions().
  - disableTooltip
```
public void disableTooltip()
```
    Disable the tooltipActive flag and reset the mouseActions, so they will be rebuilt next time this widget is processed to be sent to the JS web driver.
  - enableTooltip
```
public void enableTooltip()
```
    Enable the tooltipActive flag and reset the mouseActions, so they will be rebuilt next time this widget is processed to be sent to the JS web driver.
  - isThreeD
```
public boolean isThreeD()
```
    If the method returns true the widget should be represented with 3D visuals.
    This implementation forwards the call to isThreeD() of the parent frame. If no parent frame exists for this widget the method returns false.
    
    Specified by:
    
    isThreeD in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    see above.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of the object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of the object.
  - setMousePointer
```
public void setMousePointer(MousePtrWrapper ptr)
```
    Set the custom mouse pointer
    
    Specified by:
    
    setMousePointer in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    ptr - the custom mouse pointer
  - setMousePointer
```
public void setMousePointer(int windowId,
                            MousePtrWrapper ptr)
```
    Set the custom mouse pointer
    
    Specified by:
    
    setMousePointer in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    windowId - the window's ID
    
    ptr - the custom mouse pointer
  - getLoadedMousePointer
```
public java.util.Optional<MousePtrWrapper> getLoadedMousePointer()
```
    Get the Loaded custom mouse pointer if it is set
    
    Specified by:
    
    getLoadedMousePointer in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    the loaded custom mouse pointer if it is set
  - getCustomMousePointer
```
public java.util.Optional<MousePtrWrapper> getCustomMousePointer()
```
    Get the current custom mouse pointer if it is set
    
    Specified by:
    
    getCustomMousePointer in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    the current custom mouse pointer if it is set
  - getEffectiveMousePointer
```
public MousePtrWrapper getEffectiveMousePointer()
```
    Get the current effective custom mouse pointer
    
    Specified by:
    
    getEffectiveMousePointer in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    the current effective custom mouse pointer
  - getActualBounds
```
public NativeRectangle getActualBounds()
```
    Get the widget's actual bounds
    
    Specified by:
    
    getActualBounds in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    widget's actual bounds
  - isRMBEntrySupported
```
public boolean isRMBEntrySupported()
```
    Check if this widget gains ENTRY event when right/middle mouse button is clicked.
    
    Specified by:
    
    isRMBEntrySupported in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if this widget gains ENTRY event when right/middle mouse button is clicked.
  - clearWidget
```
public boolean clearWidget()
```
    Clear widget state on CLEAR FRAME call for the parent frame.
    
    Specified by:
    
    clearWidget in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true on success. false if CLEAR cannot be applied to this widget, e.g. if it is static text.
  - updateSystemParent
```
protected void updateSystemParent(BaseConfig bcBefore)
```
    Updates system parent with new ID came from server.
    
    Parameters:
    
    bcBefore - Config reference capturing the config state before the owner's config was modified.
  - mouseActions
```
protected int[] mouseActions()
```
    Sub-classes will override this to return a list of mouse actions on which the widget responds. This is compatible with the AWT MouseEvent codes and P2J specific MouseEvt actions.
    If null, it means the widget does not respond to mouse events.
    
    Returns:
    
    See above.
  - prepParentLocation
```
protected Point prepParentLocation(Widget<?> parent)
```
    Trick, that lets to correct parent location in cases, when it needed, for example for menus.
    
    Parameters:
    
    parent - Parent component.
    
    Returns:
    
    corrected parent location.
  - supportsCustomMousePointer
```
public boolean supportsCustomMousePointer()
```
    Check if the widget supports LOAD-MOUSE-POINTER() method
    
    Specified by:
    
    supportsCustomMousePointer in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if the widget supports LOAD-MOUSE-POINTER() method
  - enclosingFrame
```
public java.util.Optional<Frame<?>> enclosingFrame()
```
    Get the enclosing FRAME if it exists
    
    Specified by:
    
    enclosingFrame in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    the enclosing FRAME if it exists
  - unrealize
```
public void unrealize()
```
    Unrealize this widget.
    
    Specified by:
    
    unrealize in interface Widget<O extends OutputManager<?>>
  - widgetStateChanged
```
public void widgetStateChanged()
```
    Notification that this widget's state has changed (visibility, sensitivity, z-order).
    
    Specified by:
    
    widgetStateChanged in interface Widget<O extends OutputManager<?>>
  - showPopupMenu
```
public Menu<O> showPopupMenu(java.awt.event.MouseEvent e,
                             java.lang.Runnable dismissHandler)
```
    The method shows the popup menu for this widget. The menu is resolved with the help of resolvePopupMenuId().
    
    Parameters:
    
    e - The related mouse event that caused a popup to be shown. May be null, in this case the location for popup is determined from current mouse cursor position.
    
    dismissHandler - When not null, the runnable instance is executed when the popup menu is dismissed, regardless whether an item is chosen or not.
    
    Returns:
    
    Returns the popup menu shown or null if no popup is resolved for this 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<O extends OutputManager<?>>
    
    Returns:
    
    mouse cursor position, never null.
  - triggerLocationChanged
```
protected void triggerLocationChanged()
```
    Triggers the location changed event for the widget.
  - reflectSizeChanged
```
protected void reflectSizeChanged()
```
    Reflects the size change of the widget by invoking the "sizeChanged" method on all registered WidgetDimensionsListener listeners. If no listeners are registered, this method has no effect.
  - reflectVisibilityChanged
```
private void reflectVisibilityChanged()
```
    Reflects the visibility change of the widget by invoking the 'visibilityChanged' method on the registered listeners of type 'WidgetVisibilityListener'. If there are no listeners registered, this method does nothing.
  - getTextWidth
```
private int getTextWidth(java.lang.String txt,
                         FontDetails font,
                         boolean useNative)
```
    Compute the width of the given text, using the specified font in the widget's window. If the useNative flag is set, then the width is computed directly from the driver. Otherwise, FontManager.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, com.goldencode.p2j.ui.client.FontDetails, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>) is used to determine the width: the custom text metrics are interrogated first via and, if not found, it fallbacks to using the driver to determine the width.
    
    Parameters:
    
    txt - The text.
    
    font - Font details.
    
    useNative - Flag indicating that the GuiDriver.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>) needs to be used.
    
    Returns:
    
    The text width.
  - getTextWidth
```
private int getTextWidth(java.lang.String txt,
                         int font,
                         boolean useNative)
```
    Compute the width of the given text, using the specified font in the widget's window. If the useNative flag is set, then the width is computed directly from the driver. Otherwise, FontManager.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, com.goldencode.p2j.ui.client.FontDetails, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>) is used to determine the width: the custom text metrics are interrogated first via and, if not found, it fallbacks to using the driver to determine the width.
    
    Parameters:
    
    txt - The text.
    
    font - The font index in the font table.
    
    useNative - Flag indicating that the GuiDriver.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>) needs to be used.
    
    Returns:
    
    The text width.
  - getTextWidth
```
private int getTextWidth(java.lang.String txt,
                         FontDetails font,
                         int fontNum,
                         boolean useNative)
```
    Compute the width of the given text, using the specified font in the widget's window. If the useNative flag is set, then the width is computed directly from the driver. Otherwise, FontManager.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, com.goldencode.p2j.ui.client.FontDetails, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>) is used to determine the width: the custom text metrics are interrogated first via and, if not found, it fallbacks to using the driver to determine the width.
    
    Parameters:
    
    txt - The text.
    
    font - The font details. Leave it null to specify the font by fontNum.
    
    fontNum - Font number. If font is not null, it is ignored.
    
    useNative - Flag indicating that the GuiDriver.getTextWidth(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>) needs to be used.
    
    Returns:
    
    The text width.
  - getTextHeight
```
private int getTextHeight(java.lang.String txt,
                          int font,
                          boolean useNative)
```
    Compute the height of the given text, using the specified font in the widget's window. If the useNative flag is set, then the height is computed directly from the driver. Otherwise, FontManager.getTextHeight(java.lang.String, com.goldencode.p2j.ui.client.Window<?>, int, com.goldencode.p2j.ui.client.driver.ScreenDriver<?>) is used to determine the height: the custom text metrics are interrogated first via and, if not found, it fallbacks to using the driver to determine the height.
    
    Parameters:
    
    txt - The text.
    
    font - The font index in the font table.
    
    useNative - Flag indicating that the GuiDriver.getTextHeight(java.lang.String, com.goldencode.p2j.ui.client.FontDetails<F>) needs to be used.
    
    Returns:
    
    The text height.
  - doTriggerContainerStateRedrawEnabled
```
private void doTriggerContainerStateRedrawEnabled(AbstractContainer<O> c)
```
    Calls AbstractContainer.triggerContainerStateRedrawEnabled() on the supplied container and all containers recursively down the widget tree.
    
    Parameters:
    
    c - The root container.
  - isTheSameFrame
```
private boolean isTheSameFrame(Container<O> frameToTest)
```
    Checks if the given container is the same frame as the current one.
    
    Parameters:
    
    frameToTest - The frame container candidate to test against the current one.
    
    Returns:
    
    TRUE if the container the same frame, FALSE otherwise.
  - isMouseDrag
```
protected boolean isMouseDrag(java.awt.event.MouseEvent e)
```
    Check for drag operation.
    
    Parameters:
    
    e - The mouse event.
    
    Returns:
    
    true if is a drag in progress.
  - onOleDragging
```
protected void onOleDragging(java.awt.event.MouseEvent e,
                             Widget<?> widget)
```
    Called when OLE Dragging.
    
    Parameters:
    
    e - The mouse event.
    
    widget - Source widget.
  - onOleDropEnd
```
protected void onOleDropEnd(java.awt.event.MouseEvent e,
                            Widget<?> widget)
```
    Called when a OLE Drop operation is ended.
    
    Parameters:
    
    e - The mouse event.
    
    widget - Target widget.
  - oleDrag
```
public void oleDrag()
```
    Start an OLE drag/drop event with the given control as the source. Manual dragging.
    
    Specified by:
    
    oleDrag in interface Widget<O extends OutputManager<?>>
  - oleDoDrop
```
protected void oleDoDrop(java.awt.event.MouseEvent e)
```
    Called when an automatic OLE Drop operation is ended.
    
    Parameters:
    
    e - The mouse event.
  - oleStartDragging
```
protected boolean oleStartDragging(java.awt.event.MouseEvent e)
```
    Called when an automatic OLE Drag operation is started.
    
    Parameters:
    
    e - The mouse event.
    
    Returns:
    
    true if is a drag source has been selected.
  - oleDragging
```
protected void oleDragging(java.awt.event.MouseEvent e)
```
    Called on OLE Dragging.
    
    Parameters:
    
    e - The mouse event.
  - preventFocusWhenMouseDownEventDefined
```
public boolean preventFocusWhenMouseDownEventDefined()
```
    Test if this widget must prevent receiving focus on mouse-down event. The default is true.
    
    Specified by:
    
    preventFocusWhenMouseDownEventDefined in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    see above.
  - hasTooltip
```
public boolean hasTooltip()
```
    Check if widget has tooltip.
    
    Specified by:
    
    hasTooltip in interface Widget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget has tooltip.

Class AbstractWidget<O extends OutputManager<?>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

LOG

listeners

enabled

firstEnabledDisabled

hidden

highlighted

visible

focusListeners

keyListeners

parent

window

ancestorCache

popupKeyListnrAdded

screen

mouseActions

location

physicalLocation

insets

nativeInsets

mousePtr

mouseHoverAction

directManipulationActive

screenLocation

screenPhysicalLocation

isOleDragDrop

tooltipActive

sensitiveInDirectManipulation

Constructor Detail

AbstractWidget

Method Detail

copyColors

getId

screen

addFocusListener

addKeyListener

ancestor

ancestorId

window

topLevelWindow

bounds

insets

dimension

physicalDimension

isDisplayed

isRealized

draw

drawCaret

isEnabled

focusTraversable

navigable

forceVisibility

hasFocus

isCurrent

height

hidden

hide

highlighted

location

physicalLocation

minimumSize

name

parent

parent

parentObject

parentOrSelf

parentOrSelfObject

processFocusEvent

processKeyEvent

processKeyEventForSelectableWidget

processKeyListeners

processDirectManipulationEvent

repaintEventParentContainer

repaint