ValueBox (domino-ui 1.0.0-RC13 API)

java.lang.Object
- org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLElement,T>
- - org.dominokit.domino.ui.forms.BasicFormElement<T,V>
  - - org.dominokit.domino.ui.forms.ValueBox<T,E,V>

Type Parameters:

T - The type of the component extending form this class

E - The type of the HTML element that represent the root element of the component

V - The type of the component value

All Implemented Interfaces:

FormElement<T,V>, HasGrouping<T>, HasInputElement, DominoStyle<elemental2.dom.HTMLElement,T,T>, Focusable<T>, HasAutoValidation<T>, HasChangeHandlers<T,V>, HasChildren<T>, HasHelperText<T>, HasLabel<T>, HasName<T>, HasPlaceHolder<T>, HasValidation<T>, HasValue<T,V>, HasWavesElement, IsCollapsible<T>, IsReadOnly<T>, IsRequired<T>, Switchable<T>, org.gwtproject.editor.client.Editor<V>, org.gwtproject.editor.client.HasEditorErrors<V>, org.gwtproject.editor.client.LeafValueEditor<V>, org.gwtproject.editor.client.TakesValue<V>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

Direct Known Subclasses:

AbstractValueBox, DateBox, InputTimeBox, TimeBox
```
public abstract class ValueBox<T extends ValueBox<T,E,V>,E extends elemental2.dom.HTMLElement,V>
extends BasicFormElement<T,V>
implements Focusable<T>, HasPlaceHolder<T>, IsReadOnly<T>, HasChangeHandlers<T,V>
```
A base implementation for form elements that can have a value with extra features like focus, placeholders, change handlers

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ValueBox.AutoValidate` Implementations of this interface will apply the validations for a component
`static class`	`ValueBox.AutoValidator` A class to wrap an `ValueBox.AutoValidate` and provide the ability to attach/remove it from a component

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.BasicFormElement
BasicFormElement.FieldHandler<T>

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement
BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasChangeHandlers
HasChangeHandlers.ChangeHandler<V>

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasValidation
HasValidation.Validator

Nested classes/interfaces inherited from interface org.gwtproject.editor.client.Editor
org.gwtproject.editor.client.Editor.Ignore, org.gwtproject.editor.client.Editor.Path

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<HasChangeHandlers.ChangeHandler<? super V>>`	`changeHandlers`
`protected elemental2.dom.EventListener`	`changeListener`
`static String`	`DISABLED` Constant css class name for a focused component
`protected DominoElement<elemental2.dom.HTMLDivElement>`	`fieldContainer`
`protected DominoElement<elemental2.dom.HTMLDivElement>`	`fieldGroup`
`static String`	`FLOATING` Constant css class name for a component that has its labels floating above it
`static String`	`FOCUSED` Constant css class name for a focused component
`protected FlexItem<elemental2.dom.HTMLDivElement>`	`inputContainer`
`protected elemental2.dom.EventListener`	`inputListener`

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement
element

Constructor Summary

Constructors
Constructor and Description

ValueBox(String type, String label)

Constructors
Constructor and Description
`ValueBox(String type, String label)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`addChangeHandler(HasChangeHandlers.ChangeHandler<? super V> changeHandler)`
`T`	`addLeftAddOn(FlexItem<?> addon)` Adds an element as an add on to the component at left side
`T`	`addLeftAddOn(org.jboss.elemento.IsElement<?> addon)` wrap the element in a `FlexItem` and delegate to `addLeftAddOn(FlexItem)`
`T`	`addLeftAddOn(elemental2.dom.Node addon)` wrap the node in a `FlexItem` and delegate to `addLeftAddOn(FlexItem)`
`T`	`addOnClearHandler(Consumer<T> onClearHandler)` Adds a handler that will be called when the field value is cleared
`T`	`addRightAddOn(FlexItem<?> rightAddon)` Adds an element as an add on to the component at left side
`T`	`addRightAddOn(org.jboss.elemento.IsElement<?> addon)` wrap the element in a `FlexItem` and delegate to `addRightAddOn(FlexItem)`
`T`	`addRightAddOn(elemental2.dom.Node addon)` wrap the node in a `FlexItem` and delegate to `addRightAddOn(FlexItem)`
`protected boolean`	`allowEmptyLabel()`
`T`	`asTableField()` flag the field to be used inside a table row
`protected void`	`autoValidate()` validate the component if auto validation is enabled
`protected void`	`callChangeHandlers()` manually call the change handlers if they are not paused
`protected void`	`changeLabelFloating()` Changes the label floating state when the field get focus or lose focus
`T`	`clear()` Clears the field value and trigger the change handlers
`T`	`clear(boolean silent)` Clears the field value and only triggers the change handlers if silent flag is true
`T`	`clearInvalid()` Removes all error messages and mark the component as valid
`protected void`	`clearValue()` clear the field value
`protected abstract void`	`clearValue(boolean silent)` clear the field value
`T`	`condense()` Reduces the vertical spaces for this component to reduce its height
`protected abstract ValueBox.AutoValidator`	`createAutoValidator(ValueBox.AutoValidate autoValidate)` Create an AutoValidator that will automatically validate the component when it loses focus
`protected abstract E`	`createInputElement(String type)` Creates an input element with the specified type
`protected DominoElement<elemental2.dom.HTMLLabelElement>`	`createLabelElement()` create the label element for this component
`protected DominoElement<elemental2.dom.HTMLDivElement>`	`createMandatoryAddOn()`
`T`	`disable()`
`protected void`	`doFocus()` Focus the element and apply focus styles
`protected abstract void`	`doSetValue(V value)`
`protected void`	`doUnfocus()` un-focus the component and remove the focus styles
`elemental2.dom.HTMLElement`	`element()`
`T`	`enable()`
`T`	`floating()` Make the label always floating over the field even if the value is empty
`protected void`	`floatLabel()` Make the label float over the component
`T`	`focus()` focus the component
`DominoElement<elemental2.dom.HTMLDivElement>`	`getAdditionalInfoContainer()`
`FlexItem`	`getCountItem()`
`FlexItem`	`getErrorItem()`
`protected DominoElement<elemental2.dom.HTMLElement>`	`getErrorsContainer()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getFieldContainer()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getFieldGroup()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getFieldInputContainer()`
`FieldStyle`	`getFieldStyle()`
`Color`	`getFocusColor()`
`protected DominoElement<elemental2.dom.HTMLElement>`	`getHelperContainer()`
`FlexItem`	`getHelpItem()`
`FlexItem`	`getInputContainer()`
`DominoElement<E>`	`getInputElement()`
`Optional<DominoElement<elemental2.dom.HTMLLabelElement>>`	`getLabelElement()`
`Optional<DominoElement<elemental2.dom.HTMLElement>>`	`getLabelTextElement()`
`FlexLayout`	`getLeftAddonContainer()`
`FlexLayout`	`getLeftAddOnsContainer()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getMandatoryAddOn()`
`DominoElement<elemental2.dom.HTMLDivElement>`	`getNotesContainer()`
`List<Consumer<T>>`	`getOnClearHandlers()`
`String`	`getPlaceholder()`
`String`	`getPostfix()`
`FlexItem`	`getPostFixItem()`
`String`	`getPrefix()`
`FlexItem`	`getPrefixItem()`
`FlexLayout`	`getRightAddonContainer()`
`FlexLayout`	`getRightAddOnsContainer()`
`String`	`getStringValue()`
`V`	`getValue()`
`boolean`	`hasChangeHandler(HasChangeHandlers.ChangeHandler<? super V> changeHandler)` Checks if a component has the specified ChangeHandler
`T`	`hideLabelText()`
`protected void`	`hidePlaceholder()`
`T`	`invalidate(List<String> errorMessages)` Mark the component as invalid with a list of error messages
`T`	`invalidate(String errorMessage)` Mark the component as invalid with the specified error message
`protected boolean`	`isAddFocusColor()`
`boolean`	`isAutoValidation()`
`boolean`	`isEmpty()`
`boolean`	`isEmptyIgnoreSpaces()`
`boolean`	`isFloating()`
`boolean`	`isFocused()`
`boolean`	`isReadOnly()`
`protected void`	`linkLabelToField()` this will set the attribute for on the label with the field id as a value
`T`	`nonfloating()` Make the label floating over the field only when it has value
`protected void`	`onEnterKey()`
`T`	`pauseChangeHandlers()` Delagete to `setPauseChangeHandlers(boolean)` with value true
`T`	`pauseFocusValidation()` pauses the validation when the field loses focus so they wont trigger
`T`	`removeChangeHandler(HasChangeHandlers.ChangeHandler<? super V> changeHandler)`
`T`	`removeLeftAddOn(FlexItem addon)`
`T`	`removeLeftAddOn(int index)`
`T`	`removeLeftAddOn(org.jboss.elemento.IsElement<?> addon)`
`T`	`removeLeftAddOn(elemental2.dom.Node addon)`
`T`	`removeLeftAddOns()` Remove all left addons
`T`	`removeOnClearHandler(Consumer<T> onClearHandler)`
`T`	`removeRightAddOn(FlexItem addon)`
`T`	`removeRightAddOn(int index)`
`T`	`removeRightAddOn(org.jboss.elemento.IsElement<?> addon)`
`T`	`removeRightAddOn(elemental2.dom.Node addon)`
`T`	`removeRightAddOns()` Remove all right addons
`T`	`resumeChangeHandlers()` Delagete to `setPauseChangeHandlers(boolean)` with value false
`T`	`resumeFocusValidation()` resume the validation when the field loses focus so they trigger
`T`	`setAutoValidation(boolean autoValidation)`
`T`	`setFieldStyle(FieldStyle fieldStyle)` Change the style of the field
`T`	`setFixErrorsPosition(boolean fixPosition)`
`T`	`setFloating(boolean floating)`
`T`	`setFocusColor(Color focusColor)` Set a color to use for focus indicators
`T`	`setLabel(org.jboss.elemento.IsElement<?> element)` Sets the label from an element
`T`	`setLabel(elemental2.dom.Node node)` Sets the label as a custom element
`T`	`setLabel(org.gwtproject.safehtml.shared.SafeHtml safeHtml)` Sets the label from html
`T`	`setLabel(String label)`
`T`	`setLabelTextVisible(boolean visible)` Show/hide the label element text
`T`	`setPauseChangeHandlers(boolean pauseChangeHandlers)` Disable/Enable change handlers
`T`	`setPlaceholder(String placeholder)`
`T`	`setPostFix(String postfix)` Adds a postfix text that will be a mandatory part of the field string value
`T`	`setPrefix(String prefix)` Adds a prefix text that will be a mandatory part of the field string value
`T`	`setReadOnly(boolean readOnly)` set the readonly attribute value
`T`	`setSpellCheck(boolean spellCheck)` Enable/Disable spellcheck for the component, sets the spellcheck attribute
`T`	`setTableField(boolean asTableField)` based on the flag styles will be added or removed to make inside or outside of a table row
`protected boolean`	`shouldShowPlaceholder()`
`T`	`showLabelText()`
`protected void`	`showPlaceholder()`
`T`	`spread()` Increase the vertical spaces for this component to increase its height
`protected void`	`unfloatLabel()` unfloat a floating label
`T`	`unfocus()` remove the focus from the component
`protected void`	`updateLabel(String label)`
`T`	`value(V value)`
`T`	`value(V value, boolean silent)`

Methods inherited from class org.dominokit.domino.ui.forms.BasicFormElement
addValidator, getErrorLabels, getErrors, getHelperText, getLabel, getName, getRequiredErrorMessage, groupBy, hasValidator, isDisabled, isEnabled, isFixErrorsPosition, isRequired, isShowRequiredIndicator, isValidationDisabled, makeErrorLabel, removeValidator, setHelperText, setName, setRequired, setRequired, setRequiredErrorMessage, setShowRequiredIndicator, setValidationDisabled, setValue, showErrors, ungroup, validate, withValidationDisabled

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement
add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, elevate, elevate, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isEmptyElement, isEqualNode, isForceHidden, isHidden, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.dominokit.domino.ui.utils.HasValidation
validateAll

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible
isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle
add, add, remove, remove, removeProperty, replace, setProperty, setProperty

- Field Detail
  - FOCUSED
```
public static final String FOCUSED
```
    Constant css class name for a focused component
    
    See Also:
    
    Constant Field Values
  - FLOATING
```
public static final String FLOATING
```
    Constant css class name for a component that has its labels floating above it
    
    See Also:
    
    Constant Field Values
  - DISABLED
```
public static final String DISABLED
```
    Constant css class name for a focused component
    
    See Also:
    
    Constant Field Values
  - changeListener
```
protected final elemental2.dom.EventListener changeListener
```
  - inputListener
```
protected final elemental2.dom.EventListener inputListener
```
  - fieldGroup
```
protected DominoElement<elemental2.dom.HTMLDivElement> fieldGroup
```
  - fieldContainer
```
protected DominoElement<elemental2.dom.HTMLDivElement> fieldContainer
```
  - inputContainer
```
protected FlexItem<elemental2.dom.HTMLDivElement> inputContainer
```
  - changeHandlers
```
protected List<HasChangeHandlers.ChangeHandler<? super V>> changeHandlers
```
- Constructor Detail
  - ValueBox
```
public ValueBox(String type,
                String label)
```
    Parameters:
    
    type - String type of the field input element
    
    label - String
- Method Detail
  - onEnterKey
```
protected void onEnterKey()
```
  - getFieldStyle
```
public FieldStyle getFieldStyle()
```
    Returns:
    
    the FieldStyle
  - setFieldStyle
```
public T setFieldStyle(FieldStyle fieldStyle)
```
    Change the style of the field
    
    Parameters:
    
    fieldStyle - FieldStyle
    
    Returns:
    
    same implementing component
  - setFixErrorsPosition
```
public T setFixErrorsPosition(boolean fixPosition)
```
    Overrides:
    
    setFixErrorsPosition in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    fixPosition - boolean, if true the errors message container size will be fixed and wont change the spacing between the fields when an error message is shown.
    
    Returns:
    
    same form element instance
  - linkLabelToField
```
protected void linkLabelToField()
```
    this will set the attribute for on the label with the field id as a value
  - callChangeHandlers
```
protected void callChangeHandlers()
```
    manually call the change handlers if they are not paused
  - createLabelElement
```
protected DominoElement<elemental2.dom.HTMLLabelElement> createLabelElement()
```
    create the label element for this component
    
    Returns:
    
    an HTMLLabelElement wrapped as DominoElement
  - createInputElement
```
protected abstract E createInputElement(String type)
```
    Creates an input element with the specified type
    
    Parameters:
    
    type - String the input element type
    
    Returns:
    
    E the input html element
  - setFloating
```
public T setFloating(boolean floating)
```
    Parameters:
    
    floating - boolean, if true delegate to floating() otherwise delegate to nonfloating()
    
    Returns:
    
    same component instance
  - floating
```
public T floating()
```
    Make the label always floating over the field even if the value is empty
    
    Returns:
    
    same component instance
  - nonfloating
```
public T nonfloating()
```
    Make the label floating over the field only when it has value
    
    Returns:
    
    same component instance
  - isFloating
```
public boolean isFloating()
```
    Returns:
    
    boolean, the current status of floating label
  - getMandatoryAddOn
```
public DominoElement<elemental2.dom.HTMLDivElement> getMandatoryAddOn()
```
    Returns:
    
    the FlexItem that is added as a mandatoryAddOn
  - focus
```
public T focus()
```
    focus the component
    
    Specified by:
    
    focus in interface Focusable<T extends ValueBox<T,E,V>>
    
    Returns:
    
    same implementing class
  - unfocus
```
public T unfocus()
```
    remove the focus from the component
    
    Specified by:
    
    unfocus in interface Focusable<T extends ValueBox<T,E,V>>
    
    Returns:
    
    same implementing class
  - doFocus
```
protected void doFocus()
```
    Focus the element and apply focus styles
  - isAddFocusColor
```
protected boolean isAddFocusColor()
```
    Returns:
    
    boolean, true if the field will add a focus color when focused, default to true
  - doUnfocus
```
protected void doUnfocus()
```
    un-focus the component and remove the focus styles
  - updateLabel
```
protected void updateLabel(String label)
```
    Overrides:
    
    updateLabel in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    label - String new label to replace the old one
  - getLabelTextElement
```
public Optional<DominoElement<elemental2.dom.HTMLElement>> getLabelTextElement()
```
    Overrides:
    
    getLabelTextElement in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    the HTMLElement that contains the label text wrapped as DominoElement
  - hideLabelText
```
public T hideLabelText()
```
    Returns:
    
    same component instance
  - showLabelText
```
public T showLabelText()
```
    Returns:
    
    same component instance
  - setLabelTextVisible
```
public T setLabelTextVisible(boolean visible)
```
    Show/hide the label element text
    
    Parameters:
    
    visible - boolean
    
    Returns:
    
    same component instance
  - isFocused
```
public boolean isFocused()
```
    Specified by:
    
    isFocused in interface Focusable<T extends ValueBox<T,E,V>>
    
    Returns:
    
    boolean, true if the component is focused
  - enable
```
public T enable()
```
    Specified by:
    
    enable in interface Switchable<T extends ValueBox<T,E,V>>
    
    Overrides:
    
    enable in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    same implementing component
  - disable
```
public T disable()
```
    Specified by:
    
    disable in interface Switchable<T extends ValueBox<T,E,V>>
    
    Overrides:
    
    disable in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    same implementing component
  - setLabel
```
public T setLabel(String label)
```
    Specified by:
    
    setLabel in interface HasLabel<T extends ValueBox<T,E,V>>
    
    Overrides:
    
    setLabel in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    label - String component label
    
    Returns:
    
    same implementing class instance
  - allowEmptyLabel
```
protected boolean allowEmptyLabel()
```
  - setLabel
```
public T setLabel(elemental2.dom.Node node)
```
    Sets the label as a custom element
    
    Overrides:
    
    setLabel in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    node - Node label element
    
    Returns:
    
    same form element class
  - setLabel
```
public T setLabel(org.gwtproject.safehtml.shared.SafeHtml safeHtml)
```
    Sets the label from html
    
    Overrides:
    
    setLabel in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    safeHtml - SafeHtml
    
    Returns:
    
    same form element class
  - setLabel
```
public T setLabel(org.jboss.elemento.IsElement<?> element)
```
    Sets the label from an element
    
    Overrides:
    
    setLabel in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    element - IsElement
    
    Returns:
    
    same form element class
  - setPlaceholder
```
public T setPlaceholder(String placeholder)
```
    Specified by:
    
    setPlaceholder in interface HasPlaceHolder<T extends ValueBox<T,E,V>>
    
    Parameters:
    
    placeholder - String placeholder
    
    Returns:
    
    same implementing class instance
  - showPlaceholder
```
protected void showPlaceholder()
```
  - hidePlaceholder
```
protected void hidePlaceholder()
```
  - shouldShowPlaceholder
```
protected boolean shouldShowPlaceholder()
```
  - getPlaceholder
```
public String getPlaceholder()
```
    Specified by:
    
    getPlaceholder in interface HasPlaceHolder<T extends ValueBox<T,E,V>>
    
    Returns:
    
    String placeholder of the component
  - setFocusColor
```
public T setFocusColor(Color focusColor)
```
    Set a color to use for focus indicators
    
    Specified by:
    
    setFocusColor in interface Focusable<T extends ValueBox<T,E,V>>
    
    Parameters:
    
    focusColor - Color
    
    Returns:
    
    same implementing class
  - getFieldInputContainer
```
public DominoElement<elemental2.dom.HTMLDivElement> getFieldInputContainer()
```
    Specified by:
    
    getFieldInputContainer in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    the HTMLDivElement that contains this field input element wrapped as DominoElement
  - getFieldContainer
```
public DominoElement<elemental2.dom.HTMLDivElement> getFieldContainer()
```
    Specified by:
    
    getFieldContainer in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    the HTMLDivElement that contains this field wrapped as DominoElement
  - addLeftAddOn
```
public T addLeftAddOn(FlexItem<?> addon)
```
    Adds an element as an add on to the component at left side
    
    Parameters:
    
    addon - FlexItem that contains the add on element
    
    Returns:
    
    same component instance
  - addLeftAddOn
```
public T addLeftAddOn(org.jboss.elemento.IsElement<?> addon)
```
    wrap the element in a FlexItem and delegate to addLeftAddOn(FlexItem)
    
    Parameters:
    
    addon - IsElement
    
    Returns:
    
    same component instance
  - addLeftAddOn
```
public T addLeftAddOn(elemental2.dom.Node addon)
```
    wrap the node in a FlexItem and delegate to addLeftAddOn(FlexItem)
    
    Parameters:
    
    addon - IsElement
    
    Returns:
    
    same component instance
  - addRightAddOn
```
public T addRightAddOn(FlexItem<?> rightAddon)
```
    Adds an element as an add on to the component at left side
    
    Parameters:
    
    rightAddon - FlexItem that contains the add on element
    
    Returns:
    
    same component instance
  - addRightAddOn
```
public T addRightAddOn(org.jboss.elemento.IsElement<?> addon)
```
    wrap the element in a FlexItem and delegate to addRightAddOn(FlexItem)
    
    Parameters:
    
    addon - IsElement
    
    Returns:
    
    same component instance
  - addRightAddOn
```
public T addRightAddOn(elemental2.dom.Node addon)
```
    wrap the node in a FlexItem and delegate to addRightAddOn(FlexItem)
    
    Parameters:
    
    addon - IsElement
    
    Returns:
    
    same component instance
  - removeRightAddOn
```
public T removeRightAddOn(FlexItem addon)
```
    Parameters:
    
    addon - FlexItem
    
    Returns:
    
    same component instance
  - removeRightAddOn
```
public T removeRightAddOn(org.jboss.elemento.IsElement<?> addon)
```
    Parameters:
    
    addon - IsElement
    
    Returns:
    
    same component instance
  - removeRightAddOn
```
public T removeRightAddOn(elemental2.dom.Node addon)
```
    Parameters:
    
    addon - Node
    
    Returns:
    
    same component instance
  - removeRightAddOn
```
public T removeRightAddOn(int index)
```
    Parameters:
    
    index - int index of the addon to remove
    
    Returns:
    
    same component instance
  - removeLeftAddOn
```
public T removeLeftAddOn(FlexItem addon)
```
    Parameters:
    
    addon - FlexItem
    
    Returns:
    
    same component instance
  - removeLeftAddOn
```
public T removeLeftAddOn(org.jboss.elemento.IsElement<?> addon)
```
    Parameters:
    
    addon - IsElement
    
    Returns:
    
    same component instance
  - removeLeftAddOn
```
public T removeLeftAddOn(elemental2.dom.Node addon)
```
    Parameters:
    
    addon - Node
    
    Returns:
    
    same component instance
  - removeLeftAddOn
```
public T removeLeftAddOn(int index)
```
    Parameters:
    
    index - int index of the addon to remove
    
    Returns:
    
    same component instance
  - removeRightAddOns
```
public T removeRightAddOns()
```
    Remove all right addons
    
    Returns:
    
    same component instance
  - removeLeftAddOns
```
public T removeLeftAddOns()
```
    Remove all left addons
    
    Returns:
    
    same component instance
  - getInputElement
```
public DominoElement<E> getInputElement()
```
    Specified by:
    
    getInputElement in interface HasInputElement
    
    Returns:
    
    E the input element wrapped as DominoElement
  - getHelperContainer
```
protected DominoElement<elemental2.dom.HTMLElement> getHelperContainer()
```
    Specified by:
    
    getHelperContainer in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    the HTMLElement that contains this field helper text element wrapped as DominoElement
  - getErrorsContainer
```
protected DominoElement<elemental2.dom.HTMLElement> getErrorsContainer()
```
    Specified by:
    
    getErrorsContainer in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    the HTMLElement that contains this field errors element wrapped as DominoElement
  - getValue
```
public V getValue()
```
    Specified by:
    
    getValue in interface org.gwtproject.editor.client.LeafValueEditor<V>
    
    Specified by:
    
    getValue in interface org.gwtproject.editor.client.TakesValue<V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface HasGrouping<T extends ValueBox<T,E,V>>
    
    Returns:
    
    boolean, true if the component value is empty
  - isEmptyIgnoreSpaces
```
public boolean isEmptyIgnoreSpaces()
```
    Specified by:
    
    isEmptyIgnoreSpaces in interface HasGrouping<T extends ValueBox<T,E,V>>
    
    Returns:
    
    boolean, true if the component value is empty after trimming spaces
  - getStringValue
```
public String getStringValue()
```
    Specified by:
    
    getStringValue in interface HasInputElement
    
    Returns:
    
    String value of the input element
  - getLabelElement
```
public Optional<DominoElement<elemental2.dom.HTMLLabelElement>> getLabelElement()
```
    Specified by:
    
    getLabelElement in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    the field HTMLLabelElement wrapped as DominoElement
  - element
```
public elemental2.dom.HTMLElement element()
```
    Specified by:
    
    element in interface org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>
    
    Specified by:
    
    element in class BaseDominoElement<elemental2.dom.HTMLElement,T extends ValueBox<T,E,V>>
    
    Returns:
    
    the HTML element of type E which is the root element of the component
  - invalidate
```
public T invalidate(String errorMessage)
```
    Mark the component as invalid with the specified error message
    
    Specified by:
    
    invalidate in interface HasValidation<T extends ValueBox<T,E,V>>
    
    Overrides:
    
    invalidate in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    errorMessage - String
    
    Returns:
    
    same implementing component
  - asTableField
```
public T asTableField()
```
    flag the field to be used inside a table row
    
    Returns:
    
    same component instance
  - setTableField
```
public T setTableField(boolean asTableField)
```
    based on the flag styles will be added or removed to make inside or outside of a table row
    
    Parameters:
    
    asTableField - boolean, if true adds the styles, otherwise removes them
    
    Returns:
    
    same component instance
  - invalidate
```
public T invalidate(List<String> errorMessages)
```
    Mark the component as invalid with a list of error messages
    
    Specified by:
    
    invalidate in interface HasValidation<T extends ValueBox<T,E,V>>
    
    Overrides:
    
    invalidate in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    errorMessages - List of String error messages
    
    Returns:
    
    same implementing component
  - pauseFocusValidation
```
public T pauseFocusValidation()
```
    pauses the validation when the field loses focus so they wont trigger
    
    Returns:
    
    same component instance
  - resumeFocusValidation
```
public T resumeFocusValidation()
```
    resume the validation when the field loses focus so they trigger
    
    Returns:
    
    same component instance
  - clearInvalid
```
public T clearInvalid()
```
    Removes all error messages and mark the component as valid
    
    Specified by:
    
    clearInvalid in interface HasValidation<T extends ValueBox<T,E,V>>
    
    Overrides:
    
    clearInvalid in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    same implementing component
  - setAutoValidation
```
public T setAutoValidation(boolean autoValidation)
```
    Specified by:
    
    setAutoValidation in interface HasAutoValidation<T extends ValueBox<T,E,V>>
    
    Parameters:
    
    autoValidation - boolean, true to enable auto validation, false to disable it
    
    Returns:
    
    T the instance of the implementing class
  - isAutoValidation
```
public boolean isAutoValidation()
```
    Specified by:
    
    isAutoValidation in interface HasAutoValidation<T extends ValueBox<T,E,V>>
    
    Returns:
    
    boolean, true if auto validation is enabled, otherwise false
  - createAutoValidator
```
protected abstract ValueBox.AutoValidator createAutoValidator(ValueBox.AutoValidate autoValidate)
```
    Create an AutoValidator that will automatically validate the component when it loses focus
    
    Parameters:
    
    autoValidate - ValueBox.AutoValidate
    
    Returns:
    
    same component instance
  - clear
```
public T clear()
```
    Clears the field value and trigger the change handlers
    
    Specified by:
    
    clear in interface HasGrouping<T extends ValueBox<T,E,V>>
    
    Returns:
    
    same implementing component instance
  - clear
```
public T clear(boolean silent)
```
    Clears the field value and only triggers the change handlers if silent flag is true
    
    Specified by:
    
    clear in interface HasGrouping<T extends ValueBox<T,E,V>>
    
    Parameters:
    
    silent - boolean, if false clear the value without triggering the change handlers
    
    Returns:
    
    same implementing component instance
  - value
```
public T value(V value)
```
    Specified by:
    
    value in interface HasValue<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    value - V to set as a value of the component
    
    Returns:
    
    same implementing component instance
  - value
```
public T value(V value,
               boolean silent)
```
    Specified by:
    
    value in interface HasValue<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    value - V to set as a value of the component
    
    silent - boolean if true set the value without triggering change handlers
    
    Returns:
    
    same implementing component instance
  - setReadOnly
```
public T setReadOnly(boolean readOnly)
```
    set the readonly attribute value
    
    Specified by:
    
    setReadOnly in interface IsReadOnly<T extends ValueBox<T,E,V>>
    
    Overrides:
    
    setReadOnly in class BaseDominoElement<elemental2.dom.HTMLElement,T extends ValueBox<T,E,V>>
    
    Parameters:
    
    readOnly - boolean, if true switch the component to readonly mode, otherwise switch out off readonly mode
    
    Returns:
    
    same instance of the implementing class
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface IsReadOnly<T extends ValueBox<T,E,V>>
    
    Overrides:
    
    isReadOnly in class BaseDominoElement<elemental2.dom.HTMLElement,T extends ValueBox<T,E,V>>
    
    Returns:
    
    boolean, if true then the component is in readonly mode, otherwise it is not.
  - changeLabelFloating
```
protected void changeLabelFloating()
```
    Changes the label floating state when the field get focus or lose focus
  - floatLabel
```
protected void floatLabel()
```
    Make the label float over the component
  - unfloatLabel
```
protected void unfloatLabel()
```
    unfloat a floating label
  - autoValidate
```
protected void autoValidate()
```
    validate the component if auto validation is enabled
  - addChangeHandler
```
public T addChangeHandler(HasChangeHandlers.ChangeHandler<? super V> changeHandler)
```
    Specified by:
    
    addChangeHandler in interface HasChangeHandlers<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    changeHandler - HasChangeHandlers.ChangeHandler
    
    Returns:
    
    same implementing class instance
  - removeChangeHandler
```
public T removeChangeHandler(HasChangeHandlers.ChangeHandler<? super V> changeHandler)
```
    Specified by:
    
    removeChangeHandler in interface HasChangeHandlers<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    changeHandler - HasChangeHandlers.ChangeHandler
    
    Returns:
    
    same implementing class instance
  - setPauseChangeHandlers
```
public T setPauseChangeHandlers(boolean pauseChangeHandlers)
```
    Disable/Enable change handlers
    
    Parameters:
    
    pauseChangeHandlers - boolean, true to pause the change handlers, false to enable them
    
    Returns:
    
    same component instance
  - pauseChangeHandlers
```
public T pauseChangeHandlers()
```
    Delagete to setPauseChangeHandlers(boolean) with value true
    
    Returns:
    
    same component instance
  - resumeChangeHandlers
```
public T resumeChangeHandlers()
```
    Delagete to setPauseChangeHandlers(boolean) with value false
    
    Returns:
    
    same component instance
  - getLeftAddonContainer
```
public FlexLayout getLeftAddonContainer()
```
    Returns:
    
    the FlexLayout element that contains all left addons
  - getRightAddonContainer
```
public FlexLayout getRightAddonContainer()
```
    Returns:
    
    the FlexLayout element that contains all right addons
  - hasChangeHandler
```
public boolean hasChangeHandler(HasChangeHandlers.ChangeHandler<? super V> changeHandler)
```
    Checks if a component has the specified ChangeHandler
    
    Specified by:
    
    hasChangeHandler in interface HasChangeHandlers<T extends ValueBox<T,E,V>,V>
    
    Parameters:
    
    changeHandler - HasChangeHandlers.ChangeHandler
    
    Returns:
    
    same implementing class instance
  - setSpellCheck
```
public T setSpellCheck(boolean spellCheck)
```
    Enable/Disable spellcheck for the component, sets the spellcheck attribute
    
    Parameters:
    
    spellCheck - boolean, true to enable spellcheck, false to diable it
    
    Returns:
    
    same component instance
  - addOnClearHandler
```
public T addOnClearHandler(Consumer<T> onClearHandler)
```
    Adds a handler that will be called when the field value is cleared
    
    Parameters:
    
    onClearHandler - Consumer of T
    
    Returns:
    
    same component instance
  - removeOnClearHandler
```
public T removeOnClearHandler(Consumer<T> onClearHandler)
```
    Parameters:
    
    onClearHandler - Consumer of T
    
    Returns:
    
    same component instance
  - getOnClearHandlers
```
public List<Consumer<T>> getOnClearHandlers()
```
    Returns:
    
    a List of the clear handler for this component
  - setPrefix
```
public T setPrefix(String prefix)
```
    Adds a prefix text that will be a mandatory part of the field string value
    
    Parameters:
    
    prefix - String
    
    Returns:
    
    same component instance
  - getPrefix
```
public String getPrefix()
```
    Returns:
    
    String
  - setPostFix
```
public T setPostFix(String postfix)
```
    Adds a postfix text that will be a mandatory part of the field string value
    
    Parameters:
    
    postfix - String
    
    Returns:
    
    same component instance
  - getFieldGroup
```
public DominoElement<elemental2.dom.HTMLDivElement> getFieldGroup()
```
    Returns:
    
    the HTMLDivElement that groups the different elements of this component
  - getInputContainer
```
public FlexItem getInputContainer()
```
    Returns:
    
    the FlexItem that contains the input element of this component
  - getNotesContainer
```
public DominoElement<elemental2.dom.HTMLDivElement> getNotesContainer()
```
    Returns:
    
    the HTMLDivElement that contains the notes of this component
  - getAdditionalInfoContainer
```
public DominoElement<elemental2.dom.HTMLDivElement> getAdditionalInfoContainer()
```
    Specified by:
    
    getAdditionalInfoContainer in class BasicFormElement<T extends ValueBox<T,E,V>,V>
    
    Returns:
    
    the HTMLDivElement that contains this field additional info element wrapped as DominoElement
  - getLeftAddOnsContainer
```
public FlexLayout getLeftAddOnsContainer()
```
    Returns:
    
    the FlexLayout that contains all the left addons
  - getRightAddOnsContainer
```
public FlexLayout getRightAddOnsContainer()
```
    Returns:
    
    the FlexLayout that contains all the right addons
  - getHelpItem
```
public FlexItem getHelpItem()
```
    Returns:
    
    the FlexItem that contains the helper text of this component
  - getCountItem
```
public FlexItem getCountItem()
```
    Returns:
    
    the FlexItem that contains the character count for this component
  - getErrorItem
```
public FlexItem getErrorItem()
```
    Returns:
    
    the FlexItem that contains the error messages for this component
  - getPrefixItem
```
public FlexItem getPrefixItem()
```
    Returns:
    
    the FlexItem that contains the prefix text for this component
  - getPostFixItem
```
public FlexItem getPostFixItem()
```
    Returns:
    
    the FlexItem that contains the postfix for this component
  - getFocusColor
```
public Color getFocusColor()
```
    Returns:
    
    the Color used to indicate focus of this field
  - getPostfix
```
public String getPostfix()
```
    Returns:
    
    String
  - clearValue
```
protected void clearValue()
```
    clear the field value
  - clearValue
```
protected abstract void clearValue(boolean silent)
```
    clear the field value
  - doSetValue
```
protected abstract void doSetValue(V value)
```
    Parameters:
    
    value - V the value to set for this field
  - condense
```
public T condense()
```
    Reduces the vertical spaces for this component to reduce its height
    
    Returns:
    
    same component instance
  - spread
```
public T spread()
```
    Increase the vertical spaces for this component to increase its height
    
    Returns:
    
    same component instance
  - createMandatoryAddOn
```
protected DominoElement<elemental2.dom.HTMLDivElement> createMandatoryAddOn()
```
    Returns:
    
    the FlexItem that contains the mandatory addons

Class ValueBox<T extends ValueBox<T,E,V>,E extends elemental2.dom.HTMLElement,V>

Nested Class Summary

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.BasicFormElement

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasChangeHandlers

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasValidation

Nested classes/interfaces inherited from interface org.gwtproject.editor.client.Editor

Field Summary

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

Constructor Summary

Method Summary

Methods inherited from class org.dominokit.domino.ui.forms.BasicFormElement

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

Methods inherited from class java.lang.Object

Methods inherited from interface org.dominokit.domino.ui.utils.HasValidation

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

Field Detail

FOCUSED

FLOATING

DISABLED

changeListener

inputListener

fieldGroup

fieldContainer

inputContainer

changeHandlers

Constructor Detail

ValueBox

Method Detail

onEnterKey

getFieldStyle

setFieldStyle

setFixErrorsPosition

linkLabelToField

callChangeHandlers

createLabelElement

createInputElement

setFloating

floating

nonfloating

isFloating

getMandatoryAddOn

focus

unfocus

doFocus

isAddFocusColor

doUnfocus

updateLabel

getLabelTextElement

hideLabelText

showLabelText

setLabelTextVisible

isFocused

enable

disable

setLabel

allowEmptyLabel

setLabel

setLabel

setLabel

setPlaceholder

showPlaceholder

hidePlaceholder

shouldShowPlaceholder

getPlaceholder

setFocusColor

getFieldInputContainer

getFieldContainer

addLeftAddOn

addLeftAddOn

addLeftAddOn

addRightAddOn

addRightAddOn

addRightAddOn

removeRightAddOn

removeRightAddOn

removeRightAddOn

removeRightAddOn

removeLeftAddOn