Package org.vaadin.miki.superfields.gridselect

Class AbstractGridSelect<V,​F>

  • Type Parameters:
    V - Type of data in the grid.
    F - Type of data in the field.
    All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<com.vaadin.flow.component.customfield.CustomField>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<com.vaadin.flow.component.customfield.CustomField>, com.vaadin.flow.component.FocusNotifier<com.vaadin.flow.component.customfield.CustomField>, 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<F>,​F>,​F>, com.vaadin.flow.component.HasValueAndElement<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<F>,​F>,​F>, com.vaadin.flow.component.shared.HasTooltip, Serializable
    Direct Known Subclasses:
    GridMultiSelect, GridSelect
    @CssImport(value="./styles/label-positions.css",themeFor="vaadin-custom-field") @CssImport(value="./styles/label-positions-grids.css",themeFor="vaadin-custom-field")
public abstract class AbstractGridSelect<V,​F>
extends com.vaadin.flow.component.customfield.CustomField<F>
    Base class for various Grid selects.
    Since:
    2020-12-09
    Author:
    miki
    See Also:
    Serialized Form

    • 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 
      Modifier Constructor Description
      protected AbstractGridSelect​(com.vaadin.flow.component.grid.Grid<V> underlyingGrid)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void configureGrid​(com.vaadin.flow.component.grid.Grid<V> grid)
      Configures the grid.
      com.vaadin.flow.component.grid.Grid<V> getGrid()
      Returns the underlying Grid.
      boolean isEnabled()  
      protected void onGridSelected​(com.vaadin.flow.data.selection.SelectionEvent<com.vaadin.flow.component.grid.Grid<V>,​V> event)
      This method is called when a grid cell is selected in the client.
      void setEnabled​(boolean enabled)  
      void setReadOnly​(boolean readOnly)  

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

        add, addThemeVariants, generateModelValue, getErrorMessage, getLabel, isInvalid, onAttach, remove, removeThemeVariants, setErrorMessage, setInvalid, setLabel, setPresentationValue, 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.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, setTooltipText

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

        clear, getOptionalValue

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

        isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

    • Constructor Detail

      • AbstractGridSelect

        protected AbstractGridSelect​(com.vaadin.flow.component.grid.Grid<V> underlyingGrid)

    • Method Detail

      • configureGrid

        protected void configureGrid​(com.vaadin.flow.component.grid.Grid<V> grid)
        Configures the grid.
        Parameters:
        grid - Grid to configure.

      • onGridSelected

        protected void onGridSelected​(com.vaadin.flow.data.selection.SelectionEvent<com.vaadin.flow.component.grid.Grid<V>,​V> event)
        This method is called when a grid cell is selected in the client. By default, it calls CustomField.updateValue().
        Parameters:
        event - Event with selection details.

      • getGrid

        public com.vaadin.flow.component.grid.Grid<V> getGrid()
        Returns the underlying Grid. Use with caution. Please do not mess with grid's selection. Note: unless a protected constructor with predefined grid - GridSelect(Grid) - is called, the returned grid will be a RestrictedModeGrid.
        Returns:
        The Grid. Any changes to the grid will affect this component.

      • setReadOnly

        public void setReadOnly​(boolean readOnly)

      • setEnabled

        public void setEnabled​(boolean enabled)

      • isEnabled

        public boolean isEnabled()