Skip to content

Commit eff6762

Browse files
authored
feat: add missing setItemLabelGenerator for a ListBox (#2275)
* Add setItemLabelGenerator for ListBox * Refresh the items after itemLabelGenerator changes
1 parent 16b3089 commit eff6762

4 files changed

Lines changed: 76 additions & 1 deletion

File tree

  • vaadin-list-box-flow-parent
    • vaadin-list-box-flow-demo/src/main/java/com/vaadin/flow/component/listbox/demo
    • vaadin-list-box-flow-integration-tests/src
    • vaadin-list-box-flow/src/main/java/com/vaadin/flow/component/listbox

‎vaadin-list-box-flow-parent/vaadin-list-box-flow-demo/src/main/java/com/vaadin/flow/component/listbox/demo/ListBoxView.java‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ public void initView() {
6161
dataViewFiltering();
6262
separatorDemo();// Presentation
6363
customOptions();
64+
usingItemLabelGenerator();
6465
usingTemplateRenderer();
6566
styling(); // Styling
6667
}
@@ -152,6 +153,20 @@ private List<Department> getDepartments() {
152153
return departmentData.getDepartments();
153154
}
154155

156+
private void usingItemLabelGenerator() {
157+
// begin-source-example
158+
// source-example-heading: Item Label Generator
159+
ListBox<Department> listBox = new ListBox<>();
160+
List<Department> listOfDepartments = getDepartments();
161+
listBox.setItems(listOfDepartments);
162+
listBox.setValue(listOfDepartments.get(0));
163+
164+
listBox.setItemLabelGenerator(Department::getName);
165+
// end-source-example
166+
167+
addCard(PRESENTATION, "Item Label Generator", listBox);
168+
}
169+
155170
private void usingTemplateRenderer() {
156171
// begin-source-example
157172
// source-example-heading: Multi-line label

‎vaadin-list-box-flow-parent/vaadin-list-box-flow-integration-tests/src/main/java/com/vaadin/flow/component/listbox/test/ListBoxViewDemoPage.java‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ public void initView() {
4545
addComponentsBetween();
4646
addItemRenderer();
4747
addDisabledListBox();
48+
addItemLabelGenerator();
4849

4950
addCard("Example object used in the demo");
5051
}
@@ -90,6 +91,19 @@ private void addComponentsBetween() {
9091
.setId("list-box-with-components-between");
9192
}
9293

94+
private void addItemLabelGenerator() {
95+
// begin-source-example
96+
// source-example-heading: Using item label generator
97+
ListBox<Item> listBox = new ListBox<>();
98+
listBox.setItems(getItems());
99+
100+
listBox.setItemLabelGenerator(Item::getName);
101+
102+
// end-source-example
103+
addCard("Using item label generator", listBox)
104+
.setId("list-box-with-item-label-generator");
105+
}
106+
93107
private void addItemRenderer() {
94108
// begin-source-example
95109
// source-example-heading: Using item renderer and disabling items

‎vaadin-list-box-flow-parent/vaadin-list-box-flow-integration-tests/src/test/java/com/vaadin/flow/component/listbox/test/ListBoxIT.java‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,4 +156,21 @@ private void assertItem(WebElement item, String itemName) {
156156
"true", item.getAttribute("disabled"));
157157
}
158158

159+
@Test
160+
public void itemItemLabelGenerator() {
161+
init("list-box-with-item-label-generator");
162+
assertItemGenerator(items.get(0), BREAD);
163+
assertItemGenerator(items.get(1), BUTTER);
164+
assertItemGenerator(items.get(2), MILK);
165+
}
166+
167+
private void assertItemGenerator(WebElement item, String itemName) {
168+
List<WebElement> labels = item.findElements(By.tagName("span"));
169+
String nameText = labels.get(0).getText();
170+
171+
Assert.assertThat(
172+
"First label inside the item should contain the name of the item",
173+
nameText, containsString(itemName));
174+
}
175+
159176
}

‎vaadin-list-box-flow-parent/vaadin-list-box-flow/src/main/java/com/vaadin/flow/component/listbox/ListBoxBase.java‎

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
import com.vaadin.flow.component.DetachEvent;
3232
import com.vaadin.flow.component.HasSize;
3333
import com.vaadin.flow.component.HasStyle;
34+
import com.vaadin.flow.component.ItemLabelGenerator;
3435
import com.vaadin.flow.component.Tag;
3536
import com.vaadin.flow.component.UI;
3637
import com.vaadin.flow.component.dependency.JsModule;
@@ -78,7 +79,9 @@ public abstract class ListBoxBase<C extends ListBoxBase<C, ITEM, VALUE>, ITEM, V
7879
private final AtomicReference<DataProvider<ITEM, ?>> dataProvider = new AtomicReference<>(
7980
DataProvider.ofItems());
8081
private List<ITEM> items;
81-
private ComponentRenderer<? extends Component, ITEM> itemRenderer = new TextRenderer<>();
82+
private ItemLabelGenerator<ITEM> itemLabelGenerator = String::valueOf;
83+
private ComponentRenderer<? extends Component, ITEM> itemRenderer = new TextRenderer<>(
84+
itemLabelGenerator);
8285
private SerializablePredicate<ITEM> itemEnabledProvider = item -> isEnabled();
8386
private Registration dataProviderListenerRegistration;
8487

@@ -177,6 +180,32 @@ public void setRenderer(
177180
getItemComponents().forEach(this::refreshContent);
178181
}
179182

183+
/**
184+
* Sets the item label generator that is used to produce the strings shown
185+
* in the ListBox for each item. By default, {@link String#valueOf(Object)}
186+
* is used.
187+
*
188+
* @param itemLabelGenerator
189+
* the item label provider to use, not null
190+
*/
191+
public void setItemLabelGenerator(
192+
ItemLabelGenerator<ITEM> itemLabelGenerator) {
193+
Objects.requireNonNull(itemLabelGenerator,
194+
"The item label generator can not be null");
195+
this.itemLabelGenerator = itemLabelGenerator;
196+
setRenderer(new TextRenderer<>(this.itemLabelGenerator));
197+
}
198+
199+
/**
200+
* Gets the item label generator that is used to produce the strings shown
201+
* in the ListBox for each item.
202+
*
203+
* @return the item label generator used, not null
204+
*/
205+
public ItemLabelGenerator<ITEM> getItemLabelGenerator() {
206+
return itemLabelGenerator;
207+
}
208+
180209
/**
181210
* Sets the item enabled predicate for this ListBox. The predicate is
182211
* applied to each item to determine whether the item should be enabled

0 commit comments

Comments
 (0)