Skip to content

fix: preserve joined headers #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jun 9, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.grid.Grid.Column;
import com.vaadin.flow.component.grid.HeaderRow;
import com.vaadin.flow.component.grid.HeaderRow.HeaderCell;
import com.vaadin.flow.component.grid.dataview.GridLazyDataView;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.DataCommunicator;
Expand All @@ -38,8 +39,6 @@
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.apache.commons.lang3.tuple.ImmutablePair;
import org.apache.commons.lang3.tuple.Pair;
import org.apache.logging.log4j.util.Strings;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
Expand Down Expand Up @@ -105,16 +104,7 @@ private GridHeader<T> getGridHeader(Grid<T> grid, Column<T> column) {
List<String> headerTexts = new ArrayList<>();
List<HeaderRow> headerRows = grid.getHeaderRows();
for (HeaderRow headerRow : headerRows) {
String headerText = renderCellTextContent(grid, column, GridExporter.COLUMN_HEADER, (col) -> {
String value = headerRow.getCell(col).getText();
if (Strings.isBlank(value)) {
Component component = headerRow.getCell(col).getComponent();
if (component != null) {
value = component.getElement().getTextRecursively();
}
}
return value;
});
String headerText = renderHeaderCellTextContent(grid, headerRow, column);
headerTexts.add(headerText);
}
return new GridHeader<>(headerTexts, column);
Expand All @@ -125,44 +115,65 @@ protected List<GridFooter<T>> getGridFooters(Grid<T> grid) {
.map(
column ->
new GridFooter<>(
renderCellTextContent(grid, column, GridExporter.COLUMN_FOOTER, null),column
renderFooterCellTextContent(grid, column), column
)
)
.collect(Collectors.toList());
}

private String renderCellTextContent(Grid<T> grid, Column<T> column, String columnType, SerializableFunction<Column<T>,String> obtainCellFunction) {
String headerOrFooter = (String) ComponentUtil.getData(column, columnType);
if (Strings.isBlank(headerOrFooter)) {
SerializableFunction<Column<?>, Component> getHeaderOrFooterComponent;
if (GridExporter.COLUMN_HEADER.equals(columnType)) {
getHeaderOrFooterComponent = Column::getHeaderComponent;
headerOrFooter = column.getHeaderText();
} else if (GridExporter.COLUMN_FOOTER.equals(columnType)) {
getHeaderOrFooterComponent = Column::getFooterComponent;
headerOrFooter = column.getFooterText();
} else {
throw new IllegalArgumentException();
private String obtainCellFunction(HeaderCell headerCell, Column<T> column) {
String value = headerCell.getText();
if (Strings.isBlank(value)) {
Component component = headerCell.getComponent();
if (component != null) {
value = component.getElement().getTextRecursively();
}
if (Strings.isBlank(headerOrFooter)) {
}
return value;
}

private String renderHeaderCellTextContent(Grid<T> grid, HeaderRow headerRow, Column<T> column) {
String header = (String) ComponentUtil.getData(column, GridExporter.COLUMN_HEADER);

if (Strings.isBlank(header)) {
HeaderCell headerCell = headerRow.getCell(column);
int columnIndex = grid.getColumns().indexOf(column);
if (columnIndex == 0
|| headerRow.getCell(grid.getColumns().get(columnIndex - 1)) != headerCell) {
try {
header = obtainCellFunction(headerCell, column);
} catch (RuntimeException e) {
throw new IllegalStateException(
"Problem when trying to render header cell text content", e);
}
}
}

return header == null ? "" : header;
}

private String renderFooterCellTextContent(Grid<T> grid, Column<T> column) {
String footer = (String) ComponentUtil.getData(column, GridExporter.COLUMN_FOOTER);
if (Strings.isBlank(footer)) {
SerializableFunction<Column<?>, Component> footerComponent;
footerComponent = Column::getFooterComponent;
footer = column.getFooterText();

if (Strings.isBlank(footer)) {
try {
Component component;
if (obtainCellFunction!=null) {
headerOrFooter = obtainCellFunction.apply(column);
} else {
component = getHeaderOrFooterComponent.apply(column);
if (component != null) {
headerOrFooter = component.getElement().getTextRecursively();
}
component = footerComponent.apply(column);
if (component != null) {
footer = component.getElement().getTextRecursively();
}
} catch (RuntimeException e) {
throw new IllegalStateException(
"Problem when trying to render header or footer cell text content", e);
"Problem when trying to render footer cell text content", e);
}
}
}

return headerOrFooter==null?"":headerOrFooter;
return footer==null?"":footer;
}

protected Stream<T> obtainDataStream(DataProvider<T, ?> dataProvider) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,12 @@ public GridExporterMultipleHeaderRowsDemo() throws EncryptedDocumentException, I
Grid<Person> grid = new Grid<>(Person.class);
DecimalFormat decimalFormat = new DecimalFormat(NUMBER_FORMAT_PATTERN);
grid.removeAllColumns();
grid.addColumn(
Column<Person> firstNameColumn = grid.addColumn(
LitRenderer.<Person>of("<b>${item.name}</b>").withProperty("name", Person::getName))
.setHeader("Name");
grid.addColumn("lastName").setHeader("Last Name");
grid.addColumn(item -> Faker.instance().lorem().characters(30, 50)).setHeader("Big column");
Column<Person> lastNameColumn = grid.addColumn("lastName").setHeader("Last Name");
Column<Person> bigColumn =
grid.addColumn(item -> Faker.instance().lorem().characters(30, 50)).setHeader("Big column");
Column<Person> budgetColumn = grid.addColumn(item -> decimalFormat.format(item.getBudget()))
.setHeader("Budget").setTextAlign(ColumnTextAlign.END);
List<Person> people = IntStream.range(0, 100).asLongStream().mapToObj(number -> {
Expand All @@ -78,12 +79,16 @@ public GridExporterMultipleHeaderRowsDemo() throws EncryptedDocumentException, I

grid.setItems(people);
grid.setWidthFull();
this.setSizeFull();
setSizeFull();

HeaderRow joinedHeaderRow = grid.prependHeaderRow();
joinedHeaderRow.join(firstNameColumn, lastNameColumn).setText("Full name");
joinedHeaderRow.join(bigColumn, budgetColumn).setText("Big column and budget");

HeaderRow firstExtraHeaderRow = grid.appendHeaderRow();
HeaderRow secondExtraHeaderRow = grid.appendHeaderRow();
for (Column<Person> column : grid.getColumns()) {
String columnHeader = grid.getHeaderRows().get(0).getCell(column).getText();
String columnHeader = grid.getHeaderRows().get(1).getCell(column).getText();

HeaderCell firstHeaderCell = firstExtraHeaderRow.getCell(column);
firstHeaderCell.setComponent(new Span(columnHeader + " 1"));
Expand Down