com.vaadin.ui.VerticalLayout Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui;
import com.vaadin.shared.ui.orderedlayout.VerticalLayoutState;
/**
* Vertical layout
*
* VerticalLayout is a component container, which shows the
* subcomponents in the order of their addition (vertically). A vertical layout
* is by default 100% wide.
*
* @author Vaadin Ltd.
* @since 5.3
*/
@SuppressWarnings("serial")
public class VerticalLayout extends AbstractOrderedLayout {
/**
* Constructs an empty VerticalLayout.
*/
public VerticalLayout() {
setWidth("100%");
setSpacing(true);
setMargin(true);
}
/**
* Constructs a VerticalLayout with the given components. The components are
* added in the given order.
*
* @see AbstractOrderedLayout#addComponents(Component...)
*
* @param children
* The components to add.
*/
public VerticalLayout(Component... children) {
this();
addComponents(children);
}
@Override
protected VerticalLayoutState getState() {
return (VerticalLayoutState) super.getState();
}
@Override
protected VerticalLayoutState getState(boolean markAsDirty) {
return (VerticalLayoutState) super.getState(markAsDirty);
}
/**
* Adds the given components to this layout and sets them as expanded. The
* height of all added child components are set to 100% so that the
* expansion will be effective. The height of this layout is also set to
* 100% if it is currently undefined.
*
* The components are added in the provided order to the end of this layout.
* Any components that are already children of this layout will be moved to
* new positions.
*
* @param components
* the components to set, not null
* @since 8.0
*/
public void addComponentsAndExpand(Component... components) {
addComponents(components);
if (getHeight() < 0) {
setHeight(100, Unit.PERCENTAGE);
}
for (Component child : components) {
child.setHeight(100, Unit.PERCENTAGE);
setExpandRatio(child, 1);
}
}
}