Implement demo, fix minor problems

AB-xdev · AB-xdev · commit 81ea7164c8c2 · 2024-10-07T15:29:30.000+02:00
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/DemoView.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/DemoView.java
@@ -0,0 +1,81 @@
+package software.xdev.vaadin.gridfilter;
+
+import java.util.List;
+
+import com.vaadin.flow.component.AttachEvent;
+import com.vaadin.flow.component.Composite;
+import com.vaadin.flow.component.grid.Grid;
+import com.vaadin.flow.component.grid.GridVariant;
+import com.vaadin.flow.component.html.Anchor;
+import com.vaadin.flow.component.html.Span;
+import com.vaadin.flow.component.orderedlayout.VerticalLayout;
+import com.vaadin.flow.data.renderer.ComponentRenderer;
+import com.vaadin.flow.router.PageTitle;
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.gridfilter.demo.LocalizationDemo;
+import software.xdev.vaadin.gridfilter.demo.MaxNestedDepthDemo;
+import software.xdev.vaadin.gridfilter.demo.MinimalisticDemo;
+import software.xdev.vaadin.gridfilter.demo.QueryParameterDemo;
+
+
+@PageTitle("Grid Filter demos")
+@Route("")
+public class DemoView extends Composite<VerticalLayout>
+{
+	private final Grid<Example> grExamples = new Grid<>();
+	
+	public DemoView()
+	{
+		this.grExamples
+			.addColumn(new ComponentRenderer<>(example -> {
+				final Anchor anchor = new Anchor(example.route(), example.name());
+				
+				final Span spDesc = new Span(example.desc());
+				spDesc.getStyle().set("font-size", "90%");
+				spDesc.getStyle().set("white-space", "pre");
+				
+				final VerticalLayout vl = new VerticalLayout(anchor, spDesc);
+				vl.setSpacing(false);
+				return vl;
+			}))
+			.setHeader("Available demos");
+		
+		this.grExamples.setSizeFull();
+		this.grExamples.addThemeVariants(GridVariant.LUMO_COMPACT, GridVariant.LUMO_NO_BORDER);
+		
+		this.getContent().add(this.grExamples);
+		this.getContent().setHeightFull();
+	}
+	
+	@Override
+	protected void onAttach(final AttachEvent attachEvent)
+	{
+		this.grExamples.setItems(List.of(
+			new Example(
+				MinimalisticDemo.NAV,
+				"Minimalistic",
+				"Showcasing the simplest form of using the component"
+			),
+			new Example(
+				QueryParameterDemo.NAV,
+				"Store filters in QueryParameter",
+				"Shows how filters can be persisted in and loaded from QueryParameters/Url"
+			),
+			new Example(
+				MaxNestedDepthDemo.NAV,
+				"Limit depth/nesting of filters",
+				"Limits the how many filters can be nested"
+			),
+			new Example(
+				LocalizationDemo.NAV,
+				"Localization",
+				"Showcases how localization can be done (UI in German)"
+			)
+		));
+	}
+	
+	record Example(String route, String name, String desc)
+	{
+	}
+}
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/AbstractDemo.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/AbstractDemo.java
@@ -0,0 +1,33 @@
+package software.xdev.vaadin.gridfilter.demo;
+
+import java.time.LocalDate;
+
+import com.vaadin.flow.component.AttachEvent;
+import com.vaadin.flow.component.grid.Grid;
+import com.vaadin.flow.component.orderedlayout.VerticalLayout;
+
+import software.xdev.vaadin.gridfilter.GridFilter;
+import software.xdev.vaadin.gridfilter.model.Department;
+import software.xdev.vaadin.gridfilter.model.Person;
+
+
+public class AbstractDemo extends VerticalLayout
+{
+	protected final Grid<Person> grid = new Grid<>(Person.class, true);
+	
+	protected GridFilter<Person> createDefaultFilter()
+	{
+		return GridFilter.createDefault(this.grid)
+			.withFilterableField("ID", Person::id, Integer.class)
+			.withFilterableField("First Name", Person::firstName, String.class)
+			.withFilterableField("Birthday", Person::birthday, LocalDate.class)
+			.withFilterableField("Married", Person::married, Boolean.class)
+			.withFilterableField("Department", Person::department, Department.class);
+	}
+	
+	@Override
+	protected void onAttach(final AttachEvent attachEvent)
+	{
+		this.grid.setItems(Person.list());
+	}
+}
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/LocalizationDemo.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/LocalizationDemo.java
@@ -0,0 +1,31 @@
+package software.xdev.vaadin.gridfilter.demo;
+
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.gridfilter.GridFilter;
+import software.xdev.vaadin.gridfilter.GridFilterLocalizationConfig;
+import software.xdev.vaadin.gridfilter.model.Person;
+
+
+@Route(LocalizationDemo.NAV)
+public class LocalizationDemo extends AbstractDemo
+{
+	public static final String NAV = "/localization";
+	
+	public LocalizationDemo()
+	{
+		final GridFilter<Person> filter = this.createDefaultFilter()
+			.withLocalizationConfig(new GridFilterLocalizationConfig()
+				.with(GridFilterLocalizationConfig.BLOCK_AND, "UND")
+				.with(GridFilterLocalizationConfig.BLOCK_OR, "ODER")
+				.with(GridFilterLocalizationConfig.BLOCK_NOT, "NICHT")
+				.with(GridFilterLocalizationConfig.OP_CONTAINS, "enthält")
+				.with(GridFilterLocalizationConfig.OP_GREATER_THAN, "größer als")
+				.with(GridFilterLocalizationConfig.OP_LESS_THAN, "kleiner als")
+				.with(GridFilterLocalizationConfig.OP_EQUALS, "ist gleich")
+				.with(GridFilterLocalizationConfig.OP_IS_EMPTY, "ist leer")
+				.with(GridFilterLocalizationConfig.CONDITION, "Bedingung"));
+		
+		this.add(filter, this.grid);
+	}
+}
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/MaxNestedDepthDemo.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/MaxNestedDepthDemo.java
@@ -0,0 +1,21 @@
+package software.xdev.vaadin.gridfilter.demo;
+
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.gridfilter.GridFilter;
+import software.xdev.vaadin.gridfilter.model.Person;
+
+
+@Route(MaxNestedDepthDemo.NAV)
+public class MaxNestedDepthDemo extends AbstractDemo
+{
+	public static final String NAV = "/maxNestedDepth";
+	
+	public MaxNestedDepthDemo()
+	{
+		final GridFilter<Person> filter = this.createDefaultFilter()
+			.withMaxNestedDepth(1);
+		
+		this.add(filter, this.grid);
+	}
+}
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/MinimalisticDemo.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/MinimalisticDemo.java
@@ -0,0 +1,27 @@
+package software.xdev.vaadin.gridfilter.demo;
+
+import com.vaadin.flow.component.details.Details;
+import com.vaadin.flow.component.details.DetailsVariant;
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.gridfilter.GridFilter;
+import software.xdev.vaadin.gridfilter.model.Person;
+
+
+@Route(MinimalisticDemo.NAV)
+public class MinimalisticDemo extends AbstractDemo
+{
+	public static final String NAV = "/minimalistic";
+	
+	public MinimalisticDemo()
+	{
+		final GridFilter<Person> filter = this.createDefaultFilter();
+		
+		// Add filter inside details block for better looking UI
+		final Details details = new Details("Filter data");
+		details.addThemeVariants(DetailsVariant.FILLED);
+		details.add(filter);
+		details.setOpened(true);
+		this.add(details, this.grid);
+	}
+}
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/QueryParameterDemo.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/demo/QueryParameterDemo.java
@@ -0,0 +1,33 @@
+package software.xdev.vaadin.gridfilter.demo;
+
+import com.vaadin.flow.router.AfterNavigationEvent;
+import com.vaadin.flow.router.AfterNavigationObserver;
+import com.vaadin.flow.router.Route;
+
+import software.xdev.vaadin.gridfilter.GridFilter;
+import software.xdev.vaadin.gridfilter.model.Person;
+import software.xdev.vaadin.gridfilter.queryparameter.GridFilterQueryParameterAdapter;
+
+
+@Route(QueryParameterDemo.NAV)
+public class QueryParameterDemo extends AbstractDemo implements AfterNavigationObserver
+{
+	public static final String NAV = "/queryparameter";
+	
+	private final GridFilterQueryParameterAdapter queryParameterAdapter;
+	
+	public QueryParameterDemo()
+	{
+		final GridFilter<Person> filter = this.createDefaultFilter();
+		
+		this.queryParameterAdapter = new GridFilterQueryParameterAdapter(filter, "filter");
+		
+		this.add(filter, this.grid);
+	}
+	
+	@Override
+	public void afterNavigation(final AfterNavigationEvent event)
+	{
+		this.queryParameterAdapter.afterNavigation(event);
+	}
+}
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/model/Department.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/model/Department.java
@@ -1,4 +1,4 @@
-package software.xdev.vaadin.model;
+package software.xdev.vaadin.gridfilter.model;
 
 public enum Department
 {
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/model/Person.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/gridfilter/model/Person.java
@@ -1,4 +1,4 @@
-package software.xdev.vaadin.model;
+package software.xdev.vaadin.gridfilter.model;
 
 import java.time.LocalDate;
 import java.util.List;
diff --git a/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/ui/DemoView.java b/vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/ui/DemoView.java
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/FilterableField.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/FilterableField.java
@@ -15,6 +15,7 @@
  */
 package software.xdev.vaadin.gridfilter;
 
+import java.util.Objects;
 import java.util.function.Function;
 
 
@@ -26,7 +27,11 @@ public record FilterableField<I, T>(
 {
 	public FilterableField
 	{
-		if(this.name().chars().anyMatch(c -> !Character.isLetter(c) && !Character.isDigit(c)))
+		Objects.requireNonNull(name);
+		Objects.requireNonNull(identifier);
+		Objects.requireNonNull(keyExtractor);
+		Objects.requireNonNull(clazz);
+		if(identifier.chars().anyMatch(c -> !Character.isLetter(c) && !Character.isDigit(c)))
 		{
 			throw new IllegalArgumentException("identifier needs to be alphanumeric");
 		}
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterBlockComponent.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/filtercomponents/block/FilterBlockComponent.java
@@ -90,7 +90,7 @@ public FilterBlockComponent(
 		this.nestedDepth = nestedDepth;
 		this.maxNestedDepth = maxNestedDepth;
 		
-		final Span spBlockIdentifier = new Span(displayKey);
+		final Span spBlockIdentifier = new Span(localizationConfig.getTranslation(displayKey, this));
 		spBlockIdentifier.addClassNames(FilterBlockComponentStyles.BLOCK_IDENTIFIER);
 		
 		this.filterContainerComponent = new FilterContainerComponent<>(onValueUpdated, true);
diff --git a/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/queryparameter/GridFilterQueryParameterAdapter.java b/vaadin-grid-filter/src/main/java/software/xdev/vaadin/gridfilter/queryparameter/GridFilterQueryParameterAdapter.java
@@ -35,10 +35,21 @@ public class GridFilterQueryParameterAdapter
 	protected final String queryParamKey;
 	
 	public GridFilterQueryParameterAdapter(final GridFilter<?> gridFilter, final String queryParamKey)
+	{
+		this(gridFilter, queryParamKey, true);
+	}
+	
+	public GridFilterQueryParameterAdapter(
+		final GridFilter<?> gridFilter,
+		final String queryParamKey,
+		final boolean attachUpdateListener)
 	{
 		this.gridFilter = Objects.requireNonNull(gridFilter);
 		this.queryParamKey = Objects.requireNonNull(queryParamKey);
-		this.addQueryParamUpdateListener();
+		if(attachUpdateListener)
+		{
+			this.addQueryParamUpdateListener();
+		}
 	}
 	
 	protected void addQueryParamUpdateListener()

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package software.xdev.vaadin.model;`
	`1`	`+package software.xdev.vaadin.gridfilter.model;`
`2`	`2`
`3`	`3`	`public enum Department`
`4`	`4`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@`
`15`	`15`	`*/`
`16`	`16`	`package software.xdev.vaadin.gridfilter;`
`17`	`17`
	`18`	`+import java.util.Objects;`
`18`	`19`	`import java.util.function.Function;`
`19`	`20`
`20`	`21`
`@@ -26,7 +27,11 @@ public record FilterableField<I, T>(`
`26`	`27`	`{`
`27`	`28`	`public FilterableField`
`28`	`29`	`{`
`29`		`- if(this.name().chars().anyMatch(c -> !Character.isLetter(c) && !Character.isDigit(c)))`
	`30`	`+ Objects.requireNonNull(name);`
	`31`	`+ Objects.requireNonNull(identifier);`
	`32`	`+ Objects.requireNonNull(keyExtractor);`
	`33`	`+ Objects.requireNonNull(clazz);`
	`34`	`+ if(identifier.chars().anyMatch(c -> !Character.isLetter(c) && !Character.isDigit(c)))`
`30`	`35`	`{`
`31`	`36`	`throw new IllegalArgumentException("identifier needs to be alphanumeric");`
`32`	`37`	`}`