com.foreach.across.modules.bootstrapui.elements

Class FormGroupElement

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

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 FormGroupElement
extends com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

A form group element usually represents a single form control, with associated label and description texts. It is a helper for automatic styling of forms based on a general form layout.

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

Constructor Summary

Constructors

Constructor and Description
FormGroupElement()

Method Summary

Modifier and Type	Method and Description
FormGroupElement	addAttributes(Map<String,Object> attributes)
FormGroupElement	addChild(com.foreach.across.modules.web.ui.ViewElement element)
FormGroupElement	addChildren(Collection<? extends com.foreach.across.modules.web.ui.ViewElement> elements)
FormGroupElement	addCssClass(String... cssClass)
FormGroupElement	addFirstChild(com.foreach.across.modules.web.ui.ViewElement element)
FormGroupElement	apply(Consumer<com.foreach.across.modules.web.ui.elements.ContainerViewElement> consumer)
<U extends com.foreach.across.modules.web.ui.ViewElement> FormGroupElement	applyUnsafe(Consumer<U> consumer)
FormGroupElement	clearChildren()
Stream<com.foreach.across.modules.web.ui.ViewElement>	elementStream()
<V extends com.foreach.across.modules.web.ui.ViewElement> V	getControl(Class<V> elementType)
<V extends com.foreach.across.modules.web.ui.ViewElement> V	getDescriptionBlock(Class<V> elementType)
<V extends com.foreach.across.modules.web.ui.ViewElement> V	getHelpBlock(Class<V> elementType)
<V extends com.foreach.across.modules.web.ui.ViewElement> V	getLabel(Class<V> elementType)
<V extends com.foreach.across.modules.web.ui.ViewElement> V	getTooltip(Class<V> elementType)
FormGroupElement	remove(com.foreach.across.modules.web.ui.ViewElement.WitherRemover... functions)
FormGroupElement	removeAttribute(String attributeName)
boolean	removeChild(com.foreach.across.modules.web.ui.ViewElement element)
FormGroupElement	removeCssClass(String... cssClass)
FormGroupElement	set(com.foreach.across.modules.web.ui.ViewElement.WitherSetter... setters)
FormGroupElement	setAttribute(String attributeName, Object attributeValue)
FormGroupElement	setAttributes(Map<String,Object> attributes)
FormGroupElement	setCustomTemplate(String customTemplate)
protected FormGroupElement	setElementType(String elementType)
FormGroupElement	setFieldErrorsToShow(String... fieldNames) Additional field names for which errors should be detected from the bound object.
FormGroupElement	setHtmlId(String htmlId)
FormGroupElement	setName(String name)
protected FormGroupElement	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

find, find, findAll, findAll, findAll, findOrSelf, findOrSelf, flatStream, getChildren, getCustomTemplate, getElementType, getName, hasChildren, removeAllFromTree, 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

Constructor Detail

FormGroupElement

public FormGroupElement()

Method Detail

getLabel

public <V extends com.foreach.across.modules.web.ui.ViewElement> V getLabel(Class<V> elementType)

getControl

public <V extends com.foreach.across.modules.web.ui.ViewElement> V getControl(Class<V> elementType)

getHelpBlock

public <V extends com.foreach.across.modules.web.ui.ViewElement> V getHelpBlock(Class<V> elementType)

getDescriptionBlock

public <V extends com.foreach.across.modules.web.ui.ViewElement> V getDescriptionBlock(Class<V> elementType)

getTooltip

public <V extends com.foreach.across.modules.web.ui.ViewElement> V getTooltip(Class<V> elementType)

setFieldErrorsToShow

public FormGroupElement setFieldErrorsToShow(String... fieldNames)

Additional field names for which errors should be detected from the bound object. These errors will be rendered no matter the setting of #isDetectFieldErrors(). The latter will only auto-detect the field errors for the attached control.

The Errors object attached to the bound object will be queried for the field errors with the given names.

Parameters:

fieldNames - field names

elementStream

public Stream<com.foreach.across.modules.web.ui.ViewElement> elementStream()

Overrides:

elementStream in class com.foreach.across.modules.web.ui.elements.ContainerViewElement

removeChild

public boolean removeChild(com.foreach.across.modules.web.ui.ViewElement element)

Overrides:

removeChild in class com.foreach.across.modules.web.ui.elements.ContainerViewElement

addCssClass

public FormGroupElement 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 FormGroupElement 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 FormGroupElement 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 FormGroupElement 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 FormGroupElement 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 FormGroupElement 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 FormGroupElement 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 FormGroupElement 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 FormGroupElement setElementType(String elementType)

Overrides:

setElementType in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

addChild

public FormGroupElement addChild(com.foreach.across.modules.web.ui.ViewElement element)

Overrides:

addChild in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

addChildren

public FormGroupElement 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 FormGroupElement addFirstChild(com.foreach.across.modules.web.ui.ViewElement element)

Overrides:

addFirstChild in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

clearChildren

public FormGroupElement clearChildren()

Overrides:

clearChildren in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

apply

public FormGroupElement 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> FormGroupElement applyUnsafe(Consumer<U> consumer)

Overrides:

applyUnsafe in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setTagName

protected FormGroupElement setTagName(String tagName)

Overrides:

setTagName in class com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement

setHtmlId

public FormGroupElement 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 FormGroupElement 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 FormGroupElement 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