T - the type of the value object inside the elementpublic class ListGroup<T> extends BaseDominoElement<elemental2.dom.HTMLUListElement,ListGroup<T>>
This component provides a container which accepts a collection of elements to view which customized content for each one.
Customize the component can be done by overwriting classes provided by ListStyles
For example:
ListGroup.create()
.setItemRenderer((listGroup, item) -> {
item.appendChild(Label.createPrimary(item.getValue())
})
.setItems(Arrays.asList("first item", "second item"));
BaseDominoElement| Modifier and Type | Class and Description |
|---|---|
static interface |
ListGroup.AddListener<T>
A handler which will be called when adding items
|
static interface |
ListGroup.DeSelectionListener<T>
A handler which will be called when deselecting items
|
static interface |
ListGroup.ItemRenderer<T>
A handler which will be called for adding elements inside the
ListItem |
static interface |
ListGroup.RemoveListener<T>
A handler which will be called when removing items
|
static interface |
ListGroup.SelectionListener<T>
A handler which will be called when selecting items
|
BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler| Constructor and Description |
|---|
ListGroup() |
| Modifier and Type | Method and Description |
|---|---|
ListGroup<T> |
addAddListener(ListGroup.AddListener<T> addListener)
Adds adding listener to be called when a new item is added
|
ListGroup<T> |
addDeselectionListener(ListGroup.DeSelectionListener<T> deSelectionListener)
Adds deselection listener to be called when item is deselected
|
ListGroup<T> |
addItem(T value)
Adds a single value to the collection of values in the list group
|
ListGroup<T> |
addItems(List<? extends T> items)
Adds a new collection of values to the existed ones
|
ListGroup<T> |
addRemoveListener(ListGroup.RemoveListener<T> removeListener)
Adds removing listener to be called when item is removed
|
ListGroup<T> |
addSelectionListener(ListGroup.SelectionListener<T> selectionListener)
Adds selection listener to be called when item is selected
|
static <T> ListGroup<T> |
create()
Creates an empty list group
|
ListGroup<T> |
deselect(List<ListItem<T>> items)
Deselects a collection of
ListItem |
ListGroup<T> |
deselect(ListItem<T> listItem)
Deselects a single
ListItem |
ListGroup<T> |
deselect(ListItem<T> listItem,
boolean silent)
Deselects a single
ListItem with a boolean to indicate if this should inform handlers
or not |
elemental2.dom.HTMLUListElement |
element() |
List<ListItem<T>> |
getItems() |
List<ListItem<T>> |
getSelectedItems() |
List<T> |
getSelectedValues() |
Color |
getSelectionColor() |
List<T> |
getValues() |
ListGroup<T> |
insertAt(int index,
T value)
Adds a single value at a specific index in the list
|
ListGroup<T> |
insertFirst(T value)
Adds a single value at the beginning of the list
|
boolean |
isMultiSelect() |
ListGroup<T> |
removeAddListener(ListGroup.AddListener<T> addListener)
Removes adding listener
|
ListGroup<T> |
removeAll()
Clears the list group
|
ListGroup<T> |
removeDeselectionListener(ListGroup.DeSelectionListener<T> deSelectionListener)
Removes a deselection listener
|
ListGroup<T> |
removeItem(ListItem<? extends T> item)
Removes a single
ListItem from the list group |
ListGroup<T> |
removeItem(ListItem<? extends T> item,
boolean silent)
Removes a single
ListItem from the list group with a boolean to indicate if this should
inform handlers or not |
ListGroup<T> |
removeItem(T value)
Removes a single value from the list
|
ListGroup<T> |
removeItems(List<ListItem<? extends T>> items)
Removes a collection of
ListItem from the list group |
ListGroup<T> |
removeItemsByValue(List<? extends T> toBeRemoved)
Removes all values existed in the provided
toBeRemoved list |
ListGroup<T> |
removeRemoveListener(ListGroup.RemoveListener<T> removeListener)
Removes removing listener
|
ListGroup<T> |
removeSelectionListener(ListGroup.SelectionListener<T> selectionListener)
Removes a selection listener
|
ListGroup<T> |
select(List<ListItem<T>> items)
Selects a collection of
ListItem |
ListGroup<T> |
select(ListItem<T> listItem)
Selects a single
ListItem |
ListGroup<T> |
select(ListItem<T> listItem,
boolean silent)
Selects a single
ListItem with a boolean to indicate if this should inform handlers or
not |
ListGroup<T> |
setBordered(boolean bordered)
Sets to true for adding border for all elements inside the list group
|
ListGroup<T> |
setItemRenderer(ListGroup.ItemRenderer<T> itemRenderer)
Sets the renderer for which adds the content of a single element inside the group
|
ListGroup<T> |
setItems(List<? extends T> items)
Sets the collection of values to show in the list group
|
ListGroup<T> |
setMultiSelect(boolean multiSelect)
Sets if this list group is a multiselect
|
ListGroup<T> |
setSelectable(boolean selectable)
Sets if this list group supports single selection
|
ListGroup<T> |
setSelectionColor(Color selectionColor)
Sets the color for all selected items
|
add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isDisabled, isEmptyElement, isEqualNode, isForceHidden, isHidden, isReadOnly, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setReadOnly, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWavesclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitisExpandedadd, add, remove, remove, removeProperty, replace, setProperty, setPropertypublic static <T> ListGroup<T> create()
T - the type of the value objectpublic ListGroup<T> setItemRenderer(ListGroup.ItemRenderer<T> itemRenderer)
itemRenderer - the ListGroup.ItemRendererpublic ListGroup<T> setItems(List<? extends T> items)
items - the collection of valuespublic ListGroup<T> addItems(List<? extends T> items)
items - the new collection of values to addpublic ListGroup<T> addItem(T value)
value - the new valuepublic ListGroup<T> insertFirst(T value)
value - the new valuepublic ListGroup<T> insertAt(int index, T value)
index - the indexvalue - the new valuepublic ListGroup<T> removeItemsByValue(List<? extends T> toBeRemoved)
toBeRemoved listtoBeRemoved - the values that will be removed from the listpublic ListGroup<T> removeItem(T value)
value - the value to removepublic ListGroup<T> removeItem(ListItem<? extends T> item)
ListItem from the list groupitem - the ListItem to removepublic ListGroup<T> removeItems(List<ListItem<? extends T>> items)
ListItem from the list groupitems - the collection of the ListItem to removepublic ListGroup<T> removeItem(ListItem<? extends T> item, boolean silent)
ListItem from the list group with a boolean to indicate if this should
inform handlers or notitem - the ListItem to removesilent - true for not informing the handlers associated with the list group, false
otherwisepublic ListGroup<T> setBordered(boolean bordered)
bordered - true to add border, false otherwisepublic ListGroup<T> select(List<ListItem<T>> items)
ListItemitems - the collection of ListItem to selectpublic ListGroup<T> select(ListItem<T> listItem)
ListItemlistItem - the ListItem to selectpublic ListGroup<T> select(ListItem<T> listItem, boolean silent)
ListItem with a boolean to indicate if this should inform handlers or
notlistItem - the ListItem to selectsilent - true for not informing the handlers associated with the list group, false
otherwisepublic ListGroup<T> deselect(List<ListItem<T>> items)
ListItemitems - the collection of ListItem to deselectpublic ListGroup<T> deselect(ListItem<T> listItem)
ListItemlistItem - the ListItem to deselectpublic ListGroup<T> deselect(ListItem<T> listItem, boolean silent)
ListItem with a boolean to indicate if this should inform handlers
or notlistItem - the ListItem to deselectsilent - true for not informing the handlers associated with the list group, false
otherwisepublic boolean isMultiSelect()
public ListGroup<T> setMultiSelect(boolean multiSelect)
multiSelect - true to add multiselect support, false otherwisepublic ListGroup<T> addSelectionListener(ListGroup.SelectionListener<T> selectionListener)
selectionListener - the ListGroup.SelectionListener to addpublic ListGroup<T> removeSelectionListener(ListGroup.SelectionListener<T> selectionListener)
selectionListener - the ListGroup.SelectionListener to removepublic ListGroup<T> addDeselectionListener(ListGroup.DeSelectionListener<T> deSelectionListener)
deSelectionListener - the ListGroup.DeSelectionListener to addpublic ListGroup<T> removeDeselectionListener(ListGroup.DeSelectionListener<T> deSelectionListener)
deSelectionListener - the ListGroup.DeSelectionListener to removepublic ListGroup<T> addAddListener(ListGroup.AddListener<T> addListener)
addListener - the ListGroup.AddListener to addpublic ListGroup<T> removeAddListener(ListGroup.AddListener<T> addListener)
addListener - the ListGroup.AddListener to removepublic ListGroup<T> addRemoveListener(ListGroup.RemoveListener<T> removeListener)
removeListener - the ListGroup.RemoveListener to addpublic ListGroup<T> removeRemoveListener(ListGroup.RemoveListener<T> removeListener)
removeListener - the ListGroup.RemoveListener to removepublic Color getSelectionColor()
public ListGroup<T> setSelectionColor(Color selectionColor)
selectionColor - the Colorpublic ListGroup<T> setSelectable(boolean selectable)
selectable - true to add support for single selection, false otherwisepublic elemental2.dom.HTMLUListElement element()
element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLUListElement>element in class BaseDominoElement<elemental2.dom.HTMLUListElement,ListGroup<T>>Copyright © 2019–2022 Dominokit. All rights reserved.