ej.fp

Class Composite

java.lang.Object

ej.fp.Widget

ej.fp.Composite

All Implemented Interfaces:

Iterable<Widget>

Direct Known Subclasses:

Device

public class Composite
extends Widget
implements Iterable<Widget>

A composite is a widget that can contain other Widget instances, following the composite pattern.

The children are stored in a list. The order of the list defines the front-to-back stacking order of the widgets within the composite. The first widget in the list is at the back of the stacking order.

A widget cannot be added two times in a hierarchy.

Nested Class Summary

Nested classes/interfaces inherited from class ej.fp.Widget

Widget.WidgetAttribute, Widget.WidgetDescription

Field Summary

Fields inherited from class ej.fp.Widget

DEFAULT_LABEL

Constructor Summary

Constructors

Constructor and Description
Composite() Creates a new composite.

Method Summary

Modifier and Type	Method and Description
void	add(Widget widget) Adds the specified widget to the end of the list of children of this composite.
void	dispose() Disposes all composite children widgets.
Iterator<Widget>	iterator() Gets an iterator over the composite children widgets in proper sequence.

Methods inherited from class ej.fp.Widget

finalizeConfiguration, getAbsoluteX, getAbsoluteY, getCurrentSkin, getFilter, getHeight, getLabel, getParent, getSkin, getWidth, getX, getY, isOver, repaint, repaint, setCurrentSkin, setFilter, setHeight, setLabel, setOverlay, setSkin, setWidth, setX, setY, showYourself, start

Methods inherited from class java.lang.Object

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

Constructor Detail

Composite

public Composite()

Creates a new composite.

Its bounds will be set to 0.

Method Detail

add

public void add(Widget widget)
         throws IllegalArgumentException

Adds the specified widget to the end of the list of children of this composite. If Widget widget is null, no exception is thrown and no action is performed.

Parameters:

widget - the widget to add.

Throws:

IllegalArgumentException - if the specified widget is already in a hierarchy (already contained in a composite).

dispose

public void dispose()

Disposes all composite children widgets. When a child is a composite, its children are disposed too.

Overrides:

dispose in class Widget

iterator

public Iterator<Widget> iterator()

Gets an iterator over the composite children widgets in proper sequence. When a child is a composite, the returned iterator iterates on its children.

The Iterator.remove() is not implemented (throws a UnsupportedOperationException).

Specified by:

iterator in interface Iterable<Widget>

Returns:

an iterator over the composite children widgets in proper sequence.