com.vaadin.fluent.api

Interface FluentAbstractOrderedLayout<THIS extends FluentAbstractLayout<THIS> & FluentLayout.FluentAlignmentHandler<THIS> & FluentLayout.FluentMarginHandler<THIS> & FluentLayout.FluentSpacingHandler<THIS>>

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.ComponentContainer, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, FluentAbstractComponent<THIS>, FluentAbstractComponentContainer<THIS>, FluentAbstractLayout<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponentContainer<THIS>, FluentContextClickNotifier<THIS>, FluentHasComponents<THIS>, FluentHasComponents.FluentComponentAttachDetachNotifier<THIS>, FluentLayout<THIS>, FluentLayout.FluentAlignmentHandler<THIS>, FluentLayout.FluentMarginHandler<THIS>, FluentLayout.FluentSpacingHandler<THIS>, FluentSizeable<THIS>, com.vaadin.ui.HasComponents, com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, Iterable<com.vaadin.ui.Component>, com.vaadin.ui.Layout, com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler, Serializable, com.vaadin.server.Sizeable

All Known Subinterfaces:

FluentFormLayout<THIS>, FluentHorizontalLayout<THIS>, FluentVerticalLayout<THIS>

All Known Implementing Classes:

FFormLayout, FHorizontalLayout, FVerticalLayout

public interface FluentAbstractOrderedLayout<THIS extends FluentAbstractLayout<THIS> & FluentLayout.FluentAlignmentHandler<THIS> & FluentLayout.FluentMarginHandler<THIS> & FluentLayout.FluentSpacingHandler<THIS>>
extends FluentLayout.FluentAlignmentHandler<THIS>, FluentLayout.FluentMarginHandler<THIS>, FluentLayout.FluentSpacingHandler<THIS>, FluentAbstractLayout<THIS>

The base interface for fluent versions of AbstractOrderedLayout

See Also:

AbstractOrderedLayout

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentLayout

FluentLayout.FluentAlignmentHandler<THIS extends FluentLayout.FluentAlignmentHandler<THIS>>, FluentLayout.FluentMarginHandler<THIS extends FluentLayout.FluentMarginHandler<THIS>>, FluentLayout.FluentSpacingHandler<THIS extends FluentLayout.FluentSpacingHandler<THIS>>

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

com.vaadin.ui.Layout.AlignmentHandler, com.vaadin.ui.Layout.MarginHandler, com.vaadin.ui.Layout.SpacingHandler

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentHasComponents

FluentHasComponents.FluentComponentAttachDetachNotifier<THIS extends FluentHasComponents<THIS>>

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

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

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

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

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

Method Summary

Modifier and Type	Method and Description
default THIS	withComponent(com.vaadin.ui.Component c, int index) Adds a component into indexed position in this container.
default THIS	withComponentAsFirst(com.vaadin.ui.Component c) Adds a component into this container.
default THIS	withExpandRatio(com.vaadin.ui.Component component, float ratio) This method is used to control how excess space in layout is distributed among components.

Methods inherited from interface com.vaadin.fluent.api.FluentLayout.FluentAlignmentHandler

withComponentAlignment, withDefaultComponentAlignment

Methods inherited from interface com.vaadin.ui.Layout.AlignmentHandler

getComponentAlignment, getDefaultComponentAlignment, setComponentAlignment, setDefaultComponentAlignment

Methods inherited from interface com.vaadin.fluent.api.FluentLayout.FluentMarginHandler

withMargin, withMargin

Methods inherited from interface com.vaadin.ui.Layout.MarginHandler

getMargin, setMargin, setMargin

Methods inherited from interface com.vaadin.fluent.api.FluentLayout.FluentSpacingHandler

withSpacing

Methods inherited from interface com.vaadin.ui.Layout.SpacingHandler

isSpacing, setSpacing

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Methods inherited from interface com.vaadin.fluent.api.FluentComponentContainer

withComponent, withComponents

Methods inherited from interface com.vaadin.ui.ComponentContainer

addComponent, addComponents, getComponentCount, getComponentIterator, moveComponentsFrom, removeAllComponents, removeComponent, replaceComponent

Methods inherited from interface com.vaadin.ui.HasComponents

iterator

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

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

Methods inherited from interface com.vaadin.fluent.api.FluentHasComponents.FluentComponentAttachDetachNotifier

withComponentAttachListener, withComponentDetachListener

Methods inherited from interface com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier

addComponentAttachListener, addComponentDetachListener, removeComponentAttachListener, removeComponentDetachListener

Method Detail

withComponent

default THIS withComponent(com.vaadin.ui.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.

Returns:

this (for method chaining)

See Also:

AbstractOrderedLayout.addComponent(Component, int)

withComponentAsFirst

default THIS withComponentAsFirst(com.vaadin.ui.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.

Returns:

this (for method chaining)

See Also:

AbstractOrderedLayout.addComponentAsFirst(Component)

withExpandRatio

default THIS withExpandRatio(com.vaadin.ui.Component component,
                             float ratio)

This method is used to control how excess space in layout is distributed among components. Excess space may exist if layout is sized and contained non relatively sized components don't consume all available space.

Example how to distribute 1:3 (33%) for component1 and 2:3 (67%) for component2 : layout.setExpandRatio(component1, 1);
layout.setExpandRatio(component2, 2);

If no ratios have been set, the excess space is distributed evenly among all components.

Note, that width or height (depending on orientation) needs to be defined for this method to have any effect.

Parameters:

component - the component in this layout which expand ratio is to be set

ratio - new expand ratio (greater or equal to 0)

Returns:

this (for method chaining)

Throws:

IllegalArgumentException - if the expand ratio is negative or the component is not a direct child of the layout

See Also:

Sizeable, AbstractOrderedLayout.setExpandRatio(Component, float)