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

Class AutoSuggestFormElementBuilder

java.lang.Object

com.foreach.across.modules.web.ui.GlobalContextSupportingViewElementBuilder<T>

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

Field Summary

Fields

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

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(AutoSuggestFormElementConfiguration configuration) Set the configuration for the autosuggest control.
protected AutoSuggestFormElement	createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
AutoSuggestFormElementBuilder	endpoint(String endpoint) Configure the endpoint that this control should use to retrieve suggestions.
AutoSuggestFormElementBuilder	idProperty(String idProperty)
AutoSuggestFormElementBuilder	itemTemplate(com.foreach.across.modules.web.ui.ViewElement containerTemplate, com.foreach.across.modules.web.ui.ViewElement itemTemplate) Use a custom ViewElement that will be used as a template for the rendering of selected suggestions.
AutoSuggestFormElementBuilder	linkBuilder(java.util.function.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(com.foreach.across.modules.web.ui.ViewElement notFoundTemplate)
AutoSuggestFormElementBuilder	notFoundTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder notFoundTemplate)
AutoSuggestFormElementBuilder	prefill(List<Map<String,Object>> prefillValues)
AutoSuggestFormElementBuilder	properties(String... properties)
protected void	registerWebResources(com.foreach.across.modules.web.resource.WebResourceRegistry webResourceRegistry)
AutoSuggestFormElementBuilder	suggestionTemplate(com.foreach.across.modules.web.ui.ViewElement template) com.foreach.across.modules.bootstrapui.elements.builder.AutoSuggestFormElementBuilder#suggestionTemplate
AutoSuggestFormElementBuilder	suggestionTemplate(com.foreach.across.modules.web.ui.ViewElementBuilder template) Use a custom ViewElementBuilder that will be used as a template for the rendering of suggestions 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, name, postProcess, postProcessor

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

build

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_DATA_PROPERTY

public static final String ATTRIBUTE_DATA_PROPERTY

See Also:

Constant Field Values

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

CSS_TYPEAHEAD_ITEM_CLASS

public static final String CSS_TYPEAHEAD_ITEM_CLASS

See Also:

Constant Field Values

CSS_PREFILL_TABLE

public static final String CSS_PREFILL_TABLE

See Also:

Constant Field Values

CSS_SUGGESTION_TEMPLATE

public static final String CSS_SUGGESTION_TEMPLATE

See Also:

Constant Field Values

CSS_ITEM_TEMPLATE

public static final String CSS_ITEM_TEMPLATE

See Also:

Constant Field Values

CSS_EMPTY_TEMPLATE

public static final String CSS_EMPTY_TEMPLATE

See Also:

Constant Field Values

DEFAULT_PROPERTY

public static final String DEFAULT_PROPERTY

See Also:

Constant Field Values

Constructor Detail

AutoSuggestFormElementBuilder

public AutoSuggestFormElementBuilder()

Method Detail

configuration

public AutoSuggestFormElementBuilder configuration(@NonNull
                                                   AutoSuggestFormElementConfiguration configuration)

Set the configuration for the autosuggest control.

Parameters:

configuration - to use

Returns:

current builder

idProperty

public AutoSuggestFormElementBuilder idProperty(String idProperty)

prefill

public AutoSuggestFormElementBuilder prefill(List<Map<String,Object>> prefillValues)

properties

public AutoSuggestFormElementBuilder properties(String... properties)

endpoint

public AutoSuggestFormElementBuilder endpoint(String endpoint)

Configure the endpoint that this control should use to retrieve suggestions.

Parameters:

endpoint - url

Returns:

current builder

notFoundTemplate

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

notFoundTemplate

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

suggestionTemplate

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

Use a custom ViewElementBuilder that will be used as a template for the rendering of suggestions in the suggestion dropdown.

If you want to reuse properties from this AutoSuggestFormElementBuilder instance, make sure to add an attribute ATTRIBUTE_DATA_PROPERTYto the node element which inner HTML should be replaced.

suggestionTemplate

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

com.foreach.across.modules.bootstrapui.elements.builder.AutoSuggestFormElementBuilder#suggestionTemplate

itemTemplate

public AutoSuggestFormElementBuilder itemTemplate(com.foreach.across.modules.web.ui.ViewElement containerTemplate,
                                                  com.foreach.across.modules.web.ui.ViewElement itemTemplate)

Use a custom ViewElement that will be used as a template for the rendering of selected suggestions.

The given ContainerViewElementBuilder will contain all selected suggestions. The container may not have child nodes The given itemTemplate must contain a node with class CSS_ITEM_TEMPLATE. This childnode will be repeated for all selected suggestions. If you want to reuse properties from this AutoSuggestFormElementBuilder instance, make sure to add an attribute ATTRIBUTE_DATA_PROPERTYto the node element which inner HTML should be replaced

linkBuilder

public AutoSuggestFormElementBuilder linkBuilder(java.util.function.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>