org.vaadin.miki.superfields.gridselect

Class GridSelect<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<F>

org.vaadin.miki.superfields.gridselect.AbstractGridSelect<V,V>

org.vaadin.miki.superfields.gridselect.GridSelect<V>

Type Parameters:

V - Type of value to include in the grid.

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.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.data.binder.HasItems<V>, Serializable, HasHelperPositionable, HasId, HasLabelPositionable, WithHelperMixin<GridSelect<V>>, WithHelperPositionableMixin<GridSelect<V>>, WithIdMixin<GridSelect<V>>, WithItemsMixin<V,GridSelect<V>>, WithLabelMixin<GridSelect<V>>, WithLabelPositionableMixin<GridSelect<V>>, WithValueMixin<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<V>,V>,V,GridSelect<V>>

@Tag(value="grid-select")
 @CssImport(value="./styles/label-positions-grids.css",
           themeFor="grid-select")
 @JsModule(value="./grid-select.js")
public class GridSelect<V>
extends AbstractGridSelect<V,V>
implements WithIdMixin<GridSelect<V>>, WithItemsMixin<V,GridSelect<V>>, WithHelperMixin<GridSelect<V>>, WithHelperPositionableMixin<GridSelect<V>>, WithLabelMixin<GridSelect<V>>, WithLabelPositionableMixin<GridSelect<V>>, WithValueMixin<com.vaadin.flow.component.AbstractField.ComponentValueChangeEvent<com.vaadin.flow.component.customfield.CustomField<V>,V>,V,GridSelect<V>>

A single-selection Grid that also is a value component that broadcasts value change events.

Since:

2020-08-07

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>

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

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>

Field Summary

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

Modifier	Constructor and Description
	GridSelect(Class<V> type, boolean createColumns, V... items) Constructs the component.
protected	GridSelect(com.vaadin.flow.component.grid.Grid<V> underlyingGrid) More advanced constructor that allows using predefined grid.
	GridSelect(V... items) Creates the component.

Method Summary

Modifier and Type	Method and Description
protected V	generateModelValue()
void	setItems(Collection<V> collection)
protected void	setPresentationValue(V v)

Methods inherited from class org.vaadin.miki.superfields.gridselect.AbstractGridSelect

configureGrid, getGrid, isEnabled, onGridSelected, setEnabled, setReadOnly

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

add, getErrorMessage, getLabel, isInvalid, remove, setErrorMessage, setInvalid, 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, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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 org.vaadin.miki.markers.WithIdMixin

withId

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

getId, setId

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

withItems, withItems, withItems

Methods inherited from interface com.vaadin.flow.data.binder.HasItems

setItems, setItems

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

withHelperComponent, withHelperText

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

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

withHelperAbove, withHelperAbove, withHelperBelow

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

isHelperAbove, setHelperAbove, setHelperAbove, setHelperBelow

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

withLabel

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

getLabel, setLabel

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

withLabelPosition

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

getLabelPosition, setLabelPosition

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

getElement

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

withValue

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

addValueChangeListener, clear, getEmptyValue, getOptionalValue, getValue, isEmpty, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible, setValue

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

getCssSize, 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.Focusable

addFocusShortcut, blur, focus, getTabIndex, setTabIndex

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

addBlurListener

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

addFocusListener

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

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

addAttachListener

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

addDetachListener

Constructor Detail

GridSelect

@SafeVarargs
public GridSelect(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()

GridSelect

@SafeVarargs
public GridSelect(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.

GridSelect

protected GridSelect(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

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>

setItems

public void setItems(Collection<V> collection)

Specified by:

setItems in interface com.vaadin.flow.data.binder.HasItems<V>