OptionFormElementBuilder (Bootstrap UI Module 3.1.0.RELEASE API)

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<T,SELF>
    - - com.foreach.across.modules.bootstrapui.elements.builder.FormControlElementBuilderSupport<T,OptionFormElementBuilder<T>>
      - com.foreach.across.modules.bootstrapui.elements.builder.OptionFormElementBuilder<T>

All Implemented Interfaces:

com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<T,OptionFormElementBuilder<T>>, com.foreach.across.modules.web.ui.ViewElementBuilder<T>, Comparable<OptionFormElementBuilder>
```
public class OptionFormElementBuilder<T extends FormControlElementSupport>
extends FormControlElementBuilderSupport<T,OptionFormElementBuilder<T>>
implements Comparable<OptionFormElementBuilder>
```
Responsible for building a single CheckboxFormElement, RadioFormElement or SelectFormElement.Option.

If built within an OptionsFormElementBuilder the type of the option will be determined by the options builder, as well as all properties not set on the individual option level.

Author:

Arne Vandamme

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

OptionFormElementBuilder()

Constructors
Constructor and Description
`OptionFormElementBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OptionFormElementBuilder<T>`	`add(com.foreach.across.modules.web.ui.ViewElement... viewElements)`
`OptionFormElementBuilder<T>`	`add(com.foreach.across.modules.web.ui.ViewElementBuilder... viewElements)`
`OptionFormElementBuilder<T>`	`addAll(Iterable<?> viewElements)`
`OptionFormElementBuilder<T>`	`attribute(String name, Object value)`
`OptionFormElementBuilder<T>`	`attributes(Map<String,Object> attributes)`
`OptionFormElementBuilder<T>`	`checkbox()`
`OptionFormElementBuilder<T>`	`clearAttributes()`
`int`	`compareTo(OptionFormElementBuilder o)`
`OptionFormElementBuilder<T>`	`controlName(String controlName)`
`protected T`	`createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)`
`OptionFormElementBuilder<T>`	`customTemplate(String template)`
`OptionFormElementBuilder<T>`	`disabled()`
`OptionFormElementBuilder<T>`	`disabled(boolean disabled)`
`String`	`getLabel()`
`Object`	`getRawValue()`
`String`	`getText()`
`OptionsFormElementBuilder.Type`	`getType()`
`Object`	`getValue()`
`OptionFormElementBuilder<T>`	`htmlId(String htmlId)`
`boolean`	`isSelected()`
`boolean`	`isWrapped()`
`OptionFormElementBuilder<T>`	`label(String label)`
`OptionFormElementBuilder<T>`	`name(String name)`
`OptionFormElementBuilder<T>`	`postProcessor(com.foreach.across.modules.web.ui.ViewElementPostProcessor<T> postProcessor)`
`OptionFormElementBuilder<T>`	`radio()`
`OptionFormElementBuilder<T>`	`rawValue(Object value)` Set the raw value that this option represents.
`OptionFormElementBuilder<T>`	`readonly()`
`OptionFormElementBuilder<T>`	`readonly(boolean readonly)`
`OptionFormElementBuilder<T>`	`removeAttribute(String name)`
`OptionFormElementBuilder<T>`	`required()`
`OptionFormElementBuilder<T>`	`required(boolean required)`
`OptionFormElementBuilder<T>`	`selected()`
`OptionFormElementBuilder<T>`	`selected(boolean selected)`
`OptionFormElementBuilder<T>`	`sort(String... elementNames)`
`OptionFormElementBuilder<T>`	`text(String text)`
`OptionFormElementBuilder<T>`	`toggle()`
`OptionFormElementBuilder<T>`	`type(OptionsFormElementBuilder.Type type)`
`OptionFormElementBuilder<T>`	`unwrapped()`
`OptionFormElementBuilder<T>`	`value(Object value)`
`OptionFormElementBuilder<T>`	`with(com.foreach.across.modules.web.ui.ViewElement.WitherSetter... setters)`
`OptionFormElementBuilder<T>`	`wrapped(boolean wrapped)`

Methods inherited from class com.foreach.across.modules.bootstrapui.elements.builder.FormControlElementBuilderSupport
apply, getControlName, getDisabled, getReadonly, getRequired

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

Methods inherited from class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport
addFirst, addFirst

Methods inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport
build, configure, elementSupplier, elementSupplier, postProcess, registerWebResources

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
  - OptionFormElementBuilder
```
public OptionFormElementBuilder()
```
- Method Detail
  - isSelected
```
public boolean isSelected()
```
  - isWrapped
```
public boolean isWrapped()
```
  - getText
```
public String getText()
```
  - getLabel
```
public String getLabel()
```
  - getValue
```
public Object getValue()
```
  - getRawValue
```
public Object getRawValue()
```
    Returns:
    
    the raw value (for example entity) that this option represents
  - getType
```
public OptionsFormElementBuilder.Type getType()
```
  - checkbox
```
public OptionFormElementBuilder<T> checkbox()
```
  - radio
```
public OptionFormElementBuilder<T> radio()
```
  - toggle
```
public OptionFormElementBuilder<T> toggle()
```
  - type
```
public OptionFormElementBuilder<T> type(OptionsFormElementBuilder.Type type)
```
  - selected
```
public OptionFormElementBuilder<T> selected()
```
  - unwrapped
```
public OptionFormElementBuilder<T> unwrapped()
```
  - wrapped
```
public OptionFormElementBuilder<T> wrapped(boolean wrapped)
```
  - selected
```
public OptionFormElementBuilder<T> selected(boolean selected)
```
  - text
```
public OptionFormElementBuilder<T> text(String text)
```
  - label
```
public OptionFormElementBuilder<T> label(String label)
```
  - rawValue
```
public OptionFormElementBuilder<T> rawValue(Object value)
```
    Set the raw value that this option represents. This value will not be attached to the actual generated form element but can be used to bulk select options.
    
    Parameters:
    
    value - raw value (for example entity)
    
    Returns:
    
    current builder
  - value
```
public OptionFormElementBuilder<T> value(Object value)
```
  - controlName
```
public OptionFormElementBuilder<T> controlName(String controlName)
```
    Overrides:
    
    controlName in class FormControlElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - disabled
```
public OptionFormElementBuilder<T> disabled()
```
    Overrides:
    
    disabled in class FormControlElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - disabled
```
public OptionFormElementBuilder<T> disabled(boolean disabled)
```
    Overrides:
    
    disabled in class FormControlElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - required
```
public OptionFormElementBuilder<T> required()
```
    Overrides:
    
    required in class FormControlElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - required
```
public OptionFormElementBuilder<T> required(boolean required)
```
    Overrides:
    
    required in class FormControlElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - readonly
```
public OptionFormElementBuilder<T> readonly()
```
    Overrides:
    
    readonly in class FormControlElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - readonly
```
public OptionFormElementBuilder<T> readonly(boolean readonly)
```
    Overrides:
    
    readonly in class FormControlElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - htmlId
```
public OptionFormElementBuilder<T> htmlId(String htmlId)
```
    Specified by:
    
    htmlId in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
    
    Overrides:
    
    htmlId in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - attribute
```
public OptionFormElementBuilder<T> attribute(String name,
                                             Object value)
```
    Specified by:
    
    attribute in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
    
    Overrides:
    
    attribute in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - attributes
```
public OptionFormElementBuilder<T> attributes(Map<String,Object> attributes)
```
    Specified by:
    
    attributes in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
    
    Overrides:
    
    attributes in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - removeAttribute
```
public OptionFormElementBuilder<T> removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
    
    Overrides:
    
    removeAttribute in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - clearAttributes
```
public OptionFormElementBuilder<T> clearAttributes()
```
    Specified by:
    
    clearAttributes in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
    
    Overrides:
    
    clearAttributes in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - add
```
public OptionFormElementBuilder<T> add(com.foreach.across.modules.web.ui.ViewElement... viewElements)
```
    Overrides:
    
    add in class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - add
```
public OptionFormElementBuilder<T> add(com.foreach.across.modules.web.ui.ViewElementBuilder... viewElements)
```
    Overrides:
    
    add in class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - addAll
```
public OptionFormElementBuilder<T> addAll(Iterable<?> viewElements)
```
    Overrides:
    
    addAll in class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - sort
```
public OptionFormElementBuilder<T> sort(String... elementNames)
```
    Overrides:
    
    sort in class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - name
```
public OptionFormElementBuilder<T> name(String name)
```
    Overrides:
    
    name in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - customTemplate
```
public OptionFormElementBuilder<T> customTemplate(String template)
```
    Overrides:
    
    customTemplate in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - postProcessor
```
public OptionFormElementBuilder<T> postProcessor(com.foreach.across.modules.web.ui.ViewElementPostProcessor<T> postProcessor)
```
    Overrides:
    
    postProcessor in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - with
```
public OptionFormElementBuilder<T> with(com.foreach.across.modules.web.ui.ViewElement.WitherSetter... setters)
```
    Overrides:
    
    with in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>
  - compareTo
```
public int compareTo(OptionFormElementBuilder o)
```
    Specified by:
    
    compareTo in interface Comparable<OptionFormElementBuilder>
  - createElement
```
protected T createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
```
    Specified by:
    
    createElement in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<T extends FormControlElementSupport,OptionFormElementBuilder<T extends FormControlElementSupport>>

Class OptionFormElementBuilder<T extends FormControlElementSupport>

Nested Class Summary

Nested classes/interfaces inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

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

Field Summary

Fields inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

Constructor Summary

Method Summary

Methods inherited from class com.foreach.across.modules.bootstrapui.elements.builder.FormControlElementBuilderSupport

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

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

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

OptionFormElementBuilder

Method Detail

isSelected

isWrapped

getText

getLabel

getValue

getRawValue

getType

checkbox

radio

toggle

type

selected

unwrapped

wrapped

selected

text

label

rawValue

value

controlName

disabled

disabled

required

required

readonly

readonly

htmlId

attribute

attributes

removeAttribute

clearAttributes

add

add

addAll

sort

name

customTemplate

postProcessor

with

compareTo

createElement