com.vaadin.flow.component.board.Board Maven / Gradle / Ivy
package com.vaadin.flow.component.board;
/*-
* #%L
* Vaadin Board for Vaadin 10
* %%
* Copyright (C) 2017 - 2018 Vaadin Ltd
* %%
* This program is available under Commercial Vaadin Add-On License 3.0
* (CVALv3).
*
* See the file license.html distributed with this software for more
* information about licensing.
*
* You should have received a copy of the CVALv3 along with this program.
* If not, see .
* #L%
*/
import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.HasOrderedComponents;
import com.vaadin.flow.component.HasSize;
import com.vaadin.flow.component.HasStyle;
import com.vaadin.flow.component.Tag;
import com.vaadin.flow.component.board.internal.FunctionCaller;
import com.vaadin.flow.component.dependency.HtmlImport;
import com.vaadin.flow.component.dependency.JsModule;
import com.vaadin.flow.component.dependency.NpmPackage;
/**
* Vaadin Board allows creating responsive layouts in an easy way.
*
* A Board consists of {@link Row}s where you can add any Vaadin component. Each
* Row consists of four columns, and can contain up to four components taking
* one column each, or fewer components with multiple columns each as long as
* sum of columns stays less than or equal to four.
*
* Here is a simple usage example:
*
*
* Board board = new Board();
* Label lbl1 = new Label("LABEL1");
* Label lbl2 = new Label("LABEL2");
* Label lbl3 = new Label("LABEL3");
* Label lbl4 = new Label("LABEL4");
* board.addRow(lbl1, lbl2, lbl3, lbl4);
*
*/
@Tag("vaadin-board")
@NpmPackage(value = "@vaadin/vaadin-board", version = "2.2.2")
@JsModule("@vaadin/vaadin-board/vaadin-board.js")
@HtmlImport("frontend://bower_components/vaadin-board/vaadin-board.html")
public class Board extends Component
implements HasSize, HasStyle, HasOrderedComponents {
/**
* Creates an empty board.
*
* Use {@link #addRow(Component...)} to add content to the board.
**/
public Board() {
setWidth("100%");
}
/**
* Creates a new row and adds the given components to the row.
*
* All the added components have cols set to 1, i.e. use one slot in the
* row. The number of slots in the row is the number of added components.
*
* @param components
* components to add, no more than 4
* @throws IllegalArgumentException
* if there are more than 4 components
* @return a row instance which can be used for further configuration
**/
public Row addRow(Component... components) {
Row row = new Row(components);
add(row);
return row;
}
/**
* Removes the given row from the board.
*
* @param row
* the row to be removed
**/
public void removeRow(Row row) {
remove(row);
}
/**
* Forces the board to be redrawn.
*
* This method typically only needs to be called if you change CSS (through
* a variable or otherwise) which affects the size of the board or the
* breakpoints used. Otherwise, the component will be redrawn automatically
* when needed.
*/
public void redraw() {
FunctionCaller.callOnceOnClientReponse(this, "redraw");
}
}