com.foreach.across.modules.bootstrapui.elements.builder

Class OptionsFormElementBuilder

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

com.foreach.across.modules.bootstrapui.elements.builder.OptionsFormElementBuilder

All Implemented Interfaces:

com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement,OptionsFormElementBuilder>, com.foreach.across.modules.web.ui.ViewElementBuilder<com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement>

public class OptionsFormElementBuilder
extends com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement,OptionsFormElementBuilder>

Responsible for building option lists as SELECT, RADIO, TOGGLE or MULTI CHECKBOX. Takes a collection of OptionFormElementBuilders and will apply the global type to them, no matter what type they were originally defined with.

Author:

Arne Vandamme

See Also:

OptionFormElementBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OptionsFormElementBuilder.Type

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 inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

customTemplate, name

Constructor Summary

Constructors

Constructor and Description
OptionsFormElementBuilder()

Method Summary

Modifier and Type	Method and Description
OptionsFormElementBuilder	checkbox() Will generate a multiple checkbox control.
OptionsFormElementBuilder	controlName(String controlName)
protected com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement	createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
OptionsFormElementBuilder	disabled()
OptionsFormElementBuilder	disabled(boolean disabled)
String	getControlName()
OptionsFormElementBuilder.Type	getType()
boolean	isDisabled()
boolean	isMultiple()
boolean	isReadonly()
boolean	isRequired()
OptionsFormElementBuilder	multiple() Will allow multiple options to be selected.
OptionsFormElementBuilder	multiple(boolean multiple) Set if the builder should allow multiple or single options.
OptionsFormElementBuilder	radio() Will generate a radio button list.
OptionsFormElementBuilder	readonly()
OptionsFormElementBuilder	readonly(boolean readonly)
protected void	registerWebResources(com.foreach.across.modules.web.resource.WebResourceRegistry webResourceRegistry)
OptionsFormElementBuilder	required()
OptionsFormElementBuilder	required(boolean required)
OptionsFormElementBuilder	select() Will generate a select box.
OptionsFormElementBuilder	select(SelectFormElementConfiguration configuration) Will generate a boostrap-select box with the given configuration.
OptionsFormElementBuilder	single() Will allow only a single option to be selected.
OptionsFormElementBuilder	toggle() Will generate a toggle button list.

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

apply, 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

Constructor Detail

OptionsFormElementBuilder

public OptionsFormElementBuilder()

Method Detail

isDisabled

public boolean isDisabled()

isReadonly

public boolean isReadonly()

isRequired

public boolean isRequired()

getControlName

public String getControlName()

isMultiple

public boolean isMultiple()

getType

public OptionsFormElementBuilder.Type getType()

multiple

public OptionsFormElementBuilder multiple()

Will allow multiple options to be selected.

Returns:

current builder

single

public OptionsFormElementBuilder single()

Will allow only a single option to be selected.

Returns:

current builder

multiple

public OptionsFormElementBuilder multiple(boolean multiple)

Set if the builder should allow multiple or single options.

Parameters:

multiple - true if multiple options can be selected

Returns:

current builder

checkbox

public OptionsFormElementBuilder checkbox()

Will generate a multiple checkbox control. Checkbox always allows multiple values.

Returns:

current builder

radio

public OptionsFormElementBuilder radio()

Will generate a radio button list. Radio button list never allows multiple values.

Returns:

current builder

toggle

public OptionsFormElementBuilder toggle()

Will generate a toggle button list. Toggle always allows multiple values.

Returns:

current builder

select

public OptionsFormElementBuilder select()

Will generate a select box.

Returns:

current builder

select

public OptionsFormElementBuilder select(SelectFormElementConfiguration configuration)

Will generate a boostrap-select box with the given configuration. If the configuration is null, will revert to a regular select box.

Returns:

current builder

controlName

public OptionsFormElementBuilder controlName(String controlName)

disabled

public OptionsFormElementBuilder disabled()

disabled

public OptionsFormElementBuilder disabled(boolean disabled)

required

public OptionsFormElementBuilder required()

required

public OptionsFormElementBuilder required(boolean required)

readonly

public OptionsFormElementBuilder readonly()

readonly

public OptionsFormElementBuilder readonly(boolean readonly)

createElement

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

Specified by:

createElement in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement,OptionsFormElementBuilder>

registerWebResources

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

Overrides:

registerWebResources in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<com.foreach.across.modules.web.ui.elements.AbstractNodeViewElement,OptionsFormElementBuilder>