com.vaadin.ui.components.grid.Footer Maven / Gradle / Ivy
/*
* Copyright (C) 2000-2024 Vaadin Ltd
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See for the full
* license.
*/
package com.vaadin.ui.components.grid;
import java.util.HashSet;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.vaadin.ui.Grid;
import com.vaadin.ui.Grid.Column;
/**
* Represents the footer section of a Grid.
*
* @author Vaadin Ltd.
*
* @since 8.0
*/
public abstract class Footer extends StaticSection {
/**
* A row in a Grid Footer.
*/
public class Row extends StaticSection.StaticRow
implements FooterRow {
/**
* A cell in a Grid footer row.
*/
public class Cell extends StaticSection.StaticCell
implements FooterCell {
/**
* Creates a new footer cell.
*/
protected Cell() {
super(Row.this);
}
}
/**
* Creates a new footer row.
*/
protected Row() {
super(Footer.this);
}
@Override
protected Cell createCell() {
return new Cell();
}
@Override
protected String getCellTagName() {
return "td";
}
/**
* 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.
*
* @param cellsToMerge
* the cells which should be merged. The cells should not be
* merged to any other cell set.
* @return the remaining visible cell after the merge
*
* @see #join(FooterCell...)
* @see com.vaadin.ui.AbstractComponent#setCaption(String) setCaption
*/
@Override
public FooterCell join(Set cellsToMerge) {
for (FooterCell cell : cellsToMerge) {
checkIfAlreadyMerged(cell.getColumnId());
}
// Create new cell data for the group
Cell newCell = createCell();
Set columnGroup = new HashSet<>();
for (FooterCell cell : cellsToMerge) {
columnGroup.add(cell.getColumnId());
}
addMergedCell(newCell, columnGroup);
markAsDirty();
return newCell;
}
/**
* 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.
*
* @param cellsToMerge
* the cells which should be merged. The cells should not be
* merged to any other cell set.
* @return the remaining visible cell after the merge
*
* @see #join(Set)
* @see com.vaadin.ui.AbstractComponent#setCaption(String) setCaption
*/
@Override
public FooterCell join(FooterCell... cellsToMerge) {
return join(Stream.of(cellsToMerge));
}
private FooterCell join(Stream cellStream) {
return join(cellStream.collect(Collectors.toSet()));
}
@Override
public FooterCell join(Column... columnsToMerge) {
return join(Stream.of(columnsToMerge).map(this::getCell));
}
@Override
public FooterCell join(String... columnIdsToMerge) {
Grid grid = getGrid();
return join(Stream.of(columnIdsToMerge).map(columnId -> {
Column column = grid.getColumn(columnId);
if (column == null) {
throw new IllegalStateException(
"There is no column with the id " + columnId);
}
return getCell(column);
}));
}
}
@Override
public Row createRow() {
return new Row();
}
}