org.dominokit.domino.ui.forms

Class LocalSuggestBoxStore<T>

java.lang.Object

org.dominokit.domino.ui.forms.LocalSuggestBoxStore<T>

Type Parameters:

T - The type of the SuggestBox value

All Implemented Interfaces:

SuggestBoxStore<T>

public class LocalSuggestBoxStore<T>
extends Object
implements SuggestBoxStore<T>

An implementation of SuggestBoxStore that provides Suggestion from a local List

Nested Class Summary

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.forms.SuggestBoxStore

SuggestBoxStore.MissingEntryProvider<T>, SuggestBoxStore.MissingSuggestProvider<T>, SuggestBoxStore.SuggestionFilter<T>, SuggestBoxStore.SuggestionsHandler<T>

Constructor Summary

Constructors

Constructor and Description
LocalSuggestBoxStore() Creates a store initialized with an empty List
LocalSuggestBoxStore(List<SuggestItem<T>> suggestions) Creates a store initialized with a List of Suggestions

Method Summary

Modifier and Type	Method and Description
LocalSuggestBoxStore<T>	addSuggestion(SuggestItem<T> suggestion) Adds a suggestion the suggestions List
LocalSuggestBoxStore<T>	addSuggestions(List<SuggestItem<T>> suggestions) Adds a List of suggestions to the store suggestions
static <T> LocalSuggestBoxStore<T>	create() Creates a store initialized with an empty List
static <T> LocalSuggestBoxStore<T>	create(List<SuggestItem<T>> suggestions) Creates a store initialized with a List of suggestions
void	filter(String searchValue, SuggestBoxStore.SuggestionsHandler<T> suggestionsHandler) Takes the current typed text in the SuggestBox and provide a List of matching suggestion
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
SuggestBoxStore.MissingEntryProvider<T>	getMessingEntryProvider()
SuggestBoxStore.MissingSuggestProvider<T>	getMessingSuggestionProvider()
SuggestBoxStore.SuggestionFilter<T>	getSuggestionFilter()
List<SuggestItem<T>>	getSuggestions()
LocalSuggestBoxStore<T>	setMissingEntryProvider(SuggestBoxStore.MissingEntryProvider<T> missingEntryProvider) Sets the missing entry provider to be used by this store
LocalSuggestBoxStore<T>	setMissingHandlers(SuggestBoxStore.MissingSuggestProvider<T> missingSuggestProvider, SuggestBoxStore.MissingEntryProvider<T> missingEntryProvider) A shortcut method to set bot the MissingSuggestProvider and MissingEntryProvider
LocalSuggestBoxStore<T>	setMissingValueProvider(SuggestBoxStore.MissingSuggestProvider<T> missingValueProvider) sets the missing suggestion provider for this store
LocalSuggestBoxStore<T>	setSuggestionFilter(SuggestBoxStore.SuggestionFilter<T> suggestionFilter) Set the logic of matching a SuggestItem with the search text
LocalSuggestBoxStore<T>	setSuggestions(List<SuggestItem<T>> suggestions) replace the store suggestions with the provided List

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalSuggestBoxStore

public LocalSuggestBoxStore()

Creates a store initialized with an empty List

LocalSuggestBoxStore

public LocalSuggestBoxStore(List<SuggestItem<T>> suggestions)

Creates a store initialized with a List of Suggestions

Parameters:

suggestions - List of SuggestItem

Method Detail

create

public static <T> LocalSuggestBoxStore<T> create()

Creates a store initialized with an empty List

Type Parameters:

T - the type of the SuggestBox value

Returns:

new store instance

create

public static <T> LocalSuggestBoxStore<T> create(List<SuggestItem<T>> suggestions)

Creates a store initialized with a List of suggestions

Type Parameters:

T - the type of the SuggestBox value

Parameters:

suggestions - List of SuggestItem

Returns:

new store instance

addSuggestion

public LocalSuggestBoxStore<T> addSuggestion(SuggestItem<T> suggestion)

Adds a suggestion the suggestions List

Parameters:

suggestion - SuggestItem

Returns:

same store instance

addSuggestions

public LocalSuggestBoxStore<T> addSuggestions(List<SuggestItem<T>> suggestions)

Adds a List of suggestions to the store suggestions

Parameters:

suggestions - List of SuggestItem

Returns:

same store instance

setSuggestions

public LocalSuggestBoxStore<T> setSuggestions(List<SuggestItem<T>> suggestions)

replace the store suggestions with the provided List

Parameters:

suggestions - List of new SuggestItem

Returns:

same store instance

getSuggestions

public List<SuggestItem<T>> getSuggestions()

Returns:

List of SuggestItem in this store

filter

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

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

Specified by:

filter in interface SuggestBoxStore<T>

Parameters:

searchValue - String text in the SuggestBox

suggestionsHandler - SuggestBoxStore.SuggestionsHandler

find

public 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

Specified by:

find in interface SuggestBoxStore<T>

Parameters:

searchValue - T

handler - Consumer of SuggestItem

filterItem

public 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

Specified by:

filterItem in interface SuggestBoxStore<T>

Parameters:

searchValue - String

suggestItem - SuggestItem

Returns:

boolean, true if the SuggestItem match the search text

getSuggestionFilter

public SuggestBoxStore.SuggestionFilter<T> getSuggestionFilter()

Returns:

the SuggestionFilter used by this store

setSuggestionFilter

public LocalSuggestBoxStore<T> setSuggestionFilter(SuggestBoxStore.SuggestionFilter<T> suggestionFilter)

Set the logic of matching a SuggestItem with the search text

Parameters:

suggestionFilter - SuggestionFilter

Returns:

same store instance

setMissingValueProvider

public LocalSuggestBoxStore<T> setMissingValueProvider(SuggestBoxStore.MissingSuggestProvider<T> missingValueProvider)

sets the missing suggestion provider for this store

Parameters:

missingValueProvider - MissingSuggestProvider

Returns:

same store instance

setMissingEntryProvider

public LocalSuggestBoxStore<T> setMissingEntryProvider(SuggestBoxStore.MissingEntryProvider<T> missingEntryProvider)

Sets the missing entry provider to be used by this store

Parameters:

missingEntryProvider - MissingEntryProvider

Returns:

same store instance

getMessingSuggestionProvider

public SuggestBoxStore.MissingSuggestProvider<T> getMessingSuggestionProvider()

Specified by:

getMessingSuggestionProvider in interface SuggestBoxStore<T>

Returns:

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

getMessingEntryProvider

public SuggestBoxStore.MissingEntryProvider<T> getMessingEntryProvider()

Specified by:

getMessingEntryProvider in interface SuggestBoxStore<T>

Returns:

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

setMissingHandlers

public LocalSuggestBoxStore<T> setMissingHandlers(SuggestBoxStore.MissingSuggestProvider<T> missingSuggestProvider,
                                                  SuggestBoxStore.MissingEntryProvider<T> missingEntryProvider)

A shortcut method to set bot the MissingSuggestProvider and MissingEntryProvider

Parameters:

missingSuggestProvider - MissingSuggestProvider

missingEntryProvider - MissingEntryProvider

Returns:

same store instance