AutoSuggestFormElement (Bootstrap UI Module 3.1.0.RELEASE API)

java.lang.Object
- com.foreach.across.modules.web.ui.elements.ContainerViewElement
- - com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - - com.foreach.across.modules.bootstrapui.elements.autosuggest.AutoSuggestFormElement

All Implemented Interfaces:

ConfigurablePlaceholderText, FormControlElement, FormInputElement, com.foreach.across.modules.web.ui.elements.ConfigurableTextViewElement, com.foreach.across.modules.web.ui.elements.HtmlViewElement, com.foreach.across.modules.web.ui.MutableViewElement, com.foreach.across.modules.web.ui.ViewElement
```
public final class AutoSuggestFormElement
extends com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
implements FormControlElement, com.foreach.across.modules.web.ui.elements.ConfigurableTextViewElement, ConfigurablePlaceholderText
```
Represents an autosuggest textbox field, can be created through BootstrapViewElements.autoSuggest(TextboxFormElement, HiddenFormElement) or using a AutoSuggestFormElementBuilder.

Since:

2.0.0

Author:

Arne Vandamme

Nested Class Summary
- Nested classes/interfaces inherited from interface com.foreach.across.modules.bootstrapui.elements.FormControlElement
  FormControlElement.Proxy
- Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
  com.foreach.across.modules.web.ui.elements.HtmlViewElement.Functions
- Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.ViewElement
  com.foreach.across.modules.web.ui.ViewElement.Wither<T extends com.foreach.across.modules.web.ui.ViewElement>, com.foreach.across.modules.web.ui.ViewElement.WitherGetter<T extends com.foreach.across.modules.web.ui.ViewElement,U>, com.foreach.across.modules.web.ui.ViewElement.WitherRemover<T extends com.foreach.across.modules.web.ui.ViewElement>, com.foreach.across.modules.web.ui.ViewElement.WitherSetter<T extends com.foreach.across.modules.web.ui.ViewElement>

Field Summary

Fields
Modifier and Type Field and Description

static String ATTRIBUTE_DATA_AUTOSUGGEST

static String ELEMENT_TYPE

Fields
Modifier and Type	Field and Description
`static String`	`ATTRIBUTE_DATA_AUTOSUGGEST`
`static String`	`ELEMENT_TYPE`

Constructor Summary

Constructors
Constructor and Description

AutoSuggestFormElement(TextboxFormElement textbox, HiddenFormElement valueControl)

Constructors
Constructor and Description
`AutoSuggestFormElement(TextboxFormElement textbox, HiddenFormElement valueControl)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AutoSuggestFormElement`	`addAttributes(Map<String,Object> attributes)`
`AutoSuggestFormElement`	`addChild(com.foreach.across.modules.web.ui.ViewElement element)`
`AutoSuggestFormElement`	`addChildren(Collection<? extends com.foreach.across.modules.web.ui.ViewElement> elements)`
`AutoSuggestFormElement`	`addCssClass(String... cssClass)`
`AutoSuggestFormElement`	`addFirstChild(com.foreach.across.modules.web.ui.ViewElement element)`
`AutoSuggestFormElement`	`apply(Consumer<com.foreach.across.modules.web.ui.elements.ContainerViewElement> consumer)`
`<U extends com.foreach.across.modules.web.ui.ViewElement> AutoSuggestFormElement`	`applyUnsafe(Consumer<U> consumer)`
`AutoSuggestFormElement`	`clearChildren()`
`Stream<com.foreach.across.modules.web.ui.ViewElement>`	`elementStream()`
`AutoSuggestFormElementConfiguration`	`getConfiguration()`
`String`	`getControlName()`
`String`	`getHtmlId()`
`String`	`getPlaceholder()`
`String`	`getText()`
`Object`	`getValue()`
`<V> V`	`getValue(Class<V> expectedType)`
`boolean`	`isDisabled()`
`boolean`	`isReadonly()`
`boolean`	`isRequired()`
`AutoSuggestFormElement`	`remove(com.foreach.across.modules.web.ui.ViewElement.WitherRemover... functions)`
`AutoSuggestFormElement`	`removeAttribute(String attributeName)`
`AutoSuggestFormElement`	`removeCssClass(String... cssClass)`
`AutoSuggestFormElement`	`set(com.foreach.across.modules.web.ui.ViewElement.WitherSetter... setters)`
`AutoSuggestFormElement`	`setAttribute(String attributeName, Object attributeValue)`
`AutoSuggestFormElement`	`setAttributes(Map<String,Object> attributes)`
`AutoSuggestFormElement`	`setConfiguration(@NonNull AutoSuggestFormElementConfiguration configuration)`
`AutoSuggestFormElement`	`setControlName(String controlName)`
`AutoSuggestFormElement`	`setCustomTemplate(String customTemplate)`
`AutoSuggestFormElement`	`setDisabled(boolean disabled)`
`protected AutoSuggestFormElement`	`setElementType(String elementType)`
`AutoSuggestFormElement`	`setHtmlId(String htmlId)`
`AutoSuggestFormElement`	`setName(String name)`
`AutoSuggestFormElement`	`setPlaceholder(String placeholder)`
`AutoSuggestFormElement`	`setReadonly(boolean readonly)`
`AutoSuggestFormElement`	`setRequired(boolean required)`
`protected AutoSuggestFormElement`	`setTagName(String tagName)`
`AutoSuggestFormElement`	`setText(String text)`
`AutoSuggestFormElement`	`setValue(Object value)`

Methods inherited from class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
get, getAttribute, getAttribute, getAttributes, getTagName, hasAttribute, hasCssClass, returnIfType

Methods inherited from class com.foreach.across.modules.web.ui.elements.ContainerViewElement
find, find, findAll, findAll, findAll, findOrSelf, findOrSelf, flatStream, getChildren, getCustomTemplate, getElementType, getName, hasChildren, removeAllFromTree, removeChild, removeFromTree, removeFromTree

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.HtmlViewElement
getAttribute, getAttribute, getAttributes, getTagName, hasAttribute, hasCssClass

Methods inherited from interface com.foreach.across.modules.web.ui.ViewElement
get, getCustomTemplate, getElementType, getName, matches, predicateFor, with

- Field Detail
  - ELEMENT_TYPE
```
public static final String ELEMENT_TYPE
```
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_DATA_AUTOSUGGEST
```
public static final String ATTRIBUTE_DATA_AUTOSUGGEST
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AutoSuggestFormElement
```
public AutoSuggestFormElement(TextboxFormElement textbox,
                              HiddenFormElement valueControl)
```
- Method Detail
  - getHtmlId
```
public String getHtmlId()
```
    Specified by:
    
    getHtmlId in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Overrides:
    
    getHtmlId in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setHtmlId
```
public AutoSuggestFormElement setHtmlId(String htmlId)
```
    Specified by:
    
    setHtmlId in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Overrides:
    
    setHtmlId in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - isReadonly
```
public boolean isReadonly()
```
    Specified by:
    
    isReadonly in interface FormControlElement
  - setReadonly
```
public AutoSuggestFormElement setReadonly(boolean readonly)
```
    Specified by:
    
    setReadonly in interface FormControlElement
  - isRequired
```
public boolean isRequired()
```
    Specified by:
    
    isRequired in interface FormControlElement
  - setRequired
```
public AutoSuggestFormElement setRequired(boolean required)
```
    Specified by:
    
    setRequired in interface FormControlElement
  - getControlName
```
public String getControlName()
```
    Specified by:
    
    getControlName in interface FormInputElement
  - setControlName
```
public AutoSuggestFormElement setControlName(String controlName)
```
    Specified by:
    
    setControlName in interface FormInputElement
  - isDisabled
```
public boolean isDisabled()
```
    Specified by:
    
    isDisabled in interface FormInputElement
  - setDisabled
```
public AutoSuggestFormElement setDisabled(boolean disabled)
```
    Specified by:
    
    setDisabled in interface FormInputElement
  - setPlaceholder
```
public AutoSuggestFormElement setPlaceholder(String placeholder)
```
    Specified by:
    
    setPlaceholder in interface ConfigurablePlaceholderText
  - getPlaceholder
```
public String getPlaceholder()
```
    Specified by:
    
    getPlaceholder in interface ConfigurablePlaceholderText
  - setText
```
public AutoSuggestFormElement setText(String text)
```
    Specified by:
    
    setText in interface com.foreach.across.modules.web.ui.elements.ConfigurableTextViewElement
  - getText
```
public String getText()
```
    Specified by:
    
    getText in interface com.foreach.across.modules.web.ui.elements.ConfigurableTextViewElement
  - getValue
```
public Object getValue()
```
  - getValue
```
public <V> V getValue(Class<V> expectedType)
```
  - setValue
```
public AutoSuggestFormElement setValue(Object value)
```
  - getConfiguration
```
public AutoSuggestFormElementConfiguration getConfiguration()
```
  - setConfiguration
```
public AutoSuggestFormElement setConfiguration(@NonNull
                                               @NonNull AutoSuggestFormElementConfiguration configuration)
```
  - elementStream
```
public Stream<com.foreach.across.modules.web.ui.ViewElement> elementStream()
```
    Overrides:
    
    elementStream in class com.foreach.across.modules.web.ui.elements.ContainerViewElement
  - addCssClass
```
public AutoSuggestFormElement addCssClass(String... cssClass)
```
    Specified by:
    
    addCssClass in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Overrides:
    
    addCssClass in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - removeCssClass
```
public AutoSuggestFormElement removeCssClass(String... cssClass)
```
    Specified by:
    
    removeCssClass in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Overrides:
    
    removeCssClass in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setAttributes
```
public AutoSuggestFormElement setAttributes(Map<String,Object> attributes)
```
    Specified by:
    
    setAttributes in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Overrides:
    
    setAttributes in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setAttribute
```
public AutoSuggestFormElement setAttribute(String attributeName,
                                           Object attributeValue)
```
    Specified by:
    
    setAttribute in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Overrides:
    
    setAttribute in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - addAttributes
```
public AutoSuggestFormElement addAttributes(Map<String,Object> attributes)
```
    Specified by:
    
    addAttributes in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Overrides:
    
    addAttributes in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - removeAttribute
```
public AutoSuggestFormElement removeAttribute(String attributeName)
```
    Specified by:
    
    removeAttribute in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Overrides:
    
    removeAttribute in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setName
```
public AutoSuggestFormElement setName(String name)
```
    Specified by:
    
    setName in interface com.foreach.across.modules.web.ui.MutableViewElement
    
    Overrides:
    
    setName in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setCustomTemplate
```
public AutoSuggestFormElement setCustomTemplate(String customTemplate)
```
    Specified by:
    
    setCustomTemplate in interface com.foreach.across.modules.web.ui.MutableViewElement
    
    Overrides:
    
    setCustomTemplate in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setElementType
```
protected AutoSuggestFormElement setElementType(String elementType)
```
    Overrides:
    
    setElementType in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - addChild
```
public AutoSuggestFormElement addChild(com.foreach.across.modules.web.ui.ViewElement element)
```
    Overrides:
    
    addChild in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - addChildren
```
public AutoSuggestFormElement addChildren(Collection<? extends com.foreach.across.modules.web.ui.ViewElement> elements)
```
    Overrides:
    
    addChildren in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - addFirstChild
```
public AutoSuggestFormElement addFirstChild(com.foreach.across.modules.web.ui.ViewElement element)
```
    Overrides:
    
    addFirstChild in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - clearChildren
```
public AutoSuggestFormElement clearChildren()
```
    Overrides:
    
    clearChildren in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - apply
```
public AutoSuggestFormElement apply(Consumer<com.foreach.across.modules.web.ui.elements.ContainerViewElement> consumer)
```
    Overrides:
    
    apply in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - applyUnsafe
```
public <U extends com.foreach.across.modules.web.ui.ViewElement> AutoSuggestFormElement applyUnsafe(Consumer<U> consumer)
```
    Overrides:
    
    applyUnsafe in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setTagName
```
protected AutoSuggestFormElement setTagName(String tagName)
```
    Overrides:
    
    setTagName in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - set
```
public AutoSuggestFormElement set(com.foreach.across.modules.web.ui.ViewElement.WitherSetter... setters)
```
    Specified by:
    
    set in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Specified by:
    
    set in interface com.foreach.across.modules.web.ui.MutableViewElement
    
    Specified by:
    
    set in interface com.foreach.across.modules.web.ui.ViewElement
    
    Overrides:
    
    set in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - remove
```
public AutoSuggestFormElement remove(com.foreach.across.modules.web.ui.ViewElement.WitherRemover... functions)
```
    Specified by:
    
    remove in interface com.foreach.across.modules.web.ui.elements.HtmlViewElement
    
    Specified by:
    
    remove in interface com.foreach.across.modules.web.ui.MutableViewElement
    
    Specified by:
    
    remove in interface com.foreach.across.modules.web.ui.ViewElement
    
    Overrides:
    
    remove in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

Class AutoSuggestFormElement

Nested Class Summary

Nested classes/interfaces inherited from interface com.foreach.across.modules.bootstrapui.elements.FormControlElement

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

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

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

ELEMENT_TYPE

ATTRIBUTE_DATA_AUTOSUGGEST

Constructor Detail

AutoSuggestFormElement

Method Detail

getHtmlId

setHtmlId

isReadonly

setReadonly

isRequired

setRequired

getControlName

setControlName

isDisabled

setDisabled

setPlaceholder

getPlaceholder

setText

getText

getValue

getValue

setValue

getConfiguration

setConfiguration

elementStream

addCssClass

removeCssClass

setAttributes

setAttribute

addAttributes

removeAttribute

setName

setCustomTemplate

setElementType

addChild

addChildren

addFirstChild

clearChildren

apply

applyUnsafe

setTagName

set

remove