com.vaadin.ui
Class AbstractLayout

java.lang.Object
  com.vaadin.ui.AbstractComponent
      com.vaadin.ui.AbstractComponentContainer
          com.vaadin.ui.AbstractLayout

All Implemented Interfaces:

MethodEventSource, Paintable, Sizeable, VariableOwner, Component, ComponentContainer, Layout, Layout.MarginHandler, Serializable, EventListener

Direct Known Subclasses:

AbsoluteLayout, AbstractOrderedLayout, AbstractSplitPanel, CssLayout, CustomLayout, GridLayout

public abstract class AbstractLayout
extends AbstractComponentContainer
implements Layout, Layout.MarginHandler

An abstract class that defines default implementation for the Layout interface.

Since:

5.0

Version:

6.8.18

Author:

Vaadin Ltd.

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

Paintable.RepaintRequestEvent, Paintable.RepaintRequestListener

Field Summary

protected Layout.MarginInfo

margins

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

Constructor Summary

AbstractLayout()

Method Summary

void	changeVariables(Object source, Map<String,Object> variables) Called when one or more variables handled by the implementing class are changed.
protected void	fireClick(Map<String,Object> parameters) Fire a layout click event.
Layout.MarginInfo	getMargin()
void	paintContent(PaintTarget target) Paints any needed component-specific things to the given UIDL stream.
void	setMargin(boolean enabled) Enable layout margins.
void	setMargin(boolean topEnabled, boolean rightEnabled, boolean bottomEnabled, boolean leftEnabled) Enable specific layout margins.
void	setMargin(Layout.MarginInfo marginInfo) Enable margins for this layout.

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponent, addListener, addListener, attach, detach, fireComponentAttachEvent, fireComponentDetachEvent, moveComponentsFrom, removeAllComponents, removeComponent, removeListener, removeListener, requestRepaintAll, setEnabled, setHeight, setWidth

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addListener, addStyleName, childRequestedRepaint, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getApplication, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getListeners, getLocale, getParent, getStyle, getStyleName, getWidth, getWidthUnits, getWindow, handleError, hasListeners, isEnabled, isImmediate, isReadOnly, isVisible, paint, removeListener, removeListener, removeListener, removeListener, removeListener, removeListener, removeStyleName, requestRepaint, requestRepaintRequests, setCaption, setComponentError, setData, setDebugId, setDescription, setErrorHandler, setHeight, setHeight, setHeightUnits, setIcon, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyle, setStyleName, setVisible, setWidth, setWidth, setWidthUnits

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

addComponent, addListener, addListener, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponent, removeListener, removeListener, replaceComponent, requestRepaintAll

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

isImmediate

Methods inherited from interface com.vaadin.terminal.Sizeable

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

Field Detail

margins

protected Layout.MarginInfo margins

Constructor Detail

AbstractLayout

public AbstractLayout()

Method Detail

setMargin

public void setMargin(boolean enabled)

Description copied from interface: Layout

Enable layout margins. Affects all four sides of the layout. This will tell the client-side implementation to leave extra space around the layout. The client-side implementation decides the actual amount, and it can vary between themes.

Specified by:

setMargin in interface Layout

getMargin

public Layout.MarginInfo getMargin()

Specified by:

getMargin in interface Layout.MarginHandler

Returns:

MarginInfo containing the currently enabled margins.

setMargin

public void setMargin(Layout.MarginInfo marginInfo)

Description copied from interface: Layout.MarginHandler

Enable margins for this layout.

NOTE: This will only affect the space around the components in the layout, not space between the components in the layout. Use #setSpacing(boolean) to add space between the components in the layout.

See the reference manual for more information about CSS rules for defining the size of the margin.

Specified by:

setMargin in interface Layout.MarginHandler

Parameters:

marginInfo - MarginInfo object containing the new margins.

setMargin

public void setMargin(boolean topEnabled,
                      boolean rightEnabled,
                      boolean bottomEnabled,
                      boolean leftEnabled)

Description copied from interface: Layout

Enable specific layout margins. This will tell the client-side implementation to leave extra space around the layout in specified edges, clockwise from top (top, right, bottom, left). The client-side implementation decides the actual amount, and it can vary between themes.

Specified by:

setMargin in interface Layout

paintContent

public void paintContent(PaintTarget target)
                  throws PaintException

Description copied from class: AbstractComponent

Paints any needed component-specific things to the given UIDL stream. The more general AbstractComponent.paint(PaintTarget) method handles all general attributes common to all components, and it calls this method to paint any component-specific attributes to the UIDL stream.

Overrides:

paintContent in class AbstractComponent

Parameters:

target - the target UIDL stream where the component should paint itself to

Throws:

PaintException - if the paint operation failed.

changeVariables

public void changeVariables(Object source,
                            Map<String,Object> variables)

Description copied from interface: VariableOwner

Called when one or more variables handled by the implementing class are changed.

Specified by:

changeVariables in interface VariableOwner

Overrides:

changeVariables in class AbstractComponent

Parameters:

source - the Source of the variable change. This is the origin of the event. For example in Web Adapter this is the request.

variables - the Mapping from variable names to new variable values.

fireClick

protected void fireClick(Map<String,Object> parameters)

Fire a layout click event. Note that this method is only used by the subclasses that implement LayoutEvents.LayoutClickNotifier, and can be overridden for custom click event firing.

Parameters:

parameters - The parameters received from the client side implementation