org.dominokit.domino.ui.menu

Class AbstractMenuItem<V,T extends AbstractMenuItem<V,T>>

java.lang.Object

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

org.dominokit.domino.ui.menu.AbstractMenuItem<V,T>

Type Parameters:

V - The type of the menu item value

T - The type of the class extending from this class

All Implemented Interfaces:

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

Direct Known Subclasses:

CustomMenuItem, MenuItem

public class AbstractMenuItem<V,T extends AbstractMenuItem<V,T>>
extends BaseDominoElement<elemental2.dom.HTMLLIElement,T>
implements HasSelectionHandler<T,T>, HasDeselectionHandler<T>

The base implementation for AbstractMenu items

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractMenu<V,?>	parent

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

element

Constructor Summary

Constructors

Constructor and Description
AbstractMenuItem()

Method Summary

Modifier and Type	Method and Description
T	addDeselectionHandler(HasDeselectionHandler.DeselectionHandler deselectionHandler)
T	addLeftAddOn(FlexItem<?> addOn) Adds an element as an add-on to the left
T	addRightAddOn(FlexItem<?> addOn) Adds an element as an add-on to the right
T	addSelectionHandler(HasSelectionHandler.SelectionHandler<T> selectionHandler) Adds a Selection handler to the component
T	appendChild(org.jboss.elemento.IsElement<?> element) Appends a IsElement to the contentElement
T	appendChild(elemental2.dom.Node node) Appends a Node to the contentElement
T	closeSubMenu() Close the item sub-menu
T	deselect() Deselects the menu item and trigger the selection handlers
T	deselect(boolean silent) Deselect the menu item with the option to trigger/disable the select handlers
elemental2.dom.HTMLLIElement	element()
T	focus() Force focus on the menu item
elemental2.dom.HTMLElement	getClickableElement() by default this return the same component root element
FlexItem<elemental2.dom.HTMLDivElement>	getContentElement()
String	getKey()
FlexItem<?>	getNestingIndicator()
AbstractMenu<V,?>	getParent()
V	getValue()
boolean	hasMenu()
boolean	isSelected()
boolean	onSearch(String token, boolean caseSensitive) Apply a search token matching on the menu item
void	openSubMenu() Opens the sub-menu of the menu item
T	removeSelectionHandler(HasSelectionHandler.SelectionHandler<T> selectionHandler)
T	select() Selects the menu item and trigger the select handlers
T	select(boolean silent) Selects the menu item with the option to trigger/disable the select handlers
T	setKey(String key)
T	setMenu(AbstractMenu<V,?> menu) Sets the sub-menu of the menu item
T	setNestingIndicator(FlexItem<?> nestingIndicator) Sets a custom menu nesting indicator
T	setValue(V value)

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

parent

protected AbstractMenu<V,?> parent

Constructor Detail

AbstractMenuItem

public AbstractMenuItem()

Method Detail

addLeftAddOn

public T addLeftAddOn(FlexItem<?> addOn)

Adds an element as an add-on to the left

Parameters:

addOn - FlexItem

Returns:

same menu item instance

addRightAddOn

public T addRightAddOn(FlexItem<?> addOn)

Adds an element as an add-on to the right

Parameters:

addOn - FlexItem

Returns:

same menu item instance

getContentElement

public FlexItem<elemental2.dom.HTMLDivElement> getContentElement()

Returns:

The FlexItem of the main content conatiner

appendChild

public T appendChild(elemental2.dom.Node node)

Appends a Node to the contentElement

Specified by:

appendChild in interface HasChildren<T extends AbstractMenuItem<V,T>>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLLIElement,T extends AbstractMenuItem<V,T>>

Parameters:

node - Node to be appended to the component

Returns:

same menu item instance

appendChild

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

Appends a IsElement to the contentElement

Specified by:

appendChild in interface HasChildren<T extends AbstractMenuItem<V,T>>

Overrides:

appendChild in class BaseDominoElement<elemental2.dom.HTMLLIElement,T extends AbstractMenuItem<V,T>>

Parameters:

element - IsElement to be appended to the component

Returns:

same menu item instance

onSearch

public boolean onSearch(String token,
                        boolean caseSensitive)

Apply a search token matching on the menu item

Parameters:

token - String search text

caseSensitive - boolean, true if the search is case-sensitive

Returns:

boolean, true if the menu item match the search token, false if not

select

public T select()

Selects the menu item and trigger the select handlers

Returns:

same menu item instance

deselect

public T deselect()

Deselects the menu item and trigger the selection handlers

Returns:

same menu item instance

select

public T select(boolean silent)

Selects the menu item with the option to trigger/disable the select handlers

Parameters:

silent - boolean, true to avoid triggering the select handlers.

Returns:

same menu item instance

deselect

public T deselect(boolean silent)

Deselect the menu item with the option to trigger/disable the select handlers

Parameters:

silent - boolean, true to avoid triggering the select handlers.

Returns:

same menu item instance

isSelected

public boolean isSelected()

Returns:

boolean, true if the menu item is selected

addSelectionHandler

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

Adds a Selection handler to the component

Specified by:

addSelectionHandler in interface HasSelectionHandler<T extends AbstractMenuItem<V,T>,T extends AbstractMenuItem<V,T>>

Parameters:

selectionHandler - Selectable.SelectionHandler

Returns:

same implementing component instance

removeSelectionHandler

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

Specified by:

removeSelectionHandler in interface HasSelectionHandler<T extends AbstractMenuItem<V,T>,T extends AbstractMenuItem<V,T>>

addDeselectionHandler

public T addDeselectionHandler(HasDeselectionHandler.DeselectionHandler deselectionHandler)

Specified by:

addDeselectionHandler in interface HasDeselectionHandler<T extends AbstractMenuItem<V,T>>

Parameters:

deselectionHandler - HasDeselectionHandler.DeselectionHandler

Returns:

same implementing component

focus

public T focus()

Force focus on the menu item

Returns:

same menu item instance

getKey

public String getKey()

Returns:

String unique key of the menu item

setKey

public T setKey(String key)

Parameters:

key - String unique key of the menu item

Returns:

String menu iten unique key

getValue

public V getValue()

Returns:

the value of the menu item

setValue

public T setValue(V value)

Parameters:

value - the value of the meu item

Returns:

same menu item instance

getNestingIndicator

public FlexItem<?> getNestingIndicator()

Returns:

the FlexItem that represent the current menu nesting indication.

setNestingIndicator

public T setNestingIndicator(FlexItem<?> nestingIndicator)

Sets a custom menu nesting indicator

Parameters:

nestingIndicator - FlexItem

Returns:

same menu item

setMenu

public T setMenu(AbstractMenu<V,?> menu)

Sets the sub-menu of the menu item

Parameters:

menu - AbstractMenu

Returns:

same menu item

openSubMenu

public void openSubMenu()

Opens the sub-menu of the menu item

closeSubMenu

public T closeSubMenu()

Close the item sub-menu

Returns:

same menu item instance

getParent

public AbstractMenu<V,?> getParent()

Returns:

The parent AbstractMenu of the menu item

hasMenu

public boolean hasMenu()

getClickableElement

public elemental2.dom.HTMLElement getClickableElement()

by default this return the same component root element

Overrides:

getClickableElement in class BaseDominoElement<elemental2.dom.HTMLLIElement,T extends AbstractMenuItem<V,T>>

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,T extends AbstractMenuItem<V,T>>

Returns:

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