Class HorizontalLayout
- All Implemented Interfaces:
AttachNotifier
,ClickNotifier<HorizontalLayout>
,DetachNotifier
,HasComponents
,HasElement
,HasEnabled
,HasOrderedComponents
,HasSize
,HasStyle
,FlexComponent
,ThemableLayout
,Serializable
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent
FlexComponent.Alignment, FlexComponent.JustifyContentMode
-
Constructor Summary
ConstructorDescriptionConstructs an empty layout with spacing on by default.HorizontalLayout
(Component... children) Convenience constructor to create a layout with the children already inside it. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAndExpand
(Component... components) Adds the given components to this layout and sets them as expanded.This is the same asgetDefaultVerticalComponentAlignment()
.getAlignSelf
(HasElement component) This is the same asgetVerticalComponentAlignment(Component)
.Gets the default vertical alignment used by all components without individual alignments inside the layout.getVerticalComponentAlignment
(Component component) Gets the individual vertical alignment of a given component.void
setAlignItems
(FlexComponent.Alignment alignment) This is the same assetDefaultVerticalComponentAlignment(Alignment)
.void
setAlignSelf
(FlexComponent.Alignment alignment, HasElement... components) This is the same assetVerticalComponentAlignment(Alignment, Component...)
.void
Sets the default vertical alignment to be used by all components without individual alignments inside the layout.void
setSpacing
(boolean spacing) Togglesspacing
theme setting for the element.void
setVerticalComponentAlignment
(FlexComponent.Alignment alignment, Component... componentsToAlign) Sets a vertical alignment for individual components inside the layout.Methods inherited from class com.vaadin.flow.component.Component
addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListener
Methods inherited from interface com.vaadin.flow.component.ClickNotifier
addClickListener, addClickShortcut
Methods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListener
Methods inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent
expand, getFlexGrow, getFlexShrink, getJustifyContentMode, replace, setFlexGrow, setFlexShrink, setJustifyContentMode
Methods inherited from interface com.vaadin.flow.component.HasComponents
add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll
Methods inherited from interface com.vaadin.flow.component.HasElement
getElement
Methods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabled
Methods inherited from interface com.vaadin.flow.component.HasOrderedComponents
getChildren, getComponentAt, getComponentCount, indexOf
Methods inherited from interface com.vaadin.flow.component.HasSize
getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull
Methods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName
Methods inherited from interface com.vaadin.flow.component.orderedlayout.ThemableLayout
getBoxSizing, getThemeList, isMargin, isPadding, isSpacing, setBoxSizing, setMargin, setPadding
-
Constructor Details
-
HorizontalLayout
public HorizontalLayout()Constructs an empty layout with spacing on by default. -
HorizontalLayout
Convenience constructor to create a layout with the children already inside it.- Parameters:
children
- the items to add to this layout- See Also:
-
-
Method Details
-
setSpacing
public void setSpacing(boolean spacing) Togglesspacing
theme setting for the element. If a theme supports this attribute, it will apply or remove spacing to the element.This method adds medium spacing to the component theme, to set other options, use
ThemableLayout.getThemeList()
. List of options possible:- spacing-xs
- spacing-s
- spacing
- spacing-l
- spacing-xl
Spacing is enabled by default for horizontal layout.
- Specified by:
setSpacing
in interfaceThemableLayout
- Parameters:
spacing
- addsspacing
theme setting iftrue
or removes it iffalse
-
setVerticalComponentAlignment
public void setVerticalComponentAlignment(FlexComponent.Alignment alignment, Component... componentsToAlign) Sets a vertical alignment for individual components inside the layout. This individual alignment for the component overrides any alignment set at thesetDefaultVerticalComponentAlignment(Alignment)
.It effectively sets the
"alignSelf"
style value.The default alignment for individual components is
FlexComponent.Alignment.AUTO
.It's the same as the
setAlignSelf(Alignment, HasElement...)
method- Parameters:
alignment
- the individual alignment for the children components. Settingnull
will reset the alignment to its defaultcomponentsToAlign
- The components to which the individual alignment should be set- See Also:
-
getVerticalComponentAlignment
Gets the individual vertical alignment of a given component.The default alignment for individual components is
FlexComponent.Alignment.AUTO
.It's the same as the
getAlignSelf(HasElement)
method.- Parameters:
component
- The component which individual layout should be read- Returns:
- the alignment of the component, never
null
- See Also:
-
setDefaultVerticalComponentAlignment
Sets the default vertical alignment to be used by all components without individual alignments inside the layout. Individual components can be aligned by using thesetVerticalComponentAlignment(Alignment, Component...)
method.It effectively sets the
"alignItems"
style value.The default alignment is
FlexComponent.Alignment.STRETCH
.It's the same as the
setAlignItems(Alignment)
method.- Parameters:
alignment
- the alignment to apply to the components. Settingnull
will reset the alignment to its default- See Also:
-
getDefaultVerticalComponentAlignment
Gets the default vertical alignment used by all components without individual alignments inside the layout.The default alignment is
FlexComponent.Alignment.STRETCH
.This is the same as the
getAlignItems()
method.- Returns:
- the general alignment used by the layout, never
null
-
setAlignItems
This is the same assetDefaultVerticalComponentAlignment(Alignment)
.- Specified by:
setAlignItems
in interfaceFlexComponent
- Parameters:
alignment
- the alignment to apply to the components. Settingnull
will reset the alignment to its default- See Also:
-
getAlignItems
This is the same asgetDefaultVerticalComponentAlignment()
.- Specified by:
getAlignItems
in interfaceFlexComponent
- Returns:
- the general alignment used by the layout, never
null
-
setAlignSelf
This is the same assetVerticalComponentAlignment(Alignment, Component...)
.- Specified by:
setAlignSelf
in interfaceFlexComponent
- Parameters:
alignment
- the individual alignment for the children components. Settingnull
will reset the alignment to its defaultcomponents
- The components to which the individual alignment should be set- See Also:
-
getAlignSelf
This is the same asgetVerticalComponentAlignment(Component)
.- Specified by:
getAlignSelf
in interfaceFlexComponent
- Parameters:
component
- The component which individual layout should be read- Returns:
- the alignment of the component, never
null
- See Also:
-
addAndExpand
Adds the given components to this layout and sets them as expanded. The flex-grow of all added child components are set to 1 so that the expansion will be effective. The width of this layout is also set to 100%.- Parameters:
components
- the components to set, notnull
-