TextboxFormElementBuilder (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<TextboxFormElement,TextboxFormElementBuilder>
      - com.foreach.across.modules.bootstrapui.elements.builder.TextboxFormElementBuilder

All Implemented Interfaces:

com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>, com.foreach.across.modules.web.ui.ViewElementBuilder<TextboxFormElement>
```
public class TextboxFormElementBuilder
extends FormControlElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
```
Reponsible for building both TextboxFormElement and TextareaFormElement.

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

TextboxFormElementBuilder()

Constructors
Constructor and Description
`TextboxFormElementBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TextboxFormElementBuilder`	`add(com.foreach.across.modules.web.ui.ViewElement... viewElements)`
`TextboxFormElementBuilder`	`add(com.foreach.across.modules.web.ui.ViewElementBuilder... viewElements)`
`TextboxFormElementBuilder`	`addAll(Iterable<?> viewElements)`
`TextboxFormElementBuilder`	`attribute(String name, Object value)`
`TextboxFormElementBuilder`	`attributes(Map<String,Object> attributes)`
`TextboxFormElementBuilder`	`autoSize()` Set the textbox to resize automatically.
`TextboxFormElementBuilder`	`autoSize(boolean autoSize)` Set the textbox to resize automatically or not.
`TextboxFormElementBuilder`	`clearAttributes()`
`TextboxFormElementBuilder`	`controlName(String controlName)`
`protected TextboxFormElement`	`createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)`
`TextboxFormElementBuilder`	`customTemplate(String template)`
`TextboxFormElementBuilder`	`disabled()`
`TextboxFormElementBuilder`	`disabled(boolean disabled)`
`TextboxFormElementBuilder`	`disableLineBreaks()` Indicate the textbox should not accept line-breaks (ENTER keys).
`TextboxFormElementBuilder`	`disableLineBreaks(boolean disableLineBreaks)` Indicate the textbox should not accept line-breaks (ENTER keys).
`TextboxFormElementBuilder`	`htmlId(String htmlId)`
`TextboxFormElementBuilder`	`maxLength(Integer maxLength)` Set the maxlength attribute.
`TextboxFormElementBuilder`	`multiLine()` Will create a textarea element.
`TextboxFormElementBuilder`	`multiLine(boolean multiLine)` Should a textarea element be created.
`TextboxFormElementBuilder`	`multiLine(int rows)` Will create a textarea element with the set number of rows.
`TextboxFormElementBuilder`	`name(String name)`
`TextboxFormElementBuilder`	`password()` Will create a password type element.
`TextboxFormElementBuilder`	`placeholder(String placeholder)`
`TextboxFormElementBuilder`	`postProcessor(com.foreach.across.modules.web.ui.ViewElementPostProcessor<TextboxFormElement> postProcessor)`
`TextboxFormElementBuilder`	`readonly()`
`TextboxFormElementBuilder`	`readonly(boolean readonly)`
`protected void`	`registerWebResources(com.foreach.across.modules.web.resource.WebResourceRegistry webResourceRegistry)`
`TextboxFormElementBuilder`	`removeAttribute(String name)`
`TextboxFormElementBuilder`	`required()`
`TextboxFormElementBuilder`	`required(boolean required)`
`TextboxFormElementBuilder`	`rows(int rows)` Will switch to creating a textarea element with the set number of rows.
`TextboxFormElementBuilder`	`sort(String... elementNames)`
`TextboxFormElementBuilder`	`text(String text)`
`TextboxFormElementBuilder`	`type(TextboxFormElement.Type type)`

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, 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
  - TextboxFormElementBuilder
```
public TextboxFormElementBuilder()
```
- Method Detail
  - multiLine
```
public TextboxFormElementBuilder multiLine()
```
    Will create a textarea element.
    
    Returns:
    
    current builder
  - multiLine
```
public TextboxFormElementBuilder multiLine(boolean multiLine)
```
    Should a textarea element be created.
    
    Parameters:
    
    multiLine - true if a textarea should be created
    
    Returns:
    
    current builder
  - multiLine
```
public TextboxFormElementBuilder multiLine(int rows)
```
    Will create a textarea element with the set number of rows.
    
    Returns:
    
    current builder
  - autoSize
```
public TextboxFormElementBuilder autoSize()
```
    Set the textbox to resize automatically. This will cause a TextareaFormElement to be rendered if the type remains text.
    
    Returns:
    
    current builder
  - autoSize
```
public TextboxFormElementBuilder autoSize(boolean autoSize)
```
    Set the textbox to resize automatically or not.
    
    Parameters:
    
    autoSize - true if box should resize automatically
    
    Returns:
    
    current builder
  - disableLineBreaks
```
public TextboxFormElementBuilder disableLineBreaks()
```
    Indicate the textbox should not accept line-breaks (ENTER keys). This will set the TextboxFormElement.CSS_DISABLE_LINE_BREAKS css class. The actual support relies on the right javascript being registered.
    
    Returns:
    
    current builder
  - disableLineBreaks
```
public TextboxFormElementBuilder disableLineBreaks(boolean disableLineBreaks)
```
    Indicate the textbox should not accept line-breaks (ENTER keys). This will set the TextboxFormElement.CSS_DISABLE_LINE_BREAKS css class. The actual support relies on the right javascript being registered.
    
    Parameters:
    
    disableLineBreaks - true if line breaks should be disabled
    
    Returns:
    
    current builder
  - maxLength
```
public TextboxFormElementBuilder maxLength(Integer maxLength)
```
    Set the maxlength attribute. Usually only applies to non-textarea elements.
    
    Parameters:
    
    maxLength - maximum allowed length of the value
    
    Returns:
    
    current builder
  - password
```
public TextboxFormElementBuilder password()
```
    Will create a password type element.
    
    Returns:
    
    current builder
  - type
```
public TextboxFormElementBuilder type(TextboxFormElement.Type type)
```
  - placeholder
```
public TextboxFormElementBuilder placeholder(String placeholder)
```
  - text
```
public TextboxFormElementBuilder text(String text)
```
  - rows
```
public TextboxFormElementBuilder rows(int rows)
```
    Will switch to creating a textarea element with the set number of rows.
    
    Parameters:
    
    rows - Number of rows to display.
    
    Returns:
    
    current builder
  - controlName
```
public TextboxFormElementBuilder controlName(String controlName)
```
    Overrides:
    
    controlName in class FormControlElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - disabled
```
public TextboxFormElementBuilder disabled()
```
    Overrides:
    
    disabled in class FormControlElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - disabled
```
public TextboxFormElementBuilder disabled(boolean disabled)
```
    Overrides:
    
    disabled in class FormControlElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - readonly
```
public TextboxFormElementBuilder readonly()
```
    Overrides:
    
    readonly in class FormControlElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - readonly
```
public TextboxFormElementBuilder readonly(boolean readonly)
```
    Overrides:
    
    readonly in class FormControlElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - required
```
public TextboxFormElementBuilder required()
```
    Overrides:
    
    required in class FormControlElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - required
```
public TextboxFormElementBuilder required(boolean required)
```
    Overrides:
    
    required in class FormControlElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - htmlId
```
public TextboxFormElementBuilder htmlId(String htmlId)
```
    Specified by:
    
    htmlId in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
    
    Overrides:
    
    htmlId in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
  - attribute
```
public TextboxFormElementBuilder attribute(String name,
                                           Object value)
```
    Specified by:
    
    attribute in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
    
    Overrides:
    
    attribute in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
  - attributes
```
public TextboxFormElementBuilder attributes(Map<String,Object> attributes)
```
    Specified by:
    
    attributes in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
    
    Overrides:
    
    attributes in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
  - removeAttribute
```
public TextboxFormElementBuilder removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
    
    Overrides:
    
    removeAttribute in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
  - clearAttributes
```
public TextboxFormElementBuilder clearAttributes()
```
    Specified by:
    
    clearAttributes in interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
    
    Overrides:
    
    clearAttributes in class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<TextboxFormElement,TextboxFormElementBuilder>
  - add
```
public TextboxFormElementBuilder add(com.foreach.across.modules.web.ui.ViewElement... viewElements)
```
    Overrides:
    
    add in class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - add
```
public TextboxFormElementBuilder add(com.foreach.across.modules.web.ui.ViewElementBuilder... viewElements)
```
    Overrides:
    
    add in class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - addAll
```
public TextboxFormElementBuilder addAll(Iterable<?> viewElements)
```
    Overrides:
    
    addAll in class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - sort
```
public TextboxFormElementBuilder sort(String... elementNames)
```
    Overrides:
    
    sort in class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - name
```
public TextboxFormElementBuilder name(String name)
```
    Overrides:
    
    name in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - customTemplate
```
public TextboxFormElementBuilder customTemplate(String template)
```
    Overrides:
    
    customTemplate in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - postProcessor
```
public TextboxFormElementBuilder postProcessor(com.foreach.across.modules.web.ui.ViewElementPostProcessor<TextboxFormElement> postProcessor)
```
    Overrides:
    
    postProcessor in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - createElement
```
protected TextboxFormElement createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
```
    Specified by:
    
    createElement in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>
  - registerWebResources
```
protected void registerWebResources(com.foreach.across.modules.web.resource.WebResourceRegistry webResourceRegistry)
```
    Overrides:
    
    registerWebResources in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<TextboxFormElement,TextboxFormElementBuilder>

Class TextboxFormElementBuilder

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

TextboxFormElementBuilder

Method Detail

multiLine

multiLine

multiLine

autoSize

autoSize

disableLineBreaks

disableLineBreaks

maxLength

password

type

placeholder

text

rows

controlName

disabled

disabled

readonly

readonly

required

required

htmlId

attribute

attributes

removeAttribute

clearAttributes

add

add

addAll

sort

name

customTemplate

postProcessor

createElement

registerWebResources