com.vaadin.flow.component.gridpro

Class GridPro.EditColumn<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.grid.Grid.Column<T>

com.vaadin.flow.component.gridpro.GridPro.EditColumn<T>

Type Parameters:

T - type of the underlying grid this column is compatible with

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, Serializable

Enclosing class:

GridPro<E>

@Tag(value="vaadin-grid-pro-edit-column")
public static class GridPro.EditColumn<T>
extends Grid.Column<T>

Server-side component for the <vaadin-grid-edit-column> element.

Every added column sends data to the client side regardless of its visibility state. Don't add a new column at all or use Grid.removeColumn(Column) to avoid sending extra data.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.flow.dom.Element	footerTemplate
protected Grid<?>	grid
protected com.vaadin.flow.dom.Element	headerTemplate

Constructor Summary

Constructors

Constructor and Description
EditColumn(GridPro<T> grid, String columnId, com.vaadin.flow.data.renderer.Renderer<T> renderer) Constructs a new Column for use inside a Grid.

Method Summary

Modifier and Type	Method and Description
protected String	addGridSorter(String arg0)
protected List<Grid.Column<?>>	getBottomChildColumns()
protected com.vaadin.flow.component.AbstractField	getEditorField()
protected String	getEditorType() Gets the type of the editor that is used for modifying cell value.
protected com.vaadin.flow.data.renderer.Renderer<?>	getFooterRenderer()
protected com.vaadin.flow.data.renderer.Renderer<?>	getHeaderRenderer()
protected ItemUpdater<T,String>	getItemUpdater() Gets the itemUpdater function that will be called on item changed.
protected List<String>	getOptions() Gets the list of options that is used for select type of the editor.
default ColumnTextAlign	getTextAlign()
com.vaadin.flow.function.ValueProvider<T,?>	getValueProvider()
protected boolean	hasSortingIndicators()
default boolean	isFrozen()
default boolean	isResizable()
protected void	setBaseHeaderTemplate(String arg0)
protected void	setEditorField(com.vaadin.flow.component.AbstractField editorField)
protected GridPro.EditColumn<T>	setEditorType(EditorType type) Sets the type of the editor that is used for modifying cell value.
protected void	setFooterComponent(com.vaadin.flow.component.Component arg0)
protected void	setFooterRenderer(com.vaadin.flow.data.renderer.Renderer<?> arg0)
protected void	setFooterText(String arg0)
default T	setFrozen(boolean arg0)
protected void	setHeaderComponent(com.vaadin.flow.component.Component arg0)
protected void	setHeaderRenderer(com.vaadin.flow.data.renderer.Renderer<?> arg0)
protected void	setHeaderText(String arg0)
protected GridPro.EditColumn<T>	setItemUpdater(ItemUpdater<T,String> itemUpdater) Sets the itemUpdater function that will be called on item changed.
protected GridPro.EditColumn<T>	setOptions(List<String> options) Sets the list of options that is used for select type of the editor.
default T	setResizable(boolean arg0)
protected void	setSortingIndicators(boolean arg0)
default T	setTextAlign(ColumnTextAlign arg0)
void	setValueProvider(com.vaadin.flow.function.ValueProvider<T,?> valueProvider)
protected void	updateSortingIndicators(boolean arg0)

Methods inherited from class com.vaadin.flow.component.grid.Grid.Column

destroyDataGenerators, getBottomLevelColumn, getClassNameGenerator, getComparator, getEditorComponent, getElement, getFlexGrow, getInternalId, getKey, getRenderer, getSortOrder, getWidth, isAutoWidth, isSortable, setAutoWidth, setClassNameGenerator, setComparator, setComparator, setEditorComponent, setEditorComponent, setFlexGrow, setFooter, setFooter, setHeader, setHeader, setKey, setSortable, setSortOrderProvider, setSortProperty, setWidth

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getChildren, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId

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.AttachNotifier

addAttachListener

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

addDetachListener

Field Detail

grid

protected final Grid<?> grid

headerTemplate

protected com.vaadin.flow.dom.Element headerTemplate

footerTemplate

protected com.vaadin.flow.dom.Element footerTemplate

Constructor Detail

EditColumn

public EditColumn(GridPro<T> grid,
                  String columnId,
                  com.vaadin.flow.data.renderer.Renderer<T> renderer)

Constructs a new Column for use inside a Grid.

Parameters:

grid - the grid this column is attached to

columnId - unique identifier of this column

renderer - the renderer to use in this column, must not be null

Method Detail

setItemUpdater

protected GridPro.EditColumn<T> setItemUpdater(ItemUpdater<T,String> itemUpdater)

Sets the itemUpdater function that will be called on item changed.

Parameters:

itemUpdater - the callback function that is called when item is changed. It receives two arguments: item and newValue.

Returns:

this column instance

getItemUpdater

protected ItemUpdater<T,String> getItemUpdater()

Gets the itemUpdater function that will be called on item changed.

Returns:

the instance of itemUpdater for this column

getEditorField

protected com.vaadin.flow.component.AbstractField getEditorField()

setEditorField

protected void setEditorField(com.vaadin.flow.component.AbstractField editorField)

setEditorType

protected GridPro.EditColumn<T> setEditorType(EditorType type)

Sets the type of the editor that is used for modifying cell value.

Parameters:

type - the type of the editor

Returns:

this column instance

See Also:

EditorType

getEditorType

@Synchronize(value="editor-type-changed")
protected String getEditorType()

Gets the type of the editor that is used for modifying cell value.

Returns:

the editor type

setOptions

protected GridPro.EditColumn<T> setOptions(List<String> options)

Sets the list of options that is used for select type of the editor.

Parameters:

options - the list of options

Returns:

this column instance

getOptions

@Synchronize(value="editor-options-changed")
protected List<String> getOptions()

Gets the list of options that is used for select type of the editor.

Returns:

the list of options

getValueProvider

public com.vaadin.flow.function.ValueProvider<T,?> getValueProvider()

setValueProvider

public void setValueProvider(com.vaadin.flow.function.ValueProvider<T,?> valueProvider)

setHeaderRenderer

protected void setHeaderRenderer(com.vaadin.flow.data.renderer.Renderer<?> arg0)

setFooterRenderer

protected void setFooterRenderer(com.vaadin.flow.data.renderer.Renderer<?> arg0)

setHeaderText

protected void setHeaderText(String arg0)

setFooterText

protected void setFooterText(String arg0)

setHeaderComponent

protected void setHeaderComponent(com.vaadin.flow.component.Component arg0)

setFooterComponent

protected void setFooterComponent(com.vaadin.flow.component.Component arg0)

getHeaderRenderer

protected com.vaadin.flow.data.renderer.Renderer<?> getHeaderRenderer()

getFooterRenderer

protected com.vaadin.flow.data.renderer.Renderer<?> getFooterRenderer()

updateSortingIndicators

protected void updateSortingIndicators(boolean arg0)

setSortingIndicators

protected void setSortingIndicators(boolean arg0)

hasSortingIndicators

protected boolean hasSortingIndicators()

setBaseHeaderTemplate

protected void setBaseHeaderTemplate(String arg0)

addGridSorter

protected String addGridSorter(String arg0)

getBottomChildColumns

protected List<Grid.Column<?>> getBottomChildColumns()

setResizable

public T setResizable(boolean arg0)

isResizable

@Synchronize(value="resizable-changed")
public boolean isResizable()

setFrozen

public T setFrozen(boolean arg0)

isFrozen

@Synchronize(value="frozen-changed")
public boolean isFrozen()

setTextAlign

public T setTextAlign(ColumnTextAlign arg0)

getTextAlign

@Synchronize(value="text-align-changed")
public ColumnTextAlign getTextAlign()