com.vaadin.flow.component.orderedlayout.VerticalLayout Maven / Gradle / Ivy
/*
* Copyright 2000-2024 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.flow.component.orderedlayout;
import com.vaadin.flow.component.ClickNotifier;
import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.HasElement;
import com.vaadin.flow.component.Tag;
import com.vaadin.flow.component.dependency.JsModule;
import com.vaadin.flow.component.dependency.NpmPackage;
/**
* Vertical Layout places components top-to-bottom in a column. By default, it
* has 100% width and undefined height, meaning its width is constrained by its
* parent component and its height is determined by the components it contains.
*/
@Tag("vaadin-vertical-layout")
@NpmPackage(value = "@vaadin/polymer-legacy-adapter", version = "23.5.5")
@JsModule("@vaadin/polymer-legacy-adapter/style-modules.js")
@NpmPackage(value = "@vaadin/vertical-layout", version = "23.5.5")
@NpmPackage(value = "@vaadin/vaadin-ordered-layout", version = "23.5.5")
@JsModule("@vaadin/vertical-layout/src/vaadin-vertical-layout.js")
public class VerticalLayout extends Component implements ThemableLayout,
FlexComponent, ClickNotifier {
/**
* Constructs an empty layout with spacing and padding on by default.
*/
public VerticalLayout() {
setWidth("100%");
setSpacing(true);
setPadding(true);
}
/**
* Convenience constructor to create a layout with the children already
* inside it.
*
* @param children
* the items to add to this layout
* @see #add(Component...)
*/
public VerticalLayout(Component... children) {
this();
add(children);
}
/**
* {@inheritDoc}
*
* Spacing is enabled by default for vertical layout.
*
* @param spacing
* adds {@code spacing} theme setting if {@code true} or removes
* it if {@code false}
*/
@Override
public void setSpacing(boolean spacing) {
ThemableLayout.super.setSpacing(spacing);
}
/**
* {@inheritDoc}
*
* Padding is enabled by default for vertical layout.
*
* @param padding
* adds {@code padding} theme setting if {@code true} or removes
* it if {@code false}
*/
@Override
public void setPadding(boolean padding) {
ThemableLayout.super.setPadding(padding);
}
/**
* Sets a horizontal alignment for individual components inside the layout.
* This individual alignment for the component overrides any alignment set
* at the {@link #setDefaultHorizontalComponentAlignment(Alignment)}.
*
* The default alignment for individual components is
* {@link Alignment#AUTO}.
*
* It's the same as the {@link #setAlignSelf(Alignment, HasElement...)}
* method.
*
* @param alignment
* the individual alignment for the children components. Setting
* null will reset the alignment to its default
* @param componentsToAlign
* The components to which the individual alignment should be set
*/
public void setHorizontalComponentAlignment(Alignment alignment,
Component... componentsToAlign) {
setAlignSelf(alignment, componentsToAlign);
}
/**
* Gets the individual horizontal alignment of a given component.
*
* The default alignment for individual components is
* {@link Alignment#AUTO}.
*
* It's the same as the {@link #getAlignSelf(HasElement)} method
*
* @see #getAlignSelf(HasElement)
*
* @param component
* The component which individual layout should be read
* @return the alignment of the component, never null
*/
public Alignment getHorizontalComponentAlignment(Component component) {
return getAlignSelf(component);
}
/**
* Sets the default horizontal alignment to be used by all components
* without individual alignments inside the layout. Individual components
* can be aligned by using the
* {@link #setHorizontalComponentAlignment(Alignment, Component...)} method.
*
* The default alignment is {@link Alignment#STRETCH}.
*
* It's the same as the {@link #setAlignItems(Alignment)} method.
*
* @param alignment
* the alignment to apply to the components. Setting
* null will reset the alignment to its default
*/
public void setDefaultHorizontalComponentAlignment(Alignment alignment) {
setAlignItems(alignment);
}
/**
* Gets the default horizontal alignment used by all components without
* individual alignments inside the layout.
*
* The default alignment is {@link Alignment#STRETCH}.
*
* It's the same as the {@link #getAlignItems()} method.
*
* @return the general alignment used by the layout, never null
*/
public Alignment getDefaultHorizontalComponentAlignment() {
return getAlignItems();
}
/**
* This is the same as
* {@link #setDefaultHorizontalComponentAlignment(Alignment)}.
*
* @param alignment
* the alignment to apply to the components. Setting
* null will reset the alignment to its default
* @see #setDefaultHorizontalComponentAlignment(Alignment)
*/
@Override
public void setAlignItems(Alignment alignment) {
// this method is overridden to make javadocs point to the correct
// method to be used, and since FlexComponent has different default
// value.
FlexComponent.super.setAlignItems(alignment);
}
/**
* This is the same as {@link #getDefaultHorizontalComponentAlignment()}.
*
* @return the general alignment used by the layout, never null
*/
@Override
public Alignment getAlignItems() {
// this method is overridden to make javadocs point to the correct
// method to be used, and since FlexComponent has different default
// value.
return FlexComponent.super.getAlignItems();
}
/**
* This is the same as
* {@link #setHorizontalComponentAlignment(Alignment, Component...)}.
*
* @param alignment
* the individual alignment for the children components. Setting
* null will reset the alignment to its default
* @param elementContainers
* The element containers (components) to which the individual
* alignment should be set
* @see #setHorizontalComponentAlignment(Alignment, Component...)
*/
@Override
public void setAlignSelf(Alignment alignment,
HasElement... elementContainers) {
// this method is overridden to have javadocs that point to the method
// that should be used and has better javadocs.
FlexComponent.super.setAlignSelf(alignment, elementContainers);
}
/**
* This is the same as {@link #getHorizontalComponentAlignment(Component)}.
*
* @param container
* The element container (component) which individual layout
* should be read
* @return the alignment of the container, never null
* @see #getHorizontalComponentAlignment(Component)
*/
@Override
public Alignment getAlignSelf(HasElement container) {
// this method is overridden to have javadocs that point to the method
// that should be used and has better javadocs.
return FlexComponent.super.getAlignSelf(container);
}
/**
* 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 height of this layout is also set to
* 100%.
*
* @param components
* the components to set, not null
*/
public void addAndExpand(Component... components) {
add(components);
setHeightFull();
expand(components);
}
}