This component provides a container that accepts a collection of elements for viewing with customized content for each one.
For example:
ListGroup.create()
.setItemRenderer((listGroup, item) -> {
item.appendChild(Label.createPrimary(item.getValue())
})
.setItems(Arrays.asList("first item", "second item"));
T
the type of the value object inside the element
See also :
Usage example:
ListItemlistItem = ListItem.create("Item 1"); listItem.addSelectionListener((source, selection) -> { // Handle selection event if (selection.isSelected()) { // Item is selected } else { // Item is deselected } });
T
The type of value associated with the list item.
See also :
public void ListGroup()
ListGroup with bordered style.
public static ListGroup<T> create()
ListGroup instance.
The list group is initially created with bordered style.
Returns:
a new ListGroup instance.
public ListGroup<T> setItemRenderer(ItemRenderer<T> itemRenderer)
itemRenderer
The item renderer function.
this ListGroup instance.
public ListGroup<T> setItems(List<? extends T> items)
items
The list of items to set.
this ListGroup instance.
public ListGroup<T> removeAll()
this ListGroup instance.
public ListGroup<T> addItems(List<? extends T> items)
items
The list of items to add.
this ListGroup instance.
public ListGroup<T> addItem(T value)
value
The item value to add.
this ListGroup instance.
public ListGroup<T> insertFirst(T value)
value
The item value to insert.
this ListGroup instance.
public ListGroup<T> insertAt(int index, T value)
index
The index at which to insert the item.
value
The item value to insert.
this ListGroup instance.
public ListGroup<T> removeItemsByValue(List<? extends T> toBeRemoved)
toBeRemoved
The list of items to remove.
this ListGroup instance.
public ListGroup<T> removeItem(T value)
value
The item value to remove.
this ListGroup instance.
public ListGroup<T> removeItem(ListItem<? extends T> item)
item
The item to remove.
this ListGroup instance.
public ListGroup<T> removeItems(List<ListItem<? extends T>> items)
items
The list of items to remove.
this ListGroup instance.
public ListGroup<T> removeItem(ListItem<? extends T> item, boolean silent)
item
The item to remove.
silent
Whether to trigger removal listeners.
this ListGroup instance.
public ListGroup<T> updateItem(T value)
value
The new value for the item.
this ListGroup instance.
public ListGroup<T> updateItems(List<? extends T> newValues)
newValues
The list of new values to update.
this ListGroup instance.
public ListGroup<T> setBordered(boolean bordered)
bordered
Whether to set the bordered style.
this ListGroup instance.
public List<ListItem<T>> getItems()
A list of items.
public List<ListItem<T>> getSelectedItems()
A list of selected items.
public ListGroup<T> pauseSelectionListeners()
This ListGroup instance.
public ListGroup<T> resumeSelectionListeners()
This ListGroup instance.
public ListGroup<T> togglePauseSelectionListeners(boolean toggle)
toggle
true to pause selection listeners, false to resume them.
This ListGroup instance.
public Set<SelectionListener<? super T, ? super List<T>>> getSelectionListeners()
A set of selection listeners.
public Set<SelectionListener<? super T, ? super List<T>>> getDeselectionListeners()
A set of deselection listeners.
public boolean isSelectionListenersPaused()
true if selection listeners are paused, false otherwise.
public ListGroup<T> triggerSelectionListeners(T source, List<T> selection)
source
The source of the selection event.
selection
The list of selected items.
This ListGroup instance.
public ListGroup<T> triggerDeselectionListeners(T source, List<T> selection)
source
The source of the deselection event.
selection
The list of deselected items.
This ListGroup instance.
public List<T> getSelection()
A list of selected items.
public List<T> getValues()
A list of values.
public ListGroup<T> select(List<ListItem<T>> items)
items
The list of items to select.
this ListGroup instance.
public ListGroup<T> select(ListItem<T> listItem)
listItem
The item to select.
this ListGroup instance.
public ListGroup<T> select(ListItem<T> listItem, boolean silent)
listItem
The item to select.
silent
Whether to suppress selection events.
this ListGroup instance.
public ListGroup<T> deselect(List<ListItem<T>> items)
items
The list of items to deselect.
this ListGroup instance.
public ListGroup<T> deselect(ListItem<T> listItem)
listItem
The item to deselect.
this ListGroup instance.
public ListGroup<T> deselect(ListItem<T> listItem, boolean silent)
listItem
The item to deselect.
silent
Whether to suppress deselection events.
this ListGroup instance.
public boolean isMultiSelect()
true if multi-select is enabled, false otherwise.
public ListGroup<T> setMultiSelect(boolean multiSelect)
multiSelect
Whether to enable multi-select.
this ListGroup instance.
public ListGroup<T> addAddListener(AddListener<T> addListener)
addListener
The add listener to add.
this ListGroup instance.
public ListGroup<T> removeAddListener(AddListener<T> addListener)
addListener
The add listener to remove.
this ListGroup instance.
public ListGroup<T> addRemoveListener(RemoveListener<T> removeListener)
removeListener
The remove listener to add.
this ListGroup instance.
public ListGroup<T> removeRemoveListener(RemoveListener<T> removeListener)
removeListener
The remove listener to remove.
this ListGroup instance.
public ListGroup<T> setSelectable(boolean selectable)
selectable
Whether to set items as selectable.
this ListGroup instance.
public boolean isSelectable()
true if items are selectable, false otherwise.
public HTMLUListElement element()
HTMLUListElement associated with this ListGroup .
The HTMLUListElement representing the list group.
public void ListItem(T value)
value
The value associated with this `ListItem`.
public static ListItem<T> create(T value)
value
The value associated with this `ListItem`.
T
The type of the value.
A new `ListItem` instance.
public void bindTo(ListGroup<T> owner)
owner
The `ListGroup` to which this `ListItem` will be bound.
public HTMLLIElement element()
The HTML list item element.
public T getValue()
The value associated with the list item.
public void setValue(T value)
value
The value to set.
public ListItem<T> pauseSelectionListeners()
This list item instance with selection listeners paused.
public ListItem<T> resumeSelectionListeners()
This list item instance with selection listeners resumed.
public ListItem<T> togglePauseSelectionListeners(boolean toggle)
toggle
true to pause, false to resume.
This list item instance with selection listeners paused or resumed based on the toggle value.
public Set<SelectionListener<? super ListItem<T>, ? super ListItem<T>>> getSelectionListeners()
A set of selection listeners.
public Set<SelectionListener<? super ListItem<T>, ? super ListItem<T>>> getDeselectionListeners()
A set of deselection listeners.
public boolean isSelectionListenersPaused()
true if selection listeners are paused, false otherwise.
public ListItem<T> triggerSelectionListeners(ListItem<T> source, ListItem<T> selection)
source
The source of the selection event.
selection
The selected list item.
This list item instance.
public ListItem<T> triggerDeselectionListeners(ListItem<T> source, ListItem<T> selection)
source
The source of the deselection event.
selection
The deselected list item.
This list item instance.
public ListItem<T> getSelection()
This list item if it is selected, or null if it is not selected.
public ListItem<T> select()
This list item instance with the selection state updated.
public ListItem<T> deselect()
This list item instance with the deselection state updated.
public ListItem<T> select(boolean silent)
silent
true to suppress selection/deselection events, false to trigger them.
This list item instance with the selection state updated.
public ListItem<T> deselect(boolean silent)
silent
true to suppress deselection events, false to trigger them.
This list item instance with the deselection state updated.
public boolean isSelected()
true if this list item is selected, false otherwise.
public boolean isSelectable()
true if this list item is selectable, false otherwise.
public ListItem<T> setSelectable(boolean selectable)
selectable
true to make this list item selectable, false to make it non-selectable.
This list item instance with the selectability state updated.
public ListItem<T> setSelected(boolean selected)
selected
The new selected state.
This list item instance with the selected state updated.
public ListItem<T> setSelected(boolean selected, boolean silent)
selected
The new selected state.
silent
true to suppress selection/deselection events, false to trigger them.
This list item instance with the selected state updated.