Backport upstream

Diff of f84fe78e6ae00ca532ffd38630c846de93471d78 -> 89a634d81fd6622deb22128c4cd79622f4a2598f

Co-Authored-By: Luis <[email protected]>
Co-Authored-By: Johannes Rabauer <[email protected]>

Author: 3 people

vaadin-grid-filter-demo/src/main/java/software/xdev/vaadin/ui/MainView.java

@@ -77,7 +77,9 @@ private void initUI()
 				CustomizableFilterBuilder.builder()
 					.withValueProvider(Person::getBirthday, "Birthday")
 					.withIsAfterComparator()
+					.withIsAfterOrEqualsComparator()
 					.withIsBeforeComparator()
+					.withIsBeforeOrEqualsComparator()
 					.withIsBetweenComparator()
 			)
 			.withDatePickerI18n(datePickerI18n)

vaadin-grid-filter/src/main/java/software/xdev/vaadin/FilterComponent.java

@@ -61,11 +61,13 @@
 import com.vaadin.flow.component.select.Select;
 import com.vaadin.flow.component.textfield.BigDecimalField;
 import com.vaadin.flow.component.textfield.TextField;
+import com.vaadin.flow.data.value.ValueChangeMode;
 import com.vaadin.flow.router.BeforeEnterEvent;
 import com.vaadin.flow.router.BeforeEnterObserver;
 import com.vaadin.flow.router.QueryParameters;
 
 import software.xdev.vaadin.builder.CustomizableFilterBuilder;
+import software.xdev.vaadin.comparators.ContainsComparator;
 import software.xdev.vaadin.comparators.FilterComparator;
 import software.xdev.vaadin.comparators.utl.DateHelper;
 import software.xdev.vaadin.daterange_picker.business.DateRange;
@@ -102,11 +104,13 @@ public class FilterComponent<T> extends Composite<VerticalLayout> implements Bef
 	public static final String BTN_CANCEL_FILTER_FILTER_COMPONENT = "btnCancelFilterFilterComponent";
 	public static final String DATE_RANGE_PICKER_QUERY_FILTER_COMPONENT = "dateRangePickerQueryFilterComponent";
 	public static final String DELETED_INITIAL_CONDITION_STRING = "deletedInitialCondition";
+	public static final String BTN_RESET_FILTER_FILTER_COMPONENT = "btnResetFilterFilterComponent";
 
 	private final UI ui;
 	private final Button btnAddNewFilter = new Button("Add filter");
 	private final Button btnAcceptFilter = new Button(VaadinIcon.CHECK.create());
 	private final Button btnCancelFilter = new Button(VaadinIcon.CLOSE.create());
+	private final Button btnResetFilter = new Button(VaadinIcon.ROTATE_RIGHT.create());
 	private final Select<FilterField<T, ?>> selFields = new Select<>();
 	private final Select<FilterComparator> selOperations = new Select<>();
 	private final TextField txtSearchQuery = new TextField();
@@ -130,6 +134,7 @@ private static DateRangePicker<DateRange> createDateRangePicker()
 
 	// Data
 	private final List<ChipBadgeExtension<FilterCondition<T, ?>>> chipBadges = new ArrayList<>();
+	private final List<ChipBadgeExtension<FilterCondition<T, ?>>> initialChipBadges = new ArrayList<>();
 
 	private int initialConditionIdCounter = 1;
 	private String editingBadgeId;
@@ -160,12 +165,13 @@ public FilterComponent(final Grid<T> dataGrid)
 	private void initUI()
 	{
 		final VerticalLayout vlRoot = this.getContent();
-		vlRoot.add(this.btnAddNewFilter, this.hlFilter, this.hlChipBadges);
+		vlRoot.add(new HorizontalLayout(this.btnAddNewFilter, this.btnResetFilter), this.hlFilter, this.hlChipBadges);
 
 		// click listener
 		this.btnAddNewFilter.addClickListener(e -> this.onShowFilterInput());
 		this.btnCancelFilter.addClickListener(e -> this.hlFilter.removeAll());
 		this.btnAcceptFilter.addClickListener(e -> this.onAcceptFilter());
+		this.btnResetFilter.addClickListener(e -> this.onResetFilter());
 
 		// value change listener
 		this.selFields.addValueChangeListener(e -> this.onFieldChange(this.selFields.getValue()));
@@ -182,6 +188,11 @@ private void initUI()
 			this.btnAcceptFilter.setEnabled(e.getValue() != null && this.selOperations.getValue() != null));
 		this.selSearchQuery.addValueChangeListener(e ->
 			this.btnAcceptFilter.setEnabled(e.getValue() != null && this.selOperations.getValue() != null));
+		this.txtSearchQuery.addValueChangeListener(e ->
+			this.btnAcceptFilter.setEnabled(!e.getValue().isBlank() && this.selOperations.getValue() != null));
+		
+		this.nmbSearchQuery.setValueChangeMode(ValueChangeMode.EAGER);
+		this.txtSearchQuery.setValueChangeMode(ValueChangeMode.EAGER);
 
 		// renderer
 		this.selFields.setTextRenderer(FilterField::getDescription);
@@ -193,9 +204,12 @@ private void initUI()
 		this.btnAcceptFilter.addClickShortcut(Key.ENTER);
 		this.btnCancelFilter.addClickShortcut(Key.ESCAPE);
 
+		this.btnResetFilter.setEnabled(false);
+		
 		// ids
 		this.btnAcceptFilter.setId(BTN_ACCEPT_FILTER_FILTER_COMPONENT);
 		this.btnCancelFilter.setId(BTN_CANCEL_FILTER_FILTER_COMPONENT);
+		this.btnResetFilter.setId(BTN_RESET_FILTER_FILTER_COMPONENT);
 		this.selFields.setId(SEL_FIELDS_FILTER_COMPONENT);
 		this.selOperations.setId(SEL_OPERATIONS_FILTER_COMPONENT);
 		this.txtSearchQuery.setId(TXT_SEARCH_QUERY_FILTER_COMPONENT);
@@ -207,6 +221,30 @@ private void initUI()
 		this.dateRangePickerQuery.setId(DATE_RANGE_PICKER_QUERY_FILTER_COMPONENT);
 	}
 
+	private void onResetFilter()
+	{
+		final List<ChipBadgeExtension<FilterCondition<T, ?>>> copyChipBadges = new ArrayList<>(this.chipBadges);
+		for(final ChipBadgeExtension<FilterCondition<T, ?>> chipBadge : copyChipBadges)
+		{
+			this.removeChipBadgeCondition(chipBadge);
+		}
+		
+		// Creating the initial filter again
+		this.chipBadges.addAll(this.initialChipBadges);
+		this.initialChipBadges.forEach(this.hlChipBadges::add);
+		this.updateGridFilter();
+		
+		// Remove query parameter
+		this.ui.getPage().fetchCurrentURL(currentUrl ->
+			this.ui
+				.getPage()
+				.getHistory()
+				.replaceState(null, currentUrl.getPath()));
+		
+		// Disable reset button again
+		this.btnResetFilter.setEnabled(false);
+	}
+	
 	private void onOperatorChanged()
 	{
 		this.btnAcceptFilter.setEnabled(this.shouldTheAcceptButtonBeEnabled());
@@ -219,10 +257,14 @@ private void onOperatorChanged()
 
 				// Change to a text field if the field is of type enum with condition 'contains'
 				if(isSelSearchQueryVisible
-					&& this.selOperations.getValue().getDescription().contains("contains"))
+					&& this.selOperations.getValue()
+					.getDescription()
+					.equals(ContainsComparator.CONTAINS_COMPARATOR_DESCRIPTION))
 				{
 					this.selSearchQuery.setVisible(false);
 					this.txtSearchQuery.setVisible(true);
+					
+					this.btnAcceptFilter.setEnabled(this.shouldTheAcceptButtonBeEnabled());
 				}
 				else if(!isSelSearchQueryVisible)
 				{
@@ -260,6 +302,10 @@ private void onShowFilterInput()
 
 		if(this.hlFilter.getChildren().findAny().isEmpty())
 		{
+			// Needed if the previous condition was an editable initial condition
+			// The editable initial condition makes the cancel button invisible
+			this.btnCancelFilter.setVisible(true);
+			
 			this.selFields.setValue(null);
 			this.selOperations.setItems(Collections.emptyList());
 			this.selOperations.setEnabled(false);
@@ -334,6 +380,9 @@ private void onAcceptFilter()
 
 		// Removing all filter components after accepting
 		this.hlFilter.removeAll();
+		
+		// When something changes from the initial start, enable the reset button
+		this.btnResetFilter.setEnabled(true);
 	}
 
 	private ChipBadgeExtension<FilterCondition<T, ?>> createBadgeConditionAndApplyFilter(
@@ -402,7 +451,7 @@ private void onAcceptFilter()
 		}
 
 		this.chipBadges.add(badge);
-		this.hlChipBadges.add(badge, badge);
+		this.hlChipBadges.add(badge);
 
 		this.updateGridFilter();
 
@@ -421,11 +470,16 @@ private void deactivateDeleteButtonFromChipComponents(
 			{
 				this.removeChipBadgeCondition(badge);
 
-				if(badge.getBadgeId() != null && !badge.getBadgeId().equals(NO_BADGE_ID_STRING))
+				if(!this.identifier.isBlank()
+					&& badge.getBadgeId() != null
+					&& !badge.getBadgeId().equals(NO_BADGE_ID_STRING))
 				{
 					badge.setBadgeId(DELETED_INITIAL_CONDITION_STRING);
 					this.addQueryParameter(badge);
 				}
+				
+				// Activate the reset button
+				this.btnResetFilter.setEnabled(true);
 			});
 		}
 	}
@@ -436,8 +490,10 @@ private void deactivateDeleteButtonFromChipComponents(
 	@SuppressWarnings("PMD.CognitiveComplexity") // Fixed in v2
 	private void formatLocalDateChipBadgeText(final ChipBadge<FilterCondition<T, ?>> chipBadge)
 	{
+		final FilterCondition<T, ?> filterField = chipBadge.getItem();
+		
 		if(this.dateRangePickerQuery.isVisible()
-			&& chipBadge.getItem().getSelectedCondition().getDescription().equals(IS_BETWEEN_COMPARATOR_DESCRIPTION))
+			&& filterField.getSelectedCondition().getDescription().equals(IS_BETWEEN_COMPARATOR_DESCRIPTION))
 		{
 			chipBadge.setItemLabelGenerator((ItemLabelGenerator<FilterCondition<T, ?>>)tFilterCondition ->
 			{
@@ -476,7 +532,7 @@ private void formatLocalDateChipBadgeText(final ChipBadge<FilterCondition<T, ?>>
 				return createChipComponentString(tFilterCondition, dateString);
 			});
 		}
-		else if(this.dateSearchQuery.isVisible())
+		else if(this.dateSearchQuery.isVisible() && filterField.getItem().getType().equals(LocalDate.class))
 		{
 			chipBadge.setItemLabelGenerator((ItemLabelGenerator<FilterCondition<T, ?>>)tFilterCondition ->
 			{
@@ -506,7 +562,7 @@ else if(this.dateSearchQuery.isVisible())
 				return createChipComponentString(tFilterCondition, dateString);
 			});
 		}
-		else if(this.dateTimeSearchQuery.isVisible())
+		else if(this.dateTimeSearchQuery.isVisible() && filterField.getItem().getType().equals(LocalDateTime.class))
 		{
 			chipBadge.setItemLabelGenerator((ItemLabelGenerator<FilterCondition<T, ?>>)tFilterCondition ->
 				{
@@ -657,7 +713,7 @@ else if(this.selSearchQuery.isVisible())
 		else
 		{
 			// For txtSearchQuery
-			valueNotNull = true;
+			valueNotNull = !this.txtSearchQuery.getValue().isBlank();
 		}
 
 		return valueNotNull && this.selOperations.getValue() != null;
@@ -1116,6 +1172,8 @@ public void beforeEnter(final BeforeEnterEvent beforeEnterEvent)
 
 				this.removeInitialConditionIfBadgeIdAlreadyExists(this.queryBadgeIdList);
 				this.createConditionsFromQueryParameters();
+				
+				this.btnResetFilter.setEnabled(true);
 			}
 		}
 	}
@@ -1318,7 +1376,7 @@ public FilterComponent<T> withInitialFilter(
 			this.selFields.setItems(this.filterFieldList);
 		}
 
-		final ChipBadge<FilterCondition<T, ?>> chipBadge = this.createBadgeConditionAndApplyFilter(
+		final ChipBadgeExtension<FilterCondition<T, ?>> chipBadge = this.createBadgeConditionAndApplyFilter(
 			finalFilterField,
 			selectedCondition,
 			searchQuery,
@@ -1328,6 +1386,9 @@ public FilterComponent<T> withInitialFilter(
 		// Just needed if the url parameters are activated
 		chipBadge.setBadgeId(badgeId);
 
+		// Needed for resetting the conditions
+		this.initialChipBadges.add(chipBadge);
+		
 		return this;
 	}
 

vaadin-grid-filter/src/main/java/software/xdev/vaadin/comparators/ContainsComparator.java

@@ -27,6 +27,8 @@
  */
 public final class ContainsComparator implements FilterComparator
 {
+	public static final String CONTAINS_COMPARATOR_DESCRIPTION = "contains";
+	
 	private static ContainsComparator instance;
 
 	private ContainsComparator()
@@ -46,7 +48,7 @@ public static ContainsComparator getInstance()
 	@Override
 	public String getDescription()
 	{
-		return "contains";
+		return CONTAINS_COMPARATOR_DESCRIPTION;
 	}
 
 	@Override

vaadin-grid-filter/src/main/java/software/xdev/vaadin/comparators/GreaterThanOrEqualsComparator.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright © 2024 XDEV Software (https://xdev.software)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package software.xdev.vaadin.comparators;
+
+import java.util.function.Predicate;
+
+import com.vaadin.flow.function.ValueProvider;
+
+import software.xdev.vaadin.comparators.utl.TypeHelper;
+
+
+public final class GreaterThanOrEqualsComparator implements FilterComparator
+{
+	public static final String GREATER_THAN_OR_EQUALS_COMPARATOR_DESCRIPTION = "is greater than or equals";
+	
+	public static GreaterThanOrEqualsComparator instance;
+	
+	private GreaterThanOrEqualsComparator()
+	{
+	}
+	
+	public static GreaterThanOrEqualsComparator getInstance()
+	{
+		if(instance == null)
+		{
+			instance = new GreaterThanOrEqualsComparator();
+		}
+		
+		return instance;
+	}
+	
+	@Override
+	public String getDescription()
+	{
+		return GREATER_THAN_OR_EQUALS_COMPARATOR_DESCRIPTION;
+	}
+	
+	@Override
+	public boolean isApplicable(final Class<?> clazz)
+	{
+		return Number.class.isAssignableFrom(clazz);
+	}
+	
+	@Override
+	public <B, T> Predicate<B> compare(final ValueProvider<B, T> provider, final String searchQuery)
+	{
+		return item ->
+		{
+			final T apply = provider.apply(item);
+			
+			TypeHelper.checkIfTypeIsApplicable(this, apply.getClass());
+			
+			if(apply instanceof final Number numb && TypeHelper.isDouble(searchQuery))
+			{
+				return numb.doubleValue() >= (Double.parseDouble(searchQuery));
+			}
+			
+			return false;
+		};
+	}
+}