com.foreach.across.modules.bootstrapui.elements.autosuggest

Class AutoSuggestFormElementConfiguration

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

com.foreach.across.modules.bootstrapui.utils.ElementConfigurationMap<AutoSuggestFormElementConfiguration>

com.foreach.across.modules.bootstrapui.elements.autosuggest.AutoSuggestFormElementConfiguration

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class AutoSuggestFormElementConfiguration
extends ElementConfigurationMap<AutoSuggestFormElementConfiguration>

Configuration class for a AutoSuggestFormElementBuilder based on typeahead.js.

Optimized to represent the different Typeahead configuration options, may hold multiple datasets where a dataset representation is optimized for a Bloodhound datasource.

Author:

Sander Van Loock, Arne Vandamme

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AutoSuggestFormElementConfiguration.DataSet Represents a single dataset.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_DATASETS Attribute that holds the collection of dataset definitions.
static String	DEFAULT_DATASET Name of the default data set.
static String	DEFAULT_ENDPOINT

Constructor Summary

Constructors

Constructor and Description
AutoSuggestFormElementConfiguration()

Method Summary

Modifier and Type	Method and Description
AutoSuggestFormElementConfiguration	addDataSet(@NonNull AutoSuggestFormElementConfiguration.DataSet dataSet) Add a dataset to the collection, if there is another dataset with that name already, it will be removed first.
static AutoSuggestFormElementConfiguration.DataSet	createDataSet()
String	getEndpoint()
AutoSuggestFormElementConfiguration	highlight(boolean highlight) Highlight the matching input text in the suggestions.
AutoSuggestFormElementConfiguration	minLength(int minLength) Minimum length the input value should have before fetching suggestiong.
AutoSuggestFormElementConfiguration	removeDataSet(String dataSetName) Remove the dataset with the given name if it is present.
void	setEndpoint(@NonNull String endpoint) Sets the remote url endpoint where to fetch suggestions.
AutoSuggestFormElementConfiguration	showHint(boolean showHint) Should the textbox show a hint for auto-completion.
AutoSuggestFormElementConfiguration	translate(Function<String,String> linkBuilder) Create a new instance of this configuration, where the links have been translated by the specified builder.
static AutoSuggestFormElementConfiguration	withDataSet(Consumer<AutoSuggestFormElementConfiguration.DataSet> consumer) Create a new configuration with a default dataset.
AutoSuggestFormElementConfiguration	withDataSet(String dataSetName, Consumer<AutoSuggestFormElementConfiguration.DataSet> consumer) Configure the dataset with the given name, if it is not yet present, it will be added first.

Methods inherited from class com.foreach.across.modules.bootstrapui.utils.ElementConfigurationMap

setAttribute

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Field Detail

ATTR_DATASETS

public static final String ATTR_DATASETS

Attribute that holds the collection of dataset definitions.

See Also:

Constant Field Values

DEFAULT_DATASET

public static final String DEFAULT_DATASET

Name of the default data set.

See Also:

Constant Field Values

DEFAULT_ENDPOINT

public static final String DEFAULT_ENDPOINT

See Also:

Constant Field Values

Constructor Detail

AutoSuggestFormElementConfiguration

public AutoSuggestFormElementConfiguration()

Method Detail

setEndpoint

public void setEndpoint(@NonNull
                        @NonNull String endpoint)

Sets the remote url endpoint where to fetch suggestions. Defaults to DEFAULT_ENDPOINT. The parameter {value} will be replaced with the actual input text.

Parameters:

endpoint - url

getEndpoint

public String getEndpoint()

Returns:

configured endpoint url

showHint

public AutoSuggestFormElementConfiguration showHint(boolean showHint)

Should the textbox show a hint for auto-completion.

Parameters:

showHint - to show

Returns:

current configuration

highlight

public AutoSuggestFormElementConfiguration highlight(boolean highlight)

Highlight the matching input text in the suggestions.

Parameters:

highlight - match

Returns:

current configuration

minLength

public AutoSuggestFormElementConfiguration minLength(int minLength)

Minimum length the input value should have before fetching suggestiong.

Parameters:

minLength - input should have

Returns:

current configuration

withDataSet

public AutoSuggestFormElementConfiguration withDataSet(String dataSetName,
                                                       Consumer<AutoSuggestFormElementConfiguration.DataSet> consumer)

Configure the dataset with the given name, if it is not yet present, it will be added first.

Parameters:

dataSetName - name of the dataset

consumer - to configure the dataset

Returns:

current configuration

removeDataSet

public AutoSuggestFormElementConfiguration removeDataSet(String dataSetName)

Remove the dataset with the given name if it is present.

Parameters:

dataSetName - name of the dataset to remove

Returns:

current configuration

addDataSet

public AutoSuggestFormElementConfiguration addDataSet(@NonNull
                                                      @NonNull AutoSuggestFormElementConfiguration.DataSet dataSet)

Add a dataset to the collection, if there is another dataset with that name already, it will be removed first.

Parameters:

dataSet - to add to the collection

Returns:

current configuration

translate

public AutoSuggestFormElementConfiguration translate(Function<String,String> linkBuilder)

Create a new instance of this configuration, where the links have been translated by the specified builder.

Parameters:

linkBuilder - to use

Returns:

new copy of the configuration

withDataSet

public static AutoSuggestFormElementConfiguration withDataSet(Consumer<AutoSuggestFormElementConfiguration.DataSet> consumer)

Create a new configuration with a default dataset.

Parameters:

consumer - to customize the dataset

Returns:

current configuration

createDataSet

public static AutoSuggestFormElementConfiguration.DataSet createDataSet()

Returns:

a new blank dataset