Package org.vaadin.miki.superfields.gridselect

Class GridMultiSelect<V>

    • 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 GridMultiSelect​(com.vaadin.flow.component.grid.Grid<V> underlyingGrid)
      More advanced constructor that allows using predefined grid.
        GridMultiSelect​(Class<V> type, boolean createColumns, V... items)
      Constructs the component.
        GridMultiSelect​(V... items)
      Creates the component.

    • 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.
      protected Set<V> generateModelValue()  
      int getMaximumSelectionSize()
      Returns the current maximum selection size.
      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 setItems​(Collection<V> collection)  
      void setMaximumSelectionSize​(int maximumSelectionSize)
      Defines the new maximum selection size.
      protected void setPresentationValue​(Set<V> vs)  
      protected void updateValue()  

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

        add, addThemeVariants, getErrorMessage, getLabel, isInvalid, onAttach, remove, removeThemeVariants, setErrorMessage, setInvalid, setLabel

      • 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.data.binder.HasItems

        setItems, setItems

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

        getLabel, setLabel

      • 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

      • GridMultiSelect

        @SafeVarargs
public GridMultiSelect​(V... items)
        Creates the component. This requires a subsequent configuration of grid's columns.
        Parameters:
        items - Items to add to the grid.
        See Also:
        AbstractGridSelect.getGrid()

      • GridMultiSelect

        @SafeVarargs
public GridMultiSelect​(Class<V> type,
                       boolean createColumns,
                       V... items)
        Constructs the component. This is the recommended constructor.
        Parameters:
        type - Type of items displayed in the grid.
        createColumns - Whether or not to create default columns.
        items - Items to add to the grid.

      • GridMultiSelect

        protected GridMultiSelect​(com.vaadin.flow.component.grid.Grid<V> underlyingGrid)
        More advanced constructor that allows using predefined grid. It is not public, as usage of this constructor implies you know what you are doing.
        Parameters:
        underlyingGrid - A grid to use.

    • Method Detail

      • onGridSelected

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

      • generateModelValue

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

      • updateValue

        protected void updateValue()
        Overrides:
        updateValue in class com.vaadin.flow.component.customfield.CustomField<Set<V>>

      • setPresentationValue

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

      • setItems

        public void setItems​(Collection<V> collection)
        Specified by:
        setItems in interface com.vaadin.flow.data.binder.HasItems<V>

      • setMaximumSelectionSize

        public void setMaximumSelectionSize​(int maximumSelectionSize)
        Description copied from interface: HasMaximumSelectionSize
        Defines the new maximum selection size. When current selection is above the new limit, the selection should change so that it fits the new limit.
        Specified by:
        setMaximumSelectionSize in interface HasMaximumSelectionSize
        Parameters:
        maximumSelectionSize - Maximum selection size.