Skip to content

Commit

Permalink
Make it possible to better customize SpecificConfigComponent
Browse files Browse the repository at this point in the history
and add a demo how this can be done

See #316
  • Loading branch information
AB-xdev committed Feb 21, 2025
1 parent 3c68acd commit db87cff
Show file tree
Hide file tree
Showing 4 changed files with 101 additions and 6 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 3.2.5
* Make it possible to better customize ``SpecificConfigComponent``

## 3.2.4
* Updated dependencies

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import software.xdev.vaadin.grid_exporter.GridExporter;
import software.xdev.vaadin.grid_exporter.jasper.config.JasperConfigsLocalization;
import software.xdev.vaadin.gridexport.example.jsonext.JsonGridExporterProvider;
import software.xdev.vaadin.gridexport.example.pre_defined_title.PredefinedTitleProvider;


@PageTitle("GridExport Examples")
Expand Down Expand Up @@ -45,6 +46,12 @@ public DemoView()
VaadinIcon.PRINT.create(),
e -> GridExporter.newWithDefaults(this.grExamples)
.loadFromProvider(new JsonGridExporterProvider())
.open()),
new Button(
"Export (Predefined title)",
VaadinIcon.PRINT.create(),
e -> new GridExporter<>(this.grExamples)
.loadFromProvider(new PredefinedTitleProvider("Custom title!"))
.open())
);

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
package software.xdev.vaadin.gridexport.example.pre_defined_title;

import java.util.List;

import software.xdev.dynamicreports.jasper.builder.JasperReportBuilder;
import software.xdev.dynamicreports.jasper.builder.export.Exporters;
import software.xdev.dynamicreports.jasper.builder.export.JasperPdfExporterBuilder;
import software.xdev.vaadin.grid_exporter.GridExporterProvider;
import software.xdev.vaadin.grid_exporter.Translator;
import software.xdev.vaadin.grid_exporter.jasper.config.JasperConfigsLocalization;
import software.xdev.vaadin.grid_exporter.jasper.config.header.HeaderConfigComponent;
import software.xdev.vaadin.grid_exporter.jasper.config.highlight.HighlightConfigComponent;
import software.xdev.vaadin.grid_exporter.jasper.config.page.PageConfigComponent;
import software.xdev.vaadin.grid_exporter.jasper.config.title.TitleConfig;
import software.xdev.vaadin.grid_exporter.jasper.config.title.TitleConfigComponent;
import software.xdev.vaadin.grid_exporter.jasper.format.AbstractJasperReportFormat;


public class PredefinedTitleProvider extends GridExporterProvider
{
public PredefinedTitleProvider(final String predefinedTitle)
{
super(
JasperConfigsLocalization.DEFAULT_VALUES,
List.of(
new PredefinedTitlePdfFormat(predefinedTitle)
));
}

public static class PredefinedTitlePdfFormat extends AbstractJasperReportFormat<JasperPdfExporterBuilder>
{
public PredefinedTitlePdfFormat(final String defaultTitle)
{
super(
"PDF",
"pdf",
"application/pdf",
true,
true,
JasperReportBuilder::toPdf,
Exporters::pdfExporter
);
this.withConfigComponents(
translator -> new PreDefinedTitleConfigComponent(translator, defaultTitle),
HeaderConfigComponent::new,
HighlightConfigComponent::new,
PageConfigComponent::new
);
}
}


public static class PreDefinedTitleConfigComponent extends TitleConfigComponent
{
public PreDefinedTitleConfigComponent(final Translator translator, final String defaultTitle)
{
super(translator);
this.setNewConfigSupplier(() -> {
final TitleConfig titleConfig = new TitleConfig();
titleConfig.setTitle(defaultTitle);
return titleConfig;
});
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ public abstract class SpecificConfigComponent<T extends SpecificConfig>
extends Composite<FormLayout>
implements Translator
{
protected final Translator translator;
protected final Supplier<T> newConfigSupplier;
protected final String header;
protected Translator translator;
protected Supplier<T> newConfigSupplier;
protected String header;

protected Binder<T> binder = new Binder<>();

Expand All @@ -40,16 +40,36 @@ protected SpecificConfigComponent(
final Supplier<T> newConfigSupplier,
final String headerToTranslate)
{
this.translator = Objects.requireNonNull(translator);
this.newConfigSupplier = Objects.requireNonNull(newConfigSupplier);
this.header = this.translate(Objects.requireNonNull(headerToTranslate));
this.setTranslator(translator);
this.setNewConfigSupplier(newConfigSupplier);
this.setHeaderAndTranslate(headerToTranslate);

this.getContent().setResponsiveSteps(
new FormLayout.ResponsiveStep("0", 1),
new FormLayout.ResponsiveStep("400px", 2)
);
}

protected void setTranslator(final Translator translator)
{
this.translator = Objects.requireNonNull(translator);
}

protected void setNewConfigSupplier(final Supplier<T> newConfigSupplier)
{
this.newConfigSupplier = Objects.requireNonNull(newConfigSupplier);
}

protected void setHeader(final String header)
{
this.header = header;
}

protected void setHeaderAndTranslate(final String headerToTranslate)
{
this.setHeader(this.translate(headerToTranslate));
}

public Supplier<T> getNewConfigSupplier()
{
return this.newConfigSupplier;
Expand Down

0 comments on commit db87cff

Please sign in to comment.