Package org.vaadin.miki.superfields.text

Class LabelField<V>

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.AbstractField<com.vaadin.flow.component.customfield.CustomField<T>,T>
com.vaadin.flow.component.customfield.CustomField<V>
org.vaadin.miki.superfields.text.LabelField<V>
Type Parameters:
V - Value type.
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField<V>>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField<V>>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField<V>>, 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<com.vaadin.flow.component.customfield.CustomField<V>,V>,V>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<V>,V>,V>, com.vaadin.flow.component.shared.HasTooltip, com.vaadin.flow.component.shared.HasValidationProperties, Serializable, HasHelperPositionable, HasId, HasLabelPositionable, WithHelperMixin<LabelField<V>>, WithHelperPositionableMixin<LabelField<V>>, WithIdMixin<LabelField<V>>, WithLabelMixin<LabelField<V>>, WithLabelPositionableMixin<LabelField<V>>, WithValueMixin<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<V>,V>,V,LabelField<V>>
@CssImport(value="./styles/label-positions.css", themeFor="vaadin-custom-field") public class LabelField<V> extends com.vaadin.flow.component.customfield.CustomField<V> implements com.vaadin.flow.component.HasStyle, WithLabelMixin<LabelField<V>>, WithHelperPositionableMixin<LabelField<V>>, WithHelperMixin<LabelField<V>>, WithLabelPositionableMixin<LabelField<V>>, WithIdMixin<LabelField<V>>, WithValueMixin<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<V>,V>,V,LabelField<V>>
A label field. Basically, an unchangeable field that does not allow any UI controls to modify the value. By default, it uses Object.toString() to show the text representation and DEFAULT_NULL_REPRESENTATION to show null values.
Since:
2022-04-08
Author:
miki
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 extends Object>

    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 extends Object>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_NULL_REPRESENTATION
     

    Fields inherited from interface org.vaadin.miki.markers.HasHelperPositionable

    HELPER_ABOVE_THEME_VARIANT

    Fields inherited from interface org.vaadin.miki.markers.HasLabelPositionable

    LABEL_POSITION_ATTRIBUTE, LABEL_POSITION_DETAILS_ATTRIBUTE

  • Constructor Summary

    Constructors
    Constructor
    Description
    LabelField()
    Creates a label field.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected V
    generateModelValue()
     
    com.vaadin.flow.function.SerializableFunction<V,String>
    getConverter()
    Returns converter from value to String.
    final String
    getNullRepresentation()
    Returns current representation for null value.
    void
    setConverter(com.vaadin.flow.function.SerializableFunction<V,String> converter)
    Sets a converter used to translate a value of type V to String.
    final void
    setNullRepresentation(String nullRepresentation)
    Sets text to be displayed when the value is null.
    protected void
    setPresentationValue(V v)
     
    final LabelField<V>
    withConverter(com.vaadin.flow.function.SerializableFunction<V,String> converter)
    Chains setConverter(SerializableFunction) and returns itself.
    final LabelField<V>
    withNullRepresentation(String nullRepresentation)
    Chains setNullRepresentation(String) and returns itself.

    Methods inherited from class com.vaadin.flow.component.customfield.CustomField

    add, addThemeVariants, getLabel, onAttach, remove, removeThemeVariants, setLabel, updateValue

    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, 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 org.vaadin.miki.markers.HasHelperPositionable

    isHelperAbove, setHelperAbove, setHelperAbove, setHelperBelow

    Methods inherited from interface org.vaadin.miki.markers.HasId

    getId, setId

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

    getLabel, setLabel

    Methods inherited from interface org.vaadin.miki.markers.HasLabelPositionable

    getLabelPosition, setLabelPosition

    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, setTooltipText

    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

    Methods inherited from interface org.vaadin.miki.markers.WithHelperMixin

    withHelperComponent, withHelperText

    Methods inherited from interface org.vaadin.miki.markers.WithHelperPositionableMixin

    withHelperAbove, withHelperAbove, withHelperBelow

    Methods inherited from interface org.vaadin.miki.markers.WithIdMixin

    withId

    Methods inherited from interface org.vaadin.miki.markers.WithLabelMixin

    withLabel

    Methods inherited from interface org.vaadin.miki.markers.WithLabelPositionableMixin

    withLabelPosition

    Methods inherited from interface org.vaadin.miki.markers.WithValueMixin

    withValue

  • Field Details

  • Constructor Details

    • LabelField

      public LabelField()
      Creates a label field.

  • Method Details

    • generateModelValue

      protected V generateModelValue()
      Specified by:
      generateModelValue in class com.vaadin.flow.component.customfield.CustomField<V>

    • setPresentationValue

      protected void setPresentationValue(V v)
      Specified by:
      setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<V>

    • getNullRepresentation

      public final String getNullRepresentation()
      Returns current representation for null value.
      Returns:
      A text that is displayed when the value is null. Will never be null itself.

    • setNullRepresentation

      public final void setNullRepresentation(String nullRepresentation)
      Sets text to be displayed when the value is null.
      Parameters:
      nullRepresentation - New text. If it is null, DEFAULT_NULL_REPRESENTATION will be used instead.

    • withNullRepresentation

      public final LabelField<V> withNullRepresentation(String nullRepresentation)
      Chains setNullRepresentation(String) and returns itself.
      Parameters:
      nullRepresentation - Text to display when value is null.
      Returns:
      This.

    • getConverter

      public com.vaadin.flow.function.SerializableFunction<V,String> getConverter()
      Returns converter from value to String.
      Returns:
      A non-null function that accepts V and returns a String. Object.toString() by default.

    • setConverter

      public void setConverter(com.vaadin.flow.function.SerializableFunction<V,String> converter)
      Sets a converter used to translate a value of type V to String. Updates the currently shown text.
      Parameters:
      converter - A converter to use. null is never passed to the converter.
      See Also:

    • withConverter

      public final LabelField<V> withConverter(com.vaadin.flow.function.SerializableFunction<V,String> converter)
      Chains setConverter(SerializableFunction) and returns itself.
      Parameters:
      converter - Converter to use.
      Returns:
      This.