org.dominokit.domino.ui.chips

Class ChipsGroup

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,ChipsGroup>

org.dominokit.domino.ui.chips.ChipsGroup

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,ChipsGroup,ChipsGroup>, HasChildren<ChipsGroup>, HasDeselectionHandler<ChipsGroup>, HasSelectionHandler<ChipsGroup,Chip>, HasWavesElement, IsCollapsible<ChipsGroup>, IsReadOnly<ChipsGroup>, Switchable<ChipsGroup>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class ChipsGroup
extends BaseDominoElement<elemental2.dom.HTMLDivElement,ChipsGroup>
implements Switchable<ChipsGroup>, HasSelectionHandler<ChipsGroup,Chip>, HasDeselectionHandler<ChipsGroup>

This component provides a group of Chip which handles the selection behaviour between them.

This component will handle the switching between all the chips configured, so that one chip will be select at one time

For example:

     ChipsGroup.create()
             .appendChild(Chip.create("Extra small"))
             .appendChild(Chip.create("Small"))
             .appendChild(Chip.create("Medium"))
             .appendChild(Chip.create("Large"))
             .appendChild(Chip.create("Extra large"))
             .setColorScheme(ColorScheme.TEAL)
             .addSelectionHandler(value -> Notification.createInfo("Chip [ " + chipsGroup.getSelectedChip().getValue() + " ] is selected").show())
 

See Also:

BaseDominoElement, Chip, HasSelectionHandler, HasDeselectionHandler, Switchable

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasSelectionHandler

HasSelectionHandler.SelectionHandler<V>

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasDeselectionHandler

HasDeselectionHandler.DeselectionHandler

Constructor Summary

Constructors

Constructor and Description
ChipsGroup()

Method Summary

Modifier and Type	Method and Description
ChipsGroup	addChip(Chip chip) Deprecated. use appendChild(Chip)
ChipsGroup	addDeselectionHandler(HasDeselectionHandler.DeselectionHandler deselectionHandler)
ChipsGroup	addSelectionHandler(HasSelectionHandler.SelectionHandler<Chip> selectionHandler) Adds a Selection handler to the component
ChipsGroup	appendChild(Chip chip) Adds new Chip
static ChipsGroup	create()
ChipsGroup	disable()
elemental2.dom.HTMLDivElement	element()
ChipsGroup	enable()
List<Chip>	getChips()
Chip	getSelectedChip()
boolean	isEnabled()
ChipsGroup	removeSelectionHandler(HasSelectionHandler.SelectionHandler<Chip> selectionHandler)
ChipsGroup	selectAt(int index) Selects a chip at an index
ChipsGroup	setColorScheme(ColorScheme colorScheme) Sets ColorScheme for all the chips configured in this group

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

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, elevate, elevate, 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, withWaves

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Constructor Detail

ChipsGroup

public ChipsGroup()

Method Detail

create

public static ChipsGroup create()

Returns:

new instance

addChip

@Deprecated
public ChipsGroup addChip(Chip chip)

Deprecated. use appendChild(Chip)

appendChild

public ChipsGroup appendChild(Chip chip)

Adds new Chip

This will set the chip as selectable and adds selection/deselection handler to handle the switching between all the chips.

Parameters:

chip - the new Chip to add

Returns:

same instance

enable

public ChipsGroup enable()

Specified by:

enable in interface Switchable<ChipsGroup>

Overrides:

enable in class BaseDominoElement<elemental2.dom.HTMLDivElement,ChipsGroup>

Returns:

same implementing component

disable

public ChipsGroup disable()

Specified by:

disable in interface Switchable<ChipsGroup>

Overrides:

disable in class BaseDominoElement<elemental2.dom.HTMLDivElement,ChipsGroup>

Returns:

same implementing component

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Switchable<ChipsGroup>

Returns:

boolean, true if component is enabled else false

getSelectedChip

public Chip getSelectedChip()

Returns:

The current selected chip

addSelectionHandler

public ChipsGroup addSelectionHandler(HasSelectionHandler.SelectionHandler<Chip> selectionHandler)

Adds a Selection handler to the component

Specified by:

addSelectionHandler in interface HasSelectionHandler<ChipsGroup,Chip>

Parameters:

selectionHandler - Selectable.SelectionHandler

Returns:

same implementing component instance

removeSelectionHandler

public ChipsGroup removeSelectionHandler(HasSelectionHandler.SelectionHandler<Chip> selectionHandler)

Specified by:

removeSelectionHandler in interface HasSelectionHandler<ChipsGroup,Chip>

addDeselectionHandler

public ChipsGroup addDeselectionHandler(HasDeselectionHandler.DeselectionHandler deselectionHandler)

Specified by:

addDeselectionHandler in interface HasDeselectionHandler<ChipsGroup>

Parameters:

deselectionHandler - HasDeselectionHandler.DeselectionHandler

Returns:

same implementing component

element

public elemental2.dom.HTMLDivElement element()

Specified by:

element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLDivElement,ChipsGroup>

Returns:

the HTML element of type E which is the root element of the component

setColorScheme

public ChipsGroup setColorScheme(ColorScheme colorScheme)

Sets ColorScheme for all the chips configured in this group

Parameters:

colorScheme - the new ColorScheme

Returns:

same instance

selectAt

public ChipsGroup selectAt(int index)

Selects a chip at an index

Parameters:

index - the index of the chip to select

Returns:

same instance

getChips

public List<Chip> getChips()

Returns:

All the chips added to this group