org.jowidgets.tools.widgets.wrapper

Class ContainerWrapper

java.lang.Object

org.jowidgets.tools.widgets.wrapper.WidgetWrapper

org.jowidgets.tools.widgets.wrapper.ComponentWrapper

org.jowidgets.tools.widgets.wrapper.ContainerWrapper

All Implemented Interfaces:

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

Direct Known Subclasses:

CompositeWrapper, FrameWrapper

public class ContainerWrapper
extends ComponentWrapper
implements IContainer

Constructor Summary

Constructors

Constructor and Description
ContainerWrapper(IContainer widget)

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	addComponentListenerRecursive(IListenerFactory<IComponentListener> listenerFactory)
void	addContainerListener(IContainerListener listener) Adds a container listener
void	addContainerRegistry(IContainerRegistry registry) Adds a container registry recursively.
void	addFocusListenerRecursive(IListenerFactory<IFocusListener> listenerFactory)
void	addKeyListenerRecursive(IListenerFactory<IKeyListener> listenerFactory)
void	addMouseListenerRecursive(IListenerFactory<IMouseListener> listenerFactory)
void	addPopupDetectionListenerRecursive(IListenerFactory<IPopupDetectionListener> listenerFactory)
Dimension	computeDecoratedSize(Dimension clientAreaSize) Gets the decorated size (size with border / insets ) for a given client area size
java.util.List<IControl>	getChildren() Gets the containers children
Rectangle	getClientArea() Gets the client area of the container.
protected IContainer	getWidget()
void	layout() Layouts the container
void	layoutBegin() Informs that more than one operation on the containers children be done and that now redraw should be done until layout end will be invoked to avoid flickering.
void	layoutEnd() Layouts the container
void	layoutLater() Layouts the container later in the event queue.
boolean	remove(IControl control) Removes a control from this container.
void	removeAll() Removes all child controls from the container.
void	removeComponentListenerRecursive(IListenerFactory<IComponentListener> listenerFactory)
void	removeContainerListener(IContainerListener listener) Removes a container listener
void	removeContainerRegistry(IContainerRegistry registry) Removes a container registry
void	removeFocusListenerRecursive(IListenerFactory<IFocusListener> listenerFactory)
void	removeKeyListenerRecursive(IListenerFactory<IKeyListener> listenerFactory)
void	removeMouseListenerRecursive(IListenerFactory<IMouseListener> listenerFactory)
void	removePopupDetectionListenerRecursive(IListenerFactory<IPopupDetectionListener> listenerFactory)
void	setLayout(ILayoutDescriptor layoutDescriptor) Sets the layout for this container
<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 class org.jowidgets.tools.widgets.wrapper.ComponentWrapper

addComponentListener, addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, addPopupDetectionListener, addShowingStateListener, createPopupMenu, fromComponent, getBackgroundColor, getBounds, getForegroundColor, getPosition, getSize, hasFocus, isReparentable, isShowing, isVisible, redraw, removeComponentListener, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePopupDetectionListener, removeShowingStateListener, requestFocus, setBackgroundColor, setBounds, setCursor, setForegroundColor, setPopupMenu, setPosition, setPosition, setRedrawEnabled, setSize, setSize, setVisible, toComponent, toLocal, toScreen

Methods inherited from class org.jowidgets.tools.widgets.wrapper.WidgetWrapper

addDisposeListener, dispose, getParent, getRoot, getUiReference, isDisposed, isEnabled, removeDisposeListener, setEnabled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

ContainerWrapper

public ContainerWrapper(IContainer widget)

Method Detail

getWidget

protected IContainer getWidget()

Overrides:

getWidget in class ComponentWrapper

getClientArea

public Rectangle getClientArea()

Description copied from interface: IContainerCommon

Gets the client area of the container. Thats the area where child controls can be layouted into.

Specified by:

getClientArea in interface IContainerCommon

Returns:

The client area, never null

computeDecoratedSize

public Dimension computeDecoratedSize(Dimension clientAreaSize)

Description copied from interface: IContainerCommon

Gets the decorated size (size with border / insets ) for a given client area size

Specified by:

computeDecoratedSize in interface IContainerCommon

Parameters:

clientAreaSize - The client area size to get the decorated size for.

Returns:

The decorated size

setLayout

public void setLayout(ILayoutDescriptor layoutDescriptor)

Description copied from interface: IContainerCommon

Sets the layout for this container

Specified by:

setLayout in interface IContainerCommon

Parameters:

layoutDescriptor - The layout to set

setLayout

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

Description copied from interface: IContainer

Sets the layouter for this container defined by a layout factory

Specified by:

setLayout in interface IContainer

Parameters:

layoutFactory - The layout to set

Returns:

The layouter created from the factory

layoutBegin

public void layoutBegin()

Description copied from interface: IContainerCommon

Informs that more than one operation on the containers children be done and that now redraw should be done until layout end will be invoked to avoid flickering.

Specified by:

layoutBegin in interface IContainerCommon

layout

public void layout()

Description copied from interface: IContainer

Layouts the container

Specified by:

layout in interface IContainer

layoutEnd

public void layoutEnd()

Description copied from interface: IContainerCommon

Layouts the container

Specified by:

layoutEnd in interface IContainerCommon

layoutLater

public void layoutLater()

Description copied from interface: IContainer

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.

Specified by:

layoutLater in interface IContainer

removeAll

public void removeAll()

Description copied from interface: IContainerCommon

Removes all child controls from the container. The removed controls will be disposed

Specified by:

removeAll in interface IContainerCommon

getChildren

public java.util.List<IControl> getChildren()

Description copied from interface: IContainer

Gets the containers children

Specified by:

getChildren in interface IContainer

Returns:

a unmodifiable copy of the containers children

remove

public boolean remove(IControl control)

Description copied from interface: IContainer

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

Specified by:

remove in interface IContainer

Parameters:

control - The control to remove

Returns:

true if the widget was removed, false otherwise

add

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

Description copied from interface: IContainer

Creates and adds an control to this container.

Specified by:

add in interface IContainer

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

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

Description copied from interface: IContainer

Creates and adds an control to this container.

Specified by:

add in interface IContainer

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

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

Description copied from interface: IContainer

Creates and adds an control to this container

Specified by:

add in interface IContainer

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

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

Description copied from interface: IContainer

Creates and adds an control to this container

Specified by:

add in interface IContainer

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

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

Description copied from interface: IContainer

Creates and adds an control to this container.

Specified by:

add in interface IContainer

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

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

Description copied from interface: IContainer

Creates and adds an control to this container

Specified by:

add in interface IContainer

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

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

Description copied from interface: IContainer

Creates and adds an control to this container.

Specified by:

add in interface IContainer

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

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

Description copied from interface: IContainer

Creates and adds an control to this container

Specified by:

add in interface IContainer

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

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

Description copied from interface: IContainer

Sets the tab order of the container's controls.

Specified by:

setTabOrder in interface IContainer

Parameters:

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

setTabOrder

public void setTabOrder(IControl... controls)

Description copied from interface: IContainer

Sets the tab order of the container's controls.

Specified by:

setTabOrder in interface IContainer

addContainerListener

public void addContainerListener(IContainerListener listener)

Description copied from interface: IContainerObservable

Adds a container listener

Specified by:

addContainerListener in interface IContainerObservable

Parameters:

listener - The listener to add

removeContainerListener

public void removeContainerListener(IContainerListener listener)

Description copied from interface: IContainerObservable

Removes a container listener

Specified by:

removeContainerListener in interface IContainerObservable

Parameters:

listener - The listener to remove

addContainerRegistry

public void addContainerRegistry(IContainerRegistry registry)

Description copied from interface: IContainer

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

Specified by:

addContainerRegistry in interface IContainer

Parameters:

registry - The registry to add

removeContainerRegistry

public void removeContainerRegistry(IContainerRegistry registry)

Description copied from interface: IContainer

Removes a container registry

Specified by:

removeContainerRegistry in interface IContainer

Parameters:

registry - The registry to remove

addComponentListenerRecursive

public void addComponentListenerRecursive(IListenerFactory<IComponentListener> listenerFactory)

Specified by:

addComponentListenerRecursive in interface IRecursiveContainerObservable

removeComponentListenerRecursive

public void removeComponentListenerRecursive(IListenerFactory<IComponentListener> listenerFactory)

Specified by:

removeComponentListenerRecursive in interface IRecursiveContainerObservable

addFocusListenerRecursive

public void addFocusListenerRecursive(IListenerFactory<IFocusListener> listenerFactory)

Specified by:

addFocusListenerRecursive in interface IRecursiveContainerObservable

removeFocusListenerRecursive

public void removeFocusListenerRecursive(IListenerFactory<IFocusListener> listenerFactory)

Specified by:

removeFocusListenerRecursive in interface IRecursiveContainerObservable

addKeyListenerRecursive

public void addKeyListenerRecursive(IListenerFactory<IKeyListener> listenerFactory)

Specified by:

addKeyListenerRecursive in interface IRecursiveContainerObservable

removeKeyListenerRecursive

public void removeKeyListenerRecursive(IListenerFactory<IKeyListener> listenerFactory)

Specified by:

removeKeyListenerRecursive in interface IRecursiveContainerObservable

addMouseListenerRecursive

public void addMouseListenerRecursive(IListenerFactory<IMouseListener> listenerFactory)

Specified by:

addMouseListenerRecursive in interface IRecursiveContainerObservable

removeMouseListenerRecursive

public void removeMouseListenerRecursive(IListenerFactory<IMouseListener> listenerFactory)

Specified by:

removeMouseListenerRecursive in interface IRecursiveContainerObservable

addPopupDetectionListenerRecursive

public void addPopupDetectionListenerRecursive(IListenerFactory<IPopupDetectionListener> listenerFactory)

Specified by:

addPopupDetectionListenerRecursive in interface IRecursiveContainerObservable

removePopupDetectionListenerRecursive

public void removePopupDetectionListenerRecursive(IListenerFactory<IPopupDetectionListener> listenerFactory)

Specified by:

removePopupDetectionListenerRecursive in interface IRecursiveContainerObservable