com.vaadin.ui.components.grid.

Interface HeaderRow

  • All Superinterfaces:

    Serializable

    All Known Implementing Classes:

    Header.Row

    public interface HeaderRow
    extends Serializable

    A header row in a Grid.

    Since:

    8.0

    Author:

    Vaadin Ltd

    • Method Detail

      • getCell

        HeaderCell getCell​(String columnId)

        Returns the cell on this row corresponding to the given column id.

        Parameters:

        columnId - the id of the column whose header cell to get, not null

        Returns:

        the header cell

        Throws:

        IllegalArgumentException - if there is no such column in the grid

        See Also:

        Grid.Column.setId(String)

      • getCell

        HeaderCell getCell​(Grid.Column<?,​?> column)

        Returns the cell on this row corresponding to the given column.

        Parameters:

        column - the column whose header cell to get, not null

        Returns:

        the header cell

        Throws:

        IllegalArgumentException - if there is no such column in the grid

      • join

        HeaderCell join​(Set<HeaderCell> cellsToMerge)

        Merges column cells in the row. Original cells are hidden, and new merged cell is shown instead. The cell has a width of all merged cells together, inherits styles of the first merged cell but has empty caption.

        Parameters:

        cellsToMerge - the cells which should be merged. The cells should not be merged to any other cell set.

        Returns:

        the remaining visible cell after the merge

        See Also:

        join(HeaderCell...), setCaption

      • join

        HeaderCell join​(HeaderCell... cellsToMerge)

        Merges column cells in the row. Original cells are hidden, and new merged cell is shown instead. The cell has a width of all merged cells together, inherits styles of the first merged cell but has empty caption.

        Parameters:

        cellsToMerge - the cells which should be merged. The cells should not be merged to any other cell set.

        Returns:

        the remaining visible cell after the merge

        See Also:

        join(Set), setCaption

      • join

        HeaderCell join​(Grid.Column<?,​?>... columnsToMerge)

        Merges cells corresponding to the given columns in the row. Original cells are hidden, and new merged cell is shown instead. The cell has a width of all merged cells together, inherits styles of the first merged cell but has empty caption.

        Parameters:

        columnsToMerge - the columns of the cells that should be merged. The cells should not be merged to any other cell set.

        Returns:

        the remaining visible cell after the merge

        See Also:

        join(Set), setCaption

      • join

        HeaderCell join​(String... columnIdsToMerge)

        Merges cells corresponding to the given column ids in the row. Original cells are hidden, and new merged cell is shown instead. The cell has a width of all merged cells together, inherits styles of the first merged cell but has empty caption.

        Parameters:

        columnIdsToMerge - the ids of the columns of the cells that should be merged. The cells should not be merged to any other cell set.

        Returns:

        the remaining visible cell after the merge

        See Also:

        join(Set), setCaption, Grid.Column.setId(String)

      • getStyleName

        String getStyleName()

        Returns the custom style name for this row.

        Returns:

        the style name or null if no style name has been set

      • setStyleName

        void setStyleName​(String styleName)

        Sets a custom style name for this row.

        Parameters:

        styleName - the style name to set or null to not use any style name

      • getComponents

        Collection<? extends Component> getComponents()

        Gets a collection of all components inside this row.

        The order of the components in the returned collection is not specified.

        Returns:

        a collection of components in the row

        Since:

        8.0.3