Skip to content

Commit 0f85176

Browse files
authored
refactor: rename header component to header content (#6830)
1 parent 8b00ed7 commit 0f85176

File tree

3 files changed

+32
-32
lines changed

3 files changed

+32
-32
lines changed

vaadin-dashboard-flow-parent/vaadin-dashboard-flow-integration-tests/src/main/java/com/vaadin/flow/component/dashboard/tests/DashboardWidgetPage.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public DashboardWidgetPage() {
2929
DashboardWidget widget1 = new DashboardWidget();
3030
widget1.setTitle("Widget 1");
3131
widget1.setContent(new Div("Some content"));
32-
widget1.setHeaderComponent(new Span("Some header"));
32+
widget1.setHeaderContent(new Span("Some header"));
3333
widget1.setId("widget-1");
3434

3535
DashboardWidget widget2 = new DashboardWidget();
@@ -89,7 +89,7 @@ public DashboardWidgetPage() {
8989
updateHeaderOfTheFirstWidget.addClickListener(click -> {
9090
List<DashboardWidget> widgets = dashboard.getWidgets();
9191
if (!widgets.isEmpty()) {
92-
widgets.get(0).setHeaderComponent(new Span("Updated header"));
92+
widgets.get(0).setHeaderContent(new Span("Updated header"));
9393
}
9494
});
9595
updateHeaderOfTheFirstWidget.setId("update-header-of-the-first-widget");
@@ -99,7 +99,7 @@ public DashboardWidgetPage() {
9999
removeHeaderOfTheFirstWidget.addClickListener(click -> {
100100
List<DashboardWidget> widgets = dashboard.getWidgets();
101101
if (!widgets.isEmpty()) {
102-
widgets.get(0).setHeaderComponent(null);
102+
widgets.get(0).setHeaderContent(null);
103103
}
104104
});
105105
removeHeaderOfTheFirstWidget.setId("remove-header-of-the-first-widget");

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/DashboardWidget.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/**
1818
* DashboardWidget represents a customizable widget that can be placed within a
1919
* {@link Dashboard}. It supports layout options such as colspan and rowspan,
20-
* and allows setting content and a header component.
20+
* and allows setting content and header content.
2121
*
2222
* @see Dashboard
2323
*
@@ -140,24 +140,24 @@ public void setContent(Component content) {
140140
}
141141

142142
/**
143-
* Gets the component in the header content slot of this widget.
143+
* Gets the content in the header content slot of this widget.
144144
*
145-
* @return the header component of this widget, or {@code null} if no header
146-
* component has been set
145+
* @return the header content of this widget, or {@code null} if no header
146+
* content has been set
147147
*/
148-
public Component getHeaderComponent() {
148+
public Component getHeaderContent() {
149149
return SlotUtils.getChildInSlot(this, "header-content");
150150
}
151151

152152
/**
153-
* Sets the component in the header content slot of this widget, replacing
154-
* any existing header component.
153+
* Sets the content in the header content slot of this widget, replacing any
154+
* existing header content.
155155
*
156156
* @param header
157-
* the component to set, can be {@code null} to remove existing
158-
* header component
157+
* the content to set, can be {@code null} to remove existing
158+
* header content
159159
*/
160-
public void setHeaderComponent(Component header) {
160+
public void setHeaderContent(Component header) {
161161
SlotUtils.setSlot(this, "header-content", header);
162162
}
163163

vaadin-dashboard-flow-parent/vaadin-dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardWidgetTest.java

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -173,59 +173,59 @@ public void setNullContentToNonEmptyWidget_contentIsRemoved() {
173173
@Test
174174
public void defaultHeaderIsNull() {
175175
DashboardWidget widget = new DashboardWidget();
176-
Assert.assertNull(widget.getHeaderComponent());
176+
Assert.assertNull(widget.getHeaderContent());
177177
}
178178

179179
@Test
180180
public void setHeaderToEmptyWidget_correctHeaderIsSet() {
181181
Div header = new Div();
182182
DashboardWidget widget = new DashboardWidget();
183-
widget.setHeaderComponent(header);
184-
Assert.assertEquals(header, widget.getHeaderComponent());
183+
widget.setHeaderContent(header);
184+
Assert.assertEquals(header, widget.getHeaderContent());
185185
}
186186

187187
@Test
188188
public void setAnotherHeaderToNonEmptyWidget_correctHeaderIsSet() {
189189
DashboardWidget widget = new DashboardWidget();
190-
widget.setHeaderComponent(new Div());
190+
widget.setHeaderContent(new Div());
191191
Span newHeader = new Span();
192-
widget.setHeaderComponent(newHeader);
193-
Assert.assertEquals(newHeader, widget.getHeaderComponent());
192+
widget.setHeaderContent(newHeader);
193+
Assert.assertEquals(newHeader, widget.getHeaderContent());
194194
}
195195

196196
@Test
197197
public void setTheSameHeaderToNonEmptyWidget_correctHeaderIsSet() {
198198
Div header = new Div();
199199
DashboardWidget widget = new DashboardWidget();
200-
widget.setHeaderComponent(header);
201-
widget.setHeaderComponent(header);
202-
Assert.assertEquals(header, widget.getHeaderComponent());
200+
widget.setHeaderContent(header);
201+
widget.setHeaderContent(header);
202+
Assert.assertEquals(header, widget.getHeaderContent());
203203
}
204204

205205
@Test
206206
public void setNullHeaderToNonEmptyWidget_headerIsRemoved() {
207207
DashboardWidget widget = new DashboardWidget();
208-
widget.setHeaderComponent(new Div());
209-
widget.setHeaderComponent(null);
210-
Assert.assertNull(widget.getHeaderComponent());
208+
widget.setHeaderContent(new Div());
209+
widget.setHeaderContent(null);
210+
Assert.assertNull(widget.getHeaderContent());
211211
}
212212

213213
@Test
214214
public void setNullHeaderToWidgetWithContent_contentIsNotRemoved() {
215215
Div content = new Div();
216216
DashboardWidget widget = new DashboardWidget();
217217
widget.setContent(content);
218-
widget.setHeaderComponent(null);
218+
widget.setHeaderContent(null);
219219
Assert.assertEquals(content, widget.getContent());
220220
}
221221

222222
@Test
223223
public void setNullContentToWidgetWithHeader_headerIsNotRemoved() {
224224
Div header = new Div();
225225
DashboardWidget widget = new DashboardWidget();
226-
widget.setHeaderComponent(header);
226+
widget.setHeaderContent(header);
227227
widget.setContent(null);
228-
Assert.assertEquals(header, widget.getHeaderComponent());
228+
Assert.assertEquals(header, widget.getHeaderContent());
229229
}
230230

231231
@Test
@@ -234,20 +234,20 @@ public void setHeaderToWidgetWithContent_contentAndHeaderCorrectlyRetrieved() {
234234
Span header = new Span();
235235
DashboardWidget widget = new DashboardWidget();
236236
widget.setContent(content);
237-
widget.setHeaderComponent(header);
237+
widget.setHeaderContent(header);
238238
Assert.assertEquals(content, widget.getContent());
239-
Assert.assertEquals(header, widget.getHeaderComponent());
239+
Assert.assertEquals(header, widget.getHeaderContent());
240240
}
241241

242242
@Test
243243
public void setContentToWidgetWithHeader_contentAndHeaderCorrectlyRetrieved() {
244244
Div content = new Div();
245245
Span header = new Span();
246246
DashboardWidget widget = new DashboardWidget();
247-
widget.setHeaderComponent(header);
247+
widget.setHeaderContent(header);
248248
widget.setContent(content);
249249
Assert.assertEquals(content, widget.getContent());
250-
Assert.assertEquals(header, widget.getHeaderComponent());
250+
Assert.assertEquals(header, widget.getHeaderContent());
251251
}
252252

253253
@Test

0 commit comments

Comments
 (0)