Package com.vaadin.flow.component.board

Class Board

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.board.Board
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, Serializable
@Tag("vaadin-board") @NpmPackage(value="@vaadin/board", version="25.0.0-alpha17") @JsModule("@vaadin/board/src/vaadin-board.js") @Deprecated(since="25.0", forRemoval=true) public class Board extends com.vaadin.flow.component.Component implements com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasOrderedComponents
Deprecated, for removal: This API element is subject to removal in a future version.
Board is deprecated and will be removed in Vaadin 26. Consider using Dashboard as an alternative.
Vaadin 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.

See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Board()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates an empty board.

  • Method Summary

    Modifier and Type
    Method
    Description
    Row
    addRow(com.vaadin.flow.component.Component... components)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new row and adds the given components to the row.
    void
    redraw()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Forces the board to be redrawn.
    void
    removeRow(Row row)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Removes the given row from the board.

    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, 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, add, addComponentAsFirst, addComponentAtIndex, remove, 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 Details

    • Board

      public Board()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates an empty board.

      Use addRow(Component...) to add content to the board.

  • Method Details

    • addRow

      public Row addRow(com.vaadin.flow.component.Component... components)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 4
      Returns:
      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)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Removes the given row from the board.
      Parameters:
      row - the row to be removed

    • redraw

      public void redraw()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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.