Skip to content

Commit 902ad64

Browse files
feat: allow Spreadsheet handler customizations (#7914) (#8091)
* feat: allow Spreadsheet handler customization * Add tests to verify override of spreadsheet event handlers * cleanup Co-authored-by: Herberts <80950643+HerbertsVaadin@users.noreply.github.com>
1 parent c4abbfe commit 902ad64

3 files changed

Lines changed: 118 additions & 3 deletions

File tree

‎vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/pom.xml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,11 @@
103103
<groupId>org.apache.poi</groupId>
104104
<artifactId>poi-scratchpad</artifactId>
105105
</dependency>
106+
<dependency>
107+
<groupId>org.mockito</groupId>
108+
<artifactId>mockito-core</artifactId>
109+
<scope>test</scope>
110+
</dependency>
106111
</dependencies>
107112
<build>
108113
<resources>

‎vaadin-spreadsheet-flow-parent/vaadin-spreadsheet-flow/src/main/java/com/vaadin/flow/component/spreadsheet/Spreadsheet.java‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,8 @@ public void setId(String id) {
253253

254254
private Locale locale;
255255

256+
private Registration spreadsheetHandlerRegistration;
257+
256258
int getCols() {
257259
return cols;
258260
}
@@ -1186,7 +1188,7 @@ private void init() {
11861188
valueManager = createCellValueManager();
11871189
sheetOverlays = new HashSet<SheetOverlayWrapper>();
11881190
tables = new HashSet<SpreadsheetTable>();
1189-
registerRpc(new SpreadsheetHandlerImpl(this));
1191+
setSpreadsheetHandler(createDefaultHandler());
11901192
defaultActionHandler = new SpreadsheetDefaultActionHandler();
11911193
hyperlinkCellClickHandler = new DefaultHyperlinkCellClickHandler(this);
11921194
addActionHandler(defaultActionHandler);
@@ -1200,11 +1202,30 @@ private void updateAppId() {
12001202
});
12011203
}
12021204

1203-
private void registerRpc(SpreadsheetHandlerImpl spreadsheetHandler) {
1204-
addListener(SpreadsheetEvent.class,
1205+
/**
1206+
* Register a Spreadsheet handler to listen to Spreadsheet Events. Removes
1207+
* the default / previously set spreadsheet handler.
1208+
*
1209+
* @param spreadsheetHandler
1210+
*/
1211+
public void setSpreadsheetHandler(
1212+
SpreadsheetHandlerImpl spreadsheetHandler) {
1213+
if (this.spreadsheetHandlerRegistration != null) {
1214+
spreadsheetHandlerRegistration.remove();
1215+
}
1216+
spreadsheetHandlerRegistration = addListener(SpreadsheetEvent.class,
12051217
new SpreadsheetEventListener(spreadsheetHandler));
12061218
}
12071219

1220+
/**
1221+
* Create the default Spreadsheet handler.
1222+
*
1223+
* @return SpreadsheetHandlerImpl
1224+
*/
1225+
protected SpreadsheetHandlerImpl createDefaultHandler() {
1226+
return new SpreadsheetHandlerImpl(this);
1227+
}
1228+
12081229
/**
12091230
* Override if there are desired changes or temporary bug fixes, but be
12101231
* careful - this class should cache values for performance.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
/**
2+
* Copyright 2000-2025 Vaadin Ltd.
3+
*
4+
* This program is available under Vaadin Commercial License and Service Terms.
5+
*
6+
* See {@literal <https://vaadin.com/commercial-license-and-service-terms>} for the full
7+
* license.
8+
*/
9+
package com.vaadin.flow.component.spreadsheet.tests;
10+
11+
import static org.mockito.Mockito.*;
12+
13+
import org.junit.Assert;
14+
import org.junit.Test;
15+
16+
import com.vaadin.flow.component.ComponentEventBus;
17+
import com.vaadin.flow.component.ComponentUtil;
18+
import com.vaadin.flow.component.spreadsheet.Spreadsheet;
19+
import com.vaadin.flow.component.spreadsheet.SpreadsheetHandlerImpl;
20+
21+
public class CustomHandlerTest {
22+
23+
@Test
24+
public void singleOriginalSpreadsheetEventIsRegistered() {
25+
var originalHandler = mock(SpreadsheetHandlerImpl.class);
26+
27+
var spreadsheet = new Spreadsheet() {
28+
@Override
29+
public ComponentEventBus getEventBus() {
30+
return super.getEventBus();
31+
}
32+
33+
@Override
34+
protected SpreadsheetHandlerImpl createDefaultHandler() {
35+
return originalHandler;
36+
}
37+
};
38+
39+
var activeListeners = spreadsheet.getEventBus()
40+
.getListeners(Spreadsheet.SpreadsheetEvent.class);
41+
Assert.assertEquals(1, activeListeners.size());
42+
43+
// Mock spreadsheet event to trigger the original handler
44+
var spreadsheetEvent = mock(Spreadsheet.SpreadsheetEvent.class);
45+
when(spreadsheetEvent.getType()).thenReturn("onConnectorInit");
46+
47+
verify(originalHandler, times(0)).onConnectorInit();
48+
ComponentUtil.fireEvent(spreadsheet, spreadsheetEvent); // Fire
49+
// spreadsheet
50+
// event
51+
verify(originalHandler).onConnectorInit();
52+
}
53+
54+
@Test
55+
public void newCustomHandlerOverridesOriginal() {
56+
var originalHandler = mock(SpreadsheetHandlerImpl.class);
57+
var newHandler = mock(SpreadsheetHandlerImpl.class);
58+
59+
var spreadsheet = new Spreadsheet() {
60+
@Override
61+
public ComponentEventBus getEventBus() {
62+
return super.getEventBus();
63+
}
64+
65+
@Override
66+
protected SpreadsheetHandlerImpl createDefaultHandler() {
67+
return originalHandler;
68+
}
69+
};
70+
71+
spreadsheet.setSpreadsheetHandler(newHandler);
72+
73+
var activeListeners = spreadsheet.getEventBus()
74+
.getListeners(Spreadsheet.SpreadsheetEvent.class);
75+
Assert.assertEquals(1, activeListeners.size());
76+
77+
// Mock spreadsheet event to trigger the new handler
78+
var spreadsheetEvent = mock(Spreadsheet.SpreadsheetEvent.class);
79+
when(spreadsheetEvent.getType()).thenReturn("onConnectorInit");
80+
81+
verify(newHandler, times(0)).onConnectorInit();
82+
ComponentUtil.fireEvent(spreadsheet, spreadsheetEvent); // Fire
83+
// spreadsheet
84+
// event
85+
verify(originalHandler, times(0)).onConnectorInit();
86+
verify(newHandler).onConnectorInit();
87+
}
88+
89+
}

0 commit comments

Comments
 (0)