Package com.vaadin.flow.component.html

Class TableRow

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.HtmlComponent
com.vaadin.flow.component.html.TableRow
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<TableRow>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponentsOfType<TableCell>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, Serializable
@NullMarked @Tag("tr") public class TableRow extends com.vaadin.flow.component.HtmlComponent implements com.vaadin.flow.component.HasComponentsOfType<TableCell>, com.vaadin.flow.component.ClickNotifier<TableRow>
Component representing a <tr> element — a row of a Table.

A <tr> may only contain <td> and <th> cells, which is what HasComponentsOfType expresses: the standard add, remove, replace and bindChildren operations are all available, but only for TableCell, so anything else is rejected at compile time. What this class adds on top are the cell factories, which create a cell and attach it in one call. To put arbitrary content in a row, put it inside a cell.

Since:
25.3
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    TableRow()
    Creates a new empty row.
    TableRow(com.vaadin.flow.component.Component... components)
    Creates a new row with the given content, following the rules of addCells(Component...).
    TableRow(List<? extends com.vaadin.flow.component.Component> components)
    List equivalent of TableRow(Component...).

  • Method Summary

    Modifier and Type
    Method
    Description
    TableRow
    addCells(com.vaadin.flow.component.Component... components)
    Appends the given components to this row.
    TableRow
    addCells(List<? extends com.vaadin.flow.component.Component> components)
    List equivalent of addCells(Component...).
    TableHeaderCell
    addColumnGroupHeaderCell(String text)
    Appends a header cell labelling the band of columns it heads, with scope="colgroup" set on the resulting <th>.
    TableHeaderCell
    addColumnGroupHeaderCell(String text, int colspan)
    Appends a header cell labelling the band of columns it heads, with scope="colgroup" and the given colspan set on the resulting <th>, so that the cell reaches over the columns it names.
    TableHeaderCell
    addColumnHeaderCell(com.vaadin.flow.component.Component... content)
    Appends a header cell holding the given content and labelling the column it sits in, with scope="col" set on the resulting <th>.
    TableHeaderCell
    addColumnHeaderCell(String text)
    Appends a header cell labelling the column it sits in, with scope="col" set on the resulting <th>.
    TableRow
    addColumnHeaderCells(String... cellTexts)
    Appends a header cell for each of the given texts, each labelling the column it sits in with scope="col".
    TableRow
    addColumnHeaderCells(List<String> cellTexts)
    List equivalent of addColumnHeaderCells(String...).
    TableDataCell
    addDataCell()
    Appends a new empty data cell to this row.
    TableDataCell
    addDataCell(com.vaadin.flow.component.Component... content)
    Appends a new data cell holding the given content to this row, for a cell that is more than plain text.
    TableDataCell
    addDataCell(String text)
    Appends a new data cell with the given text to this row.
    TableRow
    addDataCells(String... cellTexts)
    Appends a sequence of data cells (<td>) with the given text contents to this row.
    TableRow
    addDataCells(List<String> cellTexts)
    List equivalent of addDataCells(String...).
    TableHeaderCell
    addHeaderCell()
    Appends a new empty header cell to this row.
    TableHeaderCell
    addHeaderCell(com.vaadin.flow.component.Component... content)
    Appends a new header cell holding the given content to this row, for a header that is more than plain text.
    TableHeaderCell
    addHeaderCell(String text)
    Appends a new header cell with the given text to this row.
    TableRow
    addHeaderCells(String... cellTexts)
    Appends a sequence of header cells (<th>) with the given text contents to this row.
    TableRow
    addHeaderCells(List<String> cellTexts)
    List equivalent of addHeaderCells(String...).
    TableHeaderCell
    addRowGroupHeaderCell(String text)
    Appends a header cell labelling the band of rows it heads, with scope="rowgroup" set on the resulting <th>.
    TableHeaderCell
    addRowGroupHeaderCell(String text, int rowspan)
    Appends a header cell labelling the band of rows it heads, with scope="rowgroup" and the given rowspan set on the resulting <th>, so that the cell reaches over the rows it names.
    TableHeaderCell
    addRowHeaderCell(String text)
    Appends a header cell to this row that labels the row itself, with scope="row" set on the resulting <th>.
    List<TableCell>
    getCells()
    Returns every cell of this row, in document order, both kinds combined.
    List<TableDataCell>
    getDataCells()
    Returns the data cells of this row, in document order.
    List<TableHeaderCell>
    getHeaderCells()
    Returns the header cells of this row, in document order.
    TableDataCell
    insertDataCell(int position)
    Inserts a new empty data cell at the given position.
    TableHeaderCell
    insertHeaderCell(int position)
    Inserts a new empty header cell at the given position.

    Methods inherited from class com.vaadin.flow.component.HtmlComponent

    getTitle, setTitle

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, bindVisible, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, setVisible, whenAttached

    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.ClickNotifier

    addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasComponentsOfType

    add, add, addComponentAsFirst, addComponentAtIndex, bindChildren, getChildren, getComponentAt, getComponentCount, indexOf, remove, remove, removeAll, replace

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    bindEnabled, isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasSize

    bindHeight, bindWidth, 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, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Constructor Details

    • TableRow

      public TableRow()
      Creates a new empty row.

    • TableRow

      public TableRow(com.vaadin.flow.component.Component... components)
      Creates a new row with the given content, following the rules of addCells(Component...).
      Parameters:
      components - the cells, or the content to wrap in cells.

    • TableRow

      public TableRow(List<? extends com.vaadin.flow.component.Component> components)
      List equivalent of TableRow(Component...).
      Parameters:
      components - the cells, or the content to wrap in cells.

  • Method Details

    • addCells

      public TableRow addCells(com.vaadin.flow.component.Component... components)
      Appends the given components to this row. A TableCell is added as-is; anything else is wrapped in a new TableDataCell, since a <tr> may only contain cells. This is the lenient counterpart of the inherited add(TableCell...), which takes cells only and rejects anything else at compile time.
      Parameters:
      components - the cells, or the content to wrap in cells.
      Returns:
      this row, for fluent chaining.

    • addCells

      public TableRow addCells(List<? extends com.vaadin.flow.component.Component> components)
      List equivalent of addCells(Component...).
      Parameters:
      components - the cells, or the content to wrap in cells.
      Returns:
      this row, for fluent chaining.

    • addDataCells

      public TableRow addDataCells(String... cellTexts)
      Appends a sequence of data cells (<td>) with the given text contents to this row.
      Parameters:
      cellTexts - the text content for each data cell.
      Returns:
      this row, for fluent chaining.

    • addDataCells

      public TableRow addDataCells(List<String> cellTexts)
      List equivalent of addDataCells(String...).
      Parameters:
      cellTexts - the text content for each data cell.
      Returns:
      this row, for fluent chaining.

    • addHeaderCells

      public TableRow addHeaderCells(String... cellTexts)
      Appends a sequence of header cells (<th>) with the given text contents to this row.
      Parameters:
      cellTexts - the text content for each header cell.
      Returns:
      this row, for fluent chaining.

    • addHeaderCells

      public TableRow addHeaderCells(List<String> cellTexts)
      List equivalent of addHeaderCells(String...).
      Parameters:
      cellTexts - the text content for each header cell.
      Returns:
      this row, for fluent chaining.

    • addColumnHeaderCells

      public TableRow addColumnHeaderCells(String... cellTexts)
      Appends a header cell for each of the given texts, each labelling the column it sits in with scope="col". This is the bulk form of addColumnHeaderCell(String) and the usual way to fill a row in a TableHead.
      Parameters:
      cellTexts - the text content of the cells, one cell per entry.
      Returns:
      this row, for chaining.

    • addColumnHeaderCells

      public TableRow addColumnHeaderCells(List<String> cellTexts)
      List equivalent of addColumnHeaderCells(String...).
      Parameters:
      cellTexts - the text content of the cells, one cell per entry.
      Returns:
      this row, for chaining.

    • addHeaderCell

      public TableHeaderCell addHeaderCell()
      Appends a new empty header cell to this row.
      Returns:
      the new <th>.

    • addHeaderCell

      public TableHeaderCell addHeaderCell(String text)
      Appends a new header cell with the given text to this row.
      Parameters:
      text - the text content.
      Returns:
      the new <th>.

    • addHeaderCell

      public TableHeaderCell addHeaderCell(com.vaadin.flow.component.Component... content)
      Appends a new header cell holding the given content to this row, for a header that is more than plain text.
      Parameters:
      content - the content of the cell.
      Returns:
      the new <th>.

    • insertHeaderCell

      public TableHeaderCell insertHeaderCell(int position)
      Inserts a new empty header cell at the given position.
      Parameters:
      position - the position to insert the cell at, between 0 and the number of cells in this row.
      Returns:
      the new <th>.

    • addRowHeaderCell

      public TableHeaderCell addRowHeaderCell(String text)
      Appends a header cell to this row that labels the row itself, with scope="row" set on the resulting <th>. This is a shortcut for the common pattern of using a leading <th> as a row label, which assistive technologies announce as the header for the data cells in the same row.
      Parameters:
      text - the text content.
      Returns:
      the new <th> with scope="row".

    • addColumnHeaderCell

      public TableHeaderCell addColumnHeaderCell(String text)
      Appends a header cell labelling the column it sits in, with scope="col" set on the resulting <th>. This is the counterpart of addRowHeaderCell(String) and the usual shape of a cell in a TableHead.
      Parameters:
      text - the text content.
      Returns:
      the new <th> with scope="col".

    • addColumnHeaderCell

      public TableHeaderCell addColumnHeaderCell(com.vaadin.flow.component.Component... content)
      Appends a header cell holding the given content and labelling the column it sits in, with scope="col" set on the resulting <th>.
      Parameters:
      content - the content of the cell.
      Returns:
      the new <th> with scope="col".

    • addRowGroupHeaderCell

      public TableHeaderCell addRowGroupHeaderCell(String text)
      Appends a header cell labelling the band of rows it heads, with scope="rowgroup" set on the resulting <th>. Use it for the cell that names a group of consecutive rows, such as "Terrestrial planets" in front of the four rows describing them, as opposed to addRowHeaderCell(String), which labels one row.
      Parameters:
      text - the text content.
      Returns:
      the new <th> with scope="rowgroup".

    • addRowGroupHeaderCell

      public TableHeaderCell addRowGroupHeaderCell(String text, int rowspan)
      Appends a header cell labelling the band of rows it heads, with scope="rowgroup" and the given rowspan set on the resulting <th>, so that the cell reaches over the rows it names.
      Parameters:
      text - the text content.
      rowspan - the number of rows the header covers, or 0 to cover the rest of the row group.
      Returns:
      the new <th> with scope="rowgroup".
      Throws:
      IllegalArgumentException - if rowspan is negative.

    • addColumnGroupHeaderCell

      public TableHeaderCell addColumnGroupHeaderCell(String text)
      Appends a header cell labelling the band of columns it heads, with scope="colgroup" set on the resulting <th>. This is the counterpart of addRowGroupHeaderCell(String), for a cell that names a group of consecutive columns rather than a single one.
      Parameters:
      text - the text content.
      Returns:
      the new <th> with scope="colgroup".

    • addColumnGroupHeaderCell

      public TableHeaderCell addColumnGroupHeaderCell(String text, int colspan)
      Appends a header cell labelling the band of columns it heads, with scope="colgroup" and the given colspan set on the resulting <th>, so that the cell reaches over the columns it names.
      Parameters:
      text - the text content.
      colspan - the number of columns the header covers.
      Returns:
      the new <th> with scope="colgroup".
      Throws:
      IllegalArgumentException - if colspan is less than 1.

    • addDataCell

      public TableDataCell addDataCell()
      Appends a new empty data cell to this row.
      Returns:
      the new <td>.

    • addDataCell

      public TableDataCell addDataCell(String text)
      Appends a new data cell with the given text to this row.
      Parameters:
      text - the text content.
      Returns:
      the new <td>.

    • addDataCell

      public TableDataCell addDataCell(com.vaadin.flow.component.Component... content)
      Appends a new data cell holding the given content to this row, for a cell that is more than plain text.
      Parameters:
      content - the content of the cell.
      Returns:
      the new <td>.

    • insertDataCell

      public TableDataCell insertDataCell(int position)
      Inserts a new empty data cell at the given position.
      Parameters:
      position - the position to insert the cell at, between 0 and the number of cells in this row.
      Returns:
      the new <td>.

    • getHeaderCells

      public List<TableHeaderCell> getHeaderCells()
      Returns the header cells of this row, in document order.
      Returns:
      this row's <th> cells.

    • getDataCells

      public List<TableDataCell> getDataCells()
      Returns the data cells of this row, in document order.
      Returns:
      this row's <td> cells.

    • getCells

      public List<TableCell> getCells()
      Returns every cell of this row, in document order, both kinds combined. This is the typed counterpart of Component.getChildren(). For kind-specific lists use getHeaderCells() or getDataCells().
      Returns:
      this row's cells.