Package com.vaadin.flow.component.customfield

Class CustomField<T>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<CustomField<T>,T>
com.vaadin.flow.component.customfield.CustomField<T>
Type Parameters:
T - field value type
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<CustomField<T>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<CustomField<T>>, com.vaadin.flow.component.FocusNotifier<CustomField<T>>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasHelper, com.vaadin.flow.component.HasLabel, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasValidation, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CustomField<T>,T>,T>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CustomField<T>,T>,T>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CustomField<T>,T>,T>, Serializable
@Tag("vaadin-custom-field") @NpmPackage(value="@vaadin/custom-field", version="25.0.0-alpha21") @JsModule("@vaadin/custom-field/src/vaadin-custom-field.js") public abstract class CustomField<T> extends com.vaadin.flow.component.AbstractField<CustomField<T>,T> implements com.vaadin.flow.component.Focusable<CustomField<T>>, com.vaadin.flow.component.shared.InputField<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<CustomField<T>,T>,T>, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasValidationProperties
A HasValue whose UI content can be constructed by the user, enabling the creation of e.g. form fields by composing Vaadin components. Customization of both the visual presentation and the logic of the field is possible.

Subclasses must implement generateModelValue() and AbstractFieldsetPresentationValue(Object).

See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.AbstractField

    com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<C extends com.vaadin.flow.component.Component,V>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.BlurNotifier

    com.vaadin.flow.component.BlurNotifier.BlurEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.FocusNotifier

    com.vaadin.flow.component.FocusNotifier.FocusEvent<C extends com.vaadin.flow.component.Component>

    Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

    com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

  • Constructor Summary

    Constructors
    Constructor
    Description
    CustomField()
    Default constructor.
    CustomField(T defaultValue)
    Constructs a new custom field.
    CustomField(T defaultValue, boolean manualValueUpdate)
    Constructs a new custom field.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    add(com.vaadin.flow.component.Component... components)
    Adds the given components as children of this component.
    void
    addThemeVariants(CustomFieldVariant... variants)
    Adds theme variants to the component.
    protected abstract T
    generateModelValue()
    This method should return the value of the field, based on value of the internal fields.
    String
    getLabel()
    Gets the label for the field.
    protected void
    remove(com.vaadin.flow.component.Component... components)
    Removes the given child components from this component.
    void
    removeThemeVariants(CustomFieldVariant... variants)
    Removes theme variants from the component.
    void
    setLabel(String label)
    Sets the label for the field.
    protected abstract void
    setPresentationValue(T newPresentationValue)
    This method should be implemented to set the value of the fields contained in this custom field according to the value of the parameter.
    protected void
    updateValue()
    Regenerates the value by calling generateModelValue() and updates the model.

    Methods inherited from class com.vaadin.flow.component.AbstractField

    addValueChangeListener, getEmptyValue, getValue, isEmpty, setModelValue, setValue, valueEquals

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.BlurNotifier

    addBlurListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.Focusable

    addFocusShortcut, blur, focus, getTabIndex, setTabIndex

    Methods inherited from interface com.vaadin.flow.component.FocusNotifier

    addFocusListener

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasHelper

    getHelperComponent, getHelperText, setHelperComponent, setHelperText

    Methods inherited from interface com.vaadin.flow.component.HasSize

    getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

    Methods inherited from interface com.vaadin.flow.component.HasTheme

    addThemeName, addThemeNames, getThemeName, getThemeNames, hasThemeName, removeThemeName, removeThemeNames, setThemeName, setThemeName

    Methods inherited from interface com.vaadin.flow.component.shared.HasTooltip

    getTooltip, setTooltipMarkdown, setTooltipText

    Methods inherited from interface com.vaadin.flow.component.HasValidation

    setManualValidation

    Methods inherited from interface com.vaadin.flow.component.shared.HasValidationProperties

    getErrorMessage, isInvalid, setErrorMessage, setInvalid

    Methods inherited from interface com.vaadin.flow.component.HasValue

    addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, setValue

    Methods inherited from interface com.vaadin.flow.component.HasValueAndElement

    isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible

  • Constructor Details

    • CustomField

      public CustomField()
      Default constructor.

    • CustomField

      public CustomField(T defaultValue)
      Constructs a new custom field.
      Parameters:
      defaultValue - The initial value for the field. Will also be used by AbstractField.getEmptyValue().
      See Also:
      • AbstractField(Object)

    • CustomField

      public CustomField(T defaultValue, boolean manualValueUpdate)
      Constructs a new custom field.
      Parameters:
      defaultValue - The initial value for the field. Will also be used by AbstractField.getEmptyValue().
      manualValueUpdate - when true the component does not automatically update its value when one of the contained fields changes. This allows controlling manually when the value is updated, which can be done by calling updateValue(). false by default.
      See Also:
      • AbstractField(Object)

  • Method Details

    • generateModelValue

      protected abstract T generateModelValue()
      This method should return the value of the field, based on value of the internal fields.
      Returns:
      new value of the field.

    • setPresentationValue

      protected abstract void setPresentationValue(T newPresentationValue)
      This method should be implemented to set the value of the fields contained in this custom field according to the value of the parameter. It can also be use to show the value to the user in some way, like placing it in an element contained on the field.

      Specified by:
      setPresentationValue in class com.vaadin.flow.component.AbstractField<CustomField<T>,T>
      Parameters:
      newPresentationValue - The new presentation value.

    • updateValue

      protected void updateValue()
      Regenerates the value by calling generateModelValue() and updates the model. If the value is different than the current one, a HasValue.ValueChangeEvent will be generated with HasValue.ValueChangeEvent.isFromClient() set to true

      This method is called when the webcomponent generates a changed event, typically in response to a change made by the user in one of the contained fields.

      Custom implementations of this method must call AbstractField.setModelValue(Object, boolean) with the updated model value. Subclasses can call this method when the model value needs to be regenerated and updated.

    • add

      protected void add(com.vaadin.flow.component.Component... components)
      Adds the given components as children of this component.
      Parameters:
      components - the components to add

    • remove

      protected void remove(com.vaadin.flow.component.Component... components)
      Removes the given child components from this component.
      Parameters:
      components - the components to remove
      Throws:
      IllegalArgumentException - if any of the components is not a child of this component

    • getLabel

      public String getLabel()
      Gets the label for the field.
      Specified by:
      getLabel in interface com.vaadin.flow.component.HasLabel
      Returns:
      the label property from the webcomponent

    • setLabel

      public void setLabel(String label)
      Sets the label for the field.
      Specified by:
      setLabel in interface com.vaadin.flow.component.HasLabel
      Parameters:
      label - value for the label property in the webcomponent

    • addThemeVariants

      public void addThemeVariants(CustomFieldVariant... variants)
      Adds theme variants to the component.
      Parameters:
      variants - theme variants to add

    • removeThemeVariants

      public void removeThemeVariants(CustomFieldVariant... variants)
      Removes theme variants from the component.
      Parameters:
      variants - theme variants to remove