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

Class AutoSuggestFormElementBuilder

java.lang.Object

com.foreach.across.modules.web.ui.ViewElementBuilderSupport<T,SELF>

com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<T,SELF>

com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<T,SELF>

com.foreach.across.modules.bootstrapui.elements.builder.FormControlElementBuilderSupport<AutoSuggestFormElement,AutoSuggestFormElementBuilder>

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

All Implemented Interfaces:

com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<AutoSuggestFormElement,AutoSuggestFormElementBuilder>, com.foreach.across.modules.web.ui.ViewElementBuilder<AutoSuggestFormElement>

public class AutoSuggestFormElementBuilder
extends FormControlElementBuilderSupport<AutoSuggestFormElement,AutoSuggestFormElementBuilder>

Will create an autosuggest component backed by a Typeahead JS implementation. The textbox will serve as the typeahead input control, a hidden control will be

The client-side javascript is responsible for swapping the actual textbox and hidden field control, so the hidden field is used for the post-back value.

Nested Class Summary

Nested classes/interfaces inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder

Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.ViewElementBuilder

com.foreach.across.modules.web.ui.ViewElementBuilder.Wither<T extends com.foreach.across.modules.web.ui.ViewElementBuilder>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CSS_TYPEAHEAD CSS class put on the textbox, that will actually be initialized as the typeahead control.
static String	CSS_TYPEAHEAD_MODULE CSS class on the wrapper, representing the autosuggest (typeahead) component.
static String	CSS_TYPEAHEAD_VALUE

Fields inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

customTemplate, name

Constructor Summary

Constructors

Constructor and Description
AutoSuggestFormElementBuilder()

Method Summary

Modifier and Type	Method and Description
protected String	buildLink(String link, com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
AutoSuggestFormElementBuilder	configuration(@NonNull AutoSuggestFormElementConfiguration configuration) Set the configuration for the autosuggest control.
protected AutoSuggestFormElement	createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
AutoSuggestFormElementBuilder	footerTemplate(String name, com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template as footer of the suggestions fetched for the default dataset
AutoSuggestFormElementBuilder	footerTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template as footer of the suggestions fetched for the default dataset
AutoSuggestFormElementBuilder	headerTemplate(String name, com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template as the header of the suggestions fetched for the default dataset
AutoSuggestFormElementBuilder	headerTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template as the header of the suggestions fetched for the default dataset
AutoSuggestFormElementBuilder	linkBuilder(Function<String,String> linkBuilder) Set a conversion function that should be applied to all url type properties when setting them as the attribute for the generated links.
AutoSuggestFormElementBuilder	notFoundTemplate(String datasetId, com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template when there are no suggestions found for the specified dataset.
AutoSuggestFormElementBuilder	notFoundTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template when there are no suggestions found for the default dataset.
AutoSuggestFormElementBuilder	pendingTemplate(String name, com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template for the default dataset when synchronous results are not available, but asynchronous results are expected.
AutoSuggestFormElementBuilder	pendingTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template for the default dataset when synchronous results are not available, but asynchronous results are expected.
protected void	registerWebResources(com.foreach.across.modules.web.resource.WebResourceRegistry webResourceRegistry)
AutoSuggestFormElementBuilder	suggestionTemplate(String datasetId, com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template for the rendering of suggestions in the suggestion dropdown for a specific dataset.
AutoSuggestFormElementBuilder	suggestionTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as template for the rendering of suggestions of the default dataset in the suggestion dropdown.

Methods inherited from class com.foreach.across.modules.bootstrapui.elements.builder.FormControlElementBuilderSupport

apply, controlName, disabled, disabled, getControlName, getDisabled, getReadonly, getRequired, readonly, readonly, required, required

Methods inherited from class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder

attribute, attributes, clearAttributes, css, htmlId, removeAttribute, removeCss

Methods inherited from class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport

add, add, addAll, addFirst, addFirst, sort

Methods inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

build, configure, customTemplate, elementSupplier, elementSupplier, name, postProcess, postProcessor, with

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder

data, removeData

Methods inherited from interface com.foreach.across.modules.web.ui.ViewElementBuilder

andThen, build, doWith, map, map, of, of, postProcess, postProcess

Field Detail

CSS_TYPEAHEAD_MODULE

public static final String CSS_TYPEAHEAD_MODULE

CSS class on the wrapper, representing the autosuggest (typeahead) component.

See Also:

Constant Field Values

CSS_TYPEAHEAD

public static final String CSS_TYPEAHEAD

CSS class put on the textbox, that will actually be initialized as the typeahead control.

See Also:

Constant Field Values

CSS_TYPEAHEAD_VALUE

public static final String CSS_TYPEAHEAD_VALUE

See Also:

Constant Field Values

Constructor Detail

AutoSuggestFormElementBuilder

public AutoSuggestFormElementBuilder()

Method Detail

configuration

public AutoSuggestFormElementBuilder configuration(@NonNull
                                                   @NonNull AutoSuggestFormElementConfiguration configuration)

Set the configuration for the autosuggest control.

Parameters:

configuration - to use

Returns:

current builder

notFoundTemplate

public AutoSuggestFormElementBuilder notFoundTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template when there are no suggestions found for the default dataset.

Parameters:

template - that should be used

Returns:

current builder

See Also:

notFoundTemplate(String, ViewElementBuilder)

notFoundTemplate

public AutoSuggestFormElementBuilder notFoundTemplate(String datasetId,
                                                      com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template when there are no suggestions found for the specified dataset.

Parameters:

datasetId - id of the dataset

template - that should be used

Returns:

current builder

suggestionTemplate

public AutoSuggestFormElementBuilder suggestionTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template for the rendering of suggestions of the default dataset in the suggestion dropdown. The template will be applied to each suggestion and the associated suggestion object will be available within the context. The default template for suggestions is <div>{{value}}</div>.

Parameters:

template - that should be used

Returns:

current builder

See Also:

suggestionTemplate(String, ViewElementBuilder)

suggestionTemplate

public AutoSuggestFormElementBuilder suggestionTemplate(String datasetId,
                                                        com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template for the rendering of suggestions in the suggestion dropdown for a specific dataset. The template will be applied to each suggestion and the associated suggestion object will be available within the context. The default template for suggestions is <div>{{value}}</div>.

Parameters:

datasetId - id of the dataset

template - that should be used

Returns:

current builder

pendingTemplate

public AutoSuggestFormElementBuilder pendingTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template for the default dataset when synchronous results are not available, but asynchronous results are expected. The current query can be used in the template, for example <div>Loading results for {{query}}...</div>

Parameters:

template - that should be used

Returns:

current builder

See Also:

pendingTemplate(String, ViewElementBuilder)

pendingTemplate

public AutoSuggestFormElementBuilder pendingTemplate(String name,
                                                     com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template for the default dataset when synchronous results are not available, but asynchronous results are expected. The current query can be used in the template, for example <div>Loading results for {{query}}...</div>

Parameters:

template - that should be used

Returns:

current builder

headerTemplate

public AutoSuggestFormElementBuilder headerTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template as the header of the suggestions fetched for the default dataset

Parameters:

template - that should be used

Returns:

current builder

See Also:

headerTemplate(String, ViewElementBuilder)

headerTemplate

public AutoSuggestFormElementBuilder headerTemplate(String name,
                                                    com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template as the header of the suggestions fetched for the default dataset

Parameters:

template - that should be used

Returns:

current builder

footerTemplate

public AutoSuggestFormElementBuilder footerTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template as footer of the suggestions fetched for the default dataset

Parameters:

template - that should be used

Returns:

current builder

See Also:

headerTemplate(String, ViewElementBuilder)

footerTemplate

public AutoSuggestFormElementBuilder footerTemplate(String name,
                                                    com.foreach.across.modules.web.ui.ViewElementBuilder template)

Use a custom ViewElementBuilder that will be used as template as footer of the suggestions fetched for the default dataset

Parameters:

template - that should be used

Returns:

current builder

linkBuilder

public AutoSuggestFormElementBuilder linkBuilder(Function<String,String> linkBuilder)

Set a conversion function that should be applied to all url type properties when setting them as the attribute for the generated links.

If not set, this builder will dispatch to ViewElementBuilderContext.buildLink(String). You can suppress the default behaviour by setting this property to Function.identity().

Parameters:

linkBuilder - to use for translating the urls

Returns:

current builder

createElement

protected AutoSuggestFormElement createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)

Specified by:

createElement in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<AutoSuggestFormElement,AutoSuggestFormElementBuilder>

buildLink

protected String buildLink(String link,
                           com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)

registerWebResources

protected void registerWebResources(com.foreach.across.modules.web.resource.WebResourceRegistry webResourceRegistry)

Overrides:

registerWebResources in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<AutoSuggestFormElement,AutoSuggestFormElementBuilder>