com.vaadin.ui.


Interface Layout

All Superinterfaces:

Component, ComponentContainer, EventListener, Paintable, Serializable, Sizeable, VariableOwner

All Known Implementing Classes:

AbsoluteLayout, AbstractLayout, AbstractOrderedLayout, AbstractSplitPanel, CssLayout, CustomLayout, ExpandLayout, FormLayout, GridLayout, HorizontalLayout, HorizontalSplitPanel, OrderedLayout, SplitPanel, VerticalLayout, VerticalSplitPanel

public interface Layout
extends ComponentContainer, Serializable

Extension to the ComponentContainer interface which adds the layouting control to the elements in the container. This is required by the various layout components to enable them to place other components in specific locations in the UI.

Since:

3.0

Version:

6.8.18

Author:

Vaadin Ltd.

Nested Class Summary
static interface Layout.AlignmentHandler
          AlignmentHandler is most commonly an advanced Layout that can align its components.
static interface Layout.MarginHandler
          This type of layout supports automatic addition of margins (space around its components).
static class Layout.MarginInfo
           
static interface Layout.SpacingHandler
          This type of layout supports automatic addition of space between its components.
 
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
 
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 setMargin(boolean enabled)
          Enable layout margins.
 void setMargin(boolean top, boolean right, boolean bottom, boolean left)
          Enable specific layout margins.
 
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
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

setMargin

void setMargin(boolean enabled)

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.

Parameters:
enabled -

setMargin

void setMargin(boolean top,
               boolean right,
               boolean bottom,
               boolean left)

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.

Parameters:
top -
right -
bottom -
left -