feat: allow Spreadsheet handler customizations (#7914) (#8091)

DiegoCardoso · HerbertsVaadin · web-flow · commit 902ad641811a · 2025-09-29T12:19:50.000+02:00
* feat: allow Spreadsheet handler customization

* Add tests to verify override of spreadsheet event handlers

* cleanup

Co-authored-by: Herberts &lt;80950643+HerbertsVaadin@users.noreply.github.com&gt;
diff --git a/vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/pom.xml b/vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/pom.xml
@@ -103,6 +103,11 @@
             <groupId>org.apache.poi</groupId>
             <artifactId>poi-scratchpad</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <build>
         <resources>
diff --git a/vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/main/java/com/vaadin/flow/component/spreadsheet/Spreadsheet.java b/vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/main/java/com/vaadin/flow/component/spreadsheet/Spreadsheet.java
@@ -253,6 +253,8 @@ public void setId(String id) {
 
     private Locale locale;
 
+    private Registration spreadsheetHandlerRegistration;
+
     int getCols() {
         return cols;
     }
@@ -1186,7 +1188,7 @@ private void init() {
         valueManager = createCellValueManager();
         sheetOverlays = new HashSet<SheetOverlayWrapper>();
         tables = new HashSet<SpreadsheetTable>();
-        registerRpc(new SpreadsheetHandlerImpl(this));
+        setSpreadsheetHandler(createDefaultHandler());
         defaultActionHandler = new SpreadsheetDefaultActionHandler();
         hyperlinkCellClickHandler = new DefaultHyperlinkCellClickHandler(this);
         addActionHandler(defaultActionHandler);
@@ -1200,11 +1202,30 @@ private void updateAppId() {
         });
     }
 
-    private void registerRpc(SpreadsheetHandlerImpl spreadsheetHandler) {
-        addListener(SpreadsheetEvent.class,
+    /**
+     * Register a Spreadsheet handler to listen to Spreadsheet Events. Removes
+     * the default / previously set spreadsheet handler.
+     *
+     * @param spreadsheetHandler
+     */
+    public void setSpreadsheetHandler(
+            SpreadsheetHandlerImpl spreadsheetHandler) {
+        if (this.spreadsheetHandlerRegistration != null) {
+            spreadsheetHandlerRegistration.remove();
+        }
+        spreadsheetHandlerRegistration = addListener(SpreadsheetEvent.class,
                 new SpreadsheetEventListener(spreadsheetHandler));
     }
 
+    /**
+     * Create the default Spreadsheet handler.
+     * 
+     * @return SpreadsheetHandlerImpl
+     */
+    protected SpreadsheetHandlerImpl createDefaultHandler() {
+        return new SpreadsheetHandlerImpl(this);
+    }
+
     /**
      * Override if there are desired changes or temporary bug fixes, but be
      * careful - this class should cache values for performance.
diff --git a/vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/test/java/com/vaadin/flow/component/spreadsheet/tests/CustomHandlerTest.java b/vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/test/java/com/vaadin/flow/component/spreadsheet/tests/CustomHandlerTest.java
@@ -0,0 +1,89 @@
+/**
+ * Copyright 2000-2025 Vaadin Ltd.
+ *
+ * This program is available under Vaadin Commercial License and Service Terms.
+ *
+ * See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
+ * license.
+ */
+package com.vaadin.flow.component.spreadsheet.tests;
+
+import static org.mockito.Mockito.*;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+import com.vaadin.flow.component.ComponentEventBus;
+import com.vaadin.flow.component.ComponentUtil;
+import com.vaadin.flow.component.spreadsheet.Spreadsheet;
+import com.vaadin.flow.component.spreadsheet.SpreadsheetHandlerImpl;
+
+public class CustomHandlerTest {
+
+    @Test
+    public void singleOriginalSpreadsheetEventIsRegistered() {
+        var originalHandler = mock(SpreadsheetHandlerImpl.class);
+
+        var spreadsheet = new Spreadsheet() {
+            @Override
+            public ComponentEventBus getEventBus() {
+                return super.getEventBus();
+            }
+
+            @Override
+            protected SpreadsheetHandlerImpl createDefaultHandler() {
+                return originalHandler;
+            }
+        };
+
+        var activeListeners = spreadsheet.getEventBus()
+                .getListeners(Spreadsheet.SpreadsheetEvent.class);
+        Assert.assertEquals(1, activeListeners.size());
+
+        // Mock spreadsheet event to trigger the original handler
+        var spreadsheetEvent = mock(Spreadsheet.SpreadsheetEvent.class);
+        when(spreadsheetEvent.getType()).thenReturn("onConnectorInit");
+
+        verify(originalHandler, times(0)).onConnectorInit();
+        ComponentUtil.fireEvent(spreadsheet, spreadsheetEvent); // Fire
+                                                                // spreadsheet
+                                                                // event
+        verify(originalHandler).onConnectorInit();
+    }
+
+    @Test
+    public void newCustomHandlerOverridesOriginal() {
+        var originalHandler = mock(SpreadsheetHandlerImpl.class);
+        var newHandler = mock(SpreadsheetHandlerImpl.class);
+
+        var spreadsheet = new Spreadsheet() {
+            @Override
+            public ComponentEventBus getEventBus() {
+                return super.getEventBus();
+            }
+
+            @Override
+            protected SpreadsheetHandlerImpl createDefaultHandler() {
+                return originalHandler;
+            }
+        };
+
+        spreadsheet.setSpreadsheetHandler(newHandler);
+
+        var activeListeners = spreadsheet.getEventBus()
+                .getListeners(Spreadsheet.SpreadsheetEvent.class);
+        Assert.assertEquals(1, activeListeners.size());
+
+        // Mock spreadsheet event to trigger the new handler
+        var spreadsheetEvent = mock(Spreadsheet.SpreadsheetEvent.class);
+        when(spreadsheetEvent.getType()).thenReturn("onConnectorInit");
+
+        verify(newHandler, times(0)).onConnectorInit();
+        ComponentUtil.fireEvent(spreadsheet, spreadsheetEvent); // Fire
+                                                                // spreadsheet
+                                                                // event
+        verify(originalHandler, times(0)).onConnectorInit();
+        verify(newHandler).onConnectorInit();
+    }
+
+}
