org.dominokit.domino.ui.forms

Class AbstractSuggestBox<T extends AbstractSuggestBox<T,V>,V>

java.lang.Object

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

org.dominokit.domino.ui.forms.BasicFormElement<T,V>

org.dominokit.domino.ui.forms.ValueBox<T,E,V>

org.dominokit.domino.ui.forms.AbstractValueBox<T,elemental2.dom.HTMLInputElement,V>

org.dominokit.domino.ui.forms.AbstractSuggestBox<T,V>

Type Parameters:

T - The type of the component extending form this class

V - the type of the AbstractSuggestBox value

All Implemented Interfaces:

FormElement<T,V>, HasGrouping<T>, HasInputElement, DominoStyle<elemental2.dom.HTMLElement,T,T>, Focusable<T>, HasAutoValidation<T>, HasChangeHandlers<T,V>, HasChildren<T>, HasHelperText<T>, HasLabel<T>, HasLength<T>, HasName<T>, HasPlaceHolder<T>, HasSelectionHandler<T,SuggestItem<V>>, HasValidation<T>, HasValue<T,V>, HasWavesElement, IsCollapsible<T>, IsReadOnly<T>, IsRequired<T>, Switchable<T>, org.gwtproject.editor.client.Editor<V>, org.gwtproject.editor.client.HasEditorErrors<V>, org.gwtproject.editor.client.LeafValueEditor<V>, org.gwtproject.editor.client.TakesValue<V>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

Direct Known Subclasses:

SuggestBox

public abstract class AbstractSuggestBox<T extends AbstractSuggestBox<T,V>,V>
extends AbstractValueBox<T,elemental2.dom.HTMLInputElement,V>
implements HasSelectionHandler<T,SuggestItem<V>>

A component that dynamically loads suggestions from a SuggestBoxStore while the user is typing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSuggestBox.DropDownPositionDown A DropDownPosition that opens the suggestion dropdown menu down
static class	AbstractSuggestBox.DropDownPositionUp A DropDownPosition that opens the suggestion dropdown menu up
static class	AbstractSuggestBox.PopupPositionTopDown A DropDownPosition that opens the suggestion dropdown menu up or down based on the largest space available, the menu will show where the is more space

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.ValueBox

ValueBox.AutoValidate, ValueBox.AutoValidator

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.BasicFormElement

BasicFormElement.FieldHandler<T>

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

HasChangeHandlers.ChangeHandler<V>

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasValidation

HasValidation.Validator

Nested classes/interfaces inherited from interface org.gwtproject.editor.client.Editor

org.gwtproject.editor.client.Editor.Ignore, org.gwtproject.editor.client.Editor.Path

Field Summary

Fields inherited from class org.dominokit.domino.ui.forms.ValueBox

changeHandlers, changeListener, DISABLED, fieldContainer, fieldGroup, FLOATING, FOCUSED, inputContainer, inputListener

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

element

Constructor Summary

Constructors

Constructor and Description
AbstractSuggestBox() Creates an instance without a label and a null store
AbstractSuggestBox(String label) Creates an instance with a label and a null store
AbstractSuggestBox(String type, String label, SuggestBoxStore<V> store) Creates an instance with a label and initialized with the input type and a store
AbstractSuggestBox(String label, SuggestBoxStore<V> store) Creates an instance with a label and initialized with a store
AbstractSuggestBox(SuggestBoxStore<V> store) Creates an instance without a label and initialized with a store

Method Summary

Modifier and Type	Method and Description
T	addSelectionHandler(HasSelectionHandler.SelectionHandler<SuggestItem<V>> selectionHandler) Adds a Selection handler to the component
protected void	clearValue(boolean silent) clear the field value
protected ValueBox.AutoValidator	createAutoValidator(ValueBox.AutoValidate autoValidate) Create an AutoValidator that will automatically validate the component when it loses focus
protected elemental2.dom.HTMLInputElement	createInputElement(String type) Creates an input element with the specified type
protected void	doSetValue(V value)
protected DropdownAction<V>	dropdownAction(SuggestItem<V> suggestItem)
DelayedTextInput.DelayedAction	getDelayedAction()
DelayedTextInput	getDelayedTextInput()
String	getDropdownMaxWidth()
Color	getHighlightColor()
Loader	getLoader()
SuggestBoxStore<V>	getStore()
String	getStringValue()
DropDownMenu	getSuggestionsMenu()
int	getTypeAheadDelay()
V	getValue()
boolean	isAutoSelect()
boolean	isEmptyAsNull()
boolean	isFocusOnClose()
T	removeSelectionHandler(HasSelectionHandler.SelectionHandler<SuggestItem<V>> selectionHandler)
void	search() Filter the items based on the currently typed text in the AbstractSuggestBox
T	setAutoSelect(boolean autoSelect)
T	setDelayedAction(DelayedTextInput.DelayedAction delayedAction) Set a custom action to be executed after the user stops typing that override the default search action
T	setDropdownMaxWidth(String dropdownMaxWidth)
T	setEmptyAsNull(boolean emptyAsNull)
T	setFocusOnClose(boolean focusOnClose)
T	setHighlightColor(Color highlightColor) Set the color to be used to highlight parts of the SuggestItems that matches the typed String in the text input
T	setLoaderEffect(LoaderEffect loaderEffect) Sets a custom loader effect to be visible while the store is retrieving the suggestions
T	setOnEnterAction(DelayedTextInput.DelayedAction onEnterAction) Sets the action to be executed when the user press Enter to override the default search action
T	setSuggestBoxStore(SuggestBoxStore<V> store)
T	setType(String type)
T	setTypeAheadDelay(int delayMilliseconds)

Methods inherited from class org.dominokit.domino.ui.forms.AbstractValueBox

getMaxLength, getMinLength, getMinLengthErrorMessage, isEmpty, isEmptyIgnoreSpaces, setMaxLength, setMinLength, setMinLengthErrorMessage, setReadOnly, updateCharacterCount, value

Methods inherited from class org.dominokit.domino.ui.forms.ValueBox

addChangeHandler, addLeftAddOn, addLeftAddOn, addLeftAddOn, addOnClearHandler, addRightAddOn, addRightAddOn, addRightAddOn, allowEmptyLabel, asTableField, autoValidate, callChangeHandlers, changeLabelFloating, clear, clear, clearInvalid, clearValue, condense, createLabelElement, createMandatoryAddOn, disable, doFocus, doUnfocus, element, enable, floating, floatLabel, focus, getAdditionalInfoContainer, getCountItem, getErrorItem, getErrorsContainer, getFieldContainer, getFieldGroup, getFieldInputContainer, getFieldStyle, getFocusColor, getHelperContainer, getHelpItem, getInputContainer, getInputElement, getLabelElement, getLabelTextElement, getLeftAddonContainer, getLeftAddOnsContainer, getMandatoryAddOn, getNotesContainer, getOnClearHandlers, getPlaceholder, getPostfix, getPostFixItem, getPrefix, getPrefixItem, getRightAddonContainer, getRightAddOnsContainer, hasChangeHandler, hideLabelText, hidePlaceholder, invalidate, invalidate, isAddFocusColor, isAutoValidation, isFloating, isFocused, isReadOnly, linkLabelToField, nonfloating, onEnterKey, pauseChangeHandlers, pauseFocusValidation, removeChangeHandler, removeLeftAddOn, removeLeftAddOn, removeLeftAddOn, removeLeftAddOn, removeLeftAddOns, removeOnClearHandler, removeRightAddOn, removeRightAddOn, removeRightAddOn, removeRightAddOn, removeRightAddOns, resumeChangeHandlers, resumeFocusValidation, setAutoValidation, setFieldStyle, setFixErrorsPosition, setFloating, setFocusColor, setLabel, setLabel, setLabel, setLabel, setLabelTextVisible, setPauseChangeHandlers, setPlaceholder, setPostFix, setPrefix, setSpellCheck, setTableField, shouldShowPlaceholder, showLabelText, showPlaceholder, spread, unfloatLabel, unfocus, updateLabel, value

Methods inherited from class org.dominokit.domino.ui.forms.BasicFormElement

addValidator, getErrorLabels, getErrors, getHelperText, getLabel, getName, getRequiredErrorMessage, groupBy, hasValidator, isDisabled, isEnabled, isFixErrorsPosition, isRequired, isShowRequiredIndicator, isValidationDisabled, makeErrorLabel, removeValidator, setHelperText, setName, setRequired, setRequired, setRequiredErrorMessage, setShowRequiredIndicator, setValidationDisabled, setValue, showErrors, ungroup, validate, withValidationDisabled

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, elevate, elevate, 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, isEmptyElement, isEqualNode, isForceHidden, isHidden, 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, 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.HasValidation

validateAll

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

AbstractSuggestBox

public AbstractSuggestBox()

Creates an instance without a label and a null store

AbstractSuggestBox

public AbstractSuggestBox(String label)

Creates an instance with a label and a null store

Parameters:

label - String label

AbstractSuggestBox

public AbstractSuggestBox(SuggestBoxStore<V> store)

Creates an instance without a label and initialized with a store

Parameters:

store - SuggestBoxStore

AbstractSuggestBox

public AbstractSuggestBox(String label,
                          SuggestBoxStore<V> store)

Creates an instance with a label and initialized with a store

Parameters:

label - String

store - SuggestBoxStore

AbstractSuggestBox

public AbstractSuggestBox(String type,
                          String label,
                          SuggestBoxStore<V> store)

Creates an instance with a label and initialized with the input type and a store

Parameters:

type - String input element type

label - String

store - SuggestBoxStore

Method Detail

search

public final void search()

Filter the items based on the currently typed text in the AbstractSuggestBox

createInputElement

protected elemental2.dom.HTMLInputElement createInputElement(String type)

Creates an input element with the specified type

Specified by:

createInputElement in class ValueBox<T extends AbstractSuggestBox<T,V>,elemental2.dom.HTMLInputElement,V>

Parameters:

type - String the input element type

Returns:

E the input html element

getTypeAheadDelay

public int getTypeAheadDelay()

Returns:

int delay in milliseconds before triggering the search after the user stops typing

setTypeAheadDelay

public T setTypeAheadDelay(int delayMilliseconds)

Parameters:

delayMilliseconds - int delay in milliseconds before triggering the search after the user stops typing

Returns:

same AbstractSuggestBox instance

getDelayedAction

public DelayedTextInput.DelayedAction getDelayedAction()

Returns:

the DelayedTextInput.DelayedAction

setDelayedAction

public T setDelayedAction(DelayedTextInput.DelayedAction delayedAction)

Set a custom action to be executed after the user stops typing that override the default search action

Parameters:

delayedAction - DelayedTextInput.DelayedAction

Returns:

same AbstractSuggestBox instance

setOnEnterAction

public T setOnEnterAction(DelayedTextInput.DelayedAction onEnterAction)

Sets the action to be executed when the user press Enter to override the default search action

Parameters:

onEnterAction - DelayedTextInput.DelayedAction

Returns:

same AbstractSuggestBox instance

clearValue

protected void clearValue(boolean silent)

clear the field value

Specified by:

clearValue in class ValueBox<T extends AbstractSuggestBox<T,V>,elemental2.dom.HTMLInputElement,V>

doSetValue

protected void doSetValue(V value)

Specified by:

doSetValue in class ValueBox<T extends AbstractSuggestBox<T,V>,elemental2.dom.HTMLInputElement,V>

Parameters:

value - V the value to set for this field

getValue

public V getValue()

Specified by:

getValue in interface org.gwtproject.editor.client.LeafValueEditor<V>

Specified by:

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

Overrides:

getValue in class ValueBox<T extends AbstractSuggestBox<T,V>,elemental2.dom.HTMLInputElement,V>

setSuggestBoxStore

public T setSuggestBoxStore(SuggestBoxStore<V> store)

Parameters:

store - SuggestBoxStore

Returns:

same AbstractSuggestBox instance

setType

public T setType(String type)

Parameters:

type - String type of the htmml input element

Returns:

same AbstractSuggestBox instance

getStringValue

public String getStringValue()

Specified by:

getStringValue in interface HasInputElement

Overrides:

getStringValue in class ValueBox<T extends AbstractSuggestBox<T,V>,elemental2.dom.HTMLInputElement,V>

Returns:

String value of the input element

dropdownAction

protected final DropdownAction<V> dropdownAction(SuggestItem<V> suggestItem)

addSelectionHandler

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

Adds a Selection handler to the component

Specified by:

addSelectionHandler in interface HasSelectionHandler<T extends AbstractSuggestBox<T,V>,SuggestItem<V>>

Parameters:

selectionHandler - Selectable.SelectionHandler

Returns:

same implementing component instance

removeSelectionHandler

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

Specified by:

removeSelectionHandler in interface HasSelectionHandler<T extends AbstractSuggestBox<T,V>,SuggestItem<V>>

setLoaderEffect

public T setLoaderEffect(LoaderEffect loaderEffect)

Sets a custom loader effect to be visible while the store is retrieving the suggestions

Parameters:

loaderEffect - LoaderEffect

Returns:

same AbstractSuggestBox instance

getLoader

public Loader getLoader()

Returns:

the Loader used by the AbstractSuggestBox

setEmptyAsNull

public T setEmptyAsNull(boolean emptyAsNull)

Parameters:

emptyAsNull - boolean, if ture empty value will be considered null otherwise it is an empty String

Returns:

same AbstractSuggestBox instance

isEmptyAsNull

public boolean isEmptyAsNull()

Returns:

boolean, true if empty value will be considered null otherwise false

getStore

public SuggestBoxStore<V> getStore()

Returns:

the SuggestBoxStore of this AbstractSuggestBox

getDelayedTextInput

public DelayedTextInput getDelayedTextInput()

Returns:

the DelayedTextInput of this AbstractSuggestBox

getSuggestionsMenu

public DropDownMenu getSuggestionsMenu()

Returns:

the DropDownMenu of the AbstractSuggestBox

getHighlightColor

public Color getHighlightColor()

Returns:

color to be used to highlight parts of the SuggestItems that matches the typed string

setHighlightColor

public T setHighlightColor(Color highlightColor)

Set the color to be used to highlight parts of the SuggestItems that matches the typed String in the text input

Parameters:

highlightColor - Color

Returns:

same AbstractSuggestBox instance

createAutoValidator

protected ValueBox.AutoValidator createAutoValidator(ValueBox.AutoValidate autoValidate)

Create an AutoValidator that will automatically validate the component when it loses focus

Specified by:

createAutoValidator in class ValueBox<T extends AbstractSuggestBox<T,V>,elemental2.dom.HTMLInputElement,V>

Parameters:

autoValidate - ValueBox.AutoValidate

Returns:

same component instance

isAutoSelect

public boolean isAutoSelect()

Returns:

boolean, true if autoSelect is enabled

setAutoSelect

public T setAutoSelect(boolean autoSelect)

Parameters:

autoSelect - boolean, if true pressing enter will automatically select the first entry from the Suggestions menu

Returns:

same AbstractSuggestBox instance

getDropdownMaxWidth

public String getDropdownMaxWidth()

Returns:

maximal width of dropdown

setDropdownMaxWidth

public T setDropdownMaxWidth(String dropdownMaxWidth)

Parameters:

dropdownMaxWidth - maximal width of dropdown. if null - equals width of control

Returns:

same AbstractSuggestBox instance

isFocusOnClose

public boolean isFocusOnClose()

Returns:

boolean, true if the focusOnClose is enabled

setFocusOnClose

public T setFocusOnClose(boolean focusOnClose)

Parameters:

focusOnClose - boolean, if true after closing the suggestions menu the focus will go back to the suggest box input

Returns:

same AbstractSuggestBox instance