org.jowidgets.api.widgets

Interface IContainer

All Superinterfaces:

IComponent, IComponentCommon, IComponentObservable, IContainerCommon, IContainerObservable, IDisposeObservable, IFocusObservable, IKeyObservable, IMouseMotionObservable, IMouseObservable, IPopupDetectionObservable, IRecursiveContainerObservable, IShowingStateObservable, IWidget, IWidgetCommon

All Known Subinterfaces:

IComposite, IExpandComposite, IFrame, IInputContentContainer, IPopupDialog, IScrollComposite, ITabItem, IToolBarContainerItem

All Known Implementing Classes:

CompositeWrapper, ContainerWrapper, Dialog, Frame, FrameWrapper, JoComposite, JoContainer, JoDialog, JoFrame, JoScrollComposite

public interface IContainer
extends IComponent, IContainerObservable, IRecursiveContainerObservable, IContainerCommon

Method Summary

Methods

Modifier and Type	Method and Description
<WIDGET_TYPE extends IControl> WIDGET_TYPE	add(ICustomWidgetCreator<WIDGET_TYPE> creator) Creates and adds an control to this container
<WIDGET_TYPE extends IControl> WIDGET_TYPE	add(ICustomWidgetCreator<WIDGET_TYPE> creator, java.lang.Object layoutConstraints) Creates and adds an control to this container
<WIDGET_TYPE extends IControl> WIDGET_TYPE	add(int index, ICustomWidgetCreator<WIDGET_TYPE> creator) Creates and adds an control to this container
<WIDGET_TYPE extends IControl> WIDGET_TYPE	add(int index, ICustomWidgetCreator<WIDGET_TYPE> creator, java.lang.Object layoutConstraints) Creates and adds an control to this container
<WIDGET_TYPE extends IControl> WIDGET_TYPE	add(int index, IWidgetDescriptor<? extends WIDGET_TYPE> descriptor) Creates and adds an control to this container.
<WIDGET_TYPE extends IControl> WIDGET_TYPE	add(int index, IWidgetDescriptor<? extends WIDGET_TYPE> descriptor, java.lang.Object layoutConstraints) Creates and adds an control to this container.
<WIDGET_TYPE extends IControl> WIDGET_TYPE	add(IWidgetDescriptor<? extends WIDGET_TYPE> descriptor) Creates and adds an control to this container.
<WIDGET_TYPE extends IControl> WIDGET_TYPE	add(IWidgetDescriptor<? extends WIDGET_TYPE> descriptor, java.lang.Object layoutConstraints) Creates and adds an control to this container.
void	addContainerRegistry(IContainerRegistry registry) Adds a container registry recursively.
java.util.List<IControl>	getChildren() Gets the containers children
void	layout() Layouts the container
void	layoutLater() Layouts the container later in the event queue.
boolean	remove(IControl control) Removes a control from this container.
void	removeContainerRegistry(IContainerRegistry registry) Removes a container registry
<LAYOUT_TYPE extends ILayouter> LAYOUT_TYPE	setLayout(ILayoutFactory<LAYOUT_TYPE> layoutFactory) Sets the layouter for this container defined by a layout factory
void	setTabOrder(java.util.Collection<? extends IControl> tabOrder) Sets the tab order of the container's controls.
void	setTabOrder(IControl... controls) Sets the tab order of the container's controls.

Methods inherited from interface org.jowidgets.api.widgets.IComponent

createPopupMenu, fromComponent, getBounds, hasFocus, isReparentable, isShowing, setBounds, setPopupMenu, setPosition, setSize, toComponent, toLocal, toScreen

Methods inherited from interface org.jowidgets.api.widgets.IWidget

dispose, getParent, getRoot, isDisposed

Methods inherited from interface org.jowidgets.api.controller.IDisposeObservable

addDisposeListener, removeDisposeListener

Methods inherited from interface org.jowidgets.api.controller.IShowingStateObservable

addShowingStateListener, removeShowingStateListener

Methods inherited from interface org.jowidgets.api.controller.IContainerObservable

addContainerListener, removeContainerListener

Methods inherited from interface org.jowidgets.api.controller.IRecursiveContainerObservable

addComponentListenerRecursive, addFocusListenerRecursive, addKeyListenerRecursive, addMouseListenerRecursive, addPopupDetectionListenerRecursive, removeComponentListenerRecursive, removeFocusListenerRecursive, removeKeyListenerRecursive, removeMouseListenerRecursive, removePopupDetectionListenerRecursive

Methods inherited from interface org.jowidgets.common.widgets.IContainerCommon

computeDecoratedSize, getClientArea, layoutBegin, layoutEnd, removeAll, setLayout

Methods inherited from interface org.jowidgets.common.widgets.IComponentCommon

getBackgroundColor, getForegroundColor, getPosition, getSize, isVisible, redraw, requestFocus, setBackgroundColor, setCursor, setForegroundColor, setPosition, setRedrawEnabled, setSize, setVisible

Methods inherited from interface org.jowidgets.common.widgets.IWidgetCommon

getUiReference, isEnabled, setEnabled

Methods inherited from interface org.jowidgets.common.widgets.controller.IComponentObservable

addComponentListener, removeComponentListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IFocusObservable

addFocusListener, removeFocusListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IKeyObservable

addKeyListener, removeKeyListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IMouseObservable

addMouseListener, removeMouseListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IMouseMotionObservable

addMouseMotionListener, removeMouseMotionListener

Methods inherited from interface org.jowidgets.common.widgets.controller.IPopupDetectionObservable

addPopupDetectionListener, removePopupDetectionListener

Method Detail

setLayout

<LAYOUT_TYPE extends ILayouter> LAYOUT_TYPE setLayout(ILayoutFactory<LAYOUT_TYPE> layoutFactory)

Sets the layouter for this container defined by a layout factory

Parameters:

layoutFactory - The layout to set

Returns:

The layouter created from the factory

layout

void layout()

Layouts the container

layoutLater

void layoutLater()

Layouts the container later in the event queue. If this method will be invoked more than once before the layout occurs, only one layout invocation will be done on this container.

addContainerRegistry

void addContainerRegistry(IContainerRegistry registry)

Adds a container registry recursively. With help of a container registry its is possible to get an access to all children of the container currently existing and all eventually added or removed children in the future

Parameters:

registry - The registry to add

removeContainerRegistry

void removeContainerRegistry(IContainerRegistry registry)

Removes a container registry

Parameters:

registry - The registry to remove

getChildren

java.util.List<IControl> getChildren()

Gets the containers children

Returns:

a unmodifiable copy of the containers children

remove

boolean remove(IControl control)

Removes a control from this container. Removing controls should be nested with layoutBegin() - layoutEnd() to ensure that the container revalidates its layout. The removed controls will be disposed an can no longer be used

Parameters:

control - The control to remove

Returns:

true if the widget was removed, false otherwise

add

<WIDGET_TYPE extends IControl> WIDGET_TYPE add(int index,
                                             IWidgetDescriptor<? extends WIDGET_TYPE> descriptor,
                                             java.lang.Object layoutConstraints)

Creates and adds an control to this container.

Type Parameters:

WIDGET_TYPE - The type of the widget that is created, added and returned

Parameters:

index - The index at which the control should be added in the container

descriptor - The descriptor that describes the control to add

layoutConstraints - The layout constraints / data for the added control

Returns:

the created and added control

add

<WIDGET_TYPE extends IControl> WIDGET_TYPE add(int index,
                                             IWidgetDescriptor<? extends WIDGET_TYPE> descriptor)

Creates and adds an control to this container.

Type Parameters:

WIDGET_TYPE - The type of the widget that is created, added and returned

Parameters:

index - The index at which the control should be added in the container

descriptor - The descriptor that describes the control to add

Returns:

the created and added control

add

<WIDGET_TYPE extends IControl> WIDGET_TYPE add(int index,
                                             ICustomWidgetCreator<WIDGET_TYPE> creator,
                                             java.lang.Object layoutConstraints)

Creates and adds an control to this container

Type Parameters:

WIDGET_TYPE - The type of the widget that is created, added and returned

Parameters:

index - The index at which the control should be added in the container

creator - The creator that creates the control

layoutConstraints - The layout constraints / data for the added control

Returns:

the created and added control

add

<WIDGET_TYPE extends IControl> WIDGET_TYPE add(int index,
                                             ICustomWidgetCreator<WIDGET_TYPE> creator)

Creates and adds an control to this container

Type Parameters:

WIDGET_TYPE - The type of the widget that is created, added and returned

Parameters:

index - The index at which the control should be added in the container

creator - The creator that creates the control

Returns:

the created and added control

add

<WIDGET_TYPE extends IControl> WIDGET_TYPE add(IWidgetDescriptor<? extends WIDGET_TYPE> descriptor,
                                             java.lang.Object layoutConstraints)

Creates and adds an control to this container.

Type Parameters:

WIDGET_TYPE - The type of the widget that is created, added and returned

Parameters:

descriptor - The descriptor that describes the control to add

layoutConstraints - The layout constraints / data for the added control

Returns:

the created and added control

add

<WIDGET_TYPE extends IControl> WIDGET_TYPE add(ICustomWidgetCreator<WIDGET_TYPE> creator,
                                             java.lang.Object layoutConstraints)

Creates and adds an control to this container

Type Parameters:

WIDGET_TYPE - The type of the widget that is created, added and returned

Parameters:

creator - The creator that creates the control

layoutConstraints - The layout constraints / data for the added control

Returns:

the created and added control

add

<WIDGET_TYPE extends IControl> WIDGET_TYPE add(IWidgetDescriptor<? extends WIDGET_TYPE> descriptor)

Creates and adds an control to this container.

Type Parameters:

WIDGET_TYPE - The type of the widget that is created, added and returned

Parameters:

descriptor - The descriptor that describes the control to add

Returns:

the created and added control

add

<WIDGET_TYPE extends IControl> WIDGET_TYPE add(ICustomWidgetCreator<WIDGET_TYPE> creator)

Creates and adds an control to this container

Type Parameters:

WIDGET_TYPE - The type of the widget that is created, added and returned

Parameters:

creator - The creator that creates the control

Returns:

the created and added control

setTabOrder

void setTabOrder(java.util.Collection<? extends IControl> tabOrder)

Sets the tab order of the container's controls.

Parameters:

tabOrder - the tab order to set or null to set the default tab behavior.

setTabOrder

void setTabOrder(IControl... controls)

Sets the tab order of the container's controls.

Parameters:

tabOrder - the tab order to set or null to set the default tab behavior.