com.vaadin.ui
Interface ComponentContainer

All Superinterfaces:

Component, EventListener, Paintable, Serializable, Sizeable, VariableOwner

All Known Subinterfaces:

Layout

All Known Implementing Classes:

AbsoluteLayout, AbstractComponentContainer, AbstractLayout, AbstractOrderedLayout, AbstractSplitPanel, Accordion, CssLayout, CustomComponent, CustomLayout, DragAndDropWrapper, ExpandLayout, FormLayout, GridLayout, HorizontalLayout, HorizontalSplitPanel, LoginForm, OrderedLayout, Panel, PopupView, SplitPanel, TabSheet, VerticalLayout, VerticalSplitPanel, Window

public interface ComponentContainer
extends Component

Extension to the Component interface which adds to it the capacity to contain other components. All UI elements that can have child elements implement this interface.

Since:

3.0

Version:

6.8.18

Author:

Vaadin Ltd.

Nested Class Summary

static class	ComponentContainer.ComponentAttachEvent Component attach event sent when a component is attached to container.
static interface	ComponentContainer.ComponentAttachListener Component attach listener interface.
static class	ComponentContainer.ComponentDetachEvent Component detach event sent when a component is detached from container.
static interface	ComponentContainer.ComponentDetachListener Component detach listener interface.

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.terminal.Paintable

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Field Summary

Fields inherited from interface com.vaadin.terminal.Sizeable

SIZE_UNDEFINED, UNIT_SYMBOLS, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

void	addComponent(Component c) Adds the component into this container.
void	addListener(ComponentContainer.ComponentAttachListener listener) Listens the component attach events.
void	addListener(ComponentContainer.ComponentDetachListener listener) Listens the component detach events.
Iterator<Component>	getComponentIterator() Gets an iterator to the collection of contained components.
void	moveComponentsFrom(ComponentContainer source) Moves all components from an another container into this container.
void	removeAllComponents() Removes all components from this container.
void	removeComponent(Component c) Removes the component from this container.
void	removeListener(ComponentContainer.ComponentAttachListener listener) Stops the listening component attach events.
void	removeListener(ComponentContainer.ComponentDetachListener listener) Stops the listening component detach events.
void	replaceComponent(Component oldComponent, Component newComponent) Replaces the component in the container with another one without changing position.
void	requestRepaintAll() Causes a repaint of this component, and all components below it.

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, childRequestedRepaint, detach, getApplication, getCaption, getIcon, getLocale, getParent, getStyleName, getWindow, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setParent, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.terminal.Paintable

addListener, getDebugId, paint, removeListener, requestRepaint, requestRepaintRequests, setDebugId

Methods inherited from interface com.vaadin.terminal.VariableOwner

changeVariables, isImmediate

Methods inherited from interface com.vaadin.terminal.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeight, setHeightUnits, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidth, setWidthUnits

Method Detail

addComponent

void addComponent(Component c)

Adds the component into this container.

Parameters:

c - the component to be added.

removeComponent

void removeComponent(Component c)

Removes the component from this container.

Parameters:

c - the component to be removed.

removeAllComponents

void removeAllComponents()

Removes all components from this container.

replaceComponent

void replaceComponent(Component oldComponent,
                      Component newComponent)

Replaces the component in the container with another one without changing position.

This method replaces component with another one is such way that the new component overtakes the position of the old component. If the old component is not in the container, the new component is added to the container. If the both component are already in the container, their positions are swapped. Component attach and detach events should be taken care as with add and remove.

Parameters:

oldComponent - the old component that will be replaced.

newComponent - the new component to be replaced.

getComponentIterator

Iterator<Component> getComponentIterator()

Gets an iterator to the collection of contained components. Using this iterator it is possible to step through all components contained in this container.

Returns:

the component iterator.

requestRepaintAll

void requestRepaintAll()

Causes a repaint of this component, and all components below it. This should only be used in special cases, e.g when the state of a descendant depends on the state of a ancestor.

moveComponentsFrom

void moveComponentsFrom(ComponentContainer source)

Moves all components from an another container into this container. The components are removed from source.

Parameters:

source - the container which contains the components that are to be moved to this container.

addListener

void addListener(ComponentContainer.ComponentAttachListener listener)

Listens the component attach events.

Parameters:

listener - the listener to add.

removeListener

void removeListener(ComponentContainer.ComponentAttachListener listener)

Stops the listening component attach events.

Parameters:

listener - the listener to removed.

addListener

void addListener(ComponentContainer.ComponentDetachListener listener)

Listens the component detach events.

removeListener

void removeListener(ComponentContainer.ComponentDetachListener listener)

Stops the listening component detach events.