org.dominokit.domino.ui.forms

Class SelectOption<T>

java.lang.Object

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

org.dominokit.domino.ui.forms.SelectOption<T>

Type Parameters:

T - The type of the SelectOption value

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,SelectOption<T>,SelectOption<T>>, HasBackground<SelectOption>, HasChildren<SelectOption<T>>, HasValue<SelectOption,T>, HasWavesElement, IsCollapsible<SelectOption<T>>, IsReadOnly<SelectOption<T>>, Selectable<SelectOption>, org.gwtproject.editor.client.TakesValue<T>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class SelectOption<T>
extends BaseDominoElement<elemental2.dom.HTMLDivElement,SelectOption<T>>
implements HasValue<SelectOption,T>, HasBackground<SelectOption>, Selectable<SelectOption>, org.gwtproject.editor.client.TakesValue<T>

A component for a single select option in the select component DropDownMenu

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.Selectable

Selectable.SelectionHandler<T>

Constructor Summary

Constructors

Constructor and Description
SelectOption(T value, String key)
SelectOption(T value, String key, String displayValue)

Method Summary

Modifier and Type	Method and Description
void	addSelectionHandler(Selectable.SelectionHandler<SelectOption> selectionHandler) Adds a selection handler to this component, the handler will be called whenever the component selected/deselected
SelectOption<T>	appendChild(org.jboss.elemento.IsElement<?> node)
SelectOption<T>	appendChild(elemental2.dom.Node node)
static <T> SelectOption<T>	create(T value, String key)
static <T> SelectOption<T>	create(T value, String key, String displayValue)
SelectOption<T>	deselect() Deselect the component if it is already selected
SelectOption<T>	deselect(boolean silent) deselect the component without triggering the selection/change handlers
elemental2.dom.HTMLDivElement	element()
String	getDisplayValue()
String	getKey()
FlexLayout	getOptionLayoutElement()
T	getValue()
DominoElement<elemental2.dom.HTMLElement>	getValueContainer()
boolean	isExcludeFromSearchResults()
boolean	isSelected()
SelectOption<T>	select() make the component selected
SelectOption<T>	select(boolean silent) make the component selected without triggering the selection/change handlers
SelectOption<T>	setBackground(Color background)
SelectOption<T>	setDisplayValue(String displayValue)
SelectOption<T>	setExcludeFromSearchResults(boolean excludeFromSearchResults) Enable/Disable exclusion from search result
void	setKey(String key)
void	setValue(T value)
SelectOption<T>	value(T value)
SelectOption	value(T value, boolean silent)

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

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, 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, 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

SelectOption

public SelectOption(T value,
                    String key,
                    String displayValue)

Parameters:

value - T the SelectOption value

key - String key unique identifier for the SelectOption

displayValue - String

SelectOption

public SelectOption(T value,
                    String key)

Parameters:

value - T the SelectOption value

key - String key unique identifier for the SelectOption and also the display value

Method Detail

create

public static <T> SelectOption<T> create(T value,
                                         String key,
                                         String displayValue)

Type Parameters:

T - type of the SelectOption value

Parameters:

value - T the SelectOption value

key - String key unique identifier for the SelectOption

displayValue - String

Returns:

new SelectOption instance

create

public static <T> SelectOption<T> create(T value,
                                         String key)

Type Parameters:

T - type of the SelectOption value

Parameters:

value - T the SelectOption value

key - String key unique identifier for the SelectOption and also the display string

Returns:

new SelectOption instance

appendChild

public SelectOption<T> appendChild(elemental2.dom.Node node)

Specified by:

appendChild in interface HasChildren<SelectOption<T>>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,SelectOption<T>>

Parameters:

node - Node to be appended to this SelectOption

Returns:

same SelectOption instance

appendChild

public SelectOption<T> appendChild(org.jboss.elemento.IsElement<?> node)

Specified by:

appendChild in interface HasChildren<SelectOption<T>>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,SelectOption<T>>

Parameters:

node - IsElement to be appended to this SelectOption

Returns:

same SelectOption instance

getKey

public String getKey()

Returns:

String key identifier of this SelectOption

setKey

public void setKey(String key)

Parameters:

key - String key identifier for this SelectOption

getValue

public T getValue()

Specified by:

getValue in interface org.gwtproject.editor.client.TakesValue<T>

setValue

public void setValue(T value)

Specified by:

setValue in interface org.gwtproject.editor.client.TakesValue<T>

addSelectionHandler

public void addSelectionHandler(Selectable.SelectionHandler<SelectOption> selectionHandler)

Adds a selection handler to this component, the handler will be called whenever the component selected/deselected

Specified by:

addSelectionHandler in interface Selectable<SelectOption>

Parameters:

selectionHandler - Selectable.SelectionHandler

getDisplayValue

public String getDisplayValue()

Returns:

String

setDisplayValue

public SelectOption<T> setDisplayValue(String displayValue)

Parameters:

displayValue - String

Returns:

same SelectionOption instance

select

public SelectOption<T> select()

make the component selected

Specified by:

select in interface Selectable<SelectOption>

Returns:

same implementing component instance

deselect

public SelectOption<T> deselect()

Deselect the component if it is already selected

Specified by:

deselect in interface Selectable<SelectOption>

Returns:

same implementing component instance

select

public SelectOption<T> select(boolean silent)

make the component selected without triggering the selection/change handlers

Specified by:

select in interface Selectable<SelectOption>

Returns:

same implementing component instance

deselect

public SelectOption<T> deselect(boolean silent)

deselect the component without triggering the selection/change handlers

Specified by:

deselect in interface Selectable<SelectOption>

Returns:

same implementing component instance

isSelected

public boolean isSelected()

Specified by:

isSelected in interface Selectable<SelectOption>

Returns:

boolean, true if the component is currently selected

setBackground

public SelectOption<T> setBackground(Color background)

Specified by:

setBackground in interface HasBackground<SelectOption>

Parameters:

background - Color

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

Returns:

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

getValueContainer

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

Returns:

the HTMLElement that contains the display value text wrapped as DominoElement

value

public SelectOption<T> value(T value)

Specified by:

value in interface HasValue<SelectOption,T>

Parameters:

value - V to set as a value of the component

Returns:

same implementing component instance

value

public SelectOption value(T value,
                          boolean silent)

Specified by:

value in interface HasValue<SelectOption,T>

Parameters:

value - V to set as a value of the component

silent - boolean if true set the value without triggering change handlers

Returns:

same implementing component instance

isExcludeFromSearchResults

public boolean isExcludeFromSearchResults()

Returns:

boolean, true if this option is excluded from showing in the search results

setExcludeFromSearchResults

public SelectOption<T> setExcludeFromSearchResults(boolean excludeFromSearchResults)

Enable/Disable exclusion from search result

Parameters:

excludeFromSearchResults - boolean, if true then even if this SelectOption matches the search criteria it wont be included in the search results

Returns:

same SelectOption

getOptionLayoutElement

public FlexLayout getOptionLayoutElement()

Returns:

the FlexLayout that contains the different elements in the SelectOption