T - the type of form field extending from this classV - the type of the form field valuepublic abstract class BasicFormElement<T extends BasicFormElement<T,V>,V> extends BaseDominoElement<elemental2.dom.HTMLElement,T> implements FormElement<T,V>, IsReadOnly<T>, HasInputElement
| Modifier and Type | Class and Description |
|---|---|
static interface |
BasicFormElement.FieldHandler<T>
a Generic function to apply some logic on a field without triggering validation
|
BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStylerHasValidation.Validatorelement| Constructor and Description |
|---|
BasicFormElement() |
| 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 |
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, withWavesclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitclear, clear, isEmpty, isEmptyIgnoreSpacesvalidateAllisAutoValidation, setAutoValidationisReadOnly, setReadOnlygetInputElement, getStringValueisExpandedadd, add, remove, remove, removeProperty, replace, setProperty, setPropertypublic T setHelperText(String helperText)
setHelperText in interface HasHelperText<T extends BasicFormElement<T,V>>helperText - Stringpublic String getHelperText()
getHelperText in interface HasHelperText<T extends BasicFormElement<T,V>>public String getName()
protected void updateLabel(String label)
label - String new label to replace the old onepublic T setLabel(elemental2.dom.Node node)
node - Node label elementpublic T setLabel(org.gwtproject.safehtml.shared.SafeHtml safeHtml)
safeHtml - SafeHtmlpublic T setLabel(org.jboss.elemento.IsElement<?> element)
element - IsElementpublic T enable()
enable in interface Switchable<T extends BasicFormElement<T,V>>enable in class BaseDominoElement<elemental2.dom.HTMLElement,T extends BasicFormElement<T,V>>public boolean isEnabled()
isEnabled in interface Switchable<T extends BasicFormElement<T,V>>public boolean isDisabled()
isDisabled in class BaseDominoElement<elemental2.dom.HTMLElement,T extends BasicFormElement<T,V>>public T disable()
disable in interface Switchable<T extends BasicFormElement<T,V>>disable in class BaseDominoElement<elemental2.dom.HTMLElement,T extends BasicFormElement<T,V>>public boolean isValidationDisabled()
public T setValidationDisabled(boolean validationDisabled)
validationDisabled - boolean, true to disable validation, false to enable itpublic ValidationResult validate()
validate in interface HasValidation<T extends BasicFormElement<T,V>>public T removeValidator(HasValidation.Validator validator)
removeValidator in interface HasValidation<T extends BasicFormElement<T,V>>validator - HasValidation.Validatorpublic boolean hasValidator(HasValidation.Validator validator)
hasValidator in interface HasValidation<T extends BasicFormElement<T,V>>validator - HasValidation.Validatorpublic T addValidator(HasValidation.Validator validator)
addValidator in interface HasValidation<T extends BasicFormElement<T,V>>validator - HasValidation.Validatorpublic T invalidate(String errorMessage)
invalidate in interface HasValidation<T extends BasicFormElement<T,V>>errorMessage - Stringpublic T invalidate(List<String> errorMessages)
invalidate in interface HasValidation<T extends BasicFormElement<T,V>>errorMessages - List of String error messagespublic T withValidationDisabled(BasicFormElement.FieldHandler<T> fieldHandler)
BasicFormElement.FieldHandler logic then restore the
validationDisabled original statefieldHandler - BasicFormElement.FieldHandlerprotected elemental2.dom.HTMLLabelElement makeErrorLabel(String message)
message - String error messagepublic T clearInvalid()
clearInvalid in interface HasValidation<T extends BasicFormElement<T,V>>public List<String> getErrors()
getErrors in interface HasValidation<T extends BasicFormElement<T,V>>public List<elemental2.dom.HTMLElement> getErrorLabels()
public T setRequired(boolean required)
setRequired in interface IsRequired<T extends BasicFormElement<T,V>>required - boolean, true to make the component value as requiredpublic T setRequired(boolean required, String message)
setRequired in interface IsRequired<T extends BasicFormElement<T,V>>required - boolean, true to make the component value requiredmessage - String to show as error message when the value is missingpublic boolean isRequired()
isRequired in interface IsRequired<T extends BasicFormElement<T,V>>public T setRequiredErrorMessage(String requiredErrorMessage)
setRequiredErrorMessage in interface IsRequired<T extends BasicFormElement<T,V>>requiredErrorMessage - String error message to show when the value is missingpublic String getRequiredErrorMessage()
getRequiredErrorMessage in interface IsRequired<T extends BasicFormElement<T,V>>public T setShowRequiredIndicator(boolean showRequiredIndicator)
showRequiredIndicator - boolean, true is visible else falsepublic boolean isShowRequiredIndicator()
public T groupBy(FieldsGrouping fieldsGrouping)
groupBy in interface HasGrouping<T extends BasicFormElement<T,V>>fieldsGrouping - FieldsGroupingpublic T ungroup(FieldsGrouping fieldsGrouping)
ungroup in interface HasGrouping<T extends BasicFormElement<T,V>>fieldsGrouping - FieldsGroupingpublic void setValue(V value)
public boolean isFixErrorsPosition()
public T setFixErrorsPosition(boolean fixErrorsPosition)
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.protected abstract DominoElement<elemental2.dom.HTMLDivElement> getFieldInputContainer()
HTMLDivElement that contains this field input element wrapped as DominoElementprotected abstract DominoElement<elemental2.dom.HTMLDivElement> getFieldContainer()
HTMLDivElement that contains this field wrapped as DominoElementprotected abstract DominoElement<elemental2.dom.HTMLElement> getHelperContainer()
HTMLElement that contains this field helper text element wrapped as DominoElementprotected abstract DominoElement<elemental2.dom.HTMLElement> getErrorsContainer()
HTMLElement that contains this field errors element wrapped as DominoElementpublic abstract Optional<DominoElement<elemental2.dom.HTMLLabelElement>> getLabelElement()
HTMLLabelElement wrapped as DominoElementpublic abstract DominoElement<elemental2.dom.HTMLDivElement> getAdditionalInfoContainer()
HTMLDivElement that contains this field additional info element wrapped as
DominoElementpublic Optional<DominoElement<elemental2.dom.HTMLElement>> getLabelTextElement()
HTMLElement that contains the label text wrapped as DominoElementCopyright © 2019–2022 Dominokit. All rights reserved.