Skip to content

Commit 26dc474

Browse files
authored
fix: do not require UI to generate property namespace (#6761)
1 parent 56d1ec4 commit 26dc474

8 files changed

Lines changed: 309 additions & 71 deletions

File tree

‎vaadin-renderer-flow-parent/vaadin-renderer-flow-integration-tests/src/main/java/com/vaadin/flow/data/renderer/tests/ComponentRendererInNewThreadPage.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public class ComponentRendererInNewThreadPage extends Div {
3636
public ComponentRendererInNewThreadPage() {
3737
UI.getCurrent().getPushConfiguration().setPushMode(PushMode.AUTOMATIC);
3838

39-
LitRendererTestComponent component = new LitRendererTestComponent();
39+
LitRendererTestComponentWrapper component = new LitRendererTestComponentWrapper();
4040
component.setItems("Item");
4141

4242
ComponentRenderer<Span, String> componentRenderer = new ComponentRenderer<Span, String>(

‎vaadin-renderer-flow-parent/vaadin-renderer-flow-integration-tests/src/main/java/com/vaadin/flow/data/renderer/tests/LitRendererPage.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public class LitRendererPage extends Div {
2929

3030
public LitRendererPage() {
3131

32-
LitRendererTestComponent component = new LitRendererTestComponent();
32+
LitRendererTestComponentWrapper component = new LitRendererTestComponentWrapper();
3333
component.setItems(Arrays.asList("0", "1", "2", "3", "4"));
3434
setLitRenderer(component);
3535

@@ -97,7 +97,7 @@ public LitRendererPage() {
9797
add(toggleAttachedButton);
9898
}
9999

100-
private void setLitRenderer(LitRendererTestComponent component) {
100+
private void setLitRenderer(LitRendererTestComponentWrapper component) {
101101
component.setRenderer(LitRenderer.<String> of(new StringBuilder()
102102
.append("<div tabindex=\"0\"")
103103
.append(" id=\"content-${index}\"")
@@ -122,7 +122,8 @@ private void setLitRenderer(LitRendererTestComponent component) {
122122
}));
123123
}
124124

125-
private void setDetailsLitRenderer(LitRendererTestComponent component) {
125+
private void setDetailsLitRenderer(
126+
LitRendererTestComponentWrapper component) {
126127
LitRenderer<String> renderer = LitRenderer.<String> of(
127128
"<div id=\"details-${index}\">Details: ${item.value}</div>");
128129
component.setDetailsRenderer(renderer);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
/*
2+
* Copyright 2000-2024 Vaadin Ltd.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
5+
* use this file except in compliance with the License. You may obtain a copy of
6+
* the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13+
* License for the specific language governing permissions and limitations under
14+
* the License.
15+
*/
16+
package com.vaadin.flow.data.renderer.tests;
17+
18+
import com.vaadin.flow.component.html.Div;
19+
import com.vaadin.flow.component.html.NativeButton;
20+
import com.vaadin.flow.component.html.Span;
21+
import com.vaadin.flow.data.renderer.ComponentRenderer;
22+
import com.vaadin.flow.data.renderer.LitRenderer;
23+
import com.vaadin.flow.router.Route;
24+
25+
@Route("vaadin-renderer-flow/lit-renderer-property-namespace")
26+
public class LitRendererPropertyNamespacePage extends Div {
27+
public LitRendererPropertyNamespacePage() {
28+
// Create a wrapper component with two LitRendererTestComponents
29+
LitRendererTestComponentWrapper wrapper = new LitRendererTestComponentWrapper(
30+
2);
31+
wrapper.setItems("Item 0");
32+
33+
NativeButton setLitRenderersButton = new NativeButton(
34+
"Set LitRenderers", e -> {
35+
for (int i = 0; i < wrapper.getComponentCount(); i++) {
36+
wrapper.setRenderer(i, createLitRenderer(
37+
"Component " + i + " : Default Renderer"));
38+
wrapper.setDetailsRenderer(i, createLitRenderer(
39+
"Component " + i + " : Details Renderer"));
40+
}
41+
});
42+
setLitRenderersButton.setId("set-lit-renderers");
43+
44+
NativeButton setComponentRenderersButton = new NativeButton(
45+
"Set ComponentRenderers", e -> {
46+
for (int i = 0; i < wrapper.getComponentCount(); i++) {
47+
wrapper.setRenderer(i, createComponentRenderer(
48+
"Component " + i + " : Default Renderer"));
49+
wrapper.setDetailsRenderer(i, createComponentRenderer(
50+
"Component " + i + " : Details Renderer"));
51+
}
52+
});
53+
setComponentRenderersButton.setId("set-component-renderers");
54+
55+
NativeButton attachButton = new NativeButton("Attach", e -> {
56+
add(wrapper);
57+
});
58+
attachButton.setId("attach");
59+
60+
add(setLitRenderersButton, setComponentRenderersButton, attachButton);
61+
}
62+
63+
private LitRenderer<String> createLitRenderer(String prefix) {
64+
LitRenderer<String> renderer = LitRenderer
65+
.of("<span>${item.content}</span>");
66+
renderer.withProperty("content", item -> prefix + " : " + item);
67+
return renderer;
68+
}
69+
70+
private ComponentRenderer<Span, String> createComponentRenderer(
71+
String prefix) {
72+
return new ComponentRenderer<>(item -> new Span(prefix + " : " + item));
73+
}
74+
}

‎vaadin-renderer-flow-parent/vaadin-renderer-flow-integration-tests/src/main/java/com/vaadin/flow/data/renderer/tests/LitRendererTestComponent.java‎

Lines changed: 6 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -16,67 +16,30 @@
1616
package com.vaadin.flow.data.renderer.tests;
1717

1818
import java.util.ArrayList;
19-
import java.util.Collection;
2019
import java.util.List;
2120

2221
import com.vaadin.flow.component.Tag;
2322
import com.vaadin.flow.component.dependency.JsModule;
2423
import com.vaadin.flow.component.html.Div;
25-
import com.vaadin.flow.data.binder.HasDataProvider;
26-
import com.vaadin.flow.data.provider.ArrayUpdater;
2724
import com.vaadin.flow.data.provider.CompositeDataGenerator;
2825
import com.vaadin.flow.data.provider.DataCommunicator;
29-
import com.vaadin.flow.data.provider.DataProvider;
3026
import com.vaadin.flow.data.renderer.LitRenderer;
3127
import com.vaadin.flow.data.renderer.Rendering;
32-
import com.vaadin.flow.internal.JsonUtils;
3328
import com.vaadin.flow.shared.Registration;
3429

35-
import elemental.json.JsonValue;
36-
3730
@Tag("lit-renderer-test-component")
3831
@JsModule("lit-renderer-test-component.js")
39-
public class LitRendererTestComponent extends Div
40-
implements HasDataProvider<String> {
41-
32+
public class LitRendererTestComponent extends Div {
4233
private final DataCommunicator<String> dataCommunicator;
43-
private final CompositeDataGenerator<String> dataGenerator = new CompositeDataGenerator<>();
34+
private final CompositeDataGenerator<String> dataGenerator;
4435

4536
private final List<Registration> renderingRegistrations = new ArrayList<>();
4637
private final List<Registration> detailsRenderingRegistrations = new ArrayList<>();
4738

48-
private final ArrayUpdater arrayUpdater = new ArrayUpdater() {
49-
@Override
50-
public Update startUpdate(int sizeChange) {
51-
return new Update() {
52-
@Override
53-
public void clear(int start, int length) {
54-
// not essential for this test
55-
}
56-
57-
@Override
58-
public void set(int start, List<JsonValue> items) {
59-
getElement().executeJs("this.items = $0",
60-
items.stream().collect(JsonUtils.asArray()));
61-
}
62-
63-
@Override
64-
public void commit(int updateId) {
65-
// not essential for this test
66-
}
67-
};
68-
}
69-
70-
@Override
71-
public void initialize() {
72-
// not essential for this test
73-
}
74-
};
75-
76-
public LitRendererTestComponent() {
77-
dataCommunicator = new DataCommunicator<>(dataGenerator, arrayUpdater,
78-
data -> {
79-
}, getElement().getNode());
39+
public LitRendererTestComponent(DataCommunicator<String> dataCommunicator,
40+
CompositeDataGenerator<String> dataGenerator) {
41+
this.dataCommunicator = dataCommunicator;
42+
this.dataGenerator = dataGenerator;
8043
}
8144

8245
public void setRenderer(LitRenderer<String> renderer) {
@@ -108,16 +71,4 @@ public void setDetailsRenderer(LitRenderer<String> renderer) {
10871
dataCommunicator.reset();
10972
}
11073
}
111-
112-
@Override
113-
public void setItems(Collection<String> items) {
114-
HasDataProvider.super.setItems(items);
115-
dataCommunicator.setRequestedRange(0, items.size());
116-
}
117-
118-
@Override
119-
public void setDataProvider(DataProvider<String, ?> dataProvider) {
120-
dataCommunicator.setDataProvider(dataProvider, null);
121-
}
122-
12374
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
/*
2+
* Copyright 2000-2024 Vaadin Ltd.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
5+
* use this file except in compliance with the License. You may obtain a copy of
6+
* the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13+
* License for the specific language governing permissions and limitations under
14+
* the License.
15+
*/
16+
package com.vaadin.flow.data.renderer.tests;
17+
18+
import java.util.Collection;
19+
import java.util.List;
20+
import java.util.stream.Collectors;
21+
22+
import com.vaadin.flow.component.html.Div;
23+
import com.vaadin.flow.data.binder.HasDataProvider;
24+
import com.vaadin.flow.data.provider.ArrayUpdater;
25+
import com.vaadin.flow.data.provider.CompositeDataGenerator;
26+
import com.vaadin.flow.data.provider.DataCommunicator;
27+
import com.vaadin.flow.data.provider.DataProvider;
28+
import com.vaadin.flow.data.renderer.LitRenderer;
29+
import com.vaadin.flow.internal.JsonUtils;
30+
31+
import elemental.json.JsonValue;
32+
33+
public class LitRendererTestComponentWrapper extends Div
34+
implements HasDataProvider<String> {
35+
private final DataCommunicator<String> dataCommunicator;
36+
private final CompositeDataGenerator<String> dataGenerator = new CompositeDataGenerator<>();
37+
38+
private final ArrayUpdater arrayUpdater = new ArrayUpdater() {
39+
@Override
40+
public Update startUpdate(int sizeChange) {
41+
return new Update() {
42+
@Override
43+
public void clear(int start, int length) {
44+
// not essential for this test
45+
}
46+
47+
@Override
48+
public void set(int start, List<JsonValue> items) {
49+
getChildren().forEach((component) -> {
50+
component.getElement().executeJs("this.items = $0",
51+
items.stream().collect(JsonUtils.asArray()));
52+
});
53+
}
54+
55+
@Override
56+
public void commit(int updateId) {
57+
// not essential for this test
58+
}
59+
};
60+
}
61+
62+
@Override
63+
public void initialize() {
64+
// not essential for this test
65+
}
66+
};
67+
68+
/**
69+
* Creates a wrapper with one LitRendererTestComponent.
70+
*/
71+
public LitRendererTestComponentWrapper() {
72+
this(1);
73+
}
74+
75+
/**
76+
* Creates a wrapper with the given number of LitRendererTestComponent.
77+
*
78+
* @param childCount
79+
* the number of children to add
80+
*/
81+
public LitRendererTestComponentWrapper(int childCount) {
82+
dataCommunicator = new DataCommunicator<>(dataGenerator, arrayUpdater,
83+
data -> {
84+
}, getElement().getNode());
85+
86+
for (int i = 0; i < childCount; i++) {
87+
add(new LitRendererTestComponent(dataCommunicator, dataGenerator));
88+
}
89+
}
90+
91+
/**
92+
* Sets the renderer for all children.
93+
*/
94+
public void setRenderer(LitRenderer<String> renderer) {
95+
getComponents().forEach(component -> {
96+
component.setRenderer(renderer);
97+
});
98+
}
99+
100+
/**
101+
* Sets the renderer for the component at the given index.
102+
*/
103+
public void setRenderer(int componentIndex, LitRenderer<String> renderer) {
104+
getComponents().get(componentIndex).setRenderer(renderer);
105+
}
106+
107+
/**
108+
* Sets the details renderer for all children.
109+
*/
110+
public void setDetailsRenderer(LitRenderer<String> renderer) {
111+
getComponents().forEach(component -> {
112+
component.setDetailsRenderer(renderer);
113+
});
114+
}
115+
116+
/**
117+
* Sets the details renderer for the component at the given index.
118+
*/
119+
public void setDetailsRenderer(int componentIndex,
120+
LitRenderer<String> renderer) {
121+
getComponents().get(componentIndex).setDetailsRenderer(renderer);
122+
}
123+
124+
private List<LitRendererTestComponent> getComponents() {
125+
return getChildren().map(LitRendererTestComponent.class::cast)
126+
.collect(Collectors.toList());
127+
}
128+
129+
@Override
130+
public void setItems(Collection<String> items) {
131+
HasDataProvider.super.setItems(items);
132+
dataCommunicator.setRequestedRange(0, items.size());
133+
}
134+
135+
@Override
136+
public void setDataProvider(DataProvider<String, ?> dataProvider) {
137+
dataCommunicator.setDataProvider(dataProvider, null);
138+
}
139+
}

0 commit comments

Comments
 (0)