FormViewElement (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.FormViewElement

All Implemented Interfaces:

com.foreach.across.modules.web.ui.elements.HtmlViewElement, com.foreach.across.modules.web.ui.MutableViewElement, com.foreach.across.modules.web.ui.ViewElement
```
public class FormViewElement
extends com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
```
Represents a HTML form element, supporting a Bootstrap FormLayout that will automatically be applied to all controls of the form that do not have a separate layout specified.

Author:

Arne Vandamme

Nested Class Summary
- 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 ELEMENT_TYPE

static String ENCTYPE_MULTIPART

static String ENCTYPE_PLAIN

static String ENCTYPE_URLENCODED

Fields
Modifier and Type	Field and Description
`static String`	`ELEMENT_TYPE`
`static String`	`ENCTYPE_MULTIPART`
`static String`	`ENCTYPE_PLAIN`
`static String`	`ENCTYPE_URLENCODED`

Constructor Summary

Constructors
Constructor and Description

FormViewElement()

Constructors
Constructor and Description
`FormViewElement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FormViewElement`	`addAttributes(Map<String,Object> attributes)`
`FormViewElement`	`addChild(com.foreach.across.modules.web.ui.ViewElement element)`
`FormViewElement`	`addChildren(Collection<? extends com.foreach.across.modules.web.ui.ViewElement> elements)`
`FormViewElement`	`addCssClass(String... cssClass)`
`FormViewElement`	`addFirstChild(com.foreach.across.modules.web.ui.ViewElement element)`
`FormViewElement`	`apply(Consumer<com.foreach.across.modules.web.ui.elements.ContainerViewElement> consumer)`
`<U extends com.foreach.across.modules.web.ui.ViewElement> FormViewElement`	`applyUnsafe(Consumer<U> consumer)`
`FormViewElement`	`clearChildren()`
`String`	`getAcceptCharSet()`
`String`	`getAction()`
`String`	`getCommandAttribute()`
`String`	`getEncType()`
`FormLayout`	`getFormLayout()`
`String`	`getFormName()`
`org.springframework.http.HttpMethod`	`getMethod()`
`boolean`	`isAutoComplete()`
`boolean`	`isNoValidate()`
`FormViewElement`	`remove(com.foreach.across.modules.web.ui.ViewElement.WitherRemover... functions)`
`FormViewElement`	`removeAttribute(String attributeName)`
`FormViewElement`	`removeCssClass(String... cssClass)`
`FormViewElement`	`set(com.foreach.across.modules.web.ui.ViewElement.WitherSetter... setters)`
`FormViewElement`	`setAcceptCharSet(String charSet)`
`FormViewElement`	`setAction(String url)`
`FormViewElement`	`setAttribute(String attributeName, Object attributeValue)`
`FormViewElement`	`setAttributes(Map<String,Object> attributes)`
`FormViewElement`	`setAutoComplete(boolean autoComplete)`
`FormViewElement`	`setCommandAttribute(String commandAttribute)` Set the attribute name of the command object that this form is for.
`FormViewElement`	`setCustomTemplate(String customTemplate)`
`protected FormViewElement`	`setElementType(String elementType)`
`FormViewElement`	`setEncType(String encType)` Set encoding type (enctype attribute) to use for this form.
`FormViewElement`	`setFormLayout(FormLayout formLayout)` Set the `FormLayout` that should be applied to all `FormGroupElement` members of this form.
`FormViewElement`	`setFormName(String name)` Set the HTML name attribute of this form.
`FormViewElement`	`setHtmlId(String htmlId)`
`FormViewElement`	`setMethod(org.springframework.http.HttpMethod httpMethod)`
`FormViewElement`	`setName(String name)`
`FormViewElement`	`setNoValidate(boolean noValidate)`
`protected FormViewElement`	`setTagName(String tagName)`

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

Methods inherited from class com.foreach.across.modules.web.ui.elements.ContainerViewElement
elementStream, 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.ViewElement
getCustomTemplate, getElementType, getName, matches, predicateFor, with

- Field Detail
  - ELEMENT_TYPE
```
public static final String ELEMENT_TYPE
```
    See Also:
    
    Constant Field Values
  - ENCTYPE_PLAIN
```
public static final String ENCTYPE_PLAIN
```
    See Also:
    
    Constant Field Values
  - ENCTYPE_MULTIPART
```
public static final String ENCTYPE_MULTIPART
```
    See Also:
    
    Constant Field Values
  - ENCTYPE_URLENCODED
```
public static final String ENCTYPE_URLENCODED
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FormViewElement
```
public FormViewElement()
```
- Method Detail
  - getFormLayout
```
public FormLayout getFormLayout()
```
  - setFormLayout
```
public FormViewElement setFormLayout(FormLayout formLayout)
```
    Set the FormLayout that should be applied to all FormGroupElement members of this form. Also set the corresponding class.
    
    Parameters:
    
    formLayout - instance
  - getCommandAttribute
```
public String getCommandAttribute()
```
  - setCommandAttribute
```
public FormViewElement setCommandAttribute(String commandAttribute)
```
    Set the attribute name of the command object that this form is for. All form groups within this form will have the control names prefixed and field errors bound. This is basically the equivalent of putting a th:object attribute on an element in Thymeleaf.
    
    Parameters:
    
    commandAttribute - instance
  - getMethod
```
public org.springframework.http.HttpMethod getMethod()
```
  - setMethod
```
public FormViewElement setMethod(org.springframework.http.HttpMethod httpMethod)
```
  - getAction
```
public String getAction()
```
  - setAction
```
public FormViewElement setAction(String url)
```
  - setName
```
public FormViewElement 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
  - getFormName
```
public String getFormName()
```
    Returns:
    
    name attribute of the form
  - setFormName
```
public FormViewElement setFormName(String name)
```
    Set the HTML name attribute of this form. Defaults to ContainerViewElement.getName().
    
    Parameters:
    
    name - attribute to use
  - getEncType
```
public String getEncType()
```
  - setEncType
```
public FormViewElement setEncType(String encType)
```
    Set encoding type (enctype attribute) to use for this form.
    
    Parameters:
    
    encType - value
  - getAcceptCharSet
```
public String getAcceptCharSet()
```
  - setAcceptCharSet
```
public FormViewElement setAcceptCharSet(String charSet)
```
  - isAutoComplete
```
public boolean isAutoComplete()
```
  - setAutoComplete
```
public FormViewElement setAutoComplete(boolean autoComplete)
```
  - isNoValidate
```
public boolean isNoValidate()
```
  - setNoValidate
```
public FormViewElement setNoValidate(boolean noValidate)
```
  - addCssClass
```
public FormViewElement 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 FormViewElement 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 FormViewElement 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 FormViewElement 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 FormViewElement 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 FormViewElement 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
  - setCustomTemplate
```
public FormViewElement 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 FormViewElement setElementType(String elementType)
```
    Overrides:
    
    setElementType in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - addChild
```
public FormViewElement addChild(com.foreach.across.modules.web.ui.ViewElement element)
```
    Overrides:
    
    addChild in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - addChildren
```
public FormViewElement 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 FormViewElement addFirstChild(com.foreach.across.modules.web.ui.ViewElement element)
```
    Overrides:
    
    addFirstChild in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - clearChildren
```
public FormViewElement clearChildren()
```
    Overrides:
    
    clearChildren in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - apply
```
public FormViewElement 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> FormViewElement applyUnsafe(Consumer<U> consumer)
```
    Overrides:
    
    applyUnsafe in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setTagName
```
protected FormViewElement setTagName(String tagName)
```
    Overrides:
    
    setTagName in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement
  - setHtmlId
```
public FormViewElement 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
  - set
```
public FormViewElement 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 FormViewElement 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 FormViewElement

Nested Class Summary

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.ViewElement

Field Detail

ELEMENT_TYPE

ENCTYPE_PLAIN

ENCTYPE_MULTIPART

ENCTYPE_URLENCODED

Constructor Detail

FormViewElement

Method Detail

getFormLayout

setFormLayout

getCommandAttribute

setCommandAttribute

getMethod

setMethod

getAction

setAction

setName

getFormName

setFormName

getEncType

setEncType

getAcceptCharSet

setAcceptCharSet

isAutoComplete

setAutoComplete

isNoValidate

setNoValidate

addCssClass

removeCssClass

setAttributes

setAttribute

addAttributes

removeAttribute

setCustomTemplate

setElementType

addChild

addChildren

addFirstChild

clearChildren

apply

applyUnsafe

setTagName

setHtmlId

set

remove