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.board.
Class Board
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.board.Board
-
All Implemented Interfaces:
AttachNotifier,DetachNotifier,HasComponents,HasElement,HasEnabled,HasOrderedComponents,HasSize,HasStyle,Serializable@Tag("vaadin-board") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="23.1.15") @NpmPackage(value="@vaadin/board",version="23.1.15") @NpmPackage(value="@vaadin/vaadin-board",version="23.1.15") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/board/vaadin-board.js") public class Board extends Component implements HasSize, HasStyle, HasOrderedComponentsVaadin Board allows creating responsive layouts in an easy way.
A Board consists of
Rows 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);See Also:
-
-
Constructor Summary
Constructors Constructor Description Board()Creates an empty board.
-
Method Summary
All Methods Modifier and Type Method Description RowaddRow(Component... components)Creates a new row and adds the given components to the row.
voidredraw()Forces the board to be redrawn.
voidremoveRow(Row row)Removes the given row from the board.
-
Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.DetachNotifier
addDetachListener
-
Methods inherited from interface com.vaadin.flow.component.HasComponents
add, add, addComponentAsFirst, addComponentAtIndex, 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, replace
-
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
-
-
-
-
Constructor Detail
-
Board
public Board()Creates an empty board.
Use
addRow(Component...)to add content to the board.
-
-
Method Detail
-
addRow
public Row addRow(Component... components)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.
Parameters:
components- components to add, no more than 4Returns:
a row instance which can be used for further configuration
Throws:
IllegalArgumentException- if there are more than 4 components
-
removeRow
public void removeRow(Row row)Removes the given row from the board.
Parameters:
row- the row to be removed
-
redraw
public void redraw()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.
-
-