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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AlertBoxGuiImpl.ButtonsPanel, AlertBoxGuiImpl.MessagePanel, BorderedPanel, BrowseColumn, BrowseConfirmPanel, DriverWidgetHost, EditorGuiImpl.EditorContent, FileDialogGuiImpl.NavigationPane, FileDialogGuiImpl.ToolsPane, FixedSizeContainer, Frame, GenericContainer, ImageListGuiImpl, LabeledPanel, Menu, RadioButton, ScrollBar, ScrollContainer, ScrollPane, SubMenu, SubMenuGuiImpl.SubMenuBody, TabSetGuiImpl, TabSetGuiImpl.TabSetItem, TextCell, TitledWindow, TreeListCaption, Viewport, WindowTitleBar
```
public abstract class AbstractContainer<O extends OutputManager<?>>
extends AbstractWidget<O>
implements Container<O>
```
Abstract widget container.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private static class AbstractContainer.WorkArea
Stores global data relating to the state of the current context.

Nested Classes
Modifier and Type	Class and Description
`private static class`	`AbstractContainer.WorkArea` Stores global data relating to the state of the current context.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.util.List<ContainerStateListener<O>>`	`containerStateListeners` List of container state listeners
`private Widget<O>`	`current` Current (in focus) widget.
`private java.util.Set<Widget<?>>`	`ignoreFocusSet` The set of widgets that are never selected for focus - they are ignored by checkWidget(Widget, boolean).
`private java.util.ArrayList<Widget<O>>`	`incomingSystemWidgets` Widgets that were relocated from another container to this container using `BaseEntity.setSystemParent(GenericWidget)`
`private Insets`	`insets` Container insets.
`private LayoutManager<O>`	`layoutManager` Layout manager.
`private static CentralLogger`	`LOG` logger
`private java.util.ArrayList<Widget<O>>`	`outgoingSystemWidgets` Widgets that were relocated from this container to another container using `BaseEntity.setSystemParent(GenericWidget)`.
`private java.util.Set<Widget<O>>`	`selectedWidgets` Widgets which are stated to be selected in this container
`private Dimension`	`size` Container size.
`private java.util.List<Widget<O>>`	`tabItemList` The tab item list for this container.
`private WidgetId`	`topLevelWidgetId` The widget ID we need to ensure be on the top.
`private java.util.ArrayList<Widget<O>>`	`widgets` Widgets stored in the container.
`private static ContextLocal<AbstractContainer.WorkArea>`	`work` Stores context-local state variables.

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

Constructor Summary

Constructors
Constructor and Description

AbstractContainer()
Constructor.

Constructors
Constructor and Description
`AbstractContainer()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Container<O>`	`add(int pos, Widget<O> widget)` Add the widget on the specified position.
`Container<O>`	`add(Widget<O> widget)` Add widget to container.
`Container<O>`	`add(Widget<O> before, Widget<O> widget)` Add the widget before the specified widget.
`void`	`addContainerStateListener(ContainerStateListener<O> listener)` Adds container state listener.
`protected void`	`addDirectly(Widget<O> widget)` Add widget directly to the list without triggering repaint or other operations.
`(package private) void`	`addIncomingSystemWidget(Widget<O> widget)` Adds a widget to the list of incoming system widgets.
`(package private) void`	`addOutgoingSystemWidget(Widget<O> widget)` Adds a widget to the list of outgoing system widgets.
`protected boolean`	`belongsTo(Widget<O> widget)` Check if specified widget belongs to this container.
`protected boolean`	`checkWidget(Widget<O> widget, boolean direction)` Check potential focus candidate and set focus on it if it matches criteria.
`Point`	`childrenLocation(Widget<O> child)` Get children location for one child.
`boolean`	`clipping()` This method should be overridden in a container that allows clipping.
`protected NativeRectangle`	`clipRectangle(NativePoint origin, NativeDimension dimension, boolean children)` Build clipped rectangle for given coordinates.
`protected void`	`copyState(Widget<?> w)` Copy the widget state from the specified source widget to this instance.
`Widget<O>`	`currentFocus()` Get widget which is in focus.
`Widget<O>`	`currentFocus(boolean recurse)` Get widget which is in focus.
`protected void`	`cycleFocus(boolean direction)` Search for the next or previous focusable widget in this container and set focus on it.
`Widget<O>`	`defaultFocus()` Get default focusable widget.
`void`	`deregisterSelectedWidget(Widget<O> widget)` Deregister a widget from the list of selected widgets.
`void`	`destroy()` Destroy this widget.
`void`	`detach(Widget<O> widget)` Detach this widget from this container.
`Dimension`	`dimension()` Get widget dimension.
`void`	`doLayout()` Lay out container.
`void`	`draw()` Draw widget.
`void`	`dumpCurrentWidgets()` Outputs the string-formatted chain of current widgets starting from this container level.
`void`	`dumpWidgets()` Dumps to console the tree of widgets.
`private void`	`dumpWidgets(java.lang.String indent)` Dumps to console the tree of widgets.
`void`	`endSizeChange(boolean repaint)` Indicates the ending of the resize process.
`Widget<O>`	`findMouseSource(NativePoint p)` Find the widget positioned just bellow the specified mouse position (in physical units).
`void`	`firstFocus()` Set focus to first focusable widget.
`Widget<O>`	`focus()` Returns the focused direct child Component.
`boolean`	`focusTraversable()` Check if widget is focus traversable.
`protected void`	`focusWorker(boolean direction)` Search for the next or previous focusable widget in the container and set focus on it.
`private java.lang.String`	`formatCurrentWidgets(java.lang.String indent)` Formats the chain of current widgets starting from this container level.
`protected java.lang.String`	`formatDump()` Formats this widget for a debug dump.
`Widget<O>`	`get(int index)` Get widget for provided index or `null` if no such component exists.
`java.util.Collection<Widget<O>>`	`getAllSelectedWidgets()` Retrieve all widgets which are registered as selected in this container.
`Rectangle`	`getClipRect()` Get clipping rectangle.
`private java.util.List<Widget<O>>`	`getDrawableWidgets()` Get the widgets which can be drawn, from this container.
`Dimension`	`getEffectiveScrollableSize()` Calculates the effective size of the scrollable area of this container.
`Widget<O>`	`getFocusInt()` Get focused widget.
`java.util.Set<Widget<?>>`	`getIgnoreFocus()` Returns the set of widgets that are never selected for focus.
`LayoutManager<O>`	`getLayout()` Get active layout manager for the container.
`Dimension`	`getScrollableSize()` Returns the preferred size of the scrollable area of this container.
`java.util.List<Widget<O>>`	`getTabItemList()` Returns the tab item list for this container.
`boolean`	`hasFocusable(Widget<O> exclude)` Reports if there is at least 1 focusable widget that is not the given widget.
`double`	`height()` Get widget height.
`Insets`	`insets()` Get container insets.
`void`	`lastFocus()` Set focus to last focusable widget.
`private Widget<O>`	`locateFocusTraversable(java.lang.Iterable<Widget<O>> iter)` Helper method for traversing widgets in the container.
`Dimension`	`minimumSize()` Get widget minimum size.
`void`	`moveAfterTabItem(Widget<O> widget, Widget<O> after)` Move specified widget after the widget "after".
`void`	`moveBeforeTabItem(Widget<O> widget, Widget<O> before)` Move specified widget before the widget "before".
`void`	`moveToBottom(Widget<O> widget)` Mode specified widget to the bottom of the widget list.
`boolean`	`moveToBottomInClass(Widget<O> widget)` Move the specified widget to the bottom of the widget list considering Z-order class.
`void`	`moveToTop(Widget<O> widget)` Move specified widget to the top of widget list.
`boolean`	`moveToTopInClass(Widget<O> widget)` Move the specified widget to the top of widget list considering Z-order class.
`void`	`moveToZpos(Widget<O> widget, int pos)` Move widget to specified position in the widget list.
`void`	`nextFocus()` Select next focusable widget.
`void`	`normalizeZOrder()` Reorder widgets according to their ZOrderClass retaining the order within the class
`protected void`	`onWidgetAdded(Widget<O> w)` The method is called when a widget is added to the container.
`protected void`	`onWidgetRemoved(Widget<O> w)` The method is called when a widget is removed from the container.
`void`	`paintOnTop(WidgetId widgetId)` Mark specified widget ID to be on the top of the painting order.
`boolean`	`parentOf(Widget<O> w)` The method returns `true` if this container is parent of the supplied widget.
`protected java.util.List<Widget<O>>`	`prepareWidgets(java.util.List<Widget<O>> widgets)` Prepare widgets before drawing
`void`	`prevFocus()` Select previous focusable widget.
`void`	`processKeyEvent(KeyInput event)` Process key event.
`void`	`reflectAncestorChange()` Called when any of the widget's ancestors gets re-assigned.
`void`	`reflectLocationChanged()` Called when the widget's location changes.
`void`	`registerSelectedWidget(Widget<O> widget)` Register a widget to the list of selected widgets.
`void`	`remove(Widget<O> widget)` Remove specified widget from the widget list.
`void`	`removeContainerStateListener(ContainerStateListener<O> listener)` Removes container state listener.
`(package private) void`	`removeIncomingSystemWidget(Widget<O> widget)` Removes a widget from the list of incoming system widgets.
`(package private) void`	`removeOutgoingSystemWidget(Widget<O> widget)` Removes a widget from the list of outgoing system widgets.
`void`	`repaint()` Request widget repainting.
`void`	`replace(Widget<O> oldWidget, Widget<O> newWidget)` Replace specified widget with another with preserving widget Z-order.
`void`	`requestFocus(boolean force)` Request focus.
`void`	`requestFocus(boolean force, boolean mouse)` Request focus.
`void`	`setFocus(Widget<O> focus)` Set focus to specified widget.
`void`	`setFocusInt(Widget<O> focus)` Set focus to specified widget.
`void`	`setHeight(double height)` Set container height.
`void`	`setIgnoreFocus(java.util.Collection<Widget<?>> widgets)` Sets the set of widgets that are never selected for focus.
`void`	`setInsets(Insets insets)` Set container insets.
`void`	`setLayout(LayoutManager<O> manager)` Set layout manager for the container.
`protected void`	`setPhysicalDimensionInt(int width, int height)` Set widget physical dimension.
`void`	`setSize(Dimension size)` Set container size.
`void`	`setSize(double width, double height)` Set container size.
`void`	`setTabItemList(java.util.List<Widget<O>> tabItemList)` Sets the tab item list for this container.
`void`	`setWidth(double width)` Set container width.
`void`	`startSizeChange(boolean saveOldRect)` Indicates the beginning of the resize process.
`void`	`swap(int first, int second)` Swap two widgets given by their indices i and j.
`void`	`triggerContainerStateRedrawEnabled()` The method is called when DISABLE-REDRAW is assigned to true on the container or a widget in the container.
`void`	`unrealize()` Unrealize this container and all its children.
`protected <C extends WidgetConfig> void`	`updateSizeWorker(C beforeUpdate)` Instructs the widget that its size may have changed.
`Widget<O>[]`	`widgets()` Get all widgets stored in the container.
`java.util.List<Widget<O>>`	`widgetsAsList(boolean system)` Get all widgets stored in the container.
`void`	`widgetStateChanged()` Notification that this widget's state has changed (visibility, sensitivity, z-order).
`double`	`width()` Get widget width.

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

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

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

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

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

- Field Detail
  - LOG
```
private static final CentralLogger LOG
```
    logger
  - work
```
private static final ContextLocal<AbstractContainer.WorkArea> work
```
    Stores context-local state variables.
  - layoutManager
```
private LayoutManager<O extends OutputManager<?>> layoutManager
```
    Layout manager.
  - current
```
private Widget<O extends OutputManager<?>> current
```
    Current (in focus) widget.
  - insets
```
private Insets insets
```
    Container insets.
  - size
```
private Dimension size
```
    Container size.
  - widgets
```
private java.util.ArrayList<Widget<O extends OutputManager<?>>> widgets
```
    Widgets stored in the container.
  - selectedWidgets
```
private java.util.Set<Widget<O extends OutputManager<?>>> selectedWidgets
```
    Widgets which are stated to be selected in this container
  - incomingSystemWidgets
```
private java.util.ArrayList<Widget<O extends OutputManager<?>>> incomingSystemWidgets
```
    Widgets that were relocated from another container to this container using BaseEntity.setSystemParent(GenericWidget)
  - outgoingSystemWidgets
```
private java.util.ArrayList<Widget<O extends OutputManager<?>>> outgoingSystemWidgets
```
    Widgets that were relocated from this container to another container using BaseEntity.setSystemParent(GenericWidget).
  - tabItemList
```
private java.util.List<Widget<O extends OutputManager<?>>> tabItemList
```
    The tab item list for this container.
  - ignoreFocusSet
```
private java.util.Set<Widget<?>> ignoreFocusSet
```
    The set of widgets that are never selected for focus - they are ignored by checkWidget(Widget, boolean).
  - containerStateListeners
```
private java.util.List<ContainerStateListener<O extends OutputManager<?>>> containerStateListeners
```
    List of container state listeners
  - topLevelWidgetId
```
private WidgetId topLevelWidgetId
```
    The widget ID we need to ensure be on the top.
- Constructor Detail
  - AbstractContainer
```
public AbstractContainer()
```
    Constructor.
- Method Detail
  - add
```
public Container<O> add(Widget<O> widget)
```
    Add widget to container.
    
    Specified by:
    
    add in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - Widget to add.
    
    Returns:
    
    this for fluent syntax support.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the argument is null or instance of TopLevelWindow
  - add
```
public Container<O> add(int pos,
                        Widget<O> widget)
```
    Add the widget on the specified position.
    
    Specified by:
    
    add in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    pos - The widget's position.
    
    widget - The child widget to add.
    
    Returns:
    
    this for fluent syntax support.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the argument is null or instance of TopLevelWindow
  - add
```
public Container<O> add(Widget<O> before,
                        Widget<O> widget)
```
    Add the widget before the specified widget.
    
    Specified by:
    
    add in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    before - The widget before the new widget will be placed.
    
    widget - The child widget to add.
    
    Returns:
    
    this for fluent syntax support.
    
    Throws:
    
    java.lang.IllegalArgumentException - when the argument is null or instance of TopLevelWindow
  - registerSelectedWidget
```
public void registerSelectedWidget(Widget<O> widget)
```
    Register a widget to the list of selected widgets.
    
    Parameters:
    
    widget - The widget to be registered.
  - deregisterSelectedWidget
```
public void deregisterSelectedWidget(Widget<O> widget)
```
    Deregister a widget from the list of selected widgets.
    
    Parameters:
    
    widget - The widget to be deregistered.
  - getAllSelectedWidgets
```
public java.util.Collection<Widget<O>> getAllSelectedWidgets()
```
    Retrieve all widgets which are registered as selected in this container. Note that this does not iterate all widgets and checks for the selected flag - it rather uses a predefined list of registered selected widgets.
    
    Returns:
    
    A list of selected widgets which were registered as selected.
  - clipping
```
public boolean clipping()
```
    This method should be overridden in a container that allows clipping.
    
    Specified by:
    
    clipping in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    true if container clips its children.
  - currentFocus
```
public Widget<O> currentFocus()
```
    Get widget which is in focus.
    
    Specified by:
    
    currentFocus in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    focused widget.
  - currentFocus
```
public Widget<O> currentFocus(boolean recurse)
```
    Get widget which is in focus.
    The method allows to choose whether the focused widget is searched in the nested containers (recurse == true) or whether only this container is searched (recurse == false).
    
    Specified by:
    
    currentFocus in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    recurse - The parameter controls whether the method should recurse to the nested containers when searching for the focused widget.
    
    Returns:
    
    focused widget.
  - getFocusInt
```
public Widget<O> getFocusInt()
```
    Get focused widget.
    
    Returns:
    
    focused widget.
  - defaultFocus
```
public Widget<O> defaultFocus()
```
    Get default focusable widget.
    
    Specified by:
    
    defaultFocus in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    default focusable widget.
  - dimension
```
public Dimension dimension()
```
    Get widget dimension.
    
    Specified by:
    
    dimension in interface Widget<O extends OutputManager<?>>
    
    Specified by:
    
    dimension in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    widget dimension.
  - doLayout
```
public void doLayout()
```
    Lay out container.
    
    Specified by:
    
    doLayout in interface Container<O extends OutputManager<?>>
  - findMouseSource
```
public Widget<O> findMouseSource(NativePoint p)
```
    Find the widget positioned just bellow the specified mouse position (in physical units). Each container should search for own widgets. Because widgets are relative positioned inside containers the container physical position is adjusted before search.
    
    Specified by:
    
    findMouseSource in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    findMouseSource in class AbstractWidget<O extends OutputManager<?>>
    
    Parameters:
    
    p - The mouse physical location.
    
    Returns:
    
    A widget over which the mouse is positioned or null if none found.
  - draw
```
public void draw()
```
    Draw widget.
    
    Specified by:
    
    draw in interface Widget<O extends OutputManager<?>>
    
    Specified by:
    
    draw in class AbstractWidget<O extends OutputManager<?>>
  - childrenLocation
```
public Point childrenLocation(Widget<O> child)
```
    Get children location for one child.
    
    Specified by:
    
    childrenLocation in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    child - Child component.
    
    Returns:
    
    Point - parents location
  - endSizeChange
```
public void endSizeChange(boolean repaint)
```
    Indicates the ending of the resize process. All repainting between startSizeChange and endSizeChange calls is suppressed.
    
    Specified by:
    
    endSizeChange in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    repaint - If true then the current bounding rectangle and the rectangle saved during startSizeChange call are repainted.
  - focus
```
public Widget<O> focus()
```
    Returns the focused direct child Component.
    
    Specified by:
    
    focus in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    The focused direct child Component.
  - focusTraversable
```
public boolean focusTraversable()
```
    Check if widget is focus traversable.
    
    Specified by:
    
    focusTraversable in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    focusTraversable in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    true if widget is focus traversable.
  - get
```
public Widget<O> get(int index)
```
    Get widget for provided index or null if no such component exists.
    
    Specified by:
    
    get in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    index - Widget index.
    
    Returns:
    
    widget at specified index or null if index is out of range.
  - getClipRect
```
public Rectangle getClipRect()
```
    Get clipping rectangle.
    
    Specified by:
    
    getClipRect in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    clipping rectangle.
  - hasFocusable
```
public boolean hasFocusable(Widget<O> exclude)
```
    Reports if there is at least 1 focusable widget that is not the given widget.
    
    Specified by:
    
    hasFocusable in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    exclude - A widget to ignore or null if any focusable widget will do.
    
    Returns:
    
    true if there is at least one other widget that can be focused.
  - height
```
public double height()
```
    Get widget height.
    
    Specified by:
    
    height in interface Widget<O extends OutputManager<?>>
    
    Specified by:
    
    height in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    widget height.
  - insets
```
public Insets insets()
```
    Get container insets.
    
    Specified by:
    
    insets in interface Container<O extends OutputManager<?>>
    
    Specified by:
    
    insets in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    insets in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    container insets.
  - minimumSize
```
public Dimension minimumSize()
```
    Get widget minimum size.
    
    Specified by:
    
    minimumSize in interface Widget<O extends OutputManager<?>>
    
    Specified by:
    
    minimumSize in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    widget minimum size.
  - moveBeforeTabItem
```
public void moveBeforeTabItem(Widget<O> widget,
                              Widget<O> before)
```
    Move specified widget before the widget "before". Widgets must be in the same field-group, that is checked on the server-side.
    
    Specified by:
    
    moveBeforeTabItem in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - Widget to move.
    
    before - The widget before which to insert mover.
  - moveAfterTabItem
```
public void moveAfterTabItem(Widget<O> widget,
                             Widget<O> after)
```
    Move specified widget after the widget "after". Widgets must be in the same field-group, that is checked on the server-side.
    
    Specified by:
    
    moveAfterTabItem in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - Widget to move.
    
    after - The widget after which to insert mover.
  - moveToBottom
```
public void moveToBottom(Widget<O> widget)
```
    Mode specified widget to the bottom of the widget list.
    
    Specified by:
    
    moveToBottom in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - Widget to mover.
  - moveToTop
```
public void moveToTop(Widget<O> widget)
```
    Move specified widget to the top of widget list.
    
    Specified by:
    
    moveToTop in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - Widget to mover.
  - paintOnTop
```
public void paintOnTop(WidgetId widgetId)
```
    Mark specified widget ID to be on the top of the painting order.
    
    Parameters:
    
    widgetId - Widget ID to be painted on the top.
  - moveToBottomInClass
```
public boolean moveToBottomInClass(Widget<O> widget)
```
    Move the specified widget to the bottom of the widget list considering Z-order class.
    
    Specified by:
    
    moveToBottomInClass in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - The given widget to move.
    
    Returns:
    
    true if the widget was moved
  - moveToTopInClass
```
public boolean moveToTopInClass(Widget<O> widget)
```
    Move the specified widget to the top of widget list considering Z-order class.
    
    Specified by:
    
    moveToTopInClass in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - The given widget to move.
    
    Returns:
    
    true if the widget was moved
  - moveToZpos
```
public void moveToZpos(Widget<O> widget,
                       int pos)
```
    Move widget to specified position in the widget list. For overlaying widgets this is basically position in widget Z-order.
    
    Specified by:
    
    moveToZpos in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - Widget to mover.
    
    pos - Position in Z-order.
  - nextFocus
```
public void nextFocus()
```
    Select next focusable widget.
    
    Specified by:
    
    nextFocus in interface Container<O extends OutputManager<?>>
  - prevFocus
```
public void prevFocus()
```
    Select previous focusable widget.
    
    Specified by:
    
    prevFocus in interface Container<O extends OutputManager<?>>
  - processKeyEvent
```
public void processKeyEvent(KeyInput event)
```
    Process key event.
    
    Specified by:
    
    processKeyEvent in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    processKeyEvent in class AbstractWidget<O extends OutputManager<?>>
    
    Parameters:
    
    event - Key event to process.
  - remove
```
public void remove(Widget<O> widget)
```
    Remove specified widget from the widget list.
    The widget will also be destroyed.
    
    Specified by:
    
    remove in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - Widget to remove.
  - detach
```
public void detach(Widget<O> widget)
```
    Detach this widget from this container. The widget will not be destroyed.
    
    Specified by:
    
    detach in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widget - Widget to detach.
    
    Throws:
    
    java.lang.RuntimeException - when the supplied widget is not attached to this container
  - destroy
```
public void destroy()
```
    Destroy this widget. Notify all of its components that the widget has been destroyed.
    
    Specified by:
    
    destroy in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    destroy in class AbstractWidget<O extends OutputManager<?>>
  - repaint
```
public void repaint()
```
    Request widget repainting.
    
    Specified by:
    
    repaint in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    repaint in class AbstractWidget<O extends OutputManager<?>>
  - replace
```
public void replace(Widget<O> oldWidget,
                    Widget<O> newWidget)
```
    Replace specified widget with another with preserving widget Z-order.
    
    Specified by:
    
    replace in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    oldWidget - Old widget.
    
    newWidget - New widget.
  - swap
```
public void swap(int first,
                 int second)
```
    Swap two widgets given by their indices i and j. The given indices should be valid, this method does not check validity of the given indices and can fail with IndexOutOfBoundsException exception.
    
    Parameters:
    
    first - The first widget index
    
    second - The second widget index
  - requestFocus
```
public void requestFocus(boolean force)
```
    Request focus.
    
    Specified by:
    
    requestFocus in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    force - When true the method will set focus on this widget unconditionally.
  - requestFocus
```
public void requestFocus(boolean force,
                         boolean mouse)
```
    Request focus.
    
    Specified by:
    
    requestFocus in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    requestFocus in class AbstractWidget<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.
  - setFocus
```
public void setFocus(Widget<O> focus)
```
    Set focus to specified widget. The method doesn't activate the focus.topLevelWindow(). If the top-level window needs to be activated, too, call WindowManager.activateWindow(TitledWindow).
    
    Specified by:
    
    setFocus in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    focus - Widget to set focus on.
  - setHeight
```
public void setHeight(double height)
```
    Set container height.
    
    Specified by:
    
    setHeight in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    height - New container height.
  - setInsets
```
public void setInsets(Insets insets)
```
    Set container insets.
    
    Specified by:
    
    setInsets in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    insets - Insets to set.
  - setLayout
```
public void setLayout(LayoutManager<O> manager)
```
    Set layout manager for the container.
    
    Specified by:
    
    setLayout in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    manager - New layout manager.
  - getLayout
```
public LayoutManager<O> getLayout()
```
    Get active layout manager for the container.
    
    Specified by:
    
    getLayout in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    Active layout manager.
  - setSize
```
public void setSize(Dimension size)
```
    Set container size.
    
    Specified by:
    
    setSize in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    size - Size to set.
  - setSize
```
public void setSize(double width,
                    double height)
```
    Set container size.
    
    Specified by:
    
    setSize in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    width - New width.
    
    height - New height.
  - setWidth
```
public void setWidth(double width)
```
    Set container width.
    
    Specified by:
    
    setWidth in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    width - Width to set.
  - startSizeChange
```
public void startSizeChange(boolean saveOldRect)
```
    Indicates the beginning of the resize process. All repainting between startSizeChange and endSizeChange calls is suppressed.
    
    Specified by:
    
    startSizeChange in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    saveOldRect - If true then the current bounding rectangle is saved for future repainting.
  - widgets
```
public Widget<O>[] widgets()
```
    Get all widgets stored in the container.
    
    Specified by:
    
    widgets in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    array of stored widgets.
  - dumpWidgets
```
public void dumpWidgets()
```
    Dumps to console the tree of widgets. Use only for debugging purposes.
  - dumpCurrentWidgets
```
public void dumpCurrentWidgets()
```
    Outputs the string-formatted chain of current widgets starting from this container level. The output is sent to system out.
  - addContainerStateListener
```
public void addContainerStateListener(ContainerStateListener<O> listener)
```
    Adds container state listener.
    
    Specified by:
    
    addContainerStateListener in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    listener - A container state listener.
  - removeContainerStateListener
```
public void removeContainerStateListener(ContainerStateListener<O> listener)
```
    Removes container state listener.
    
    Specified by:
    
    removeContainerStateListener in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    listener - A container state listener.
  - onWidgetAdded
```
protected void onWidgetAdded(Widget<O> w)
```
    The method is called when a widget is added to the container.
    
    Parameters:
    
    w - The added widget.
  - onWidgetRemoved
```
protected void onWidgetRemoved(Widget<O> w)
```
    The method is called when a widget is removed from the container.
    
    Parameters:
    
    w - The removed widget.
  - triggerContainerStateRedrawEnabled
```
public void triggerContainerStateRedrawEnabled()
```
    The method is called when DISABLE-REDRAW is assigned to true on the container or a widget in the container.
  - parentOf
```
public boolean parentOf(Widget<O> w)
```
    The method returns true if this container is parent of the supplied widget.
    
    Specified by:
    
    parentOf in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    w - Widget to check.
    
    Returns:
    
    see above
  - dumpWidgets
```
private void dumpWidgets(java.lang.String indent)
```
    Dumps to console the tree of widgets. Use only for debugging purposes. This is the recursive worker that traverse the children wisgets and prints to console the tree with IDs and physical bounds. When another container is reached the method is called with increased indentation.
    
    Parameters:
    
    indent - The indentation (spaces to be printed in formt of the widgets).
  - formatCurrentWidgets
```
private java.lang.String formatCurrentWidgets(java.lang.String indent)
```
    Formats the chain of current widgets starting from this container level.
    
    Parameters:
    
    indent - The indent for this level.
    
    Returns:
    
    The formatted string output.
  - formatDump
```
protected java.lang.String formatDump()
```
    Formats this widget for a debug dump.
    
    Returns:
    
    formatted string representing this widget
  - widgetsAsList
```
public java.util.List<Widget<O>> widgetsAsList(boolean system)
```
    Get all widgets stored in the container.
    
    Specified by:
    
    widgetsAsList in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    system - Set to true to return the child widgets as part of the system-level widget hierarchy.
    
    Returns:
    
    the new list with stored widgets.
  - width
```
public double width()
```
    Get widget width.
    
    Specified by:
    
    width in interface Widget<O extends OutputManager<?>>
    
    Specified by:
    
    width in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    widget width.
  - firstFocus
```
public void firstFocus()
```
    Set focus to first focusable widget.
    
    Specified by:
    
    firstFocus in interface Container<O extends OutputManager<?>>
  - lastFocus
```
public void lastFocus()
```
    Set focus to last focusable widget.
    
    Specified by:
    
    lastFocus in interface Container<O extends OutputManager<?>>
  - getScrollableSize
```
public Dimension getScrollableSize()
```
    Returns the preferred size of the scrollable area of this container.
    This implementation simply delegates the call to dimension().
    
    Returns:
    
    See above.
  - getEffectiveScrollableSize
```
public Dimension getEffectiveScrollableSize()
```
    Calculates the effective size of the scrollable area of this container.
    This implementation accounts all the visible child widgets into the area and simply determines the furthest x and y from the origin.
    
    Returns:
    
    see above.
  - getIgnoreFocus
```
public java.util.Set<Widget<?>> getIgnoreFocus()
```
    Returns the set of widgets that are never selected for focus.
    
    Specified by:
    
    getIgnoreFocus in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    set of widgets or null.
  - setIgnoreFocus
```
public void setIgnoreFocus(java.util.Collection<Widget<?>> widgets)
```
    Sets the set of widgets that are never selected for focus. null may be used to clear the set.
    
    Specified by:
    
    setIgnoreFocus in interface Container<O extends OutputManager<?>>
    
    Parameters:
    
    widgets - Set of widgets or null.
  - normalizeZOrder
```
public void normalizeZOrder()
```
    Reorder widgets according to their ZOrderClass retaining the order within the class
  - setFocusInt
```
public void setFocusInt(Widget<O> focus)
```
    Set focus to specified widget.
    
    Parameters:
    
    focus - Widget to set focus on.
  - unrealize
```
public void unrealize()
```
    Unrealize this container and all its children.
    
    Specified by:
    
    unrealize in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    unrealize in class AbstractWidget<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<?>>
    
    Overrides:
    
    widgetStateChanged in class AbstractWidget<O extends OutputManager<?>>
  - addIncomingSystemWidget
```
void addIncomingSystemWidget(Widget<O> widget)
```
    Adds a widget to the list of incoming system widgets. This is needed to support the system-level widget hierarchy. See BaseEntity.setSystemParent(com.goldencode.p2j.ui.GenericWidget) for more information.
    
    Parameters:
    
    widget - A widget to add. Must not be null.
  - removeIncomingSystemWidget
```
void removeIncomingSystemWidget(Widget<O> widget)
```
    Removes a widget from the list of incoming system widgets. This is needed to support the system-level widget hierarchy. See BaseEntity.setSystemParent(com.goldencode.p2j.ui.GenericWidget) for more information.
    
    Parameters:
    
    widget - A widget to remove.
  - addOutgoingSystemWidget
```
void addOutgoingSystemWidget(Widget<O> widget)
```
    Adds a widget to the list of outgoing system widgets. This is needed to support the system-level widget hierarchy. See BaseEntity.setSystemParent(com.goldencode.p2j.ui.GenericWidget) for more information.
    
    Parameters:
    
    widget - A widget to add.
  - removeOutgoingSystemWidget
```
void removeOutgoingSystemWidget(Widget<O> widget)
```
    Removes a widget from the list of outgoing system widgets. This is needed to support the system-level widget hierarchy. See BaseEntity.setSystemParent(com.goldencode.p2j.ui.GenericWidget) for more information.
    
    Parameters:
    
    widget - A widget to remove.
  - copyState
```
protected void copyState(Widget<?> w)
```
    Copy the widget state from the specified source widget to this instance.
    
    Overrides:
    
    copyState in class AbstractWidget<O extends OutputManager<?>>
    
    Parameters:
    
    w - The source widget which state needs to be copied.
  - prepareWidgets
```
protected java.util.List<Widget<O>> prepareWidgets(java.util.List<Widget<O>> widgets)
```
    Prepare widgets before drawing
    
    Parameters:
    
    widgets - Container children.
    
    Returns:
    
    widgets, prepared for drawing.
  - addDirectly
```
protected void addDirectly(Widget<O> widget)
```
    Add widget directly to the list without triggering repaint or other operations.
    
    Parameters:
    
    widget - Widget to add.
  - belongsTo
```
protected boolean belongsTo(Widget<O> widget)
```
    Check if specified widget belongs to this container.
    
    Parameters:
    
    widget - Widget to check.
    
    Returns:
    
    true if widget belongs to container.
  - clipRectangle
```
protected NativeRectangle clipRectangle(NativePoint origin,
                                        NativeDimension dimension,
                                        boolean children)
```
    Build clipped rectangle for given coordinates.
    
    Parameters:
    
    origin - Physical location.
    
    dimension - Physical dimension.
    
    children - Flag to intersect the rectangle with the to-be-drawn chidren.
    
    Returns:
    
    see above.
  - 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 ignores the supplied config instance. Instead it relies on size and AbstractWidget.config() to detect whether size has changed.
    
    Overrides:
    
    updateSizeWorker in class AbstractWidget<O extends OutputManager<?>>
    
    Type Parameters:
    
    C - Widget config type.
    
    Parameters:
    
    beforeUpdate - BaseConfig reference or null.
  - getTabItemList
```
public java.util.List<Widget<O>> getTabItemList()
```
    Returns the tab item list for this container. If the tab item list is not given, then an empty list is returned.
    
    Specified by:
    
    getTabItemList in interface Container<O extends OutputManager<?>>
    
    Returns:
    
    The tab item list.
  - setTabItemList
```
public void setTabItemList(java.util.List<Widget<O>> tabItemList)
```
    Sets the tab item list for this container.
    
    Parameters:
    
    tabItemList - The tab item list
  - focusWorker
```
protected void focusWorker(boolean direction)
```
    Search for the next or previous focusable widget in the container and set focus on it.
    
    Parameters:
    
    direction - Widget search direction.
  - checkWidget
```
protected boolean checkWidget(Widget<O> widget,
                              boolean direction)
```
    Check potential focus candidate and set focus on it if it matches criteria.
    
    Parameters:
    
    widget - Candidate widget.
    
    direction - Search direction.
    
    Returns:
    
    true if widget was focused and false otherwise.
  - cycleFocus
```
protected void cycleFocus(boolean direction)
```
    Search for the next or previous focusable widget in this container and set focus on it. When the end is reached the focus is moved to the first widget, similarly when the first widget is reached the focus is moved to the end.
    
    Parameters:
    
    direction - Widget search direction.
  - reflectAncestorChange
```
public void reflectAncestorChange()
```
    Called when any of the widget's ancestors gets re-assigned. It will clear all cached values (AbstractWidget.ancestorCache and AbstractWidget.window) for itself and the entire widget tree starting from this container.
    
    Overrides:
    
    reflectAncestorChange in class AbstractWidget<O extends OutputManager<?>>
  - 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.
    
    Overrides:
    
    reflectLocationChanged in class AbstractWidget<O extends OutputManager<?>>
  - setPhysicalDimensionInt
```
protected void setPhysicalDimensionInt(int width,
                                       int height)
```
    Set widget physical dimension.
    
    Overrides:
    
    setPhysicalDimensionInt in class AbstractWidget<O extends OutputManager<?>>
    
    Parameters:
    
    width - Widget physical width.
    
    height - Widget physical height.
  - locateFocusTraversable
```
private Widget<O> locateFocusTraversable(java.lang.Iterable<Widget<O>> iter)
```
    Helper method for traversing widgets in the container.
    
    Parameters:
    
    iter - Iterable for the contained widgets.
    
    Returns:
    
    Found widget or null if no matches found.
  - getDrawableWidgets
```
private java.util.List<Widget<O>> getDrawableWidgets()
```
    Get the widgets which can be drawn, from this container.
    
    Returns:
    
    All the widgets which touch the clipping areas, according to their z-order.

Class AbstractContainer<O extends OutputManager<?>>

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.awt.event.MouseListener

Methods inherited from interface java.awt.event.MouseMotionListener

Methods inherited from interface java.awt.event.MouseWheelListener

Field Detail

LOG

work

layoutManager

current

insets

size

widgets

selectedWidgets

incomingSystemWidgets

outgoingSystemWidgets

tabItemList

ignoreFocusSet

containerStateListeners

topLevelWidgetId

Constructor Detail

AbstractContainer

Method Detail

add

add

add

registerSelectedWidget

deregisterSelectedWidget

getAllSelectedWidgets

clipping

currentFocus

currentFocus

getFocusInt

defaultFocus

dimension

doLayout

findMouseSource

draw

childrenLocation

endSizeChange

focus

focusTraversable

get

getClipRect

hasFocusable

height

insets

minimumSize

moveBeforeTabItem

moveAfterTabItem

moveToBottom

moveToTop

paintOnTop

moveToBottomInClass

moveToTopInClass

moveToZpos

nextFocus

prevFocus

processKeyEvent

remove

detach

destroy

repaint

replace

swap

requestFocus

requestFocus

setFocus

setHeight

setInsets

setLayout

getLayout