org.dominokit.domino.ui.dropdown

Class DropdownAction<T>

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLLIElement,DropdownAction<T>>

org.dominokit.domino.ui.dropdown.DropdownAction<T>

Type Parameters:

T - The value of this action which can be any object

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLLIElement,DropdownAction<T>,DropdownAction<T>>, HasBackground<DropdownAction<T>>, HasChildren<DropdownAction<T>>, HasSelectionHandler<DropdownAction<T>,T>, HasWavesElement, IsCollapsible<DropdownAction<T>>, IsReadOnly<DropdownAction<T>>, org.jboss.elemento.IsElement<elemental2.dom.HTMLLIElement>

public class DropdownAction<T>
extends BaseDominoElement<elemental2.dom.HTMLLIElement,DropdownAction<T>>
implements HasSelectionHandler<DropdownAction<T>,T>, HasBackground<DropdownAction<T>>

A component which describes a drop down action

This component provides a representation of each DropDownMenu element

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

For example:

     DropdownAction.create("action 1");
 

See Also:

BaseDominoElement, DropDownMenu, HasSelectionHandler, HasBackground

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DropdownAction.FocusHandler<T> A handler that will be called when the element gets focused

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>

Field Summary

Fields

Modifier and Type	Field and Description
static elemental2.core.JsRegExp	REPLACER_REGEX

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

element

Constructor Summary

Constructors

Constructor and Description
DropdownAction(T value, elemental2.dom.HTMLElement content)
DropdownAction(T value, String displayValue)
DropdownAction(T value, String displayValue, BaseIcon<?> icon)

Method Summary

Modifier and Type	Method and Description
DropdownAction<T>	addFocusHandler(DropdownAction.FocusHandler<T> focusHandler) Adds focus handler that will be called when the action gets focused
DropdownAction<T>	addSelectionHandler(HasSelectionHandler.SelectionHandler<T> selectionHandler) Adds a Selection handler to the component
static DropdownAction<String>	create(String content) Creates an action with text value
static <T> DropdownAction<T>	create(T value, elemental2.dom.HTMLElement content) Creates an action with T as a value and a content HTMLElement
static <T> DropdownAction<T>	create(T value, String displayValue) Creates an action with T as a value and a displayValue to be shown
static <T> DropdownAction<T>	create(T value, String displayValue, BaseIcon<?> icon) Creates an action with T as a value, displayValue to be shown, and an icon
DropdownAction<T>	deFilter() Shows the action as it does comply with the provided search criteria
elemental2.dom.HTMLLIElement	element()
DropdownAction<T>	filter() Hides the action as it does not comply with the provided search criteria
DropdownAction<T>	focus() Focuses the action
elemental2.dom.HTMLAnchorElement	getClickableElement() by default this return the same component root element
elemental2.dom.HTMLElement	getContent()
T	getValue()
void	highlight(String displayValue, Color highlightColor) Highlights the displayValue with a color which indicates that it complies with the search criteria
boolean	isAutoClose()
boolean	isExcludeFromSearchResults()
boolean	isFilteredOut()
DropdownAction<T>	removeSelectionHandler(HasSelectionHandler.SelectionHandler<T> selectionHandler)
DropdownAction<T>	select() Selects the action, this will trigger all the selection handlers
DropdownAction<T>	setAutoClose(boolean autoClose) Sets if selecting the action will close the menu automatically
DropdownAction<T>	setBackground(Color background)
DropdownAction<T>	setDisplayValue(BaseIcon<?> icon, String displayValue) Sets the display value of the action as text along with an icon
DropdownAction<T>	setDisplayValue(elemental2.dom.HTMLElement content) Sets the display value of the action as an element
DropdownAction<T>	setDisplayValue(String displayValue) Sets the display value of the action as text
DropdownAction<T>	setExcludeFromSearchResults(boolean excludeFromSearchResults) Sets if this action is not included in the search and will be hidden if the search provided

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, disable, elevate, elevate, enable, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, 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

Field Detail

REPLACER_REGEX

public static final elemental2.core.JsRegExp REPLACER_REGEX

Constructor Detail

DropdownAction

public DropdownAction(T value,
                      String displayValue)

DropdownAction

public DropdownAction(T value,
                      String displayValue,
                      BaseIcon<?> icon)

DropdownAction

public DropdownAction(T value,
                      elemental2.dom.HTMLElement content)

Method Detail

create

public static DropdownAction<String> create(String content)

Creates an action with text value

Parameters:

content - the value as text

Returns:

new instance

create

public static <T> DropdownAction<T> create(T value,
                                           String displayValue,
                                           BaseIcon<?> icon)

Creates an action with T as a value, displayValue to be shown, and an icon

Type Parameters:

T - the type of the value

Parameters:

value - the value object

displayValue - the display value text

icon - the icon

Returns:

new instance

create

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

Creates an action with T as a value and a displayValue to be shown

Type Parameters:

T - the type of the value

Parameters:

value - the value object

displayValue - the display value text

Returns:

new instance

create

public static <T> DropdownAction<T> create(T value,
                                           elemental2.dom.HTMLElement content)

Creates an action with T as a value and a content HTMLElement

Type Parameters:

T - the type of the value

Parameters:

value - the value object

content - The content of the action as HTMLElement

Returns:

new instance

focus

public DropdownAction<T> focus()

Focuses the action

Returns:

same instance

select

public DropdownAction<T> select()

Selects the action, this will trigger all the selection handlers

Returns:

same instance

element

public elemental2.dom.HTMLLIElement element()

Specified by:

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

Specified by:

element in class BaseDominoElement<elemental2.dom.HTMLLIElement,DropdownAction<T>>

Returns:

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

addSelectionHandler

public DropdownAction<T> addSelectionHandler(HasSelectionHandler.SelectionHandler<T> selectionHandler)

Adds a Selection handler to the component

Specified by:

addSelectionHandler in interface HasSelectionHandler<DropdownAction<T>,T>

Parameters:

selectionHandler - Selectable.SelectionHandler

Returns:

same implementing component instance

removeSelectionHandler

public DropdownAction<T> removeSelectionHandler(HasSelectionHandler.SelectionHandler<T> selectionHandler)

Specified by:

removeSelectionHandler in interface HasSelectionHandler<DropdownAction<T>,T>

getValue

public T getValue()

Returns:

The current value of the action

getContent

public elemental2.dom.HTMLElement getContent()

Returns:

The content element of the action

getClickableElement

public elemental2.dom.HTMLAnchorElement getClickableElement()

by default this return the same component root element

Overrides:

getClickableElement in class BaseDominoElement<elemental2.dom.HTMLLIElement,DropdownAction<T>>

setDisplayValue

public DropdownAction<T> setDisplayValue(String displayValue)

Sets the display value of the action as text

Parameters:

displayValue - the text that will be shown as a content

Returns:

same instance

setDisplayValue

public DropdownAction<T> setDisplayValue(BaseIcon<?> icon,
                                         String displayValue)

Sets the display value of the action as text along with an icon

Parameters:

icon - the icon

displayValue - the display text

Returns:

same instance

setDisplayValue

public DropdownAction<T> setDisplayValue(elemental2.dom.HTMLElement content)

Sets the display value of the action as an element

Parameters:

content - the HTMLElement

Returns:

same instance

addFocusHandler

public DropdownAction<T> addFocusHandler(DropdownAction.FocusHandler<T> focusHandler)

Adds focus handler that will be called when the action gets focused

Parameters:

focusHandler - the DropdownAction.FocusHandler to add

Returns:

same instance

isAutoClose

public boolean isAutoClose()

Returns:

True if the selecting the action will close the menu automatically, false otherwise

setAutoClose

public DropdownAction<T> setAutoClose(boolean autoClose)

Sets if selecting the action will close the menu automatically

Parameters:

autoClose - True if the selecting the action will close the menu automatically, false otherwise

Returns:

same instance

filter

public DropdownAction<T> filter()

Hides the action as it does not comply with the provided search criteria

Returns:

same instance

deFilter

public DropdownAction<T> deFilter()

Shows the action as it does comply with the provided search criteria

Returns:

same instance

isFilteredOut

public boolean isFilteredOut()

Returns:

True if the actions does not comply with the search criteria and it is filtered out, false otherwise

isExcludeFromSearchResults

public boolean isExcludeFromSearchResults()

Returns:

True if this action is not included in the search and will be hidden if the search provided, false otherwise

setExcludeFromSearchResults

public DropdownAction<T> setExcludeFromSearchResults(boolean excludeFromSearchResults)

Sets if this action is not included in the search and will be hidden if the search provided

Parameters:

excludeFromSearchResults - True if this action is not included in the search and will be hidden if the search provided, false otherwise

Returns:

same instance

setBackground

public DropdownAction<T> setBackground(Color background)

Specified by:

setBackground in interface HasBackground<DropdownAction<T>>

Parameters:

background - Color

Returns:

same implementing component

highlight

public void highlight(String displayValue,
                      Color highlightColor)

Highlights the displayValue with a color which indicates that it complies with the search criteria

Parameters:

displayValue - the match value

highlightColor - the highlight Color