org.dominokit.domino.ui.chips

Class Chip

java.lang.Object

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

org.dominokit.domino.ui.chips.Chip

All Implemented Interfaces:

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

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

A removable container which can have image, text, icon, letters and a customizable remove icon.

This component provides a clickable container that allows adding text and an image along with a remove icon to remove the container.

Customize the component can be done by overwriting classes provided by ChipStyles

For example:

     Chip.create()
         .setValue("Yay! I\'ll be there")
         .setColorScheme(ColorScheme.RED)

     Chip.create()
         .setRemovable(true)
         .setColorScheme(ColorScheme.GREY)
         .setValue("Restaurants")

     Chip.create()
         .setValue("Schroeder Coleman")
         .setColorScheme(ColorScheme.TRANSPARENT)
         .setBorderColor(Color.INDIGO)
         .setLeftImg(img("https://randomuser.me/api/portraits/med/men/0.jpg"))
 

See Also:

BaseDominoElement, HasSelectionHandler, HasDeselectionHandler, Switchable, HasRemoveHandler

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

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

HasRemoveHandler.RemoveHandler

Constructor Summary

Constructors

Constructor and Description
Chip(String value)

Method Summary

Modifier and Type	Method and Description
Chip	addDeselectionHandler(HasDeselectionHandler.DeselectionHandler deselectionHandler)
Chip	addRemoveHandler(HasRemoveHandler.RemoveHandler removeHandler) adds a remove handler to the component
Chip	addSelectionHandler(HasSelectionHandler.SelectionHandler<String> selectionHandler) Adds a Selection handler to the component
static Chip	create()
static Chip	create(String value)
Chip	deselect() Marks the chip as deselected.
Chip	disable()
elemental2.dom.HTMLDivElement	element()
Chip	enable()
DominoElement<elemental2.dom.HTMLElement>	getLeftAddon()
DominoElement<elemental2.dom.HTMLDivElement>	getLeftAddonContainer()
DominoElement<elemental2.dom.HTMLElement>	getRemoveIcon()
DominoElement<elemental2.dom.HTMLDivElement>	getRemoveIconContainer()
DominoElement<elemental2.dom.HTMLDivElement>	getTextContainer()
String	getValue()
boolean	isEnabled()
boolean	isSelected()
Chip	remove() removes the element from the DOM tree
Chip	remove(boolean silent) Removes the chip.
Chip	removeLeftAddon() Removes the left element.
Chip	removeSelectionHandler(HasSelectionHandler.SelectionHandler<String> selectionHandler)
Chip	select() Marks the chip as selected.
Chip	setBorderColor(Color borderColor) Sets the border Color
Chip	setColor(Color color) Sets the color.
Chip	setColorScheme(ColorScheme colorScheme) Sets the color scheme for this component.
Chip	setLeftBackground(Color leftBackground) Sets the left container background
Chip	setLeftIcon(BaseIcon<?> icon) Sets the left icon of the chip
Chip	setLeftImg(elemental2.dom.HTMLImageElement imageElement) Sets the left image of the chip.
Chip	setLeftImg(org.jboss.elemento.IsElement<elemental2.dom.HTMLImageElement> imageElement) Same as setLeftImg(HTMLImageElement) but with a wrapper IsElement
Chip	setLeftLetter(String text) Sets the left element as a letter.
Chip	setRemovable(boolean removable) Sets if this chip can be removed or not.
Chip	setRemoveIcon(elemental2.dom.HTMLElement removeIcon) Sets the remove icon element.
Chip	setRemoveIcon(org.jboss.elemento.IsElement<?> removeIcon) Same as setRemoveIcon(HTMLElement) but accepts a wrapper IsElement
Chip	setSelectable(boolean selectable) Sets if the chip can be selected or not.
Chip	setValue(String value) Sets the text of the chip.
Chip	toggleSelect() Selects/Deselects the chip based on its current status (i.e.

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

Chip

public Chip(String value)

Method Detail

create

public static Chip create()

Returns:

new instance with empty text

create

public static Chip create(String value)

Returns:

new instance with value text

select

public Chip select()

Marks the chip as selected.

Selecting the chip will trigger all the SelectionHandler added to it. Also, it will change the background based on the ColorScheme configured

Returns:

same instance

deselect

public Chip deselect()

Marks the chip as deselected.

Deselecting the chip will trigger all the DeselectionHandler added to it. Also, it will change the background based on the ColorScheme configured

Returns:

same instance

toggleSelect

public Chip toggleSelect()

Selects/Deselects the chip based on its current status (i.e. if selected, then deselect)

Returns:

same instance

See Also:

select(), deselect()

isSelected

public boolean isSelected()

Returns:

True if this chip is selected, false otherwise

setRemoveIcon

public Chip setRemoveIcon(elemental2.dom.HTMLElement removeIcon)

Sets the remove icon element. This will add click EventListener to the removeIcon that removes the chip

Parameters:

removeIcon - the new remove HTMLElement

Returns:

same instance

remove

public Chip remove()

removes the element from the DOM tree

Overrides:

remove in class BaseDominoElement<elemental2.dom.HTMLDivElement,Chip>

Returns:

same component

remove

public Chip remove(boolean silent)

Removes the chip.

Accepts silent flag to call all the RemoveHandler added to it.

Parameters:

silent - if true, then this will call all the RemoveHandler

Returns:

same instance

setRemoveIcon

public Chip setRemoveIcon(org.jboss.elemento.IsElement<?> removeIcon)

Same as setRemoveIcon(HTMLElement) but accepts a wrapper IsElement

Parameters:

removeIcon - the new remove icon IsElement to set

Returns:

same instance

setColorScheme

public Chip setColorScheme(ColorScheme colorScheme)

Sets the color scheme for this component.

The color scheme will be used for changing the color based on the chip status if it is selected or not.

Parameters:

colorScheme - the new ColorScheme to set

Returns:

same instance

setColor

public Chip setColor(Color color)

Sets the color.

The color is used to get the background color to be set to this chip, if not set then the color will be configured using the ColorScheme set.

Parameters:

color - the new Color to set

Returns:

same instance

setRemovable

public Chip setRemovable(boolean removable)

Sets if this chip can be removed or not.

Setting this to removable will add the remove icon configured for this component

Parameters:

removable - true if the chip can be removed

Returns:

same instance

setValue

public Chip setValue(String value)

Sets the text of the chip.

Parameters:

value - the new text

Returns:

same instance

setLeftIcon

public Chip setLeftIcon(BaseIcon<?> icon)

Sets the left icon of the chip

Parameters:

icon - the new BaseIcon

Returns:

same instance

setLeftImg

public Chip setLeftImg(elemental2.dom.HTMLImageElement imageElement)

Sets the left image of the chip.

Parameters:

imageElement - the new HTMLImageElement

Returns:

same instance

setLeftImg

public Chip setLeftImg(org.jboss.elemento.IsElement<elemental2.dom.HTMLImageElement> imageElement)

Same as setLeftImg(HTMLImageElement) but with a wrapper IsElement

Parameters:

imageElement - the new IsElement

Returns:

same instance

setLeftLetter

public Chip setLeftLetter(String text)

Sets the left element as a letter.

Parameters:

text - the letter to set

Returns:

same instance

setLeftBackground

public Chip setLeftBackground(Color leftBackground)

Sets the left container background

Parameters:

leftBackground - the Color

Returns:

same instance

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,Chip>

Returns:

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

addSelectionHandler

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

Adds a Selection handler to the component

Specified by:

addSelectionHandler in interface HasSelectionHandler<Chip,String>

Parameters:

selectionHandler - Selectable.SelectionHandler

Returns:

same implementing component instance

addDeselectionHandler

public Chip addDeselectionHandler(HasDeselectionHandler.DeselectionHandler deselectionHandler)

Specified by:

addDeselectionHandler in interface HasDeselectionHandler<Chip>

Parameters:

deselectionHandler - HasDeselectionHandler.DeselectionHandler

Returns:

same implementing component

removeSelectionHandler

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

Specified by:

removeSelectionHandler in interface HasSelectionHandler<Chip,String>

enable

public Chip enable()

Specified by:

enable in interface Switchable<Chip>

Overrides:

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

Returns:

same implementing component

disable

public Chip disable()

Specified by:

disable in interface Switchable<Chip>

Overrides:

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

Returns:

same implementing component

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Switchable<Chip>

Returns:

boolean, true if component is enabled else false

addRemoveHandler

public Chip addRemoveHandler(HasRemoveHandler.RemoveHandler removeHandler)

adds a remove handler to the component

Specified by:

addRemoveHandler in interface HasRemoveHandler<Chip>

Parameters:

removeHandler - HasRemoveHandler.RemoveHandler

Returns:

same implementing component

setSelectable

public Chip setSelectable(boolean selectable)

Sets if the chip can be selected or not.

Parameters:

selectable - true if the chip can be selected

Returns:

same instance

setBorderColor

public Chip setBorderColor(Color borderColor)

Sets the border Color

Parameters:

borderColor - the Color to set

Returns:

same instance

removeLeftAddon

public Chip removeLeftAddon()

Removes the left element.

Returns:

same instance

getValue

public String getValue()

Returns:

The text of the chip

getTextContainer

public DominoElement<elemental2.dom.HTMLDivElement> getTextContainer()

Returns:

The text container

getLeftAddonContainer

public DominoElement<elemental2.dom.HTMLDivElement> getLeftAddonContainer()

Returns:

The left element container

getRemoveIconContainer

public DominoElement<elemental2.dom.HTMLDivElement> getRemoveIconContainer()

Returns:

The remove element container

getRemoveIcon

public DominoElement<elemental2.dom.HTMLElement> getRemoveIcon()

Returns:

The remove element

getLeftAddon

public DominoElement<elemental2.dom.HTMLElement> getLeftAddon()

Returns:

The left element