Merge branch 'develop' into update-from-template-merged

Author: xdev-gh-bot

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -15,9 +15,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/vaadin-grid-exporter/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-grid-exporter/issues) or [closed](https://github.com/xdev-software/vaadin-grid-exporter/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-grid-exporter/issues) or [closed](https://github.com/xdev-software/vaadin-grid-exporter/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-grid-exporter/issues) or [closed](https://github.com/xdev-software/vaadin-grid-exporter/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

.run/Run Demo.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
     <option name="MAIN_CLASS_NAME" value="software.xdev.vaadin.Application" />
-    <module name="template-placeholder-demo" />
+    <module name="vaadin-grid-exporter-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

CHANGELOG.md

@@ -0,0 +1,99 @@
+# 4.0.1
+* Updated dependencies
+
+# 4.0.0
+* Updated to Vaadin 25
+
+# 3.2.8
+* Updated dependencies
+
+# 3.2.7
+* Migrated deployment to _Sonatype Maven Central Portal_ [#155](https://github.com/xdev-software/standard-maven-template/issues/155)
+* Updated dependencies
+
+# 3.2.6
+* Fix naming so that Vaadin Directory sync works [#318](https://github.com/xdev-software/vaadin-addon-template/issues/318)
+* Updated dependencies
+
+# 3.2.5
+* Make it possible to better customize ``SpecificConfigComponent``
+
+# 3.2.4
+* Updated dependencies
+
+# 3.2.3
+* Added dedicated method for adding steps to WizardPanel to make overriding it easier #269
+* Updated dependencies
+
+# 3.2.2
+* Fix column order being ignored #256
+
+# 3.2.1
+* Fix cells truncating data #229
+* Updated dependencies
+
+# 3.2.0
+* Updated to Vaadin 24.4
+
+# 3.1.0
+* Update to [JasperReports 7](https://github.com/xdev-software/dynamicreports-core-for-grid-exporter/blob/develop/CHANGELOG.md#200)
+* Updated dependencies
+
+# 3.0.3
+* ⚠️ GroupId changed from ``com.xdev-software`` to ``software.xdev``
+* Updated dependencies
+
+# 3.0.2
+* Fixed not working translations on preview step #153
+* Updated dependencies
+
+# 3.0.1
+* Fixed compilation problems due to missing ``ecj`` dependency #98
+* Updated dependencies
+
+# 3.0.0
+⚠️<i>This release contains breaking changes</i>
+
+* Adds support for Vaadin 24+, drops support for Vaadin 23<br/>
+  <i>If you are still using Vaadin 23, use the ``3.x`` versions.</i>
+  * Requires Java 17+
+* Replaced the underlying reporting framework ``dynamicreports`` with [our fork of it](https://github.com/xdev-software/dynamicreports-core-for-grid-exporter) which is specially designed for this project
+  * Differences from the original project are roughly described in the [changelog](https://github.com/xdev-software/dynamicreports-core-for-grid-exporter/blob/develop/CHANGELOG.md).
+* Removed ``XML`` from the default formats because the exported data was unusable
+* Replaced ``VaadinInternalRenderingColumnHeaderResolvingStrategy`` with ``VaadinColumnHeaderResolvingStrategy``
+* Updated dependencies
+
+# 2.0.0
+* Undocked from RapidClipse
+  * Changed package from ``com.rapidclipse.framework.server.reports`` to ``software.xdev.vaadin.grid_exporter``
+* Restructured the UI
+  * Using a step-by-step-wizard like layout
+  * Made formats configurable via UI
+* Refactored software architecture to make the component more expandable
+* Removed ``XLS`` from default formats due to not included dependency which causes a crash (``XLSX`` still works)
+* Updated dependencies
+
+Example usage:
+
+| v1 | v2 |
+| --- | --- |
+| ``GridExportDialog.open(grid)`` | ``GridExporter.newWithDefaults(grid).open()`` |
+
+# 1.0.3
+* Removed unused code
+
+# 1.0.2
+* Updated dependencies
+  * Vaadin 23.2
+
+# 1.0.1
+* Removed unnecessary code and dependencies; Updated jasperreports to latest version
+
+# 1.0.0
+<i>Initial release</i>
+
+* Forked project from the RapidClipse Framework (Version 11.0)
+* Updated to Vaadin 23
+* Removed unnecessary code and dependencies
+* Removed requirement that Grid columns need keys
+* Reworked localization - can now be explicitly set using ``GridExportLocalizationConfig``

CONTRIBUTING.md

@@ -47,10 +47,10 @@ Bigger changes may require a complete restart.
   * [Vaadin automatically reloads the UI on each restart](https://vaadin.com/docs/latest/configuration/live-reload/spring-boot).<br/>
   You can control this behavior with the ``vaadin.devmode.liveReload.enabled`` property (default: ``true``).
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-grid-exporter/release.yml?branch=master)](https://github.com/xdev-software/vaadin-grid-exporter/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/template-placeholder/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/vaadin-grid-exporter/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

README.md

@@ -1,23 +1,99 @@
-[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/template-placeholder)
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/gridexporter-for-vaadin)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/vaadin-grid-exporter?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/vaadin-grid-exporter)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-grid-exporter/check-build.yml?branch=develop)](https://github.com/xdev-software/vaadin-grid-exporter/actions/workflows/check-build.yml?query=branch%3Adevelop)
 ![Vaadin 25+](https://img.shields.io/badge/Vaadin%20Platform/Flow-25+-00b4f0)
 
-# template-placeholder
-A Vaadin Template Repo
+# GridExporter for Vaadin
 
-![demo](assets/demo.png)
+The Vaadin Grid Exporter can convert nearly any Vaadin Grid to a variety of formats.<br/>
+This way you don't have to copy the Grid contents manually or print the whole website with the Grid.
 
+Out of the box supported formats:
+* CSV
+* Word (DOCX)
+* HTML
+* ODS
+* ODT
+* PDF
+* PowerPoint (PPTX)
+* RTF
+* Plain text
+* Excel (XLSX)
+
+_These formats are exported using [dynamicreports](https://github.com/xdev-software/dynamicreports-core-for-grid-exporter)._
+
+It's also easy to extend the Exporter to support your custom format.
+
+![demo](assets/preview.gif)
+
+> [!NOTE]
+> <details><summary><b>Disclaimer about the scope of this component</b> (click to expand)</summary>
+>
+> Although the GridExporter can handle most use-cases, extreme scenarios will likely impact performance, usability and might require some hacks.<br/>
+> For such cases custom written exports are recommended e.g. by utilizing JasperReports directly.<br/>
+> If you need help implementing these feel free to [contact us](#support) or open a [question](https://github.com/xdev-software/vaadin-grid-exporter/issues/new?assignees=&labels=question&projects=&template=question.yml) if you are not sure that the GridExporter is a good option for your scenario.
+>
+> </details>
+
+## Usage
+
+Default usage:
+
+```java
+GridExporter
+	.newWithDefaults(this.grExamples)
+	.open();
+```
+
+Custom format (see [JsonGridExporterProvider from Demo](vaadin-grid-exporter-demo/src/main/java/software/xdev/vaadin/gridexport/example/jsonext/JsonGridExporterProvider.java)):
+
+```java
+GridExporter
+	.newWithDefaults(this.grExamples)
+	.loadFromProvider(new JsonGridExporterProvider())
+	.open();
+```
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
+
+[Installation guide for the latest release](https://github.com/xdev-software/vaadin-grid-exporter/releases/latest#Installation)
+
+### Comaptibility with  ``CSP`` (Content-Security-Policy) and ``X-Frame-Options``
+
+> [!TIP]
+> In Spring Security the [default value of ``X-Frame-Options`` is ``DENY``](https://docs.spring.io/spring-security/reference/features/exploits/headers.html#headers-frame-options) which will break the preview if not changed.
+
+To show the preview the [CSP](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) or the [X-Frame-Options](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) (deprecated in favor of CSP) must be configured in a way that they allow showing same-site elements.
+
+This can be achieved by:
+* setting the CSP to include at least ``frame-ancestors 'self'`` and maybe additionally ``object-src 'self'``
+* setting ``X-Frame-Options`` to ``SAMESITE``.<br/>If you use Spring Security without a CSP the easiest way to set this is:
+    ```java
+    http.headers(c -> c.frameOptions(HeadersConfigurer.FrameOptionsConfig::sameOrigin));
+    ```
+
+> [!NOTE]
+> Depending on the browser the settings sometimes have slightly different effects.<br/>
+> For example Firefox blocks the preview due to privacy reasons when ``X-Frame-Option=DENY`` and ``Content-Security-Policy=frame-ancestors 'self'; object-src 'self'; ...`` but Chrome does not.
+
+### Compatibility with Vaadin
+
+| Vaadin version | GridExporter version |
+| --- | --- |
+| Vaadin 25+ (latest) | ``4+`` |
+| Vaadin 24 | ``3.x`` |
+| Vaadin 23 | ``2.x`` |
+
+### Compatibility with JasperReports
+
+Starting with version [3.1.0](./CHANGELOG.md#310) JasperReports 7 is required.
 
 ### Spring-Boot
 * You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)
 
 ## Run the Demo
 * Checkout the repo
-* Run ``mvn install && mvn -f template-placeholder-demo spring-boot:run``
+* Run ``mvn install && mvn -f vaadin-grid-exporter-demo spring-boot:run``
 * Open http://localhost:8080
 
 <details>
@@ -33,4 +109,4 @@ If you need support as soon as possible and you can't wait for any pull request,
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/template-placeholder/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-grid-exporter/dependencies)

SECURITY.md

@@ -2,4 +2,4 @@
 
 ## Reporting a Vulnerability
 
-Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/template-placeholder/security/advisories/new).
+Please report a security vulnerability [on GitHub Security Advisories](https://github.com/xdev-software/vaadin-grid-exporter/security/advisories/new).