org.vaadin.miki.superfields.gridselect

Class AbstractGridSelect<V,F>

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,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.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>, Serializable

Direct Known Subclasses:

GridMultiSelect, GridSelect

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>

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGridSelect(com.vaadin.flow.component.grid.Grid<V> underlyingGrid)

Method Summary

Modifier and Type	Method and 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, generateModelValue, getErrorMessage, getLabel, isInvalid, remove, 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, 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 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.HasElement

getElement

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

getHelperComponent, getHelperText, setHelperComponent, setHelperText

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

isReadOnly, isRequiredIndicatorVisible, setRequiredIndicatorVisible

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

clear, getOptionalValue

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

addAttachListener

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

addDetachListener

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()