com.vaadin.ui
Class CssLayout

java.lang.Object
  com.vaadin.terminal.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.AbstractComponentContainer
              com.vaadin.ui.AbstractLayout
                  com.vaadin.ui.CssLayout

All Implemented Interfaces:

LayoutEvents.LayoutClickNotifier, MethodEventSource, Connector, ClientConnector, RpcTarget, Sizeable, Component, ComponentContainer, HasComponents, Layout, Layout.MarginHandler, Serializable, Iterable<Component>

Direct Known Subclasses:

Navigator.EmptyView

public class CssLayout
extends AbstractLayout
implements LayoutEvents.LayoutClickNotifier

CssLayout is a layout component that can be used in browser environment only. It simply renders components and their captions into a same div element. Component layout can then be adjusted with css.

In comparison to HorizontalLayout and VerticalLayout

• rather similar server side api
• no spacing, alignment or expand ratios
• much simpler DOM that can be styled by skilled web developer
• no abstraction of browser differences (developer must ensure that the result works properly on each browser)
• different kind of handling for relative sizes (that are set from server side) (*)
• noticeably faster rendering time in some situations as we rely more on the browser's rendering engine.

With CustomLayout one can often achieve similar results (good looking layouts with web technologies), but with CustomLayout developer needs to work with fixed templates.

By extending CssLayout one can also inject some css rules straight to child components using getCss(Component).

(*) Relative sizes (set from server side) are treated bit differently than in other layouts in Vaadin. In cssLayout the size is calculated relatively to CSS layouts content area which is pretty much as in html and css. In other layouts the size of component is calculated relatively to the "slot" given by layout.

Also note that client side framework in Vaadin modifies inline style properties width and height. This happens on each update to component. If one wants to set component sizes with CSS, component must have undefined size on server side (which is not the default for all components) and the size must be defined with class styles - not by directly injecting width and height.

Since:

6.1 brought in from "FastLayouts" incubator project

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler

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

Layout.AlignmentHandler, Layout.MarginHandler, Layout.MarginInfo, Layout.SpacingHandler

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

ComponentContainer.ComponentAttachEvent, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachEvent, ComponentContainer.ComponentDetachListener

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

Sizeable.Unit

Field Summary

protected LinkedList<Component>

components Custom layout slots containing the components.

Fields inherited from class com.vaadin.ui.AbstractLayout

margins

Fields inherited from interface com.vaadin.terminal.Sizeable

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

Constructor Summary

CssLayout()

Method Summary

void	addComponent(Component c) Add a component into this container.
void	addComponent(Component c, int index) Adds a component into indexed position in this container.
void	addComponentAsFirst(Component c) Adds a component into this container.
void	addListener(LayoutEvents.LayoutClickListener listener) Add a click listener to the layout.
Component	getComponent(int index) Returns the component at the given position.
int	getComponentCount() Gets the number of contained components.
int	getComponentIndex(Component component) Returns the index of the given component.
Iterator<Component>	getComponentIterator() Gets the component container iterator for going trough all the components in the container.
protected String	getCss(Component c) Returns styles to be applied to given component.
CssLayoutState	getState() Returns the shared state bean with information to be sent from the server to the client.
void	removeComponent(Component c) Removes the component from this container.
void	removeListener(LayoutEvents.LayoutClickListener listener) Removes an LayoutClickListener.
void	replaceComponent(Component oldComponent, Component newComponent) Replaces the component in the container with another one without changing position.
void	updateState() Called before the shared state is sent to the client.

Methods inherited from class com.vaadin.ui.AbstractLayout

getMargin, setMargin, setMargin, setMargin

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, isComponentVisible, iterator, moveComponentsFrom, removeAllComponents, removeListener, removeListener, setHeight, setVisible, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addShortcutListener, addStyleName, attach, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getActionManager, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getRoot, getStyle, getStyleName, getWidth, getWidthUnits, handleError, hasListeners, isConnectorEnabled, isEnabled, isImmediate, isReadOnly, isVisible, removeListener, removeListener, removeListener, removeListener, removeListener, removeShortcutListener, removeStyleName, requestRepaint, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setWidth

Methods inherited from class com.vaadin.terminal.AbstractClientConnector

addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.ComponentContainer

addListener, addListener, moveComponentsFrom, removeAllComponents, removeListener, removeListener

Methods inherited from interface com.vaadin.ui.HasComponents

isComponentVisible

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector

detach, getExtensions, getStateType, isConnectorEnabled, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent

Methods inherited from interface com.vaadin.terminal.gwt.client.Connector

getConnectorId

Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget

getRpcManager

Methods inherited from interface com.vaadin.terminal.Sizeable

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

Methods inherited from interface java.lang.Iterable

iterator

Field Detail

components

protected LinkedList<Component> components

Custom layout slots containing the components.

Constructor Detail

CssLayout

public CssLayout()

Method Detail

addComponent

public void addComponent(Component c)

Add a component into this container. The component is added to the right or under the previous component.

Specified by:

addComponent in interface ComponentContainer

Overrides:

addComponent in class AbstractComponentContainer

Parameters:

c - the component to be added.

See Also:

ComponentContainer.addComponent(Component)

addComponentAsFirst

public void addComponentAsFirst(Component c)

Adds a component into this container. The component is added to the left or on top of the other components.

Parameters:

c - the component to be added.

addComponent

public void addComponent(Component c,
                         int index)

Adds a component into indexed position in this container.

Parameters:

c - the component to be added.

index - the index of the component position. The components currently in and after the position are shifted forwards.

removeComponent

public void removeComponent(Component c)

Removes the component from this container.

Specified by:

removeComponent in interface ComponentContainer

Overrides:

removeComponent in class AbstractComponentContainer

Parameters:

c - the component to be removed.

See Also:

ComponentContainer.removeComponent(Component)

getComponentIterator

public Iterator<Component> getComponentIterator()

Gets the component container iterator for going trough all the components in the container.

Specified by:

getComponentIterator in interface HasComponents

Returns:

the Iterator of the components inside the container.

getComponentCount

public int getComponentCount()

Gets the number of contained components. Consistent with the iterator returned by getComponentIterator().

Specified by:

getComponentCount in interface ComponentContainer

Returns:

the number of contained components

updateState

public void updateState()

Description copied from interface: Component

Called before the shared state is sent to the client. Gives the component an opportunity to set computed/dynamic state values e.g. state values that depend on other component features.

This method must not alter the component hierarchy in any way.

Specified by:

updateState in interface Component

Overrides:

updateState in class AbstractComponent

getState

public CssLayoutState getState()

Description copied from class: AbstractComponent

Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

Specified by:

getState in interface Connector

Specified by:

getState in interface Component

Overrides:

getState in class AbstractLayout

Returns:

updated component shared state

getCss

protected String getCss(Component c)

Returns styles to be applied to given component. Override this method to inject custom style rules to components.

Note that styles are injected over previous styles before actual child rendering. Previous styles are not cleared, but overridden.

Note that one most often achieves better code style, by separating styling to theme (with custom theme and AbstractComponent.addStyleName(String). With own custom styles it is also very easy to break browser compatibility.

Parameters:

c - the component

Returns:

css rules to be applied to component

replaceComponent

public void replaceComponent(Component oldComponent,
                             Component newComponent)

Description copied from interface: ComponentContainer

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.

Specified by:

replaceComponent in interface ComponentContainer

Parameters:

oldComponent - the old component that will be replaced.

newComponent - the new component to be replaced.

addListener

public void addListener(LayoutEvents.LayoutClickListener listener)

Description copied from interface: LayoutEvents.LayoutClickNotifier

Add a click listener to the layout. The listener is called whenever the user clicks inside the layout. An event is also triggered when the click targets a component inside a nested layout or Panel, provided the targeted component does not prevent the click event from propagating. A caption is not considered part of a component. The child component that was clicked is included in the LayoutEvents.LayoutClickEvent. Use #removeListener(LayoutClickListener) to remove the listener.

Specified by:

addListener in interface LayoutEvents.LayoutClickNotifier

Parameters:

listener - The listener to add

removeListener

public void removeListener(LayoutEvents.LayoutClickListener listener)

Description copied from interface: LayoutEvents.LayoutClickNotifier

Removes an LayoutClickListener.

Specified by:

removeListener in interface LayoutEvents.LayoutClickNotifier

Parameters:

listener - LayoutClickListener to be removed

getComponentIndex

public int getComponentIndex(Component component)

Returns the index of the given component.

Parameters:

component - The component to look up.

Returns:

The index of the component or -1 if the component is not a child.

getComponent

public Component getComponent(int index)
                       throws IndexOutOfBoundsException

Returns the component at the given position.

Parameters:

index - The position of the component.

Returns:

The component at the given index.

Throws:

IndexOutOfBoundsException - If the index is out of range.