DropDownMenu (domino-ui 1.0.0-RC13 API)

java.lang.Object
- org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLDivElement,DropDownMenu>
- - org.dominokit.domino.ui.dropdown.DropDownMenu

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,DropDownMenu,DropDownMenu>, HasBackground<DropDownMenu>, HasChildren<DropDownMenu>, HasWavesElement, IsCollapsible<DropDownMenu>, IsReadOnly<DropDownMenu>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>
```
public class DropDownMenu
extends BaseDominoElement<elemental2.dom.HTMLDivElement,DropDownMenu>
implements HasBackground<DropDownMenu>
```
A component which provides a dropdown menu relative to an element
The menu can have different actions and can be placed at specific position
Customize the component can be done by overwriting classes provided by DropDownStyles
For example:
```
      DropDownMenu.create(element)
                 .addAction(DropdownAction.create("action 1"))
                 .open();
 
```
See Also:

BaseDominoElement, HasBackground

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DropDownMenu.CloseHandler` A handler that will be called when closing the menu
`static interface`	`DropDownMenu.OnAdd` A handler that will be called when adding a new action
`static interface`	`DropDownMenu.OpenHandler` A handler that will be called when opening the menu
`static interface`	`DropDownMenu.SearchFilter` The search filter strategy which will filter the actions based on the search criteria

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

Constructor Summary

Constructors
Constructor and Description

DropDownMenu(elemental2.dom.HTMLElement targetElement)

Constructors
Constructor and Description
`DropDownMenu(elemental2.dom.HTMLElement targetElement)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DropDownMenu`	`addAction(DropdownAction<?> action)` Deprecated.
`DropDownMenu`	`addCloseHandler(DropDownMenu.CloseHandler closeHandler)` Adds a close handler to be called when the menu is closed
`DropDownMenu`	`addGroup(DropdownActionsGroup<?> group)` Adds new group of actions to this menu as a one unit
`DropDownMenu`	`addOpenHandler(DropDownMenu.OpenHandler openHandler)` Adds an open handler to be called when the menu is opened
`DropDownMenu`	`appendChild(DropdownAction<?> action)` Adds an action
`DropDownMenu`	`appendChild(elemental2.dom.Node child)`
`DropDownMenu`	`clearActions()` Clears all the actions
`void`	`clearSearch()` Clears the current search
`void`	`close()` Closes the menu
`static void`	`closeAllMenus()` Closes all current opened menus
`static DropDownMenu`	`create(elemental2.dom.HTMLElement targetElement)` Creates drop down menu relative to `targetElement`.
`static DropDownMenu`	`create(org.jboss.elemento.IsElement<?> targetElement)` Same as `create(HTMLElement)` but accepts a wrapper `IsElement`
`elemental2.dom.HTMLDivElement`	`element()`
`void`	`focus()` Sets focus at the first element of the menu
`List<DropdownAction<?>>`	`getActions()`
`AppendStrategy`	`getAppendStrategy()`
`elemental2.dom.HTMLElement`	`getAppendTarget()`
`List<DropdownAction<?>>`	`getFilteredAction()`
`DominoElement<elemental2.dom.HTMLUListElement>`	`getMenuElement()`
`DominoElement<elemental2.dom.HTMLElement>`	`getNoSearchResultsElement()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getSearchContainer()`
`DropDownMenu.SearchFilter`	`getSearchFilter()`
`boolean`	`hasActions()`
`DropDownMenu`	`insertFirst(DropdownAction<?> action)` Inserts an action at the first index
`boolean`	`isCaseSensitiveSearch()`
`boolean`	`isOpened()`
`void`	`open()` Opens the menu
`void`	`open(boolean focus)` Opens the menu with a boolean to indicate if the first element should be focused
`DropDownMenu`	`removeCloseHandler(DropDownMenu.CloseHandler closeHandler)` Removes a close handler
`DropDownMenu`	`removeOpenHandler(DropDownMenu.OpenHandler openHandler)` Removes an open handler
`DropDownMenu`	`selectAt(int index)` Focuses an action at a specific `index`
`DropDownMenu`	`separator()` Adds a separator element
`DropDownMenu`	`setAppendStrategy(AppendStrategy appendStrategy)` Sets the strategy for adding the menu to the target element.
`DropDownMenu`	`setAppendTarget(elemental2.dom.HTMLElement appendTarget)` Sets the target element for this menu that will be positioned according to its location
`DropDownMenu`	`setBackground(Color background)`
`void`	`setCaseSensitiveSearch(boolean caseSensitiveSearch)` Sets if the search is case sensitive
`DropDownMenu`	`setCreatable(boolean creatable)` Sets if the menu accepts creating new actions on the fly.
`DropDownMenu`	`setNoMatchSearchResultText(String text)` Set the text which is displayed in case nothing is found at a searchable `DropDownMenu` Default is "No results matched".
`void`	`setNoSearchResultsElement(elemental2.dom.HTMLElement noSearchResultsElement)` Sets the no search result element which will be shown when there is no results found according to the search criteria
`DropDownMenu`	`setOnAddListener(DropDownMenu.OnAdd onAdd)` Adds a listener that will be called when a new action is added
`DropDownMenu`	`setPosition(DropDownPosition position)` Sets the position of the menu
`DropDownMenu`	`setSearchable(boolean searchable)` Sets if the menu is searchable or not.
`DropDownMenu`	`setSearchFilter(DropDownMenu.SearchFilter searchFilter)` Sets the search filter strategy that will be called to filter the actions based on the search value
`DropDownMenu`	`setTitle(String title)` Sets the title of this menu

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement
add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, 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
  - DropDownMenu
```
public DropDownMenu(elemental2.dom.HTMLElement targetElement)
```
- Method Detail
  - getFilteredAction
```
public List<DropdownAction<?>> getFilteredAction()
```
    Returns:
    
    All DropdownAction filtered based on the search criteria
  - closeAllMenus
```
public static void closeAllMenus()
```
    Closes all current opened menus
  - create
```
public static DropDownMenu create(elemental2.dom.HTMLElement targetElement)
```
    Creates drop down menu relative to targetElement.
    The target element will be used to position the menu according to its location
    
    Parameters:
    
    targetElement - The target HTMLElement
    
    Returns:
    
    new instance
  - create
```
public static DropDownMenu create(org.jboss.elemento.IsElement<?> targetElement)
```
    Same as create(HTMLElement) but accepts a wrapper IsElement
    
    Parameters:
    
    targetElement - The IsElement
    
    Returns:
    
    new instance
  - insertFirst
```
public DropDownMenu insertFirst(DropdownAction<?> action)
```
    Inserts an action at the first index
    
    Parameters:
    
    action - The DropdownAction to add
    
    Returns:
    
    same instance
  - appendChild
```
public DropDownMenu appendChild(DropdownAction<?> action)
```
    Adds an action
    
    Parameters:
    
    action - The DropdownAction to add
    
    Returns:
    
    same instance
  - addAction
```
@Deprecated
public DropDownMenu addAction(DropdownAction<?> action)
```
    Deprecated.
    
    Use appendChild(DropdownAction) instead
  - separator
```
public DropDownMenu separator()
```
    Adds a separator element
    
    Returns:
    
    same instance
  - appendChild
```
public DropDownMenu appendChild(elemental2.dom.Node child)
```
    Specified by:
    
    appendChild in interface HasChildren<DropDownMenu>
    
    Overrides:
    
    appendChild in class BaseDominoElement<elemental2.dom.HTMLDivElement,DropDownMenu>
    
    Parameters:
    
    child - Node to be appended to the component
    
    Returns:
    
    same component
  - close
```
public void close()
```
    Closes the menu
  - open
```
public void open()
```
    Opens the menu
  - open
```
public void open(boolean focus)
```
    Opens the menu with a boolean to indicate if the first element should be focused
    
    Parameters:
    
    focus - true to focus the first element
  - clearSearch
```
public void clearSearch()
```
    Clears the current search
  - isOpened
```
public boolean isOpened()
```
    Returns:
    
    True if the menu is opened, false otherwise
  - setPosition
```
public DropDownMenu setPosition(DropDownPosition position)
```
    Sets the position of the menu
    
    Parameters:
    
    position - The new DropDownPosition
    
    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,DropDownMenu>
    
    Returns:
    
    the HTML element of type E which is the root element of the component
  - clearActions
```
public DropDownMenu clearActions()
```
    Clears all the actions
    
    Returns:
    
    same instance
  - hasActions
```
public boolean hasActions()
```
    Returns:
    
    True if it is has actions, false otherwise
  - selectAt
```
public DropDownMenu selectAt(int index)
```
    Focuses an action at a specific index
    
    Parameters:
    
    index - the index of the action
    
    Returns:
    
    same instance
  - addCloseHandler
```
public DropDownMenu addCloseHandler(DropDownMenu.CloseHandler closeHandler)
```
    Adds a close handler to be called when the menu is closed
    
    Parameters:
    
    closeHandler - The DropDownMenu.CloseHandler to add
    
    Returns:
    
    same instance
  - removeCloseHandler
```
public DropDownMenu removeCloseHandler(DropDownMenu.CloseHandler closeHandler)
```
    Removes a close handler
    
    Parameters:
    
    closeHandler - The DropDownMenu.CloseHandler to remove
    
    Returns:
    
    same instance
  - addOpenHandler
```
public DropDownMenu addOpenHandler(DropDownMenu.OpenHandler openHandler)
```
    Adds an open handler to be called when the menu is opened
    
    Parameters:
    
    openHandler - The DropDownMenu.OpenHandler to add
    
    Returns:
    
    same instance
  - removeOpenHandler
```
public DropDownMenu removeOpenHandler(DropDownMenu.OpenHandler openHandler)
```
    Removes an open handler
    
    Parameters:
    
    openHandler - The DropDownMenu.OpenHandler to remove
    
    Returns:
    
    same instance
  - getActions
```
public List<DropdownAction<?>> getActions()
```
    Returns:
    
    All the actions
  - setSearchable
```
public DropDownMenu setSearchable(boolean searchable)
```
    Sets if the menu is searchable or not. Searchable menu will filter the actions based on the search criteria provided in the search element
    
    Parameters:
    
    searchable - true if this menu is searchable, false otherwise
    
    Returns:
    
    same instance
  - setCreatable
```
public DropDownMenu setCreatable(boolean creatable)
```
    Sets if the menu accepts creating new actions on the fly.
    By configuring the menu as creatable means that the user can create a new action by setting the action text and then adding it directly to the actions list
    
    Parameters:
    
    creatable - true if the menu accepts creating new actions on the fly, false otherwise
    
    Returns:
    
    same instance
  - setNoMatchSearchResultText
```
public DropDownMenu setNoMatchSearchResultText(String text)
```
    Set the text which is displayed in case nothing is found at a searchable DropDownMenu Default is "No results matched".
    
    Parameters:
    
    text - the new text
    
    Returns:
    
    same instance
  - setOnAddListener
```
public DropDownMenu setOnAddListener(DropDownMenu.OnAdd onAdd)
```
    Adds a listener that will be called when a new action is added
    
    Parameters:
    
    onAdd - the DropDownMenu.OnAdd listener to add
    
    Returns:
    
    same instance
  - addGroup
```
public DropDownMenu addGroup(DropdownActionsGroup<?> group)
```
    Adds new group of actions to this menu as a one unit
    
    Parameters:
    
    group - the DropdownActionsGroup to add
    
    Returns:
    
    same instance
  - setTitle
```
public DropDownMenu setTitle(String title)
```
    Sets the title of this menu
    
    Parameters:
    
    title - the title text
    
    Returns:
    
    same instance
  - setAppendTarget
```
public DropDownMenu setAppendTarget(elemental2.dom.HTMLElement appendTarget)
```
    Sets the target element for this menu that will be positioned according to its location
    
    Parameters:
    
    appendTarget - the new target element
    
    Returns:
    
    same instance
  - getAppendTarget
```
public elemental2.dom.HTMLElement getAppendTarget()
```
    Returns:
    
    The current target element
  - setAppendStrategy
```
public DropDownMenu setAppendStrategy(AppendStrategy appendStrategy)
```
    Sets the strategy for adding the menu to the target element.
    
    Parameters:
    
    appendStrategy - the AppendStrategy
    
    Returns:
    
    same instance
  - getAppendStrategy
```
public AppendStrategy getAppendStrategy()
```
    Returns:
    
    The current AppendStrategy
  - getNoSearchResultsElement
```
public DominoElement<elemental2.dom.HTMLElement> getNoSearchResultsElement()
```
    Returns:
    
    The no search result element
  - setNoSearchResultsElement
```
public void setNoSearchResultsElement(elemental2.dom.HTMLElement noSearchResultsElement)
```
    Sets the no search result element which will be shown when there is no results found according to the search criteria
    
    Parameters:
    
    noSearchResultsElement - the new no search results element
  - isCaseSensitiveSearch
```
public boolean isCaseSensitiveSearch()
```
    Returns:
    
    True if the search is case sensitive, false otherwise
  - setCaseSensitiveSearch
```
public void setCaseSensitiveSearch(boolean caseSensitiveSearch)
```
    Sets if the search is case sensitive
    
    Parameters:
    
    caseSensitiveSearch - true if search is case sensitive, false otherwise
  - getMenuElement
```
public DominoElement<elemental2.dom.HTMLUListElement> getMenuElement()
```
    Returns:
    
    The menu container element
  - setBackground
```
public DropDownMenu setBackground(Color background)
```
    Specified by:
    
    setBackground in interface HasBackground<DropDownMenu>
    
    Parameters:
    
    background - Color
    
    Returns:
    
    same implementing component
  - getSearchContainer
```
public DominoElement<elemental2.dom.HTMLDivElement> getSearchContainer()
```
    Returns:
    
    The search element container
  - focus
```
public void focus()
```
    Sets focus at the first element of the menu
  - getSearchFilter
```
public DropDownMenu.SearchFilter getSearchFilter()
```
    Returns:
    
    The current search filter
  - setSearchFilter
```
public DropDownMenu setSearchFilter(DropDownMenu.SearchFilter searchFilter)
```
    Sets the search filter strategy that will be called to filter the actions based on the search value
    
    Parameters:
    
    searchFilter - The new DropDownMenu.SearchFilter
    
    Returns:
    
    same instance

Class DropDownMenu

Nested Class Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

DropDownMenu

Method Detail

getFilteredAction

closeAllMenus

create

create

insertFirst

appendChild

addAction

separator

appendChild

close

open

open

clearSearch

isOpened

setPosition

element

clearActions

hasActions

selectAt

addCloseHandler

removeCloseHandler

addOpenHandler

removeOpenHandler

getActions

setSearchable

setCreatable

setNoMatchSearchResultText

setOnAddListener

addGroup

setTitle

setAppendTarget

getAppendTarget

setAppendStrategy

getAppendStrategy

getNoSearchResultsElement

setNoSearchResultsElement

isCaseSensitiveSearch

setCaseSensitiveSearch

getMenuElement

setBackground

getSearchContainer

focus

getSearchFilter

setSearchFilter