com.goldencode.p2j.ui.client.widget

Interface Container<O extends OutputManager<?>>

All Superinterfaces:

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

All Known Subinterfaces:

AlertBox<O>

All Known Implementing Classes:

AbstractContainer, AbstractFileChooserDialog, AlertBoxGuiImpl, AlertBoxGuiImpl.ButtonsPanel, AlertBoxGuiImpl.MessagePanel, AlertBoxImpl, BorderedPanel, BorderedPanelGuiImpl, BorderedPanelImpl, Browse, BrowseColumn, BrowseColumnGuiImpl, BrowseConfirmPanel, BrowseFilterEntryField, BrowseGuiImpl, BrowseGuiImpl.ColumnSetContainer, BrowseGuiImpl.ColumnsScrollPane, BrowseImpl, BrowsePopupMenu, ButtonListGuiImpl, ButtonListGuiImpl.GroupButton, ButtonListGuiImpl.Item, ButtonListGuiImpl.Items, ButtonListGuiImpl.ItemsControl, CalendarGuiImpl, CalendarPopup, ClientDrivenLabel, ColorChooserGuiImpl, ColorIndexChooserGuiImpl, ContentThumbView, DetailsThumbView, DialogBoxWindow, DirDialogGuiImpl, DirDialogGuiImpl.FolderTree, DirDialogImpl, DriverWidgetHost, DropDown, DropDownGuiImpl, DropDownImpl, Editor, EditorGuiImpl, EditorGuiImpl.EditorContent, EditorGuiImpl.EditorScrollContainer, EditorImpl, EditorPopupGuiImpl, EmptyThumbView, EntryFieldGuiImpl, FileDialogGuiImpl, FileDialogGuiImpl.FolderTree, FileDialogGuiImpl.NavigationPane, FileDialogGuiImpl.ToolsPane, FileDialogImpl, FillIn, FillInGuiImpl, FillInImpl, FixedSizeContainer, FontChooserGuiImpl, Frame, Frame.FrameScrollContainer, FrameChuiImpl, FrameGuiImpl, FrameGuiImpl.GuiFrameScrollContainer, FrameOverlay, GenericContainer, HtmlBrowserGuiImpl, ImageListGuiImpl, InputDialog, LabeledDataContainer, LabeledPanel, LabelGuiImpl, LabelImpl, LineEditor, ListThumbView, MediumIconsThumbView, Menu, MenuChuiImpl, MenuGuiImpl, MenuOverlayWindow, MessageAreaGuiImpl, ModalWindow, NativeScrollContainer, OuterFrame, OverlayWindow, PrintSetupDialog, PrintSetupDialog.ButtonsPanel, RadioButton, RadioButtonGuiImpl, RadioButtonImpl, RadioSet, RadioSetGuiImpl, ScrollableContainer, ScrollBar, ScrollBarGuiImpl, ScrollContainer, ScrollPane, ScrollPaneGuiImpl, ScrollPaneImpl, ScrollPopupGuiImpl, SelectionList, SelectionListGuiImpl, SelectionListImpl, SensitiveScrollContainer, SignatureClientGuiImpl, SmallIconsThumbView, SpreadsheetGuiImpl, SubMenu, SubMenuChuiImpl, SubMenuGuiImpl, SubMenuGuiImpl.SubMenuBody, TabSetGuiImpl, TabSetGuiImpl.TabSetItem, TempContainer, Text, TextCell, TextGuiImpl, TextImpl, TilesThumbView, TitledWindow, ToolTip, TopLevelWindow, TreeGuiImpl, TreeGuiImpl.TreeEditor, TreeListCaption, TreeListGuiImpl, TreeViewGuiImpl, Viewport, Window, WindowChuiImpl, WindowGuiImpl, WindowTitleBar, WindowTitleBar.WindowTitle, WindowTitlePopupGuiImpl, WindowWorkSpace

public interface Container<O extends OutputManager<?>>
extends Widget<O>

Common interface implemented by all widget containers.

Method Summary

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 new widget before the given widget's position.
void	addContainerStateListener(ContainerStateListener<O> listener) Adds container state listener.
Point	childrenLocation(Widget<O> child) Get children location for one child.
boolean	clipping() This method should be overridden in a container that allows clipping.
Widget<O>	currentFocus() Get widget which is in focus.
Widget<O>	currentFocus(boolean recurse) Get widget which is in focus.
Widget<O>	defaultFocus() Get default focusable widget.
void	detach(Widget<O> widget) Detach this widget from this container.
void	doLayout() Lay out container.
void	endSizeChange(boolean repaint) Indicates the ending of the resize process.
void	firstFocus() Set focus to first focusable widget.
Widget<O>	focus() Returns the focused direct child Component.
Widget<O>	get(int index) Get widget for provided index or null if no such component exists.
Rectangle	getClipRect() Get clipping rectangle.
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.
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.
Insets	insets() Get container insets.
void	lastFocus() Set focus to last focusable widget.
void	moveAfterTabItem(Widget<O> widget, Widget<O> after) Mode specified after before the widget "after".
void	moveBeforeTabItem(Widget<O> widget, Widget<O> before) Mode 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) Mode 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 the widget list.
boolean	moveToTopInClass(Widget<O> widget) Move specified widget to the top of the 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.
boolean	parentOf(Widget<O> w) The method returns true if this container is parent of the supplied widget.
void	prevFocus() Select previous focusable widget.
void	remove(Widget<O> widget) Remove specified widget from the widget list.
void	removeContainerStateListener(ContainerStateListener<O> listener) Removes container state listener.
void	replace(Widget<O> oldWidget, Widget<O> newWidget) Replace specified widget with another with preserving widget Z-order.
void	setFocus(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.
void	setSize(Dimension size) Set container size.
void	setSize(double width, double height) Set container size.
void	setWidth(double width) Set container width.
void	startSizeChange(boolean saveOldRect) Indicates the beginning of the resize process.
Widget<O>[]	widgets() Get all widgets stored in the container.
default java.util.List<Widget<O>>	widgetsAsList() Get all widgets stored in the container.
java.util.List<Widget<O>>	widgetsAsList(boolean system) Get all widgets stored in the container.

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

acceptsEscAsAnyKey, acceptTrigger, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, clearWidget, completeTrigger, config, defaultMousePtr, destroy, dimension, displayPhysicalLocation, draw, drawCaret, enclosingFrame, enforceDefaultMousePtr, findMouseSource, focusTraversable, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, height, 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, minimumSize, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processEvent, processFocusEvent, processKeyEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, repaint, requestFocus, requestFocus, 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, unrealize, unregisterWidgetListener, validateDisplayValue, widgetStateChanged, width, 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

Method Detail

add

Container<O> add(Widget<O> widget)

Add widget to container.

Parameters:

widget - Widget to add.

Returns:

this for fluent syntax support.

add

Container<O> add(Widget<O> before,
                 Widget<O> widget)

Add the new widget before the given widget's position.

Parameters:

before - The widget to insert before.

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

Container<O> add(int pos,
                 Widget<O> widget)

Add the widget on the specified position.

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

clipping

boolean clipping()

This method should be overridden in a container that allows clipping.

Returns:

true if container clips its children.

currentFocus

Widget<O> currentFocus()

Get widget which is in focus.

Returns:

focused widget.

currentFocus

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

Parameters:

recurse - The parameter controls whether the method should recurse to the nested containers when searching for the focused widget.

Returns:

focused widget.

defaultFocus

Widget<O> defaultFocus()

Get default focusable widget.

Returns:

default focusable widget.

doLayout

void doLayout()

Lay out container.

endSizeChange

void endSizeChange(boolean repaint)

Indicates the ending of the resize process. All repainting between startSizeChange and endSizeChange calls is suppressed.

Parameters:

repaint - If true then the current bounding rectangle and the rectangle saved during startSizeChange call are repainted.

focus

Widget<O> focus()

Returns the focused direct child Component.

Returns:

The focused direct child Component.

get

Widget<O> get(int index)

Get widget for provided index or null if no such component exists.

Parameters:

index - Widget index.

Returns:

widget at specified index or null if index is out of range.

getClipRect

Rectangle getClipRect()

Get clipping rectangle.

Returns:

clipping rectangle.

hasFocusable

boolean hasFocusable(Widget<O> exclude)

Reports if there is at least 1 focusable widget that is not the given widget.

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.

insets

Insets insets()

Get container insets.

Specified by:

insets in interface Widget<O extends OutputManager<?>>

Returns:

container insets.

moveBeforeTabItem

void moveBeforeTabItem(Widget<O> widget,
                       Widget<O> before)

Mode specified widget before the widget "before".

Parameters:

widget - Widget to move.

before - The widget before to insert mover.

moveAfterTabItem

void moveAfterTabItem(Widget<O> widget,
                      Widget<O> after)

Mode specified after before the widget "after".

Parameters:

widget - Widget to move.

after - The widget before to insert mover.

moveToBottom

void moveToBottom(Widget<O> widget)

Mode specified widget to the bottom of the widget list.

Parameters:

widget - Widget to mover.

moveToTop

void moveToTop(Widget<O> widget)

Move specified widget to the top of the widget list.

Parameters:

widget - Widget to mover.

moveToBottomInClass

boolean moveToBottomInClass(Widget<O> widget)

Mode specified widget to the bottom of the widget list considering Z-order class.

Parameters:

widget - Widget to mover.

Returns:

true if the widget was moved

moveToTopInClass

boolean moveToTopInClass(Widget<O> widget)

Move specified widget to the top of the widget list considering Z-order class.

Parameters:

widget - Widget to mover.

Returns:

true if the widget was moved

moveToZpos

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.

Parameters:

widget - Widget to mover.

pos - Position in Z-order.

nextFocus

void nextFocus()

Select next focusable widget.

prevFocus

void prevFocus()

Select previous focusable widget.

remove

void remove(Widget<O> widget)

Remove specified widget from the widget list.

Parameters:

widget - Widget to remove.

replace

void replace(Widget<O> oldWidget,
             Widget<O> newWidget)

Replace specified widget with another with preserving widget Z-order.

Parameters:

oldWidget - Old widget.

newWidget - New widget.

setFocus

void setFocus(Widget<O> focus)

Set focus to specified widget.

Parameters:

focus - Widget to set focus on.

setHeight

void setHeight(double height)

Set container height.

Parameters:

height - New container height.

setInsets

void setInsets(Insets insets)

Set container insets.

Parameters:

insets - Insets to set.

setLayout

void setLayout(LayoutManager<O> manager)

Set layout manager for the container.

Parameters:

manager - New layout manager.

getLayout

LayoutManager<O> getLayout()

Get active layout manager for the container.

Returns:

Active layout manager.

setSize

void setSize(Dimension size)

Set container size.

Parameters:

size - Size to set.

setSize

void setSize(double width,
             double height)

Set container size.

Parameters:

width - New width.

height - New height.

setWidth

void setWidth(double width)

Set container width.

Parameters:

width - Width to set.

startSizeChange

void startSizeChange(boolean saveOldRect)

Indicates the beginning of the resize process. All repainting between startSizeChange and endSizeChange calls is suppressed.

Parameters:

saveOldRect - If true then the current bounding rectangle is saved for future repainting.

widgets

Widget<O>[] widgets()

Get all widgets stored in the container.

Returns:

array of stored widgets.

getTabItemList

java.util.List<Widget<O>> getTabItemList()

Returns the tab item list for this container.

Returns:

The tab item list.

widgetsAsList

default java.util.List<Widget<O>> widgetsAsList()

Get all widgets stored in the container.

Returns:

the new list with stored widgets.

widgetsAsList

java.util.List<Widget<O>> widgetsAsList(boolean system)

Get all widgets stored in the container.

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.

firstFocus

void firstFocus()

Set focus to first focusable widget.

lastFocus

void lastFocus()

Set focus to last focusable widget.

detach

void detach(Widget<O> widget)

Detach this widget from this container. The widget will not be destroyed.

Parameters:

widget - Widget to detach.

getIgnoreFocus

java.util.Set<Widget<?>> getIgnoreFocus()

Returns the set of widgets that are never selected for focus.

Returns:

set of widgets or null.

setIgnoreFocus

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.

Parameters:

widgets - Set of widgets or null.

childrenLocation

Point childrenLocation(Widget<O> child)

Get children location for one child.

Parameters:

child - Child component.

Returns:

Point - parents location

addContainerStateListener

void addContainerStateListener(ContainerStateListener<O> listener)

Adds container state listener.

Parameters:

listener - A container state listener.

removeContainerStateListener

void removeContainerStateListener(ContainerStateListener<O> listener)

Removes container state listener.

Parameters:

listener - A container state listener.

parentOf

boolean parentOf(Widget<O> w)

The method returns true if this container is parent of the supplied widget.

Parameters:

w - Widget to check.

Returns:

see above