feat: control manually when CustomField updates value (#7771)

jcgueriaud1 · sissbruecker · web-flow · commit 029dbce961d7 · 2025-08-11T20:41:40.000+02:00
* Add disableUpdateValueOnChange to the CustomField

* Add disableUpdateValueOnChange to the CustomField

* Fix Sonar issues

* Fix Sonar issues

* feat: Add manualValueChangeTriggering in the CustomField

* improve naming, javadoc

* replace IT with unit test

---------

Co-authored-by: Sascha Ißbrücker &lt;sissbruecker@vaadin.com&gt;
diff --git a/vaadin-custom-field-flow-parent/vaadin-custom-field-flow/src/main/java/com/vaadin/flow/component/customfield/CustomField.java b/vaadin-custom-field-flow-parent/vaadin-custom-field-flow/src/main/java/com/vaadin/flow/component/customfield/CustomField.java
@@ -69,9 +69,30 @@ public CustomField() {
      * @see AbstractField#AbstractField(Object)
      */
     public CustomField(T defaultValue) {
+        this(defaultValue, false);
+    }
+
+    /**
+     * Constructs a new custom field.
+     *
+     * @param defaultValue
+     *            The initial value for the field. Will also be used by
+     *            {@link #getEmptyValue()}.
+     * @param manualValueUpdate
+     *            when {@code true} the component does not automatically update
+     *            its value when one of the contained fields changes. This
+     *            allows controlling manually when the value is updated, which
+     *            can be done by calling {@link #updateValue()}. {@code false}
+     *            by default.
+     *
+     * @see AbstractField#AbstractField(Object)
+     */
+    public CustomField(T defaultValue, boolean manualValueUpdate) {
         super(defaultValue);
-        // Force a value update when the change event generated
-        getElement().addEventListener("change", e -> this.updateValue());
+        if (!manualValueUpdate) {
+            // Automatically update the value when a contained field changes
+            getElement().addEventListener("change", e -> this.updateValue());
+        }
         getElement().setProperty("manualValidation", true);
     }
 
diff --git a/vaadin-custom-field-flow-parent/vaadin-custom-field-flow/src/test/java/com/vaadin/flow/component/customfield/ManualValueUpdateTest.java b/vaadin-custom-field-flow-parent/vaadin-custom-field-flow/src/test/java/com/vaadin/flow/component/customfield/ManualValueUpdateTest.java
@@ -0,0 +1,95 @@
+/*
+ * Copyright 2000-2025 Vaadin Ltd.
+ *
+ * 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 com.vaadin.flow.component.customfield;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import com.vaadin.flow.dom.DomEvent;
+
+import elemental.json.Json;
+
+public class ManualValueUpdateTest {
+
+    private IncrementingCustomField automaticField;
+    private IncrementingCustomField manualField;
+
+    @Before
+    public void setup() {
+        automaticField = new IncrementingCustomField(false);
+        manualField = new IncrementingCustomField(true);
+    }
+
+    @Test
+    public void automaticValueUpdate_changeEventUpdatesValue() {
+        Assert.assertEquals(Integer.valueOf(0), automaticField.getValue());
+
+        fireChangeEvent(automaticField);
+        Assert.assertEquals(Integer.valueOf(1), automaticField.getValue());
+
+        fireChangeEvent(automaticField);
+        Assert.assertEquals(Integer.valueOf(2), automaticField.getValue());
+    }
+
+    @Test
+    public void manualValueUpdate_changeEventDoesNotUpdateValue() {
+        Assert.assertEquals(Integer.valueOf(0), manualField.getValue());
+
+        fireChangeEvent(manualField);
+        Assert.assertEquals(Integer.valueOf(0), manualField.getValue());
+
+        fireChangeEvent(manualField);
+        Assert.assertEquals(Integer.valueOf(0), manualField.getValue());
+    }
+
+    @Test
+    public void manualValueUpdate_manuallyUpdateValue() {
+        Assert.assertEquals(Integer.valueOf(0), manualField.getValue());
+
+        manualField.updateValue();
+        Assert.assertEquals(Integer.valueOf(1), manualField.getValue());
+
+        manualField.updateValue();
+        Assert.assertEquals(Integer.valueOf(2), manualField.getValue());
+    }
+
+    private void fireChangeEvent(CustomField<?> field) {
+        DomEvent changeEvent = new DomEvent(field.getElement(), "change",
+                Json.createObject());
+        field.getElement().getNode().getFeature(
+                com.vaadin.flow.internal.nodefeature.ElementListenerMap.class)
+                .fireEvent(changeEvent);
+    }
+
+    private static class IncrementingCustomField extends CustomField<Integer> {
+        private int counter = 0;
+
+        public IncrementingCustomField(boolean manualValueUpdate) {
+            super(0, manualValueUpdate);
+        }
+
+        @Override
+        protected Integer generateModelValue() {
+            return ++counter;
+        }
+
+        @Override
+        protected void setPresentationValue(Integer newPresentationValue) {
+            // Not needed for this test
+        }
+    }
+}
