Package | Description |
---|---|
com.vaadin.flow.component.grid | |
com.vaadin.flow.component.gridpro | |
com.vaadin.flow.component.treegrid |
Modifier and Type | Method and Description |
---|---|
protected <C extends Grid.Column<T>> |
Grid.addColumn(Renderer<T> renderer,
BiFunction<Renderer<T>,String,C> columnFactory)
Adds a new text column to this
Grid with a renderer and column
factory provided. |
protected <C extends Grid.Column<T>> |
Grid.addColumn(Renderer<T> renderer,
BiFunction<Renderer<T>,String,C> columnFactory,
String... sortingProperties)
Adds a new text column to this
Grid with a template renderer,
sorting properties and column factory provided. |
protected <C extends Grid.Column<T>> |
Grid.addColumn(String propertyName,
BiFunction<Renderer<T>,String,C> columnFactory)
Adds a new column for the given property name with the column factory
provided.
|
protected <C extends Grid.Column<T>> |
Grid.addColumn(ValueProvider<T,?> valueProvider,
BiFunction<Renderer<T>,String,C> columnFactory)
Adds a new text column to this
Grid with a value provider and
column factory provided. |
Modifier and Type | Method and Description |
---|---|
Grid.Column<T> |
Grid.addColumn(Renderer<T> renderer)
Adds a new text column to this
Grid with a renderer and default
column factory. |
Grid.Column<T> |
Grid.addColumn(Renderer<T> renderer,
String... sortingProperties)
Adds a new text column to this
Grid with a template renderer,
sorting properties and default column factory. |
Grid.Column<T> |
Grid.addColumn(String propertyName)
Adds a new column for the given property name with the default column
factory.
|
Grid.Column<T> |
Grid.addColumn(ValueProvider<T,?> valueProvider)
Adds a new text column to this
Grid with a value provider and
default column factory. |
<V extends Comparable<? super V>> |
Grid.addColumn(ValueProvider<T,V> valueProvider,
String... sortingProperties)
Adds a new text column to this
Grid with a value provider and
sorting properties.The value is converted to a JSON value by using
JsonSerializer.toJson(Object) . |
<V extends Component> |
Grid.addComponentColumn(ValueProvider<T,V> componentProvider)
Adds a new column that shows components.
|
protected Grid.Column<T> |
Grid.createColumn(Renderer<T> renderer,
String columnId)
Deprecated.
This method should not be used outside.
Grid.getDefaultColumnFactory() should be used instead. |
protected Grid.Column<?> |
Grid.Column.getBottomLevelColumn() |
Grid.Column<T> |
ItemClickEvent.getColumn()
Gets the column that was clicked.
|
Grid.Column<T> |
Grid.getColumnByKey(String columnKey)
Gets a
Grid.Column of this grid by its key. |
Grid.Column<T> |
ColumnResizeEvent.getResizedColumn()
Returns the column that was the target of user's resize action
|
Grid.Column<T> |
GridSortOrder.getSorted()
Gets the column this sorting information is attached to.
|
Grid.Column<T> |
Grid.Column.setAutoWidth(boolean autoWidth)
Enables or disables automatic width for this column.
|
Grid.Column<T> |
Grid.Column.setClassNameGenerator(SerializableFunction<T,String> classNameGenerator)
Sets the function that is used for generating CSS class names for
cells in this column.
|
Grid.Column<T> |
Grid.Column.setComparator(Comparator<T> comparator)
Sets a comparator to use with in-memory sorting with this column.
|
<V extends Comparable<? super V>> |
Grid.Column.setComparator(ValueProvider<T,V> keyExtractor)
Sets a comparator to use with in-memory sorting with this column
based on the return type of the given
ValueProvider .Sorting
with a back-end is done using
setSortProperty(String[]) . |
Grid.Column<T> |
Grid.Column.setEditorComponent(Component editorComponent)
Sets a component to use for editing values of this column in the
editor row.
|
Grid.Column<T> |
Grid.Column.setEditorComponent(SerializableFunction<T,? extends Component> componentCallback)
Sets a function that returns the editor component to be used for an
specific item in the editor row.
|
Grid.Column<T> |
Grid.Column.setFlexGrow(int flexGrow)
Sets the flex grow ratio for this column.
|
Grid.Column<T> |
Grid.Column.setFooter(Component footerComponent)
Sets a footer component to the column.
|
Grid.Column<T> |
Grid.Column.setFooter(String labelText)
Sets a footer text to the column.
|
Grid.Column<T> |
Grid.Column.setHeader(Component headerComponent)
Sets a header component to the column.
|
Grid.Column<T> |
Grid.Column.setHeader(String labelText)
Sets a header text to the column.
|
Grid.Column<T> |
Grid.Column.setKey(String key)
Sets the user-defined identifier to map this column.
|
Grid.Column<T> |
Grid.Column.setSortable(boolean sortable)
Sets whether the user can sort this column or not.
|
Grid.Column<T> |
Grid.Column.setSortOrderProvider(SortOrderProvider provider)
Sets the sort orders when sorting this column.
|
Grid.Column<T> |
Grid.Column.setSortProperty(String... properties)
Sets strings describing back end properties to be used when sorting
this column.
|
Grid.Column<T> |
Grid.Column.setWidth(String width)
Sets the width of this column as a CSS-string.
|
Modifier and Type | Method and Description |
---|---|
Optional<Grid.Column<T>> |
CellFocusEvent.getColumn()
Returns the column represented by the focused cell.
|
List<Grid.Column<T>> |
Grid.getColumns()
Gets an unmodifiable list of all
Grid.Column s currently in this
Grid . |
List<Grid.Column<T>> |
ColumnReorderEvent.getColumns()
Gets the new order of the columns.
|
protected BiFunction<Renderer<T>,String,Grid.Column<T>> |
Grid.getDefaultColumnFactory()
Gives a reference to the column factory.
|
Modifier and Type | Method and Description |
---|---|
static <T> GridSortOrderBuilder<T> |
GridSortOrder.asc(Grid.Column<T> by)
Creates a new grid sort builder with given sorting using ascending sort
direction.
|
protected GridSortOrder<T> |
GridSortOrderBuilder.createSortOrder(Grid.Column<T> by,
SortDirection direction) |
static <T> GridSortOrderBuilder<T> |
GridSortOrder.desc(Grid.Column<T> by)
Creates a new grid sort builder with given sorting using descending sort
direction.
|
HeaderRow.HeaderCell |
HeaderRow.join(Grid.Column<?>... columnsToMerge)
Joins the cells corresponding the given columns in the row.
|
void |
Grid.removeColumn(Grid.Column<T> column)
Removes a column from the Grid.
|
void |
Grid.removeColumns(Grid.Column<T>... columns)
Removes columns from the Grid.
|
protected void |
Grid.setColumnKey(String key,
Grid.Column column)
Sets a user-defined identifier for given column.
|
void |
Grid.setColumnOrder(Grid.Column<T>... columns)
Sets a new column order for the grid.
|
GridSortOrderBuilder<T> |
GridSortOrderBuilder.thenAsc(Grid.Column<T> by) |
GridSortOrderBuilder<T> |
GridSortOrderBuilder.thenDesc(Grid.Column<T> by) |
Modifier and Type | Method and Description |
---|---|
void |
Grid.setColumnOrder(List<Grid.Column<T>> columns)
Sets a new column order for the grid.
|
Constructor and Description |
---|
GridSortOrder(Grid.Column<T> column,
SortDirection direction)
Construct sorting information for usage in a
Grid . |
Constructor and Description |
---|
ColumnReorderEvent(Grid<T> source,
boolean fromClient,
List<Grid.Column<T>> columns)
Creates a new column reorder event.
|
Modifier and Type | Class and Description |
---|---|
static class |
GridPro.EditColumn<T>
Server-side component for the
<vaadin-grid-edit-column> element. |
Modifier and Type | Method and Description |
---|---|
Grid.Column<T> |
EditColumnConfigurator.checkbox(ItemUpdater<T,Boolean> itemUpdater)
Configures the column to have a checkbox editor with the given item
updater.
|
<V> Grid.Column<T> |
EditColumnConfigurator.custom(AbstractField<?,V> component,
ItemUpdater<T,V> itemUpdater) |
Grid.Column<T> |
EditColumnConfigurator.getColumn()
Gets the column.
|
<E extends Enum<E>> |
EditColumnConfigurator.select(ItemUpdater<T,E> itemUpdater,
Class<E> enumType)
Configures the column to have a select editor with the given item
updater, enum type using toString() as the string representation.
|
<E extends Enum<E>> |
EditColumnConfigurator.select(ItemUpdater<T,E> itemUpdater,
Class<E> enumType,
SerializableFunction<E,String> getStringRepresentation)
Configures the column to have a select editor with the given item
updater, enum type and string representation callback.
|
Grid.Column<T> |
EditColumnConfigurator.select(ItemUpdater<T,String> itemUpdater,
List<String> options)
Configures the column to have a select editor with the given item updater
and options.
|
Grid.Column<T> |
EditColumnConfigurator.select(ItemUpdater<T,String> itemUpdater,
String... options)
Configures the column to have a select editor with the given item updater
and options.
|
Grid.Column<T> |
EditColumnConfigurator.text(ItemUpdater<T,String> itemUpdater)
Configures the column to have a text editor with the given item updater.
|
Modifier and Type | Method and Description |
---|---|
<V extends Component> |
TreeGrid.addComponentHierarchyColumn(ValueProvider<T,V> componentProvider)
Adds a new Hierarchy column that shows components.
|
Grid.Column<T> |
TreeGrid.addHierarchyColumn(ValueProvider<T,?> valueProvider)
Adds a new Hierarchy column to this
Grid with a value provider. |
Grid.Column<T> |
TreeGrid.setColumns(String hierarchyPropertyName,
ValueProvider<T,?> valueProvider,
Collection<String> propertyNames)
Note: This method can only be used for a TreeGrid
created from a bean type with
TreeGrid.TreeGrid(Class) . |
Grid.Column<T> |
TreeGrid.setHierarchyColumn(String propertyName)
Note: This method can only be used for a TreeGrid
created from a bean type with
TreeGrid.TreeGrid(Class) . |
Grid.Column<T> |
TreeGrid.setHierarchyColumn(String propertyName,
ValueProvider<T,?> valueProvider)
Note: This method can only be used for a TreeGrid
created from a bean type with
TreeGrid.TreeGrid(Class) . |
Copyright © 2025. All rights reserved.