GridPro extend built-in select editor with options for enums

mager · May 2, 2025, 1:24pm

Hi,
I’d like to propose the following small QoL improvement for the GridPro component when using the built-in select editor for enums.
It should be possible to restrict which enum values are available for selection.
The suggested approach for this use case is to use String instead of an enum class.
For our use cases, this is somewhat cumbersome, since we have to convert the String back to an Enum in the ItemUpdater.

knoobie · May 2, 2025, 2:44pm

Best place for such a suggestion would be at GitHub · Where software is built - you could create a pull request for this to increase likelihood of it getting accepted since it’s quite small and a reasonable use-case.

This class flow-components/vaadin-grid-pro-flow-parent/vaadin-grid-pro-flow/src/main/java/com/vaadin/flow/component/gridpro/EditColumnConfigurator.java at main · vaadin/flow-components · GitHub and the corresponding test should be updated.

mager · May 6, 2025, 11:27am

Thanks Christian, I hadn’t thought of that, since it’s a pro-component.
Thanks also for adding the GitHub link.
I’ll get to work on creating a pull request in the next few days.

knoobie · May 6, 2025, 11:41am

You might want to create a issue first and see what the team thinks about it before “wasting” your time :) Especially with different ways of implementation the feature, you could for example add a parameter with a List or T… which values of the enum are allowed or supply a Predicate which is used to filter the enum class… both ways sound reasonable.

mager · May 6, 2025, 1:40pm

The created issue on GitHub for lookup:

github.com/vaadin/flow-components

GridPro extend built-in select editor with options for enums

opened 01:37PM - 06 May 25 UTC

florianmager

### Describe your motivation I’d like to propose the following small QoL improv…ement for the GridPro component when using the built-in select editor for enums. It should be possible to restrict which enum values are available for selection. The suggested approach for this use case is to use String instead of an enum class. For our use cases, this is somewhat cumbersome, since we have to convert the String back to an Enum in the ItemUpdater. ### Describe the solution you'd like My solution would be to add the following methods to [EditColumnConfigurator](https://github.com/vaadin/flow-components/blob/main/vaadin-grid-pro-flow-parent/vaadin-grid-pro-flow/src/main/java/com/vaadin/flow/component/gridpro/EditColumnConfigurator.java): public <E extends Enum<E>> Column<T> select(ItemUpdater<T, E> itemUpdater, Class<E> enumType, SerializableFunction<E, String> getStringRepresentation, List<E> options) public <E extends Enum<E>> Column<T> select(ItemUpdater<T, E> itemUpdater, Class<E> enumType, SerializableFunction<E, String> getStringRepresentation, E... options) public <E extends Enum<E>> Column<T> select(ItemUpdater<T, E> itemUpdater, Class<E> enumType, List<E> options) public <E extends Enum<E>> Column<T> select(ItemUpdater<T, E> itemUpdater, Class<E> enumType, E... options) The implementation would be in select(ItemUpdater<T, E> itemUpdater, Class<E> enumType, SerializableFunction<E, String> getStringRepresentation, List<E> options) and the other select enum methods would call this method. ### Describe alternatives you've considered Another solution suggested by Christian Knoob is to filter via predicate. The advantage is that only 2 methods needs to be added for this approach. The disadvante is that the select via String uses List<String> and String... for options which is then not uniform ### Additional context The current implementation of select for enums, where adding options is not a problem: ` public <E extends Enum<E>> Column<T> select(ItemUpdater<T, E> itemUpdater, Class<E> enumType, SerializableFunction<E, String> getStringRepresentation) { Map<String, E> map = new HashMap<>(); E[] items = enumType.getEnumConstants(); List<String> itemsList = new ArrayList<>(); for (E item : items) { String stringRepresentation = getStringRepresentation.apply(item); if (map.containsKey(stringRepresentation)) { throw new IllegalArgumentException("Enum constants " + map.get(stringRepresentation) + " and " + item + " both have the same string representation: " + stringRepresentation); } map.put(stringRepresentation, item); itemsList.add(stringRepresentation); } ItemUpdater<T, String> wrapper = (item, value) -> itemUpdater .accept(item, map.get(value)); return select(wrapper, itemsList); } `