Package org.vaadin.miki.superfields.layouts

Class HeaderFooterFieldWrapper<T,​H extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents,​F extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents>

    • 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<?>>

    • Constructor Summary

      Constructors 
      Constructor Description
      HeaderFooterFieldWrapper​(Supplier<R> rootSupplier, H header, V field, F footer)
      Creates the wrapper with given root layout, header, footer and field.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected T generateModelValue()  
      Optional<F> getFooter()
      Gets the current footer.
      Optional<H> getHeader()
      Gets the current header.
      int getIndex()
      Returns the current index of the object.
      String getLabel()  
      boolean isDisablingFooterOnReadOnly()  
      boolean isDisablingHeaderOnReadOnly()  
      void setDisablingFooterOnReadOnly​(boolean disablingFooterOnReadOnly)  
      void setDisablingHeaderOnReadOnly​(boolean disablingHeaderOnReadOnly)  
      void setHelperComponent​(com.vaadin.flow.component.Component component)  
      void setHelperText​(String helperText)  
      void setIndex​(int index)
      Changes the index of the object.
      void setLabel​(String label)  
      protected void setPresentationValue​(T t)  
      void setReadOnly​(boolean readOnly)  
      HeaderFooterFieldWrapper<T,​H,​F> withDisablingFooterOnReadOnly​(boolean state)  
      HeaderFooterFieldWrapper<T,​H,​F> withDisablingHeaderOnReadOnly​(boolean state)  

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

        add, addThemeVariants, getErrorMessage, isInvalid, onAttach, remove, removeThemeVariants, setErrorMessage, setInvalid, 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, scrollIntoView, set, setElement, setId, setVisible

      • 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

      • 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.HasValue

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

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

        isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

    • Constructor Detail

      • HeaderFooterFieldWrapper

        public HeaderFooterFieldWrapper​(Supplier<R> rootSupplier,
                                H header,
                                V field,
                                F footer)
        Creates the wrapper with given root layout, header, footer and field.
        Type Parameters:
        R - Generic type to enforce root layout is a Component that HasComponents.
        V - Generic type to enforce field is a Component that HasValue of type T.
        Parameters:
        rootSupplier - A provider for the root layout.
        header - Header to use. If not null, it will be added to whatever rootSupplier produces as first component.
        field - Field to wrap. Must not be null. It will be added to whatever rootSupplier.
        footer - Footer to use. If not null, it will be added to whatever rootSupplier produces after the field.

    • Method Detail

      • setLabel

        public void setLabel​(String label)
        Specified by:
        setLabel in interface com.vaadin.flow.component.HasLabel
        Overrides:
        setLabel in class com.vaadin.flow.component.customfield.CustomField<T>

      • getLabel

        public String getLabel()
        Specified by:
        getLabel in interface com.vaadin.flow.component.HasLabel
        Overrides:
        getLabel in class com.vaadin.flow.component.customfield.CustomField<T>

      • setHelperComponent

        public void setHelperComponent​(com.vaadin.flow.component.Component component)
        Specified by:
        setHelperComponent in interface com.vaadin.flow.component.HasHelper

      • setHelperText

        public void setHelperText​(String helperText)
        Specified by:
        setHelperText in interface com.vaadin.flow.component.HasHelper

      • generateModelValue

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

      • setPresentationValue

        protected void setPresentationValue​(T t)
        Specified by:
        setPresentationValue in class com.vaadin.flow.component.customfield.CustomField<T>

      • getFooter

        public Optional<F> getFooter()
        Description copied from interface: HasFooter
        Gets the current footer.
        Specified by:
        getFooter in interface HasFooter<T>
        Returns:
        Perhaps the current footer.

      • getHeader

        public Optional<H> getHeader()
        Description copied from interface: HasHeader
        Gets the current header.
        Specified by:
        getHeader in interface HasHeader<T>
        Returns:
        Perhaps the current header.

      • getIndex

        public int getIndex()
        Description copied from interface: HasIndex
        Returns the current index of the object.
        Specified by:
        getIndex in interface HasIndex
        Returns:
        Current index.

      • setIndex

        public void setIndex​(int index)
        Description copied from interface: HasIndex
        Changes the index of the object.
        Specified by:
        setIndex in interface HasIndex
        Parameters:
        index - New index.

      • setDisablingFooterOnReadOnly

        public void setDisablingFooterOnReadOnly​(boolean disablingFooterOnReadOnly)

      • isDisablingFooterOnReadOnly

        public boolean isDisablingFooterOnReadOnly()

      • setDisablingHeaderOnReadOnly

        public void setDisablingHeaderOnReadOnly​(boolean disablingHeaderOnReadOnly)

      • isDisablingHeaderOnReadOnly

        public boolean isDisablingHeaderOnReadOnly()

      • setReadOnly

        public void setReadOnly​(boolean readOnly)
        Specified by:
        setReadOnly in interface com.vaadin.flow.component.HasValue<T,​H extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents>
        Specified by:
        setReadOnly in interface com.vaadin.flow.component.HasValueAndElement<T,​H extends com.vaadin.flow.component.Component & com.vaadin.flow.component.HasComponents>