org.dominokit.domino.ui.search

Class Search

java.lang.Object

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

org.dominokit.domino.ui.search.Search

All Implemented Interfaces:

DominoStyle<elemental2.dom.HTMLDivElement,Search,Search>, HasChildren<Search>, HasWavesElement, IsCollapsible<Search>, IsReadOnly<Search>, org.jboss.elemento.IsElement<elemental2.dom.HTMLDivElement>

public class Search
extends BaseDominoElement<elemental2.dom.HTMLDivElement,Search>

A search component that can fit into another component with fixed height, this component will be hidden by default and can be revealed by a trigger.

also the component provide callback and a type ahead delay, and provides a close button to hide the component

 Search.create(true)
                 .setSearchPlaceHolder("Search")
                 .styler(style -> style.setHeight(Unit.px.of(40)))
                 .onSearch(searchToken -> Notification.create("Inline searching for : " + searchToken).show())
                 .onClose(() -> Notification.create("Closing inline search : ").show());
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Search.SearchCloseHandler A functional interface to handle closing of the Search component
static interface	Search.SearchHandler A functional interface to implement the search logic

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
Search(boolean autoSearch)

Method Summary

Modifier and Type	Method and Description
Search	close() Hides the search if it is open
static Search	create()
static Search	create(boolean autoSearch)
elemental2.dom.HTMLDivElement	element()
Search.SearchCloseHandler	getCloseHandler()
DominoElement<elemental2.dom.HTMLInputElement>	getInputElement()
Search.SearchHandler	getSearchHandler()
boolean	isAutoSearch()
Search	onClose(Search.SearchCloseHandler handler)
Search	onSearch(Search.SearchHandler handler)
Search	open() Show the search if it is hidden
void	setCloseHandler(Search.SearchCloseHandler closeHandler)
void	setSearchHandler(Search.SearchHandler searchHandler)
Search	setSearchPlaceHolder(String placeHolder)

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

Search

public Search(boolean autoSearch)

Parameters:

autoSearch - boolean, true to trigger the search while the user is typing with 200ms delay, false to trigger the search only when the user press ENTER

Method Detail

create

public static Search create()

Returns:

new Search instance

create

public static Search create(boolean autoSearch)

Parameters:

autoSearch - boolean, true to trigger the search while the user is typing with 200ms delay

Returns:

new Search instance

open

public Search open()

Show the search if it is hidden

Returns:

same Search instance

close

public Search close()

Hides the search if it is open

Returns:

same Search instance

onSearch

public Search onSearch(Search.SearchHandler handler)

Parameters:

handler - Search.SearchHandler

Returns:

same Search instance

onClose

public Search onClose(Search.SearchCloseHandler handler)

Parameters:

handler - Search.SearchCloseHandler

Returns:

same Search instance

setSearchPlaceHolder

public Search setSearchPlaceHolder(String placeHolder)

Parameters:

placeHolder - String placeholder text for the search input

Returns:

same Search instance

isAutoSearch

public boolean isAutoSearch()

Returns:

boolean, true if auto search is enabled

getSearchHandler

public Search.SearchHandler getSearchHandler()

Returns:

the Search.SearchHandler

setSearchHandler

public void setSearchHandler(Search.SearchHandler searchHandler)

Parameters:

searchHandler - Search.SearchHandler

getCloseHandler

public Search.SearchCloseHandler getCloseHandler()

Returns:

the Search.SearchCloseHandler

setCloseHandler

public void setCloseHandler(Search.SearchCloseHandler closeHandler)

Parameters:

closeHandler - Search.SearchCloseHandler

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

Returns:

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

getInputElement

public DominoElement<elemental2.dom.HTMLInputElement> getInputElement()

Returns:

the HTMLInputElement of this search component wrapped as DominoElement