refactor!: update ConfirmDialog to not use HasOrderedComponents (#7814)

web-padawan · sissbruecker · web-flow · commit bae595458b00 · 2025-08-12T08:25:22.000+02:00
* refactor!: update ConfirmDialog to not use HasOrderedComponents

* refactor: un-deprecate add and remove methods, update removeAll

* test: remove not needed logic

* Update vaadin-confirm-dialog-flow-parent/vaadin-confirm-dialog-flow/src/main/java/com/vaadin/flow/component/confirmdialog/ConfirmDialog.java

Co-authored-by: Sascha Ißbrücker &lt;sissbruecker@vaadin.com&gt;

---------

Co-authored-by: Sascha Ißbrücker &lt;sissbruecker@vaadin.com&gt;
diff --git a/vaadin-confirm-dialog-flow-parent/vaadin-confirm-dialog-flow/src/main/java/com/vaadin/flow/component/confirmdialog/ConfirmDialog.java b/vaadin-confirm-dialog-flow-parent/vaadin-confirm-dialog-flow/src/main/java/com/vaadin/flow/component/confirmdialog/ConfirmDialog.java
@@ -15,15 +15,14 @@
  */
 package com.vaadin.flow.component.confirmdialog;
 
-import java.util.Collection;
 import java.util.Optional;
 
 import com.vaadin.flow.component.Component;
 import com.vaadin.flow.component.ComponentEvent;
 import com.vaadin.flow.component.ComponentEventListener;
 import com.vaadin.flow.component.ComponentUtil;
 import com.vaadin.flow.component.DomEvent;
-import com.vaadin.flow.component.HasOrderedComponents;
+import com.vaadin.flow.component.HasComponents;
 import com.vaadin.flow.component.HasSize;
 import com.vaadin.flow.component.HasStyle;
 import com.vaadin.flow.component.Tag;
@@ -62,7 +61,7 @@
 @NpmPackage(value = "@vaadin/confirm-dialog", version = "25.0.0-alpha12")
 @JsModule("@vaadin/confirm-dialog/src/vaadin-confirm-dialog.js")
 public class ConfirmDialog extends Component
-        implements HasSize, HasStyle, HasOrderedComponents {
+        implements HasComponents, HasSize, HasStyle {
 
     /**
      * Event that is fired when the user clicks the Confirm button
@@ -703,176 +702,18 @@ public void setCloseOnEsc(boolean closeOnEsc) {
     }
 
     /**
-     * Confirm dialog does not support adding content. Use
-     * {@link #setText(Component)} instead to initialize content as a component.
+     * {@inheritDoc}
      * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public void add(Component... components) {
-        HasOrderedComponents.super.add(components);
-    }
-
-    /**
-     * Confirm dialog does not support adding content. Use
-     * {@link #setText(Component)} instead to initialize content as a component.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public void add(Collection<Component> components) {
-        HasOrderedComponents.super.add(components);
-    }
-
-    /**
-     * Confirm dialog does not support adding content. Use
-     * {@link #setText(String)} instead to initialize content as text.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
+     * Removes all components from this component except elements that have slot
+     * attribute, such as header and buttons.
      */
-    @Deprecated
-    @Override
-    public void add(String text) {
-        HasOrderedComponents.super.add(text);
-    }
-
-    /**
-     * Confirm dialog does not support removing content.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public void remove(Component... components) {
-        HasOrderedComponents.super.remove(components);
-    }
-
-    /**
-     * Confirm dialog does not support removing content.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public void remove(Collection<Component> components) {
-        HasOrderedComponents.super.remove(components);
-    }
-
-    /**
-     * Confirm dialog does not support removing content.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
     @Override
     public void removeAll() {
-        HasOrderedComponents.super.removeAll();
-    }
-
-    /**
-     * Confirm dialog does not support adding content. Use
-     * {@link #setText(Component)} instead to initialize content as a component.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public void addComponentAtIndex(int index, Component component) {
-        HasOrderedComponents.super.addComponentAtIndex(index, component);
-    }
-
-    /**
-     * Confirm dialog does not support adding content. Use
-     * {@link #setText(Component)} instead to initialize content as a component.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public void addComponentAsFirst(Component component) {
-        HasOrderedComponents.super.addComponentAsFirst(component);
-    }
-
-    /**
-     * Confirm dialog does not support replacing content.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public void replace(Component oldComponent, Component newComponent) {
-        HasOrderedComponents.super.replace(oldComponent, newComponent);
-    }
-
-    /**
-     * Confirm dialog does not support multiple components.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public int indexOf(Component component) {
-        return HasOrderedComponents.super.indexOf(component);
-    }
-
-    /**
-     * Confirm dialog does not support multiple components.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public int getComponentCount() {
-        return HasOrderedComponents.super.getComponentCount();
-    }
-
-    /**
-     * Confirm dialog does not support multiple components.
-     * <p>
-     * This method is inherited from {@link HasOrderedComponents} and has been
-     * marked as deprecated to indicate that it is not supported.
-     *
-     * @deprecated since v24.4, not supported
-     */
-    @Deprecated
-    @Override
-    public Component getComponentAt(int index) {
-        return HasOrderedComponents.super.getComponentAt(index);
+        getElement().getChildren().forEach(child -> {
+            if (!child.hasAttribute("slot")) {
+                child.removeFromParent();
+            }
+        });
     }
 
     private void setModality(boolean modal) {
diff --git a/vaadin-confirm-dialog-flow-parent/vaadin-confirm-dialog-flow/src/test/java/com/vaadin/flow/component/confirmdialog/ConfirmDialogChildrenTest.java b/vaadin-confirm-dialog-flow-parent/vaadin-confirm-dialog-flow/src/test/java/com/vaadin/flow/component/confirmdialog/ConfirmDialogChildrenTest.java
@@ -0,0 +1,92 @@
+/*
+ * 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.confirmdialog;
+
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+
+import com.vaadin.flow.component.html.Div;
+
+public class ConfirmDialogChildrenTest {
+
+    private ConfirmDialog dialog;
+
+    @Before
+    public void setup() {
+        dialog = new ConfirmDialog();
+    }
+
+    @Test
+    public void add_removeAll_componentIsRemoved() {
+        Div div = new Div();
+        dialog.add(div);
+
+        dialog.removeAll();
+
+        Assert.assertNull(div.getElement().getParent());
+    }
+
+    @Test
+    public void setText_removeAll_componentIsRemoved() {
+        Div div = new Div();
+        dialog.setText(div);
+
+        dialog.removeAll();
+
+        Assert.assertNull(div.getElement().getParent());
+    }
+
+    @Test
+    public void setHeader_removeAll_componentIsNotRemoved() {
+        Div div = new Div();
+        dialog.setHeader(div);
+
+        dialog.removeAll();
+
+        Assert.assertEquals(dialog.getElement(), div.getElement().getParent());
+    }
+
+    @Test
+    public void setConfirmButton_removeAll_componentIsNotRemoved() {
+        Div div = new Div();
+        dialog.setConfirmButton(div);
+
+        dialog.removeAll();
+
+        Assert.assertEquals(dialog.getElement(), div.getElement().getParent());
+    }
+
+    @Test
+    public void setCancelButton_removeAll_componentIsNotRemoved() {
+        Div div = new Div();
+        dialog.setCancelButton(div);
+
+        dialog.removeAll();
+
+        Assert.assertEquals(dialog.getElement(), div.getElement().getParent());
+    }
+
+    @Test
+    public void setRejectButton_removeAll_componentIsNotRemoved() {
+        Div div = new Div();
+        dialog.setRejectButton(div);
+
+        dialog.removeAll();
+
+        Assert.assertEquals(dialog.getElement(), div.getElement().getParent());
+    }
+}
