org.dominokit.domino.ui.forms

Interface SuggestBoxStore<T>

Type Parameters:

T - the type of the SuggestBox value

All Known Implementing Classes:

LocalSuggestBoxStore

public interface SuggestBoxStore<T>

This interface is used to implement data stores to provide a SuggestBox with its suggestion

The interface can be used to provide suggestions locally or remotely

See Also:

LocalSuggestBoxStore

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SuggestBoxStore.MissingEntryProvider<T> This method is used to implement the logic to handle the case when the user types in the suggest something that does not match any of the available suggestions
static interface	SuggestBoxStore.MissingSuggestProvider<T> A function to provide a SuggestItem in case we try to set a value to the suggestBox that does not match any of the possible suggestions
static interface	SuggestBoxStore.SuggestionFilter<T>
static interface	SuggestBoxStore.SuggestionsHandler<T> A function to provide a List of SuggestItem to the filter(String, SuggestionsHandler)

Method Summary

Modifier and Type	Method and Description
void	filter(String value, SuggestBoxStore.SuggestionsHandler<T> suggestionsHandler) Takes the current typed text in the SuggestBox and provide a List of matching suggestion
default boolean	filterItem(String searchValue, SuggestItem<T> suggestItem) Defines how to check a single SuggestItem against the search text, default to SuggestItem lowercase display text contains the search text
void	find(T searchValue, Consumer<SuggestItem<T>> handler) Takes a value of T and find the matching SuggestItem for this value, this is used when we directly set the value to the SuggestBox to check if it is actually still matching an existing suggestion
default SuggestBoxStore.MissingEntryProvider<T>	getMessingEntryProvider()
default SuggestBoxStore.MissingSuggestProvider<T>	getMessingSuggestionProvider()

Method Detail

filter

void filter(String value,
            SuggestBoxStore.SuggestionsHandler<T> suggestionsHandler)

Takes the current typed text in the SuggestBox and provide a List of matching suggestion

Parameters:

value - String text in the SuggestBox

suggestionsHandler - SuggestBoxStore.SuggestionsHandler

find

void find(T searchValue,
          Consumer<SuggestItem<T>> handler)

Takes a value of T and find the matching SuggestItem for this value, this is used when we directly set the value to the SuggestBox to check if it is actually still matching an existing suggestion

Parameters:

searchValue - T

handler - Consumer of SuggestItem

filterItem

default boolean filterItem(String searchValue,
                           SuggestItem<T> suggestItem)

Defines how to check a single SuggestItem against the search text, default to SuggestItem lowercase display text contains the search text

Parameters:

searchValue - String

suggestItem - SuggestItem

Returns:

boolean, true if the SuggestItem match the search text

getMessingSuggestionProvider

default SuggestBoxStore.MissingSuggestProvider<T> getMessingSuggestionProvider()

Returns:

the SuggestBoxStore.MissingSuggestProvider to handle missing suggestions for a value this is default to Optional.empty()

getMessingEntryProvider

default SuggestBoxStore.MissingEntryProvider<T> getMessingEntryProvider()

Returns:

the SuggestBoxStore.MissingEntryProvider to handle missing suggestions for a text typed in the SuggestBox this is default to Optional.empty()