We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.orderedlayout.
Class HorizontalLayout
java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.orderedlayout.HorizontalLayout
All Implemented Interfaces:
AttachNotifier, ClickNotifier<HorizontalLayout>, DetachNotifier, HasComponents, HasElement, HasEnabled, HasOrderedComponents, HasSize, HasStyle, FlexComponent, ThemableLayout, Serializable
@Tag("vaadin-horizontal-layout")
@NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.0.2") @NpmPackage(value="@vaadin/horizontal-layout",version="24.0.2")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/horizontal-layout/src/vaadin-horizontal-layout.js")
public class HorizontalLayout
extends Component
implements ThemableLayout, FlexComponent, ClickNotifier<HorizontalLayout>
Horizontal Layout places components side-by-side in a row. By default, it has undefined width and height, meaning its size is determined by the components it contains.
See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent
FlexComponent.Alignment, FlexComponent.JustifyContentMode -
Constructor Summary
ConstructorsConstructorDescriptionConstructs 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 TypeMethodDescriptionvoidaddAndExpand(Component... components) Adds the given components to this layout and sets them as expanded.
This is the same as
getDefaultVerticalComponentAlignment().getAlignSelf(HasElement component) This is the same as
getVerticalComponentAlignment(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.
voidsetAlignItems(FlexComponent.Alignment alignment) This is the same as
setDefaultVerticalComponentAlignment(Alignment).voidsetAlignSelf(FlexComponent.Alignment alignment, HasElement... components) This is the same as
setVerticalComponentAlignment(Alignment, Component...).voidSets the default vertical alignment to be used by all components without individual alignments inside the layout.
voidsetSpacing(boolean spacing) Toggles
spacingtheme setting for the element.voidsetVerticalComponentAlignment(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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.vaadin.flow.component.AttachNotifier
addAttachListenerMethods inherited from interface com.vaadin.flow.component.ClickNotifier
addClickListener, addClickShortcutMethods inherited from interface com.vaadin.flow.component.DetachNotifier
addDetachListenerMethods inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent
expand, getFlexGrow, getFlexShrink, getJustifyContentMode, replace, setFlexGrow, setFlexShrink, setJustifyContentModeMethods inherited from interface com.vaadin.flow.component.HasComponents
add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAllMethods inherited from interface com.vaadin.flow.component.HasElement
getElementMethods inherited from interface com.vaadin.flow.component.HasEnabled
isEnabled, setEnabledMethods inherited from interface com.vaadin.flow.component.HasOrderedComponents
getChildren, getComponentAt, getComponentCount, indexOfMethods 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, setWidthFullMethods inherited from interface com.vaadin.flow.component.HasStyle
addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassNameMethods 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 layoutSee Also:
-
-
Method Details
-
setSpacing
public void setSpacing(boolean spacing) Toggles
spacingtheme 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:
setSpacingin interfaceThemableLayoutParameters:
spacing- addsspacingtheme setting iftrueor 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 the
setDefaultVerticalComponentAlignment(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...)methodParameters:
alignment- the individual alignment for the children components. Settingnullwill reset the alignment to its defaultcomponentsToAlign- The components to which the individual alignment should be setSee 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 readReturns:
the alignment of the component, never
nullSee 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 the
setVerticalComponentAlignment(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. Settingnullwill reset the alignment to its defaultSee 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 as
setDefaultVerticalComponentAlignment(Alignment).Specified by:
setAlignItemsin interfaceFlexComponentParameters:
alignment- the alignment to apply to the components. Settingnullwill reset the alignment to its defaultSee Also:
-
getAlignItems
This is the same as
getDefaultVerticalComponentAlignment().Specified by:
getAlignItemsin interfaceFlexComponentReturns:
the general alignment used by the layout, never
null -
setAlignSelf
This is the same as
setVerticalComponentAlignment(Alignment, Component...).Specified by:
setAlignSelfin interfaceFlexComponentParameters:
alignment- the individual alignment for the children components. Settingnullwill reset the alignment to its defaultcomponents- The components to which the individual alignment should be setSee Also:
-
getAlignSelf
This is the same as
getVerticalComponentAlignment(Component).Specified by:
getAlignSelfin interfaceFlexComponentParameters:
component- The component which individual layout should be readReturns:
the alignment of the component, never
nullSee 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
-