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:

AttachNotifier, DetachNotifier, 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 Element	footerTemplate
protected Grid<?>	grid
protected Element	headerTemplate

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected String	addGridSorter(String templateInnerHtml)
protected List<Grid.Column<?>>	getBottomChildColumns() Gets recursively the child components of this component that are instances of Column.
protected AbstractField	getEditorField()
protected String	getEditorType() Gets the type of the editor that is used for modifying cell value.
protected Renderer<?>	getFooterRenderer()
Grid<?>	getGrid() Gets the owner of this column.
protected 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() Gets the column text align.
ValueProvider<T,?>	getValueProvider()
protected boolean	hasSortingIndicators()
default boolean	isFrozen() Gets the this column's frozen state.
default boolean	isResizable() Gets whether this column is user-resizable.
protected void	setBaseHeaderTemplate(String headerTemplate)
protected void	setEditorField(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(Component component)
protected void	setFooterRenderer(Renderer<?> renderer)
protected void	setFooterText(String text)
default T	setFrozen(boolean frozen) Sets this column's frozen state.
protected void	setHeaderComponent(Component component)
protected void	setHeaderRenderer(Renderer<?> renderer)
protected void	setHeaderText(String text)
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 resizable) When set to true, the column is user-resizable.
protected void	setSortingIndicators(boolean sortingIndicators) Sets this component to show sorting indicators or not.
default T	setTextAlign(ColumnTextAlign textAlign) Sets the column text align.
void	setValueProvider(ValueProvider<T,?> valueProvider)
void	setVisible(boolean visible) Sets the component visibility value.
protected void	updateSortingIndicators(boolean sortable) Updates this component to either have sorting indicators according to the sortable state of the underlying column, or removes the sorting indicators.

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 Element headerTemplate

footerTemplate

protected Element footerTemplate

Constructor Detail

EditColumn

public EditColumn(GridPro<T> grid,
                  String columnId,
                  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 AbstractField getEditorField()

setEditorField

protected void setEditorField(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 ValueProvider<T,?> getValueProvider()

setValueProvider

public void setValueProvider(ValueProvider<T,?> valueProvider)

getGrid

public Grid<?> getGrid()

Gets the owner of this column.

Returns:

the grid which owns this column

setVisible

public void setVisible(boolean visible)

Sets the component visibility value.

When a component is set as invisible, all the updates of the component from the server to the client are blocked until the component is set as visible again.

Invisible components don't receive any updates from the client-side. Unlike the server-side updates, client-side updates, if any, are discarded while the component is invisible, and are not transmitted to the server when the component is made visible.

Note that column related data is sent to the client side even if the column is invisible. Use Grid.removeColumn(Column) to remove column (or don't add the column all) and avoid sending extra data.

Overrides:

setVisible in class Component

Parameters:

visible - the component visibility value

See Also:

Grid.removeColumn(Column)

setHeaderRenderer

protected void setHeaderRenderer(Renderer<?> renderer)

setFooterRenderer

protected void setFooterRenderer(Renderer<?> renderer)

setHeaderText

protected void setHeaderText(String text)

setFooterText

protected void setFooterText(String text)

setHeaderComponent

protected void setHeaderComponent(Component component)

setFooterComponent

protected void setFooterComponent(Component component)

getHeaderRenderer

protected Renderer<?> getHeaderRenderer()

getFooterRenderer

protected Renderer<?> getFooterRenderer()

updateSortingIndicators

protected void updateSortingIndicators(boolean sortable)

Updates this component to either have sorting indicators according to the sortable state of the underlying column, or removes the sorting indicators.

Parameters:

sortable - true to have sorting indicators if the column is sortable, false to not have sorting indicators

setSortingIndicators

protected void setSortingIndicators(boolean sortingIndicators)

Sets this component to show sorting indicators or not.

Parameters:

sortingIndicators - true to show sorting indicators, false to remove them

hasSortingIndicators

protected boolean hasSortingIndicators()

setBaseHeaderTemplate

protected void setBaseHeaderTemplate(String headerTemplate)

addGridSorter

protected String addGridSorter(String templateInnerHtml)

getBottomChildColumns

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

Gets recursively the child components of this component that are instances of Column.

Returns:

the Column children of this component

setResizable

public T setResizable(boolean resizable)

When set to true, the column is user-resizable. By default this is set to false.

Parameters:

resizable - whether to allow user resizing of this column

Returns:

this column, for method chaining

isResizable

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

Gets whether this column is user-resizable.

Returns:

whether this column is user-resizable

setFrozen

public T setFrozen(boolean frozen)

Sets this column's frozen state.

Note: Columns are frozen in-place, freeze columns from left to right for a consistent outcome.

Parameters:

frozen - whether to freeze or unfreeze this column

Returns:

this column, for method chaining

isFrozen

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

Gets the this column's frozen state.

Returns:

whether this column is frozen

setTextAlign

public T setTextAlign(ColumnTextAlign textAlign)

Sets the column text align.

Parameters:

textAlign - the text alignment of the column. Setting it to null resets the alignment to the default value ColumnTextAlign.START.

Returns:

this column, for method chaining

getTextAlign

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

Gets the column text align. The default is ColumnTextAlign.START.

Returns:

the column text align, not null