Skip to content

Commit 7514bdf

Browse files
authored
fix: use property change listener for opened change event (#4665)
1 parent 380c6bf commit 7514bdf

5 files changed

Lines changed: 83 additions & 22 deletions

File tree

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
package com.vaadin.flow.component.details.tests;
2+
3+
import com.vaadin.flow.component.details.Details;
4+
import com.vaadin.flow.component.html.Div;
5+
import com.vaadin.flow.component.html.NativeButton;
6+
import com.vaadin.flow.router.Route;
7+
8+
@Route("vaadin-details/events")
9+
public class DetailsEventsPage extends Div {
10+
public DetailsEventsPage() {
11+
Details details = new Details();
12+
13+
Div output = new Div();
14+
output.setId("output");
15+
output.getStyle().set("white-space", "pre");
16+
details.addOpenedChangeListener(e -> {
17+
output.setText(output.getText() + String.format(
18+
"Opened changed: opened=%s, isFromClient=%s\n",
19+
e.isOpened(), e.isFromClient()));
20+
});
21+
22+
NativeButton toggle = new NativeButton("Toggle", e -> {
23+
details.setOpened(!details.isOpened());
24+
});
25+
toggle.setId("toggle");
26+
27+
add(details, new Div(toggle), output);
28+
}
29+
}

‎vaadin-details-flow-parent/vaadin-details-flow-integration-tests/src/main/java/com/vaadin/flow/component/details/tests/Home.java‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,6 @@ public Home() {
3030
new Span("Themed Content"));
3131
detailsThemed.addThemeVariants(DetailsVariant.values());
3232

33-
Details detailsListener = new Details(
34-
"Details with opened change listener", new Span("Content"));
35-
detailsListener.addOpenedChangeListener(event -> {
36-
if (event.isOpened()) {
37-
info.setText("opened-change");
38-
}
39-
});
40-
41-
add(details, detailsDisabled, detailsThemed, detailsListener, info);
33+
add(details, detailsDisabled, detailsThemed, info);
4234
}
4335
}

‎vaadin-details-flow-parent/vaadin-details-flow-integration-tests/src/test/java/com/vaadin/flow/component/details/tests/BasicIT.java‎

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public void init() {
2424
getDriver().get(url);
2525
detailsElements = $(DetailsElement.class).all();
2626

27-
Assert.assertEquals(4, detailsElements.size());
27+
Assert.assertEquals(3, detailsElements.size());
2828
}
2929

3030
@Test
@@ -42,13 +42,6 @@ public void testSummary() {
4242
detailsThemed.getSummaryText());
4343
}
4444

45-
@Test
46-
public void testOpenedChange() {
47-
DetailsElement detail = detailsElements.get(3);
48-
detail.toggle();
49-
Assert.assertEquals("opened-change", $("div").id("info").getText());
50-
}
51-
5245
@Test
5346
public void testContent() {
5447
DetailsElement detail1 = detailsElements.get(0);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
package com.vaadin.flow.component.details.tests;
2+
3+
import com.vaadin.flow.component.details.testbench.DetailsElement;
4+
import com.vaadin.flow.testutil.TestPath;
5+
import com.vaadin.testbench.TestBenchElement;
6+
import com.vaadin.tests.AbstractComponentIT;
7+
import org.junit.Assert;
8+
import org.junit.Before;
9+
import org.junit.Test;
10+
11+
@TestPath("vaadin-details/events")
12+
public class DetailsEventsIT extends AbstractComponentIT {
13+
private DetailsElement details;
14+
private TestBenchElement toggle;
15+
private TestBenchElement output;
16+
17+
@Before
18+
public void init() {
19+
open();
20+
details = $(DetailsElement.class).waitForFirst();
21+
toggle = $(TestBenchElement.class).id("toggle");
22+
output = $(TestBenchElement.class).id("output");
23+
}
24+
25+
@Test
26+
public void noInitialOpenedChangeEvent() {
27+
Assert.assertEquals("", output.getText());
28+
}
29+
30+
@Test
31+
public void toggleOnClient_openedChangeEventIsFromClient() {
32+
details.toggle();
33+
Assert.assertEquals("Opened changed: opened=true, isFromClient=true",
34+
output.getText());
35+
}
36+
37+
@Test
38+
public void toggleOnServer_openedChangeEventIsNotFromClient() {
39+
toggle.click();
40+
Assert.assertEquals("Opened changed: opened=true, isFromClient=false",
41+
output.getText());
42+
}
43+
}

‎vaadin-details-flow-parent/vaadin-details-flow/src/main/java/com/vaadin/flow/component/details/Details.java‎

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ public Details() {
8484
getElement().appendChild(contentContainer.getElement());
8585
summaryContainer = createSummaryContainer();
8686
SlotUtils.addToSlot(this, "summary", summaryContainer);
87+
88+
if (getElement().getPropertyRaw("opened") == null) {
89+
setOpened(false);
90+
}
8791
}
8892

8993
/**
@@ -294,7 +298,6 @@ public void setOpened(boolean opened) {
294298
getElement().setProperty("opened", opened);
295299
}
296300

297-
@DomEvent("opened-changed")
298301
public static class OpenedChangeEvent extends ComponentEvent<Details> {
299302
private final boolean opened;
300303

@@ -309,16 +312,17 @@ public boolean isOpened() {
309312
}
310313

311314
/**
312-
* Adds a listener for {@code opened-changed} events fired by the
313-
* webcomponent.
315+
* Adds a listener to get notified when the opened state of the component
316+
* changes.
314317
*
315318
* @param listener
316319
* the listener
317320
* @return a {@link Registration} for removing the event listener
318321
*/
319322
public Registration addOpenedChangeListener(
320323
ComponentEventListener<OpenedChangeEvent> listener) {
321-
return ComponentUtil.addListener(this, OpenedChangeEvent.class,
322-
listener);
324+
return getElement().addPropertyChangeListener("opened",
325+
event -> listener.onComponentEvent(
326+
new OpenedChangeEvent(this, event.isUserOriginated())));
323327
}
324328
}

0 commit comments

Comments
 (0)