BasicFormElement (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>

Type Parameters:

T - the type of form field extending from this class

V - the type of the form field value

All Implemented Interfaces:

FormElement<T,V>, HasGrouping<T>, HasInputElement, DominoStyle<elemental2.dom.HTMLElement,T,T>, HasAutoValidation<T>, HasChildren<T>, HasHelperText<T>, HasLabel<T>, HasName<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:

ValueBox
```
public abstract class BasicFormElement<T extends BasicFormElement<T,V>,V>
extends BaseDominoElement<elemental2.dom.HTMLElement,T>
implements FormElement<T,V>, IsReadOnly<T>, HasInputElement
```
A base implementation for Form elements

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface BasicFormElement.FieldHandler<T>
a Generic function to apply some logic on a field without triggering validation
- 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.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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`BasicFormElement.FieldHandler<T>` a Generic function to apply some logic on a field without triggering validation

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

Constructor Summary

Constructors
Constructor and Description

BasicFormElement()

Constructors
Constructor and Description
`BasicFormElement()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`T`	`addValidator(HasValidation.Validator validator)`
`T`	`clearInvalid()` Removes all error messages and mark the component as valid
`T`	`disable()`
`T`	`enable()`
`abstract DominoElement<elemental2.dom.HTMLDivElement>`	`getAdditionalInfoContainer()`
`List<elemental2.dom.HTMLElement>`	`getErrorLabels()`
`List<String>`	`getErrors()`
`protected abstract DominoElement<elemental2.dom.HTMLElement>`	`getErrorsContainer()`
`protected abstract DominoElement<elemental2.dom.HTMLDivElement>`	`getFieldContainer()`
`protected abstract DominoElement<elemental2.dom.HTMLDivElement>`	`getFieldInputContainer()`
`protected abstract DominoElement<elemental2.dom.HTMLElement>`	`getHelperContainer()`
`String`	`getHelperText()`
`Optional<String>`	`getLabel()`
`abstract Optional<DominoElement<elemental2.dom.HTMLLabelElement>>`	`getLabelElement()`
`Optional<DominoElement<elemental2.dom.HTMLElement>>`	`getLabelTextElement()`
`String`	`getName()`
`String`	`getRequiredErrorMessage()`
`T`	`groupBy(FieldsGrouping fieldsGrouping)` Adds the component to the specified fields group
`boolean`	`hasValidator(HasValidation.Validator validator)`
`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
`boolean`	`isDisabled()`
`boolean`	`isEnabled()`
`boolean`	`isFixErrorsPosition()`
`boolean`	`isRequired()`
`boolean`	`isShowRequiredIndicator()`
`boolean`	`isValidationDisabled()`
`protected elemental2.dom.HTMLLabelElement`	`makeErrorLabel(String message)` Creates a label and apply error styles on it
`T`	`removeValidator(HasValidation.Validator validator)`
`T`	`setFixErrorsPosition(boolean fixErrorsPosition)`
`T`	`setHelperText(String helperText)`
`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`	`setName(String name)`
`T`	`setRequired(boolean required)`
`T`	`setRequired(boolean required, String message)`
`T`	`setRequiredErrorMessage(String requiredErrorMessage)`
`T`	`setShowRequiredIndicator(boolean showRequiredIndicator)` Enable/Disable required indicator
`T`	`setValidationDisabled(boolean validationDisabled)` Disable/enable the validation
`void`	`setValue(V value)`
`void`	`showErrors(List<org.gwtproject.editor.client.EditorError> errors)`
`T`	`ungroup(FieldsGrouping fieldsGrouping)` remove the component from the specified fields group
`protected void`	`updateLabel(String label)`
`ValidationResult`	`validate()` validate the component and fail-fast with first error
`T`	`withValidationDisabled(BasicFormElement.FieldHandler<T> fieldHandler)` Temporary disable validation then apply the `BasicFormElement.FieldHandler` logic then restore the validationDisabled original state

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, element, 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, isReadOnly, 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, setReadOnly, 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.HasValue
value, value

Methods inherited from interface org.gwtproject.editor.client.TakesValue
getValue

Methods inherited from interface org.gwtproject.editor.client.LeafValueEditor
getValue

Methods inherited from interface org.dominokit.domino.ui.forms.HasGrouping
clear, clear, isEmpty, isEmptyIgnoreSpaces

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

Methods inherited from interface org.dominokit.domino.ui.utils.HasAutoValidation
isAutoValidation, setAutoValidation

Methods inherited from interface org.dominokit.domino.ui.utils.IsReadOnly
isReadOnly, setReadOnly

Methods inherited from interface org.dominokit.domino.ui.forms.HasInputElement
getInputElement, getStringValue

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

- Constructor Detail
  - BasicFormElement
```
public BasicFormElement()
```
- Method Detail
  - setHelperText
```
public T setHelperText(String helperText)
```
    Specified by:
    
    setHelperText in interface HasHelperText<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    helperText - String
    
    Returns:
    
    same implementing class instance
  - getHelperText
```
public String getHelperText()
```
    Specified by:
    
    getHelperText in interface HasHelperText<T extends BasicFormElement<T,V>>
    
    Returns:
    
    String helper text of the component
  - setName
```
public T setName(String name)
```
    Specified by:
    
    setName in interface HasName<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    name - String component name
    
    Returns:
    
    same implementing class
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface HasName<T extends BasicFormElement<T,V>>
    
    Returns:
    
    String component name
  - setLabel
```
public T setLabel(String label)
```
    Specified by:
    
    setLabel in interface HasLabel<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    label - String component label
    
    Returns:
    
    same implementing class instance
  - updateLabel
```
protected void updateLabel(String label)
```
    Parameters:
    
    label - String new label to replace the old one
  - setLabel
```
public T setLabel(elemental2.dom.Node node)
```
    Sets the label as a custom element
    
    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
    
    Parameters:
    
    safeHtml - SafeHtml
    
    Returns:
    
    same form element class
  - setLabel
```
public T setLabel(org.jboss.elemento.IsElement<?> element)
```
    Sets the label from an element
    
    Parameters:
    
    element - IsElement
    
    Returns:
    
    same form element class
  - getLabel
```
public Optional<String> getLabel()
```
    Specified by:
    
    getLabel in interface HasLabel<T extends BasicFormElement<T,V>>
    
    Returns:
    
    String component label
  - enable
```
public T enable()
```
    Specified by:
    
    enable in interface Switchable<T extends BasicFormElement<T,V>>
    
    Overrides:
    
    enable in class BaseDominoElement<elemental2.dom.HTMLElement,T extends BasicFormElement<T,V>>
    
    Returns:
    
    same implementing component
  - isEnabled
```
public boolean isEnabled()
```
    Specified by:
    
    isEnabled in interface Switchable<T extends BasicFormElement<T,V>>
    
    Returns:
    
    boolean, true if component is enabled else false
  - isDisabled
```
public boolean isDisabled()
```
    Overrides:
    
    isDisabled in class BaseDominoElement<elemental2.dom.HTMLElement,T extends BasicFormElement<T,V>>
    
    Returns:
    
    boolean, true if the component is disabled
  - disable
```
public T disable()
```
    Specified by:
    
    disable in interface Switchable<T extends BasicFormElement<T,V>>
    
    Overrides:
    
    disable in class BaseDominoElement<elemental2.dom.HTMLElement,T extends BasicFormElement<T,V>>
    
    Returns:
    
    same implementing component
  - isValidationDisabled
```
public boolean isValidationDisabled()
```
    Returns:
    
    boolean, true if the validation is disabled else false
  - setValidationDisabled
```
public T setValidationDisabled(boolean validationDisabled)
```
    Disable/enable the validation
    
    Parameters:
    
    validationDisabled - boolean, true to disable validation, false to enable it
    
    Returns:
    
    same form element class
  - validate
```
public ValidationResult validate()
```
    validate the component and fail-fast with first error
    
    Specified by:
    
    validate in interface HasValidation<T extends BasicFormElement<T,V>>
    
    Returns:
    
    same implementing component
  - removeValidator
```
public T removeValidator(HasValidation.Validator validator)
```
    Specified by:
    
    removeValidator in interface HasValidation<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    validator - HasValidation.Validator
    
    Returns:
    
    same implementing component
  - hasValidator
```
public boolean hasValidator(HasValidation.Validator validator)
```
    Specified by:
    
    hasValidator in interface HasValidation<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    validator - HasValidation.Validator
    
    Returns:
    
    same implementing component
  - addValidator
```
public T addValidator(HasValidation.Validator validator)
```
    Specified by:
    
    addValidator in interface HasValidation<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    validator - HasValidation.Validator
    
    Returns:
    
    same implementing 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 BasicFormElement<T,V>>
    
    Parameters:
    
    errorMessage - String
    
    Returns:
    
    same implementing component
  - 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 BasicFormElement<T,V>>
    
    Parameters:
    
    errorMessages - List of String error messages
    
    Returns:
    
    same implementing component
  - withValidationDisabled
```
public T withValidationDisabled(BasicFormElement.FieldHandler<T> fieldHandler)
```
    Temporary disable validation then apply the BasicFormElement.FieldHandler logic then restore the validationDisabled original state
    
    Parameters:
    
    fieldHandler - BasicFormElement.FieldHandler
    
    Returns:
    
    same form element class
  - makeErrorLabel
```
protected elemental2.dom.HTMLLabelElement makeErrorLabel(String message)
```
    Creates a label and apply error styles on it
    
    Parameters:
    
    message - String error message
    
    Returns:
    
    same form element instance
  - clearInvalid
```
public T clearInvalid()
```
    Removes all error messages and mark the component as valid
    
    Specified by:
    
    clearInvalid in interface HasValidation<T extends BasicFormElement<T,V>>
    
    Returns:
    
    same implementing component
  - getErrors
```
public List<String> getErrors()
```
    Specified by:
    
    getErrors in interface HasValidation<T extends BasicFormElement<T,V>>
    
    Returns:
    
    a List of String error messages
  - getErrorLabels
```
public List<elemental2.dom.HTMLElement> getErrorLabels()
```
  - setRequired
```
public T setRequired(boolean required)
```
    Specified by:
    
    setRequired in interface IsRequired<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    required - boolean, true to make the component value as required
    
    Returns:
    
    same implementing component instance
  - setRequired
```
public T setRequired(boolean required,
                     String message)
```
    Specified by:
    
    setRequired in interface IsRequired<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    required - boolean, true to make the component value required
    
    message - String to show as error message when the value is missing
    
    Returns:
    
    same implementing component instance
  - isRequired
```
public boolean isRequired()
```
    Specified by:
    
    isRequired in interface IsRequired<T extends BasicFormElement<T,V>>
    
    Returns:
    
    boolean, true if the component value is required
  - setRequiredErrorMessage
```
public T setRequiredErrorMessage(String requiredErrorMessage)
```
    Specified by:
    
    setRequiredErrorMessage in interface IsRequired<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    requiredErrorMessage - String error message to show when the value is missing
    
    Returns:
    
    same implementing component instance
  - getRequiredErrorMessage
```
public String getRequiredErrorMessage()
```
    Specified by:
    
    getRequiredErrorMessage in interface IsRequired<T extends BasicFormElement<T,V>>
    
    Returns:
    
    String required error message
  - setShowRequiredIndicator
```
public T setShowRequiredIndicator(boolean showRequiredIndicator)
```
    Enable/Disable required indicator
    
    Parameters:
    
    showRequiredIndicator - boolean, true is visible else false
    
    Returns:
    
    same form element instance
  - isShowRequiredIndicator
```
public boolean isShowRequiredIndicator()
```
    Returns:
    
    boolean, true if required indicator is enabled
  - groupBy
```
public T groupBy(FieldsGrouping fieldsGrouping)
```
    Adds the component to the specified fields group
    
    Specified by:
    
    groupBy in interface HasGrouping<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    fieldsGrouping - FieldsGrouping
    
    Returns:
    
    same implementing component instance
  - ungroup
```
public T ungroup(FieldsGrouping fieldsGrouping)
```
    remove the component from the specified fields group
    
    Specified by:
    
    ungroup in interface HasGrouping<T extends BasicFormElement<T,V>>
    
    Parameters:
    
    fieldsGrouping - FieldsGrouping
    
    Returns:
    
    same implementing component instance
  - setValue
```
public void setValue(V value)
```
    Specified by:
    
    setValue in interface org.gwtproject.editor.client.LeafValueEditor<V>
    
    Specified by:
    
    setValue in interface org.gwtproject.editor.client.TakesValue<V>
  - isFixErrorsPosition
```
public boolean isFixErrorsPosition()
```
    Returns:
    
    boolean, true if the errors message position is fixed
  - setFixErrorsPosition
```
public T setFixErrorsPosition(boolean fixErrorsPosition)
```
    Parameters:
    
    fixErrorsPosition - 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
  - getFieldInputContainer
```
protected abstract DominoElement<elemental2.dom.HTMLDivElement> getFieldInputContainer()
```
    Returns:
    
    the HTMLDivElement that contains this field input element wrapped as DominoElement
  - getFieldContainer
```
protected abstract DominoElement<elemental2.dom.HTMLDivElement> getFieldContainer()
```
    Returns:
    
    the HTMLDivElement that contains this field wrapped as DominoElement
  - getHelperContainer
```
protected abstract DominoElement<elemental2.dom.HTMLElement> getHelperContainer()
```
    Returns:
    
    the HTMLElement that contains this field helper text element wrapped as DominoElement
  - getErrorsContainer
```
protected abstract DominoElement<elemental2.dom.HTMLElement> getErrorsContainer()
```
    Returns:
    
    the HTMLElement that contains this field errors element wrapped as DominoElement
  - getLabelElement
```
public abstract Optional<DominoElement<elemental2.dom.HTMLLabelElement>> getLabelElement()
```
    Returns:
    
    the field HTMLLabelElement wrapped as DominoElement
  - getAdditionalInfoContainer
```
public abstract DominoElement<elemental2.dom.HTMLDivElement> getAdditionalInfoContainer()
```
    Returns:
    
    the HTMLDivElement that contains this field additional info element wrapped as DominoElement
  - getLabelTextElement
```
public Optional<DominoElement<elemental2.dom.HTMLElement>> getLabelTextElement()
```
    Returns:
    
    the HTMLElement that contains the label text wrapped as DominoElement
  - showErrors
```
public void showErrors(List<org.gwtproject.editor.client.EditorError> errors)
```
    Specified by:
    
    showErrors in interface org.gwtproject.editor.client.HasEditorErrors<V>

Class BasicFormElement<T extends BasicFormElement<T,V>,V>

Nested Class Summary

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

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.utils.BaseDominoElement

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gwtproject.editor.client.TakesValue

Methods inherited from interface org.gwtproject.editor.client.LeafValueEditor

Methods inherited from interface org.dominokit.domino.ui.forms.HasGrouping

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

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

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

Methods inherited from interface org.dominokit.domino.ui.forms.HasInputElement

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

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

Constructor Detail

BasicFormElement

Method Detail

setHelperText

getHelperText

setName

getName

setLabel

updateLabel

setLabel

setLabel

setLabel

getLabel

enable

isEnabled

isDisabled

disable

isValidationDisabled

setValidationDisabled

validate

removeValidator

hasValidator

addValidator

invalidate

invalidate

withValidationDisabled

makeErrorLabel

clearInvalid

getErrors

getErrorLabels

setRequired

setRequired

isRequired

setRequiredErrorMessage

getRequiredErrorMessage

setShowRequiredIndicator

isShowRequiredIndicator

groupBy

ungroup

setValue

isFixErrorsPosition

setFixErrorsPosition

getFieldInputContainer

getFieldContainer

getHelperContainer

getErrorsContainer

getLabelElement

getAdditionalInfoContainer

getLabelTextElement

showErrors