Index
All Classes and Interfaces|All Packages|Serialized Form
A
- ABOVE - Enum constant in enum class com.vaadin.flow.component.grid.dnd.GridDropLocation
-
Drop above or before the row.
- AbstractGridExtension(Grid<T>) - Constructor for class com.vaadin.flow.component.grid.Grid.AbstractGridExtension
-
Constructs a new grid extension, extending the given grid.
- AbstractGridMultiSelectionModel<T> - Class in com.vaadin.flow.component.grid
-
Abstract implementation of a GridMultiSelectionModel.
- AbstractGridMultiSelectionModel(Grid<T>) - Constructor for class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
-
Constructor for passing a reference of the grid to this implementation.
- AbstractGridSingleSelectionModel<T> - Class in com.vaadin.flow.component.grid
-
Abstract implementation of a GridSingleSelectionModel.
- AbstractGridSingleSelectionModel(Grid<T>) - Constructor for class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
-
Constructor for passing a reference of the grid to this implementation.
- addCancelListener(EditorCancelListener<T>) - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Adds an editor cancel
listener. - addCancelListener(EditorCancelListener<T>) - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- addCell(int, AbstractColumn<?>) - Method in class com.vaadin.flow.component.grid.FooterRow
- addCell(int, AbstractColumn<?>) - Method in class com.vaadin.flow.component.grid.HeaderRow
- addCellFocusListener(ComponentEventListener<CellFocusEvent<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a listener to the grid that will be notified, when a cell has been focused.
- addClientItemToggleListener(ComponentEventListener<ClientItemToggleEvent<T>>) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- addClientItemToggleListener(ComponentEventListener<ClientItemToggleEvent<T>>) - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Adds a client item toggle listener that will be called when the user toggles the selection state of an item on the client-side.
- addCloseListener(EditorCloseListener<T>) - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Adds an editor close
listener. - addCloseListener(EditorCloseListener<T>) - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- addCollapseListener(ComponentEventListener<CollapseEvent<T, TreeGrid<T>>>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Adds a CollapseEvent listener to this TreeGrid.
- addColumn(Renderer<T>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new text column to this
Gridwith a renderer and default column factory. - addColumn(Renderer<T>, BiFunction<Renderer<T>, String, C>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new text column to this
Gridwith a renderer and column factory provided. - addColumn(ValueProvider<T, ?>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new text column to this
Gridwith a value provider and default column factory. - addColumn(ValueProvider<T, ?>, BiFunction<Renderer<T>, String, C>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new text column to this
Gridwith a value provider and column factory provided. - addColumn(ValueProvider<T, V>, String...) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new text column to this
Gridwith a value provider and sorting properties.The value is converted to a JSON value by usingJacksonSerializer.toJson(Object). - addColumn(String) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new column for the given property name with the default column factory.
- addColumn(String, BiFunction<Renderer<T>, String, C>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new column for the given property name with the column factory provided.
- addColumnReorderListener(ComponentEventListener<ColumnReorderEvent<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a column reorder listener to this component.
- addColumnResizeListener(ComponentEventListener<ColumnResizeEvent<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a column resize listener to this component.
- addColumns(String...) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new columns for the given property names.
- addComponentColumn(ValueProvider<T, V>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new column that shows components.
- addComponentHierarchyColumn(ValueProvider<T, V>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Adds a new Hierarchy column that shows components.
- addContextMenu() - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new context-menu for this grid.
- addDataGenerator(DataGenerator<T>) - Method in class com.vaadin.flow.component.grid.Grid
- addDragEndListener(ComponentEventListener<GridDragEndEvent<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a drag end listener to this component.
- addDragStartListener(ComponentEventListener<GridDragStartEvent<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a drag start listener to this component.
- addDropListener(ComponentEventListener<GridDropEvent<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a drop listener to this component.
- addExpandListener(ComponentEventListener<ExpandEvent<T, TreeGrid<T>>>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Adds an ExpandEvent listener to this TreeGrid.
- addFirstHeaderRow() - Method in class com.vaadin.flow.component.grid.Grid
- addGridContextMenuOpenedListener(ComponentEventListener<GridContextMenu.GridContextMenuOpenedEvent<T>>) - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
-
Adds a listener for the
opened-changedevents fired by the web component. - addHierarchyColumn(ValueProvider<T, ?>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Adds a new Hierarchy column to this
Gridwith a value provider. - addItem(Component, ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>>) - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
- addItem(Component, ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>>) - Method in class com.vaadin.flow.component.grid.contextmenu.GridSubMenu
- addItem(String, ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>>) - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
- addItem(String, ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>>) - Method in class com.vaadin.flow.component.grid.contextmenu.GridSubMenu
- addItemClickListener(ComponentEventListener<ItemClickEvent<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds an item click listener to this component.
- addItemDoubleClickListener(ComponentEventListener<ItemDoubleClickEvent<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds an item double click listener to this component.
- addMenuItemClickListener(ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>>) - Method in class com.vaadin.flow.component.grid.contextmenu.GridMenuItem
-
Adds the given click listener for this menu item.
- addMultiSelectionListener(MultiSelectionListener<Grid<T>, T>) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- addMultiSelectionListener(MultiSelectionListener<Grid<T>, T>) - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Adds a selection listener that will be called when the selection is changed either by the user or programmatically.
- addOpenListener(EditorOpenListener<T>) - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Adds an editor open
listener. - addOpenListener(EditorOpenListener<T>) - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- addSaveListener(EditorSaveListener<T>) - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Adds an editor save
listener. - addSaveListener(EditorSaveListener<T>) - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- addSelectionListener(SelectionListener<Grid<T>, T>) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- addSelectionListener(SelectionListener<Grid<T>, T>) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- addSelectionListener(SelectionListener<Grid<T>, T>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a selection listener to the current selection model.
- addSelectionListener(SelectionListener<Grid<T>, T>) - Method in class com.vaadin.flow.component.grid.GridNoneSelectionModel
- addSingleSelectionListener(SingleSelectionListener<Grid<T>, T>) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- addSingleSelectionListener(SingleSelectionListener<Grid<T>, T>) - Method in interface com.vaadin.flow.component.grid.GridSingleSelectionModel
-
Adds a selection listener that will be called when the selection is changed either by the user or programmatically.
- addSortListener(ComponentEventListener<SortEvent<Grid<T>, GridSortOrder<T>>>) - Method in class com.vaadin.flow.component.grid.Grid
- addThemeVariants(GridVariant...) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds theme variants to the component.
- addValueProvider(String, ValueProvider<T, ?>) - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a ValueProvider to this Grid that is not tied to a Column.
- ALLOW_NULLS - Enum constant in enum class com.vaadin.flow.component.grid.Grid.NestedNullBehavior
-
silently ignore any exceptions caused by nested
nullvalues - APPEND - Enum constant in enum class com.vaadin.flow.component.grid.Grid.MultiSortPriority
-
Whenever an unsorted column is sorted, it gets added at the end of the sort order, after all the previously sorted columns.
- appendFooterRow() - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new footer row to the bottom of the existing footer rows.
- appendHeaderRow() - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new header row to the bottom of the existing header rows.
- apply(SortDirection) - Method in interface com.vaadin.flow.component.grid.SortOrderProvider
-
Generates the sort orders when rows are sorted by a column.
- asc(Grid.Column<T>) - Static method in class com.vaadin.flow.component.grid.GridSortOrder
-
Creates a new grid sort builder with given sorting using ascending sort direction.
- asMultiSelect() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- asMultiSelect() - Method in class com.vaadin.flow.component.grid.Grid
-
Use this grid as a multiselect in
Binder. - asMultiSelect() - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Gets a wrapper to use this multiselection model as a multiselect in
Binder. - asSingleSelect() - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- asSingleSelect() - Method in class com.vaadin.flow.component.grid.Grid
-
Use this grid as a single select in
Binder. - asSingleSelect() - Method in interface com.vaadin.flow.component.grid.GridSingleSelectionModel
-
Gets a wrapper to use this single selection model as a single select in
Binder. - AURA_COLUMN_BORDERS - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- AURA_NO_BORDER - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- AURA_NO_ROW_BORDERS - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- AURA_ROW_STRIPES - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- AURA_WRAP_CELL_CONTENT - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
B
- BELOW - Enum constant in enum class com.vaadin.flow.component.grid.dnd.GridDropLocation
-
Drop below or after the row.
- BETWEEN - Enum constant in enum class com.vaadin.flow.component.grid.dnd.GridDropMode
-
The drop event can happen between Grid rows.
- BODY - Enum constant in enum class com.vaadin.flow.component.grid.CellFocusEvent.GridSection
-
Body section.
- build(Element, CompositeDataGenerator<T>, U, SerializableSupplier<ValueProvider<T, String>>) - Method in class com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder
-
Build a new
DataCommunicatorobject for the given Grid instance.
C
- cancel() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Cancel will discard any changes made in editor fields for a buffered editor.
- cancel() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- CellFocusEvent<T> - Class in com.vaadin.flow.component.grid
-
Event fired when a cell in the Grid is focused.
- CellFocusEvent(Grid<T>, boolean, String, String, String) - Constructor for class com.vaadin.flow.component.grid.CellFocusEvent
-
Creates a new cell focus event.
- CellFocusEvent.GridSection - Enum Class in com.vaadin.flow.component.grid
-
An enum representing the different sections of a grid.
- cells - Variable in class com.vaadin.flow.component.grid.FooterRow
- cells - Variable in class com.vaadin.flow.component.grid.HeaderRow
- CENTER - Enum constant in enum class com.vaadin.flow.component.grid.ColumnTextAlign
- clear(int, int) - Method in class com.vaadin.flow.component.grid.Grid.UpdateQueue
- clientDeselectAll() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- ClientItemToggleEvent<T> - Class in com.vaadin.flow.component.grid
-
Event fired when the user toggles the selection state of an item on the client-side.
- ClientItemToggleEvent(Grid<T>, T, boolean, boolean) - Constructor for class com.vaadin.flow.component.grid.ClientItemToggleEvent
-
Creates a new item toggle event.
- clientSelectAll() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- closeEditor() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Closes the editor when in unbuffered mode and fires an
EditorCloseEventif the edited item is notnull. - closeEditor() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- collapse(Collection<T>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Collapse the given items.
- collapse(Collection<T>, boolean) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Collapse the given items.
- collapse(T...) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Collapse the given items.
- CollapseEvent<T,
C> - Class in com.vaadin.flow.component.treegrid - CollapseEvent(C, boolean, Collection<T>) - Constructor for class com.vaadin.flow.component.treegrid.CollapseEvent
-
CollapseEvent base constructor.
- collapseRecursively(Collection<T>, int) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Collapse the given items and their children recursively until the given depth.
- collapseRecursively(Stream<T>, int) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Collapse the given items and their children recursively until the given depth.
- Column(Grid<T>, String, Renderer<T>) - Constructor for class com.vaadin.flow.component.grid.Grid.Column
-
Constructs a new Column for use inside a Grid.
- ColumnPathRenderer<SOURCE> - Class in com.vaadin.flow.component.grid
-
Renderer for columns that doesn't use a renderer function for rendering its contents (only the value from the object model).
- ColumnPathRenderer(String, ValueProvider<SOURCE, ?>) - Constructor for class com.vaadin.flow.component.grid.ColumnPathRenderer
-
Creates a new renderer based on the property and the value provider for that property.
- ColumnRendering - Enum Class in com.vaadin.flow.component.grid
-
Constants for the rendering mode of columns.
- ColumnReorderEvent<T> - Class in com.vaadin.flow.component.grid
-
Event fired when the columns in the Grid are reordered.
- ColumnReorderEvent(Grid<T>, boolean, List<Grid.Column<T>>) - Constructor for class com.vaadin.flow.component.grid.ColumnReorderEvent
-
Creates a new column reorder event.
- ColumnReorderEvent(Grid<T>, boolean, ArrayNode) - Constructor for class com.vaadin.flow.component.grid.ColumnReorderEvent
-
Creates a new column reorder event.
- ColumnResizeEvent<T> - Class in com.vaadin.flow.component.grid
-
Event fired when a Grid column is resized by the user.
- ColumnResizeEvent(Grid<T>, boolean, String) - Constructor for class com.vaadin.flow.component.grid.ColumnResizeEvent
-
Creates a new column resize event.
- ColumnTextAlign - Enum Class in com.vaadin.flow.component.grid
-
Constants for the text alignment of columns.
- com.vaadin.flow.component.grid - package com.vaadin.flow.component.grid
- com.vaadin.flow.component.grid.contextmenu - package com.vaadin.flow.component.grid.contextmenu
- com.vaadin.flow.component.grid.dataview - package com.vaadin.flow.component.grid.dataview
- com.vaadin.flow.component.grid.dnd - package com.vaadin.flow.component.grid.dnd
- com.vaadin.flow.component.grid.editor - package com.vaadin.flow.component.grid.editor
- com.vaadin.flow.component.treegrid - package com.vaadin.flow.component.treegrid
- commit() - Method in class com.vaadin.flow.component.grid.Grid.UpdateQueue
- commit(int) - Method in class com.vaadin.flow.component.grid.Grid.UpdateQueue
- compareMaybeComparables(Object, Object) - Static method in class com.vaadin.flow.component.grid.Grid
- configureBeanType(Class<T>, boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the bean type this grid is bound to and optionally adds a set of columns for each of the bean's properties.
- count(PAGEABLE) - Method in interface com.vaadin.flow.component.grid.Grid.SpringData.CountCallback
-
Counts the number of available items based on a pageable.
- createColumn(Renderer<T>, String) - Method in class com.vaadin.flow.component.grid.Grid
-
Deprecated.
- createColumnId(boolean) - Method in class com.vaadin.flow.component.grid.Grid
- createDefaultArrayUpdater() - Method in class com.vaadin.flow.component.grid.Grid
- createEditor() - Method in class com.vaadin.flow.component.grid.Grid
-
Creates a new Editor instance.
- createMenuManager() - Method in class com.vaadin.flow.component.grid.contextmenu.GridSubMenu
- createMenuManager(SerializableRunnable) - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
- createModel(Grid<T>) - Method in enum class com.vaadin.flow.component.grid.Grid.SelectionMode
-
Creates the selection model to use with this enum.
- createSortingComparator() - Method in class com.vaadin.flow.component.grid.Grid
-
Creates a comparator for grid to sort rows.
- createSortOrder(Grid.Column<T>, SortDirection) - Method in class com.vaadin.flow.component.grid.GridSortOrderBuilder
- createSubMenu() - Method in class com.vaadin.flow.component.grid.contextmenu.GridMenuItem
D
- DataCommunicatorBuilder() - Constructor for class com.vaadin.flow.component.grid.Grid.DataCommunicatorBuilder
- DEFAULT - Enum constant in enum class com.vaadin.flow.component.grid.GridMultiSelectionModel.SelectAllCheckboxVisibility
-
By default, the visibility of the select all checkbox depends on how the Grid's items are fetched: Visible, if the data is in-memory Hidden, if the data is NOT in-memory (lazy)
- desc(Grid.Column<T>) - Static method in class com.vaadin.flow.component.grid.GridSortOrder
-
Creates a new grid sort builder with given sorting using descending sort direction.
- deselect(T) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- deselect(T) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- deselect(T) - Method in class com.vaadin.flow.component.grid.Grid
-
This method is a shorthand that delegates to the currently set selection model.
- deselect(T) - Method in class com.vaadin.flow.component.grid.GridNoneSelectionModel
- deselectAll() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- deselectAll() - Method in class com.vaadin.flow.component.grid.Grid
-
This method is a shorthand that delegates to the currently set selection model.
- deselectAll() - Method in class com.vaadin.flow.component.grid.GridNoneSelectionModel
- deselectFromClient(T) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- deselectFromClient(T) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- deselectFromClient(T) - Method in class com.vaadin.flow.component.grid.GridNoneSelectionModel
- deselectFromClient(T) - Method in interface com.vaadin.flow.component.grid.GridSelectionModel
-
Handles the deselection of an item that originates from the client.
- destroyDataGenerators() - Method in class com.vaadin.flow.component.grid.Grid.Column
E
- EAGER - Enum constant in enum class com.vaadin.flow.component.grid.ColumnRendering
-
In this mode, all columns are rendered upfront, regardless of their visibility within the viewport.
- editItem(T) - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Opens the editor component for the provided item and fires an
EditorOpenEvent. - editItem(T) - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- Editor<T> - Interface in com.vaadin.flow.component.grid.editor
-
An editor in a Grid.
- EditorCancelEvent<T> - Class in com.vaadin.flow.component.grid.editor
-
Holds the data for cancel events fired in
Editor. - EditorCancelEvent(Editor<T>, T) - Constructor for class com.vaadin.flow.component.grid.editor.EditorCancelEvent
-
Constructor for the editor cancel event.
- EditorCancelListener<T> - Interface in com.vaadin.flow.component.grid.editor
-
An event listener for a
Grideditor cancel events. - EditorCloseEvent<T> - Class in com.vaadin.flow.component.grid.editor
-
Holds the data for close events fired in
Editor. - EditorCloseEvent(Editor<T>, T) - Constructor for class com.vaadin.flow.component.grid.editor.EditorCloseEvent
-
Constructor for the editor close event.
- EditorCloseListener<T> - Interface in com.vaadin.flow.component.grid.editor
-
An event listener for a
Grideditor close events. - EditorEvent<T> - Class in com.vaadin.flow.component.grid.editor
-
Base class for events fired in
Editor. - EditorEvent(Editor<T>, T) - Constructor for class com.vaadin.flow.component.grid.editor.EditorEvent
-
Constructor for the editor event.
- EditorImpl<T> - Class in com.vaadin.flow.component.grid.editor
-
Implementation of
Editorinterface. - EditorImpl(Grid<T>, PropertySet<T>) - Constructor for class com.vaadin.flow.component.grid.editor.EditorImpl
- EditorOpenEvent<T> - Class in com.vaadin.flow.component.grid.editor
-
Holds the data for open events fired in
Editor. - EditorOpenEvent(Editor<T>, T) - Constructor for class com.vaadin.flow.component.grid.editor.EditorOpenEvent
-
Constructor for the editor open event.
- EditorOpenListener<T> - Interface in com.vaadin.flow.component.grid.editor
-
An event listener for a
Grideditor open events. - EditorRenderer<T> - Class in com.vaadin.flow.component.grid.editor
-
Renderer and DataGenerator used by
Grid.Columnto control the state of the editor components. - EditorRenderer(Editor<T>, String) - Constructor for class com.vaadin.flow.component.grid.editor.EditorRenderer
-
Creates a new renderer for a specific column.
- EditorSaveEvent<T> - Class in com.vaadin.flow.component.grid.editor
-
Holds the data for save events fired in
Editor. - EditorSaveEvent(Editor<T>, T) - Constructor for class com.vaadin.flow.component.grid.editor.EditorSaveEvent
-
Constructor for the editor save event.
- EditorSaveListener<T> - Interface in com.vaadin.flow.component.grid.editor
-
An event listener for a
Grideditor save events. - EMPTY - Enum constant in enum class com.vaadin.flow.component.grid.dnd.GridDropLocation
-
Dropping into an empty grid, or to the empty area below the grid rows when
GridDropMode.ON_TOPis used. - END - Enum constant in enum class com.vaadin.flow.component.grid.ColumnTextAlign
- enqueue(String, Serializable...) - Method in class com.vaadin.flow.component.grid.Grid.UpdateQueue
- equals(Object) - Method in class com.vaadin.flow.component.grid.GridSortOrder
- expand(Collection<T>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Expands the given items.
- expand(Collection<T>, boolean) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Expands the given items.
- expand(T...) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Expands the given items.
- ExpandEvent<T,
C> - Class in com.vaadin.flow.component.treegrid - ExpandEvent(C, boolean, Collection<T>) - Constructor for class com.vaadin.flow.component.treegrid.ExpandEvent
-
ExpandEvent base constructor.
- expandRecursively(Collection<T>, int) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Expands the given items and their children recursively until the given depth.
- expandRecursively(Stream<T>, int) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Expands the given items and their children recursively until the given depth.
- extend(Grid<T>) - Method in class com.vaadin.flow.component.grid.Grid.AbstractGridExtension
-
Adds this extension to the given grid.
F
- fetch(PAGEABLE) - Method in interface com.vaadin.flow.component.grid.Grid.SpringData.FetchCallback
-
Fetches a list of items based on a pageable.
- fireSelectionEvent(SelectionEvent<Grid<T>, T>) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
-
Method for handling the firing of selection events.
- fireSelectionEvent(SelectionEvent<Grid<T>, T>) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
-
Method for handling the firing of selection events.
- FOOTER - Enum constant in enum class com.vaadin.flow.component.grid.CellFocusEvent.GridSection
-
Footer section.
- FooterRow - Class in com.vaadin.flow.component.grid
-
One row of
FooterRow.FooterCells in a Grid. - FooterRow.FooterCell - Class in com.vaadin.flow.component.grid
-
A footer cell in a Grid.
- fromPropertyValue(String) - Static method in enum class com.vaadin.flow.component.grid.ColumnRendering
-
Converts the property name in String form to the corresponding enum value.
- fromPropertyValue(String) - Static method in enum class com.vaadin.flow.component.grid.ColumnTextAlign
-
Converts the property name in String form to the corresponding enum value.
G
- generateData(T, ObjectNode) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- generateData(T, ObjectNode) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- generateData(T, ObjectNode) - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- generateData(T, ObjectNode) - Method in class com.vaadin.flow.component.grid.editor.EditorRenderer
- getAriaLabel() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the aria-label of the component.
- getArrayUpdater() - Method in class com.vaadin.flow.component.grid.Grid
- getBeanType() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns the Class of bean this Grid is constructed with via
Grid(Class). - getBinder() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Returns the underlying Binder from Editor.
- getBinder() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- getBottomChildColumns() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets recursively the child components of this component that are instances of Column.
- getBottomLevelColumn() - Method in class com.vaadin.flow.component.grid.Grid.Column
- getCell(Grid.Column<?>) - Method in class com.vaadin.flow.component.grid.FooterRow
-
Gets the cell on this row that is on the given column.
- getCell(Grid.Column<?>) - Method in class com.vaadin.flow.component.grid.HeaderRow
-
Gets the cell on this row that is on the given column.
- getCells() - Method in class com.vaadin.flow.component.grid.FooterRow
-
Gets the cells that belong to this row as an unmodifiable list.
- getCells() - Method in class com.vaadin.flow.component.grid.HeaderRow
-
Gets the cells that belong to this row as an unmodifiable list.
- getClientName() - Method in enum class com.vaadin.flow.component.grid.dnd.GridDropLocation
-
Gets name that is used in the client side representation of the component.
- getClientName() - Method in enum class com.vaadin.flow.component.grid.dnd.GridDropMode
-
Gets name that is used in the client side representation of the component.
- getClientSideName() - Method in enum class com.vaadin.flow.component.grid.CellFocusEvent.GridSection
-
Returns the client side name of the section.
- getColumn() - Method in class com.vaadin.flow.component.grid.CellFocusEvent
-
Returns the column represented by the focused cell.
- getColumn() - Method in class com.vaadin.flow.component.grid.ItemClickEvent
-
Gets the column that was clicked.
- getColumnByInternalId(String) - Method in class com.vaadin.flow.component.grid.Grid
-
Gets a
Grid.Columnof this grid by its internal id (_flowId). - getColumnByKey(String) - Method in class com.vaadin.flow.component.grid.Grid
-
Gets a
Grid.Columnof this grid by its key. - getColumnId() - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu.GridContextMenuOpenedEvent
-
Gets the column ID in the Grid that was the target of the context-click, or an empty
Optionalif the context-click didn't target any application column in the Grid (eg. selection column). - getColumnLayers() - Method in class com.vaadin.flow.component.grid.Grid
- getColumnRendering() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the current column rendering mode.
- getColumns() - Method in class com.vaadin.flow.component.grid.ColumnReorderEvent
-
Gets the new order of the columns.
- getColumns() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets an unmodifiable list of all
Grid.Columns currently in thisGrid. - getComparator(SortDirection) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the comparator to use with in-memory sorting for this column when sorting in the given direction.
- getComponent() - Method in class com.vaadin.flow.component.grid.FooterRow.FooterCell
- getComponent() - Method in class com.vaadin.flow.component.grid.HeaderRow.HeaderCell
- getDataCommunicator() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns the data communicator of this Grid.
- getDataCommunicator() - Method in class com.vaadin.flow.component.treegrid.TreeGrid
- getDataProvider() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns the data provider of this grid.
- getDataProvider() - Method in class com.vaadin.flow.component.treegrid.TreeGrid
- getDataTransferData() - Method in class com.vaadin.flow.component.grid.dnd.GridDropEvent
-
Get all of the transfer data from the
DataTransferobject. - getDataTransferData(String) - Method in class com.vaadin.flow.component.grid.dnd.GridDropEvent
-
Get data from the
DataTransferobject. - getDataTransferText() - Method in class com.vaadin.flow.component.grid.dnd.GridDropEvent
-
Get data of any of the types
"text","Text"or"text/plain". - getDefaultColumnFactory() - Method in class com.vaadin.flow.component.grid.Grid
-
Gives a reference to the column factory.
- getDefaultHeaderRow() - Method in class com.vaadin.flow.component.grid.Grid
- getDragFilter() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the active drag filter.
- getDraggedItems() - Method in class com.vaadin.flow.component.grid.dnd.GridDragStartEvent
-
Get the dragged row items.
- getDropFilter() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the active drop filter.
- getDropLocation() - Method in class com.vaadin.flow.component.grid.dnd.GridDropEvent
-
Get the location of the drop within the row.
- getDropMode() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the drop mode of this drop target.
- getDropTargetItem() - Method in class com.vaadin.flow.component.grid.dnd.GridDropEvent
-
Get the row the drop happened on.
- getDynamicContentHandler() - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
-
Gets the callback function that is executed before the context menu is opened.
- getEditor() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the editor.
- getEditorComponent() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the editor component that is used for this column.
- getElement() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the underlying
<vaadin-grid-column>element. - getElement() - Method in class com.vaadin.flow.component.grid.Grid.UpdateQueue
- getEmptyStateComponent() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns the component that is displayed when the grid is empty.
- getEmptyStateText() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns the text that is displayed when the grid is empty.
- getFirstSelectedItem() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- getFirstSelectedItem() - Method in class com.vaadin.flow.component.grid.GridNoneSelectionModel
- getFlexGrow() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the flex grow value, by default 1.
- getFooterComponent() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Returns the footer component of the column.
- getFooterPartName() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the custom part name of the footer cell.
- getFooterRows() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets all of the footer rows in the Grid, in order from top to bottom.
- getFooterText() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Returns the footer text of the column.
- getGenericDataView() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the generic data view for the grid.
- getGenericDataView() - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.not supported
- getGrid() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the owner of this column.
- getGrid() - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu.GridContextMenuItemClickEvent
-
Gets the Grid that the context menu is connected to.
- getGrid() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Gets the Grid instance which this editor belongs to.
- getGrid() - Method in class com.vaadin.flow.component.grid.editor.EditorEvent
-
Gets the editors' grid.
- getGrid() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- getGrid() - Method in class com.vaadin.flow.component.grid.Grid.AbstractGridExtension
-
Gets the Grid this extension extends.
- getHeaderComponent() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Returns the header component of the column.
- getHeaderPartName() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the custom part name of the header cell.
- getHeaderRows() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets all of the header rows in the Grid, in order from top to bottom.
- getHeaderText() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Returns the header text of the column.
- getInternalId() - Method in class com.vaadin.flow.component.grid.Grid.Column
- getItem() - Method in class com.vaadin.flow.component.grid.CellFocusEvent
-
Returns the item represented by the focused cell.
- getItem() - Method in class com.vaadin.flow.component.grid.ClientItemToggleEvent
-
Gets the item that was toggled.
- getItem() - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu.GridContextMenuItemClickEvent
-
Gets the item in the Grid that was the target of the context-click, or an empty
Optionalif the context-click didn't target any item in the Grid (eg. if targeting a header). - getItem() - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu.GridContextMenuOpenedEvent
-
Gets the item in the Grid that was the target of the context-click, or an empty
Optionalif the context-click didn't target any item in the Grid (eg. if targeting a header). - getItem() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Gets the current item being edited, if any.
- getItem() - Method in class com.vaadin.flow.component.grid.editor.EditorEvent
-
Gets the item being edited.
- getItem() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- getItem() - Method in class com.vaadin.flow.component.grid.ItemClickEvent
-
Gets the clicked item.
- getItem(int) - Method in class com.vaadin.flow.component.grid.dataview.GridDataView
- getItemCount() - Method in class com.vaadin.flow.component.grid.dataview.GridListDataView
- getItems() - Method in class com.vaadin.flow.component.grid.dataview.GridDataView
- getItems() - Method in class com.vaadin.flow.component.grid.dataview.GridListDataView
- getItems() - Method in class com.vaadin.flow.component.treegrid.CollapseEvent
- getItems() - Method in class com.vaadin.flow.component.treegrid.ExpandEvent
- getItemsWithChildrenRecursively(Collection<T>, int) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Gets given items and their children recursively until the given depth.
- getKey() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the user-defined key for this column, or
nullif no key has been set. - getLazyDataView() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the lazy data view for the grid.
- getLazyDataView() - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.not supported
- getListDataView() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the list data view for the grid.
- getListDataView() - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.not supported
- getNestedNullBehavior() - Method in class com.vaadin.flow.component.grid.Grid
-
Get the behavior when facing nested
nullvalues. - getPageSize() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the current page size, which is the number of items fetched at a time from the dataprovider.
- getPartName() - Method in class com.vaadin.flow.component.grid.FooterRow.FooterCell
- getPartName() - Method in class com.vaadin.flow.component.grid.HeaderRow.HeaderCell
- getPartNameGenerator() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the function that is used for generating CSS part names for cells in this column.
- getPartNameGenerator() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the function that is used for generating CSS part names for rows in this grid.
- getPropertySet() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns
PropertySetof bean this Grid is constructed with viaGrid(Class). - getPropertyValue() - Method in enum class com.vaadin.flow.component.grid.ColumnRendering
-
Gets the property value for the rendering mode.
- getPropertyValue() - Method in enum class com.vaadin.flow.component.grid.ColumnTextAlign
-
Gets the client-side property for the textAlign property.
- getRenderer() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Get the renderer used for this column.
- getResizedColumn() - Method in class com.vaadin.flow.component.grid.ColumnResizeEvent
-
Returns the column that was the target of user's resize action
- getSection() - Method in class com.vaadin.flow.component.grid.CellFocusEvent
-
Returns the grid section, where this cell is located.
- getSelectAllCheckboxVisibility() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- getSelectAllCheckboxVisibility() - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Gets the current mode for the select all checkbox visibility.
- getSelectedItem() - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- getSelectedItemIds() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
-
Returns an unmodifiable view of the selected item ids.
- getSelectedItems() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- getSelectedItems() - Method in class com.vaadin.flow.component.grid.Grid
-
This method is a shorthand that delegates to the currently set selection model.
- getSelectedItems() - Method in class com.vaadin.flow.component.grid.GridNoneSelectionModel
- getSelectionColumn() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- getSelectionMode() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns the selection mode for this grid.
- getSelectionModel() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns the selection model for this grid.
- getSelectionPreservationMode() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the selection preservation mode.
- getSorted() - Method in class com.vaadin.flow.component.grid.GridSortOrder
-
Gets the column this sorting information is attached to.
- getSortOrder() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets an list of the current sort orders in the Grid.
- getSortOrder(SortDirection) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the sort orders to use with back-end sorting for this column when sorting in the given direction.
- getSource() - Method in class com.vaadin.flow.component.grid.editor.EditorEvent
- getSupportedDataProviderType() - Method in class com.vaadin.flow.component.grid.dataview.GridDataView
- getTemplateExpression() - Method in class com.vaadin.flow.component.treegrid.HierarchyColumnComponentRenderer
- getText() - Method in class com.vaadin.flow.component.grid.FooterRow.FooterCell
- getText() - Method in class com.vaadin.flow.component.grid.HeaderRow.HeaderCell
- getTextAlign() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the column text align.
- getTooltipGenerator() - Method in class com.vaadin.flow.component.grid.Grid.Column
- getTooltipPosition() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets the tooltip position relative to the cell that is being hovered or focused.
- getUniqueKeyProperty() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets property name for unique key in row's generated JSON.
- getUniqueKeyProvider() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets optional value provider for unique key in row's generated JSON.
- getVariantName() - Method in enum class com.vaadin.flow.component.grid.GridVariant
-
Gets the variant name.
- getWidth() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the width of this column as a CSS-string.
- grid - Variable in class com.vaadin.flow.component.grid.Grid.Column
- Grid<T> - Class in com.vaadin.flow.component.grid
-
Grid is a component for showing tabular data.
- Grid() - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new instance, with page size of 50.
- Grid(int) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new instance, with the specified page size.
- Grid(int, B) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new instance, with the specified page size and data communicator.
- Grid(BackEndDataProvider<T, Void>) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid using the given
BackEndDataProvider. - Grid(DataProvider<T, Void>) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid using the given generic
DataProvider. - Grid(InMemoryDataProvider<T>) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid using the given
InMemoryDataProvider. - Grid(ListDataProvider<T>) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid using the given
ListDataProvider. - Grid(Class<T>) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid with an initial set of columns for each of the bean's properties.
- Grid(Class<T>, boolean) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid with an initial set of columns for each of the bean's properties.
- Grid(Class<T>, B) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid with an initial set of columns for each of the bean's properties.
- Grid(Class<T>, B, boolean) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid with an initial set of columns for each of the bean's properties.
- Grid(Collection<T>) - Constructor for class com.vaadin.flow.component.grid.Grid
-
Creates a new grid using the given collection of items using a
ListDataProvider. - Grid.AbstractGridExtension<T> - Class in com.vaadin.flow.component.grid
-
A helper base class for creating extensions for the Grid component.
- Grid.Column<T> - Class in com.vaadin.flow.component.grid
-
Server-side component for the
<vaadin-grid-column>element. - Grid.DataCommunicatorBuilder<T,
U> - Class in com.vaadin.flow.component.grid -
Builder for
DataCommunicatorobject. - Grid.MultiSortPriority - Enum Class in com.vaadin.flow.component.grid
-
Multi-sort priority (visually indicated by numbers in column headers) controls how columns are added to the sort order, when a column becomes sorted, or the sort direction of a column is changed.
- Grid.NestedNullBehavior - Enum Class in com.vaadin.flow.component.grid
-
behavior when parsing nested properties which may contain
nullvalues in the property chain - Grid.SelectionMode - Enum Class in com.vaadin.flow.component.grid
-
Selection mode representing the built-in selection models in grid.
- Grid.SpringData - Interface in com.vaadin.flow.component.grid
- Grid.SpringData.CountCallback<PAGEABLE> - Interface in com.vaadin.flow.component.grid
-
Callback interface for counting the number of items in a backend based on a Spring Data Pageable.
- Grid.SpringData.FetchCallback<PAGEABLE,
T> - Interface in com.vaadin.flow.component.grid -
Callback interface for fetching a list of items from a backend based on a Spring Data Pageable.
- Grid.UpdateQueue - Class in com.vaadin.flow.component.grid
- GridArrayUpdater - Interface in com.vaadin.flow.component.grid
-
Array update strategy aware class for Grid.
- GridContextMenu<T> - Class in com.vaadin.flow.component.grid.contextmenu
-
Server-side component for
<vaadin-context-menu>to be used withGrid. - GridContextMenu() - Constructor for class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
-
Creates an empty context menu to be used with a Grid.
- GridContextMenu(Grid<T>) - Constructor for class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
-
Creates an empty context menu with the given target component.
- GridContextMenu.GridContextMenuItemClickEvent<T> - Class in com.vaadin.flow.component.grid.contextmenu
-
Event that is fired when a
GridMenuItemis clicked inside aGridContextMenu. - GridContextMenu.GridContextMenuOpenedEvent<T> - Class in com.vaadin.flow.component.grid.contextmenu
- GridContextMenuOpenedEvent(GridContextMenu<T>, boolean) - Constructor for class com.vaadin.flow.component.grid.contextmenu.GridContextMenu.GridContextMenuOpenedEvent
- GridDataView<T> - Class in com.vaadin.flow.component.grid.dataview
-
Implementation of generic data view for grid.
- GridDataView(DataCommunicator<T>, Grid<T>) - Constructor for class com.vaadin.flow.component.grid.dataview.GridDataView
- GridDragEndEvent<T> - Class in com.vaadin.flow.component.grid.dnd
-
Drag end event of
Gridrows. - GridDragEndEvent(Grid<T>, boolean) - Constructor for class com.vaadin.flow.component.grid.dnd.GridDragEndEvent
-
Creates a grid drag end event.
- GridDragStartEvent<T> - Class in com.vaadin.flow.component.grid.dnd
-
Drag start event of
Gridrows. - GridDragStartEvent(Grid<T>, boolean, ObjectNode) - Constructor for class com.vaadin.flow.component.grid.dnd.GridDragStartEvent
-
Creates a grid drag start event.
- GridDropEvent<T> - Class in com.vaadin.flow.component.grid.dnd
-
Drop event that occurs on the
Gridor its rows. - GridDropEvent(Grid<T>, boolean, ObjectNode, String, ArrayNode) - Constructor for class com.vaadin.flow.component.grid.dnd.GridDropEvent
-
Creates a grid drop event.
- GridDropLocation - Enum Class in com.vaadin.flow.component.grid.dnd
-
Defines drop locations within a Grid row.
- GridDropMode - Enum Class in com.vaadin.flow.component.grid.dnd
-
Defines the locations within the Grid row where an element can be dropped.
- GridLazyDataView<T> - Class in com.vaadin.flow.component.grid.dataview
-
Data view implementation for Grid with lazy data fetching.
- GridLazyDataView(DataCommunicator<T>, Grid<T>) - Constructor for class com.vaadin.flow.component.grid.dataview.GridLazyDataView
-
Creates a new lazy data view for grid and verifies the passed data provider is compatible with this data view implementation.
- GridListDataView<T> - Class in com.vaadin.flow.component.grid.dataview
-
Data view implementation for Grid with in-memory list data.
- GridListDataView(DataCommunicator<T>, Grid<T>, SerializableBiConsumer<SerializablePredicate<T>, SerializableComparator<T>>) - Constructor for class com.vaadin.flow.component.grid.dataview.GridListDataView
-
Creates a new instance of Grid in-memory data view and verifies the passed data provider is compatible with this data view implementation.
- GridMenuItem<T> - Class in com.vaadin.flow.component.grid.contextmenu
-
Item component used inside
GridContextMenuandGridSubMenu. - GridMenuItem(GridContextMenu<T>, SerializableRunnable) - Constructor for class com.vaadin.flow.component.grid.contextmenu.GridMenuItem
-
Creates a new instance using the context menu and its reset callback.
- GridMultiSelectionModel<T> - Interface in com.vaadin.flow.component.grid
-
Multiselection model interface for Grid.
- GridMultiSelectionModel.SelectAllCheckboxVisibility - Enum Class in com.vaadin.flow.component.grid
-
State for showing the select all checkbox in the grid's default header row for the selection column.
- GridNoneSelectionModel<T> - Class in com.vaadin.flow.component.grid
-
Selection model implementation for disabling selection in Grid.
- GridNoneSelectionModel() - Constructor for class com.vaadin.flow.component.grid.GridNoneSelectionModel
- GridSelectionColumn - Class in com.vaadin.flow.component.grid
-
Server side implementation for the flow specific grid selection column.
- GridSelectionColumn(SerializableRunnable, SerializableRunnable) - Constructor for class com.vaadin.flow.component.grid.GridSelectionColumn
-
Constructs a new grid selection column configured to use the given callbacks whenever the select all checkbox is toggled on the client side.
- GridSelectionModel<T> - Interface in com.vaadin.flow.component.grid
-
The server-side interface that controls Grid's selection state.
- GridSingleSelectionModel<T> - Interface in com.vaadin.flow.component.grid
-
Single selection model interface for Grid.
- GridSortOrder<T> - Class in com.vaadin.flow.component.grid
-
Sorting information for
Grid. - GridSortOrder(Grid.Column<T>, SortDirection) - Constructor for class com.vaadin.flow.component.grid.GridSortOrder
-
Construct sorting information for usage in a
Grid. - GridSortOrderBuilder<T> - Class in com.vaadin.flow.component.grid
-
Helper classes with fluent API for constructing
GridSortOrderlists. - GridSortOrderBuilder() - Constructor for class com.vaadin.flow.component.grid.GridSortOrderBuilder
- GridSubMenu<T> - Class in com.vaadin.flow.component.grid.contextmenu
-
API that allows adding content into the sub menus of a
GridContextMenuto create hierarchical menus. - GridSubMenu(GridMenuItem<T>, SerializableRunnable) - Constructor for class com.vaadin.flow.component.grid.contextmenu.GridSubMenu
-
Creates a new instance of submenu using the associated
parentMenuItem(item which opens the submenu) and reset context menu callback. - GridVariant - Enum Class in com.vaadin.flow.component.grid
-
Set of theme variants applicable for
vaadin-gridcomponent.
H
- hashCode() - Method in class com.vaadin.flow.component.grid.GridSortOrder
- hasSortingIndicators() - Method in class com.vaadin.flow.component.grid.Grid.Column
- HEADER - Enum constant in enum class com.vaadin.flow.component.grid.CellFocusEvent.GridSection
-
Header section.
- HeaderRow - Class in com.vaadin.flow.component.grid
-
One row of
HeaderRow.HeaderCells in a Grid. - HeaderRow.HeaderCell - Class in com.vaadin.flow.component.grid
-
A header cell in a Grid.
- HIDDEN - Enum constant in enum class com.vaadin.flow.component.grid.GridMultiSelectionModel.SelectAllCheckboxVisibility
-
Never shows the select all checkbox, regardless of data is in-memory or not (lazy).
- HierarchyColumnComponentRenderer<COMPONENT,
SOURCE> - Class in com.vaadin.flow.component.treegrid -
Renders components as hierarchy column for tree grid.
- HierarchyColumnComponentRenderer(ValueProvider<SOURCE, COMPONENT>, TreeGrid<SOURCE>) - Constructor for class com.vaadin.flow.component.treegrid.HierarchyColumnComponentRenderer
I
- initConnector() - Method in class com.vaadin.flow.component.grid.Grid
- initConnector() - Method in class com.vaadin.flow.component.treegrid.TreeGrid
- insertColumnLayer(int, List<AbstractColumn<?>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Creates a new layer from the provided columns, inserts the layer into given index and returns the new layer.
- isAllRowsVisible() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets whether grid's height is defined by the number of its rows.
- isAutoWidth() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets this column's auto width state.
- isBodyCell() - Method in class com.vaadin.flow.component.grid.CellFocusEvent
-
Indicates, if the clicked cell is part of the grid's body section.
- isBuffered() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Returns whether Editor is buffered or not.
- isBuffered() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- isColumnReorderingAllowed() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns whether column reordering is allowed.
- isDeselectAllowed() - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- isDetailsVisible(T) - Method in class com.vaadin.flow.component.grid.Grid
-
Returns the visibility of details component for given item.
- isDetailsVisibleOnClick() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets whether the item details are opened and closed by clicking the rows or not.
- isDragSelect() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- isDragSelect() - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Gets whether grid drag select is enabled or not.
- isDragSelect() - Method in class com.vaadin.flow.component.grid.GridSelectionColumn
-
Gets whether grid drag select is enabled or not.
- isExpanded(T) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Returns whether a given item is expanded or collapsed.
- isFooterCell() - Method in class com.vaadin.flow.component.grid.CellFocusEvent
-
Indicates, if the clicked cell is part of the grid's footer section.
- isFrozen() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the this column's frozen state.
- isFrozen() - Method in class com.vaadin.flow.component.grid.GridSelectionColumn
-
Gets the this column's frozen state.
- isFrozenToEnd() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets the this column's frozen state.
- isHeaderCell() - Method in class com.vaadin.flow.component.grid.CellFocusEvent
-
Indicates, if the clicked cell is part of the grid's header section.
- isMultiSort() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets whether multiple column sorting is enabled on the client-side.
- isOpen() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Returns whether Editor is open or not.
- isOpen() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- isOutmostRow() - Method in class com.vaadin.flow.component.grid.FooterRow
- isOutmostRow() - Method in class com.vaadin.flow.component.grid.HeaderRow
- isResizable() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets whether this column is user-resizable.
- isRowHeader() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets whether cells in this column should be announced as row headers.
- isRowsDraggable() - Method in class com.vaadin.flow.component.grid.Grid
-
Gets whether rows of the grid can be dragged.
- isSelectAllCheckboxVisible() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- isSelectAllCheckboxVisible() - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Returns whether the select all checkbox will be visible with the current setting of
GridMultiSelectionModel.setSelectAllCheckboxVisibility(SelectAllCheckboxVisibility)and the type of data set to the Grid (in-memory or lazy). - isSelected() - Method in class com.vaadin.flow.component.grid.ClientItemToggleEvent
-
Gets whether the item was selected.
- isSelected(T) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- isSelected(T) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- isSelectionColumnFrozen() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- isSelectionColumnFrozen() - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Gets the the selection column's frozen state.
- isShiftKey() - Method in class com.vaadin.flow.component.grid.ClientItemToggleEvent
-
Gets whether the shift key was pressed when the item was toggled.
- isSortable() - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Gets whether this column is sortable (e.g. shows the sorting indicators at the client-side).
- isTooltipMarkdownEnabled() - Method in class com.vaadin.flow.component.grid.Grid
-
Returns whether the tooltip content is rendered as Markdown.
- ItemClickEvent<T> - Class in com.vaadin.flow.component.grid
-
Event fired when a Grid item is clicked.
- ItemClickEvent(Grid<T>, boolean, String, String, int, int, int, int, int, int, boolean, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.grid.ItemClickEvent
-
Creates a new item click event.
- ItemDoubleClickEvent<T> - Class in com.vaadin.flow.component.grid
-
Event fired when a Grid item is double clicked.
- ItemDoubleClickEvent(Grid<T>, boolean, String, String, int, int, int, int, int, int, boolean, boolean, boolean, boolean) - Constructor for class com.vaadin.flow.component.grid.ItemDoubleClickEvent
-
Creates a new item double click event.
J
- join(FooterRow.FooterCell...) - Method in class com.vaadin.flow.component.grid.FooterRow
-
Replaces the given cells with a new cell that takes the full space of the joined cells.
- join(HeaderRow.HeaderCell...) - Method in class com.vaadin.flow.component.grid.HeaderRow
-
Replaces the given cells with a new cell that takes the full space of the joined cells.
- join(Grid.Column<?>...) - Method in class com.vaadin.flow.component.grid.FooterRow
-
Joins the cells corresponding the given columns in the row.
- join(Grid.Column<?>...) - Method in class com.vaadin.flow.component.grid.HeaderRow
-
Joins the cells corresponding the given columns in the row.
- join(Collection<FooterRow.FooterCell>) - Method in class com.vaadin.flow.component.grid.FooterRow
- join(Collection<HeaderRow.HeaderCell>) - Method in class com.vaadin.flow.component.grid.HeaderRow
-
Replaces the given cells with a new cell that takes the full space of the joined cells.
L
- layer - Variable in class com.vaadin.flow.component.grid.FooterRow
- layer - Variable in class com.vaadin.flow.component.grid.HeaderRow
- LAZY - Enum constant in enum class com.vaadin.flow.component.grid.ColumnRendering
-
In this mode, body cells are rendered only when their corresponding columns are inside the visible viewport.
- LUMO_COLUMN_BORDERS - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- LUMO_COMPACT - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- LUMO_NO_BORDER - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- LUMO_NO_ROW_BORDERS - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- LUMO_ROW_STRIPES - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
- LUMO_WRAP_CELL_CONTENT - Enum constant in enum class com.vaadin.flow.component.grid.GridVariant
M
- moveFooterContent(AbstractColumn<?>) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Moves the current footer content, either a text or a component, to a different column or column group.
- moveHeaderContent(AbstractColumn<?>) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Moves the current header content, either a text or a component, to a different column or column group.
- MULTI - Enum constant in enum class com.vaadin.flow.component.grid.Grid.SelectionMode
-
Multiselection mode that maps to built-in
SelectionModel.Multi.
N
- NONE - Enum constant in enum class com.vaadin.flow.component.grid.Grid.SelectionMode
-
Selection model that doesn't allow selection.
O
- ofClientSideName(String) - Static method in enum class com.vaadin.flow.component.grid.CellFocusEvent.GridSection
-
Returns the matching
CellFocusEvent.GridSectionfor the given client side name. - ON_GRID - Enum constant in enum class com.vaadin.flow.component.grid.dnd.GridDropMode
-
The drop event will not happen on any specific row, it will show the drop target outline around the whole grid.
- ON_TOP - Enum constant in enum class com.vaadin.flow.component.grid.dnd.GridDropLocation
-
Drop on top of the row.
- ON_TOP - Enum constant in enum class com.vaadin.flow.component.grid.dnd.GridDropMode
-
The drop event can happen on top of Grid rows.
- ON_TOP_OR_BETWEEN - Enum constant in enum class com.vaadin.flow.component.grid.dnd.GridDropMode
-
The drop event can happen either on top of or between Grid rows.
- onAttach(AttachEvent) - Method in class com.vaadin.flow.component.grid.Grid
- onBeforeOpenMenu(ObjectNode) - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
- onDataProviderChange() - Method in class com.vaadin.flow.component.grid.Grid
-
Callback which is called if a new data provider is set or any change happen in the current data provider (an
DataChangeEventevent is fired). - onDetach(DetachEvent) - Method in class com.vaadin.flow.component.grid.Grid
- onEditorCancel(EditorCancelEvent<T>) - Method in interface com.vaadin.flow.component.grid.editor.EditorCancelListener
-
Called when the editor is cancelled.
- onEditorClose(EditorCloseEvent<T>) - Method in interface com.vaadin.flow.component.grid.editor.EditorCloseListener
-
Called when the editor is closed.
- onEditorOpen(EditorOpenEvent<T>) - Method in interface com.vaadin.flow.component.grid.editor.EditorOpenListener
-
Called when the editor is opened.
- onEditorSave(EditorSaveEvent<T>) - Method in interface com.vaadin.flow.component.grid.editor.EditorSaveListener
-
Called when the editor is saved.
- onEnabledStateChanged(boolean) - Method in class com.vaadin.flow.component.grid.Grid
P
- PREPEND - Enum constant in enum class com.vaadin.flow.component.grid.Grid.MultiSortPriority
-
Whenever an unsorted column is sorted, or the sort direction of a column is changed, that column gets sort priority 1, and all the other sorted columns are updated accordingly.
- prependFooterRow() - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new footer row on the top of the existing footer rows.
- prependHeaderRow() - Method in class com.vaadin.flow.component.grid.Grid
-
Adds a new header row on the top of the existing header rows.
R
- recalculateColumnWidths() - Method in class com.vaadin.flow.component.grid.Grid
-
Updates the
widthof all columns which haveautoWidthset totrue. - refresh() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Refreshes the editor components for the current item being edited.
- refresh() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- refresh(T) - Method in class com.vaadin.flow.component.grid.Grid.AbstractGridExtension
-
A helper method for refreshing the client-side representation of a single data item.
- refreshData(T) - Method in class com.vaadin.flow.component.grid.editor.EditorRenderer
- refreshViewport() - Method in class com.vaadin.flow.component.grid.Grid
- refreshViewport() - Method in class com.vaadin.flow.component.treegrid.TreeGrid
- remove() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- remove() - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- remove() - Method in class com.vaadin.flow.component.grid.Grid.AbstractGridExtension
-
Remove this extension from its target.
- removeAllColumns() - Method in class com.vaadin.flow.component.grid.Grid
-
Removes all columns from this Grid.
- removeAllFooterRows() - Method in class com.vaadin.flow.component.grid.Grid
-
Removes all footer rows from the grid.
- removeAllHeaderRows() - Method in class com.vaadin.flow.component.grid.Grid
-
Removes all header rows from the grid.
- removeCell(AbstractColumn<?>) - Method in class com.vaadin.flow.component.grid.FooterRow
- removeCell(AbstractColumn<?>) - Method in class com.vaadin.flow.component.grid.HeaderRow
- removeColumn(Grid.Column<T>) - Method in class com.vaadin.flow.component.grid.Grid
-
Removes a column from the Grid.
- removeColumnByKey(String) - Method in class com.vaadin.flow.component.grid.Grid
-
Removes a column with the given column key from the Grid.
- removeColumnLayer(ColumnLayer) - Method in class com.vaadin.flow.component.grid.Grid
-
Removes the given layer and moves the columns on the lower level to its place.
- removeColumns(Grid.Column<T>...) - Method in class com.vaadin.flow.component.grid.Grid
-
Removes columns from the Grid.
- removeFooterRow(FooterRow) - Method in class com.vaadin.flow.component.grid.Grid
-
Removes the footer row from the grid.
- removeHeaderRow(HeaderRow) - Method in class com.vaadin.flow.component.grid.Grid
-
Removes the header row from the grid.
- removeThemeVariants(GridVariant...) - Method in class com.vaadin.flow.component.grid.Grid
-
Removes theme variants from the component.
- render(Element, DataKeyMapper<SOURCE>, String) - Method in class com.vaadin.flow.component.grid.ColumnPathRenderer
- render(Element, DataKeyMapper<T>, String) - Method in class com.vaadin.flow.component.grid.editor.EditorRenderer
S
- save() - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
In buffered mode calling save will validate bean and will save any changes made to the Editor fields to the edited bean if all validators pass.
- save() - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- scrollToEnd() - Method in class com.vaadin.flow.component.grid.Grid
-
Scrolls to the last data row of the grid.
- scrollToEnd() - Method in class com.vaadin.flow.component.treegrid.TreeGrid
- scrollToIndex(int) - Method in class com.vaadin.flow.component.grid.Grid
-
Scrolls to the given row index.
- scrollToIndex(int) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Scrolls to the index of an item so that the row is shown at the start of the visible area whenever possible.
- scrollToIndex(int...) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Scrolls to a nested item specified by its hierarchical path.
- scrollToItem(T) - Method in class com.vaadin.flow.component.grid.Grid
-
Scrolls to the given item unless it is already fully visible.
- scrollToItem(T) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Scrolls to the given item unless it is already fully visible.
- scrollToStart() - Method in class com.vaadin.flow.component.grid.Grid
-
Scrolls to the beginning of the first data row.
- select(T) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- select(T) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- select(T) - Method in class com.vaadin.flow.component.grid.Grid
-
This method is a shorthand that delegates to the currently set selection model.
- select(T) - Method in class com.vaadin.flow.component.grid.GridNoneSelectionModel
- selectAll() - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- selectFromClient(T) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- selectFromClient(T) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- selectFromClient(T) - Method in class com.vaadin.flow.component.grid.GridNoneSelectionModel
- selectFromClient(T) - Method in interface com.vaadin.flow.component.grid.GridSelectionModel
-
Handles the selection of an item that originates from the client.
- set(int, List<JsonNode>) - Method in class com.vaadin.flow.component.grid.Grid.UpdateQueue
- setAllRowsVisible(boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
If
true, the grid's height is defined by its rows. - setAriaLabel(String) - Method in class com.vaadin.flow.component.grid.Grid
-
Set the aria-label of the component to the given text.
- setAutoWidth(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Enables or disables automatic width for this column.
- setBinder(Binder<T>) - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Sets the underlying Binder to this Editor.
- setBinder(Binder<T>) - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- setBuffered(boolean) - Method in interface com.vaadin.flow.component.grid.editor.Editor
-
Sets the Editor buffered mode.
- setBuffered(boolean) - Method in class com.vaadin.flow.component.grid.editor.EditorImpl
- setColumnKey(String, Grid.Column) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets a user-defined identifier for given column.
- setColumnOrder(Grid.Column<T>...) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets a new column order for the grid.
- setColumnOrder(List<Grid.Column<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets a new column order for the grid.
- setColumnRendering(ColumnRendering) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the mode for rendering columns in the grid.
- setColumnReorderingAllowed(boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets whether or not column reordering is allowed.
- setColumns(String...) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the columns and their order based on the given properties.
- setColumns(String, ValueProvider<T, ?>, Collection<String>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Note: This method can only be used for a TreeGrid created from a bean type with
TreeGrid(Class). - setColumns(List<AbstractColumn<?>>) - Method in class com.vaadin.flow.component.grid.FooterRow
-
Change the cells to wrap the given columns
- setColumns(List<AbstractColumn<?>>) - Method in class com.vaadin.flow.component.grid.HeaderRow
-
Change the cells to wrap the given columns
- setComparator(ValueProvider<T, V>) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
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 usingGrid.Column.setSortProperty(String[]). - setComparator(Comparator<T>) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a comparator to use with in-memory sorting with this column.
- setComponent(Component) - Method in class com.vaadin.flow.component.grid.FooterRow.FooterCell
- setComponent(Component) - Method in class com.vaadin.flow.component.grid.HeaderRow.HeaderCell
- setComponentFunction(SerializableFunction<T, ? extends Component>) - Method in class com.vaadin.flow.component.grid.editor.EditorRenderer
-
Sets the function that creates components to be used as editors for the column.
- setDataProvider(DataProvider<T, ?>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets a generic data provider for the Grid to use.
- setDataProvider(DataProvider<T, ?>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.use
setDataProvider(HierarchicalDataProvider),HasHierarchicalDataProvider.setItems(Collection, ValueProvider),HasHierarchicalDataProvider.setItems(Stream, ValueProvider)orHasHierarchicalDataProvider.setTreeData(TreeData)instead. - setDataProvider(HierarchicalDataProvider<T, ?>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
- setDefaultMultiSortPriority(Grid.MultiSortPriority) - Static method in class com.vaadin.flow.component.grid.Grid
-
Sets the default multi-sort priority to use for all Grid instances.
- setDeselectAllowed(boolean) - Method in class com.vaadin.flow.component.grid.AbstractGridSingleSelectionModel
- setDetailsVisible(T, boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the visibility of details component for given item.
- setDetailsVisibleOnClick(boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets whether the item details can be opened and closed by clicking the rows or not.
- setDragDataGenerator(String, SerializableFunction<T, String>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets a generator function for customizing drag data.
- setDragFilter(SerializablePredicate<T>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the drag filter for this drag source.
- setDragSelect(boolean) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- setDragSelect(boolean) - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
If
true, grid rows can be selected or deselected by dragging the mouse cursor over grid's selection column. - setDragSelect(boolean) - Method in class com.vaadin.flow.component.grid.GridSelectionColumn
-
If
true, grid rows can be selected or deselected by dragging the mouse cursor over grid's selection column. - setDropFilter(SerializablePredicate<T>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the drop filter for this drag target.
- setDropMode(GridDropMode) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the drop mode of this drop target.
- setDynamicContentHandler(SerializablePredicate<T>) - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
-
Sets a callback that is executed before the context menu is opened.
- setEditorComponent(Component) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a component to use for editing values of this column in the editor row.
- setEditorComponent(SerializableFunction<T, ? extends Component>) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a function that returns the editor component to be used for an specific item in the editor row.
- setEmptyStateComponent(Component) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the component to be displayed when the grid is empty.
- setEmptyStateText(String) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the text to be displayed when the grid is empty.
- setFlexGrow(int) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets the flex grow ratio for this column.
- setFooter(Component) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a footer component to the column.
- setFooter(String) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a footer text to the column.
- setFooterComponent(Component) - Method in class com.vaadin.flow.component.grid.Grid.Column
- setFooterPartName(String) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a custom part name for the footer cell.
- setFooterText(String) - Method in class com.vaadin.flow.component.grid.Grid.Column
- setFrozen(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets this column's frozen state.
- setFrozen(boolean) - Method in class com.vaadin.flow.component.grid.GridSelectionColumn
-
Sets this column's frozen state.
- setFrozenToEnd(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets this column's frozen state.
- setHeader(Component) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a header component to the column.
- setHeader(String) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a header text to the column.
- setHeaderComponent(Component) - Method in class com.vaadin.flow.component.grid.Grid.Column
- setHeaderPartName(String) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets a custom part name for the header cell.
- setHeaderText(String) - Method in class com.vaadin.flow.component.grid.Grid.Column
- setHierarchyColumn(String) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Note: This method can only be used for a TreeGrid created from a bean type with
TreeGrid(Class). - setHierarchyColumn(String, ValueProvider<T, ?>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Note: This method can only be used for a TreeGrid created from a bean type with
TreeGrid(Class). - setIdentifierProvider(IdentifierProvider<T>) - Method in class com.vaadin.flow.component.grid.dataview.GridDataView
- setIdentifierProvider(IdentifierProvider<T>) - Method in class com.vaadin.flow.component.grid.dataview.GridListDataView
- setItemCountCallback(CallbackDataProvider.CountCallback<T, Void>) - Method in class com.vaadin.flow.component.grid.dataview.GridLazyDataView
-
Sets a callback that the Grid uses to get the exact item count in the backend.
- setItemCountEstimate(int) - Method in class com.vaadin.flow.component.grid.dataview.GridLazyDataView
- setItemCountFromDataProvider() - Method in class com.vaadin.flow.component.grid.dataview.GridLazyDataView
- setItemCountUnknown() - Method in class com.vaadin.flow.component.grid.dataview.GridLazyDataView
- setItemDetailsRenderer(Renderer<T>) - Method in class com.vaadin.flow.component.grid.Grid
-
Set the renderer to use for displaying the item details rows in this grid.
- setItems(BackEndDataProvider<T, Void>) - Method in class com.vaadin.flow.component.grid.Grid
- setItems(BackEndDataProvider<T, Void>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.use
setDataProvider(HierarchicalDataProvider),HasHierarchicalDataProvider.setItems(Collection, ValueProvider),HasHierarchicalDataProvider.setItems(Stream, ValueProvider)orHasHierarchicalDataProvider.setTreeData(TreeData)instead. - setItems(CallbackDataProvider.FetchCallback<T, Void>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.use
setDataProvider(HierarchicalDataProvider),HasHierarchicalDataProvider.setItems(Collection, ValueProvider),HasHierarchicalDataProvider.setItems(Stream, ValueProvider)orHasHierarchicalDataProvider.setTreeData(TreeData)instead. - setItems(DataProvider<T, Void>) - Method in class com.vaadin.flow.component.grid.Grid
- setItems(InMemoryDataProvider<T>) - Method in class com.vaadin.flow.component.grid.Grid
- setItems(ListDataProvider<T>) - Method in class com.vaadin.flow.component.grid.Grid
- setItems(ListDataProvider<T>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.use
setDataProvider(HierarchicalDataProvider),HasHierarchicalDataProvider.setItems(Collection, ValueProvider),HasHierarchicalDataProvider.setItems(Stream, ValueProvider)orHasHierarchicalDataProvider.setTreeData(TreeData)instead. - setItems(Collection<T>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.use
setDataProvider(HierarchicalDataProvider),HasHierarchicalDataProvider.setItems(Collection, ValueProvider),HasHierarchicalDataProvider.setItems(Stream, ValueProvider)orHasHierarchicalDataProvider.setTreeData(TreeData)instead. - setItems(T...) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Deprecated.use
setDataProvider(HierarchicalDataProvider),HasHierarchicalDataProvider.setItems(Collection, ValueProvider),HasHierarchicalDataProvider.setItems(Stream, ValueProvider)orHasHierarchicalDataProvider.setTreeData(TreeData)instead. - setItemSelectableProvider(SerializablePredicate<T>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets a predicate to check whether a specific item in the grid may be selected or deselected by the user.
- setItemsPageable(Grid.SpringData.FetchCallback<Pageable, T>) - Method in class com.vaadin.flow.component.grid.Grid
-
Supply items lazily with a callback from a backend based on a Spring Data Pageable.
- setItemsPageable(Grid.SpringData.FetchCallback<Pageable, T>, Grid.SpringData.CountCallback<Pageable>) - Method in class com.vaadin.flow.component.grid.Grid
-
Supply items lazily with callbacks: the first one fetches a list of items from a backend based on a Spring Data Pageable, the second provides the exact count of items in the backend.
- setKey(String) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets the user-defined identifier to map this column.
- setLayer(ColumnLayer) - Method in class com.vaadin.flow.component.grid.FooterRow
-
Change this row to wrap the given layer
- setLayer(ColumnLayer) - Method in class com.vaadin.flow.component.grid.HeaderRow
-
Change this row to wrap the given layer
- setMultiSort(boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets whether multiple column sorting is enabled on the client-side.
- setMultiSort(boolean, boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets whether multiple column sorting is enabled on the client-side.
- setMultiSort(boolean, Grid.MultiSortPriority) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets whether multiple column sorting is enabled on the client-side.
- setMultiSort(boolean, Grid.MultiSortPriority, boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets whether multiple column sorting is enabled on the client-side.
- setNestedNullBehavior(Grid.NestedNullBehavior) - Method in class com.vaadin.flow.component.grid.Grid
-
Set the behavior when facing nested
nullvalues. - setPageSize(int) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the page size, which is the number of items fetched at a time from the data provider.
- setPartName(String) - Method in class com.vaadin.flow.component.grid.FooterRow.FooterCell
- setPartName(String) - Method in class com.vaadin.flow.component.grid.HeaderRow.HeaderCell
- setPartNameGenerator(SerializableFunction<T, String>) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets the function that is used for generating CSS part names for cells in this column.
- setPartNameGenerator(SerializableFunction<T, String>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the function that is used for generating CSS part names for all the cells in the rows in this grid.
- setRenderer(Renderer<T>) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Set the renderer for this column.
- setResizable(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
When set to
true, the column is user-resizable. - setRowHeader(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets whether cells in this column should be announced as row headers.
- setRowsDraggable(boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets whether the user can drag the grid rows or not.
- setSelectAllCheckboxIndeterminateState(boolean) - Method in class com.vaadin.flow.component.grid.GridSelectionColumn
-
Sets the indeterminate state of the select all checkbox on the client.
- setSelectAllCheckboxState(boolean) - Method in class com.vaadin.flow.component.grid.GridSelectionColumn
-
Sets the checked state of the select all checkbox on the client.
- setSelectAllCheckboxVisibility(GridMultiSelectionModel.SelectAllCheckboxVisibility) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- setSelectAllCheckboxVisibility(GridMultiSelectionModel.SelectAllCheckboxVisibility) - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Sets the select all checkbox visibility mode.
- setSelectAllCheckBoxVisibility(boolean) - Method in class com.vaadin.flow.component.grid.GridSelectionColumn
-
Sets the visibility of the select all checkbox on the client.
- setSelectionColumnFrozen(boolean) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- setSelectionColumnFrozen(boolean) - Method in interface com.vaadin.flow.component.grid.GridMultiSelectionModel
-
Sets the selection column's frozen state.
- setSelectionDragDetails(int, Map<String, String>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets explicit drag operation details for when the user is dragging the selected items.
- setSelectionMode(Grid.SelectionMode) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the grid's selection mode.
- setSelectionModel(GridSelectionModel<T>, Grid.SelectionMode) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the selection model for the grid.
- setSelectionPreservationMode(SelectionPreservationMode) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the selection preservation mode.
- setSortable(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets whether the user can sort this column or not.
- setSortableColumns(String...) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the defined columns as sortable, based on the given property names.
- setSortingIndicators(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets this component to show sorting indicators or not.
- setSortOrderProvider(SortOrderProvider) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets the sort orders when sorting this column.
- setSortProperty(String...) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets strings describing back end properties to be used when sorting this column.
- setTarget(Component) - Method in class com.vaadin.flow.component.grid.contextmenu.GridContextMenu
- setText(String) - Method in class com.vaadin.flow.component.grid.FooterRow.FooterCell
- setText(String) - Method in class com.vaadin.flow.component.grid.HeaderRow.HeaderCell
- setTextAlign(ColumnTextAlign) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets the column text align.
- setTooltipGenerator(SerializableFunction<T, String>) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets the function that is used for generating tooltip text for cells in this column.
- setTooltipGenerator(SerializableFunction<T, String>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the function that is used for generating tooltip text for all cells in this grid.
- setTooltipMarkdownEnabled(boolean) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets whether the tooltip content is rendered as Markdown.
- setTooltipPosition(Tooltip.TooltipPosition) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets the tooltip position relative to the cell that is being hovered or focused.
- setUniqueKeyDataGenerator(String, ValueProvider<T, String>) - Method in class com.vaadin.flow.component.treegrid.TreeGrid
-
Sets property name and value provider for unique key in row's generated JSON.
- setUniqueKeyProperty(String) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets property name for unique key in row's generated JSON.
- setUniqueKeyProvider(ValueProvider<T, String>) - Method in class com.vaadin.flow.component.grid.Grid
-
Sets value provider for unique key in row's generated JSON.
- setVisible(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
- setWidth(String) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Sets the width of this column as a CSS-string.
- SINGLE - Enum constant in enum class com.vaadin.flow.component.grid.Grid.SelectionMode
-
Single selection mode that maps to built-in
SelectionModel.Single. - sort(List<GridSortOrder<T>>) - Method in class com.vaadin.flow.component.grid.Grid
-
Forces a defined sort order for the columns in the Grid.
- SortOrderProvider - Interface in com.vaadin.flow.component.grid
-
Generates the sort orders when rows are sorted by a column.
- START - Enum constant in enum class com.vaadin.flow.component.grid.ColumnTextAlign
T
- thenAsc(Grid.Column<T>) - Method in class com.vaadin.flow.component.grid.GridSortOrderBuilder
- thenDesc(Grid.Column<T>) - Method in class com.vaadin.flow.component.grid.GridSortOrderBuilder
- THROW - Enum constant in enum class com.vaadin.flow.component.grid.Grid.NestedNullBehavior
-
throw a NullPointerException if there is a nested
nullvalue - TreeGrid<T> - Class in com.vaadin.flow.component.treegrid
-
Tree Grid is a component for displaying hierarchical tabular data grouped into expandable and collapsible nodes.
- TreeGrid() - Constructor for class com.vaadin.flow.component.treegrid.TreeGrid
-
Creates a new
TreeGridwithout support for creating columns based on property names. - TreeGrid(int, Grid.DataCommunicatorBuilder<T, GridArrayUpdater>) - Constructor for class com.vaadin.flow.component.treegrid.TreeGrid
-
Creates a new
TreeGridwithout support for creating columns based on property names. - TreeGrid(HierarchicalDataProvider<T, ?>) - Constructor for class com.vaadin.flow.component.treegrid.TreeGrid
-
Creates a new
TreeGridusing the givenHierarchicalDataProvider, without support for creating columns based on property names. - TreeGrid(Class<T>) - Constructor for class com.vaadin.flow.component.treegrid.TreeGrid
-
Creates a new
TreeGridwith an initial set of columns for each of the bean's properties. - TreeGrid(Class<T>, boolean) - Constructor for class com.vaadin.flow.component.treegrid.TreeGrid
-
Creates a new
TreeGridwith an initial set of columns for each of the bean's properties. - TreeGrid(Class<T>, Grid.DataCommunicatorBuilder<T, GridArrayUpdater>) - Constructor for class com.vaadin.flow.component.treegrid.TreeGrid
-
Creates a new
TreeGridwith an initial set of columns for each of the bean's properties.
U
- UpdateQueue(Element, int) - Constructor for class com.vaadin.flow.component.grid.Grid.UpdateQueue
- updateSelection(Set<T>, Set<T>) - Method in class com.vaadin.flow.component.grid.AbstractGridMultiSelectionModel
- updateSelectionModeOnClient() - Method in class com.vaadin.flow.component.grid.Grid
- updateSortingIndicators(boolean) - Method in class com.vaadin.flow.component.grid.Grid.Column
-
Updates this component to either have sorting indicators according to the sortable state of the underlying column, or removes the sorting indicators.
V
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.CellFocusEvent.GridSection
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.ColumnRendering
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.ColumnTextAlign
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.dnd.GridDropLocation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.dnd.GridDropMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.Grid.MultiSortPriority
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.Grid.NestedNullBehavior
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.Grid.SelectionMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.GridMultiSelectionModel.SelectAllCheckboxVisibility
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.vaadin.flow.component.grid.GridVariant
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.vaadin.flow.component.grid.CellFocusEvent.GridSection
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.ColumnRendering
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.ColumnTextAlign
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.dnd.GridDropLocation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.dnd.GridDropMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.Grid.MultiSortPriority
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.Grid.NestedNullBehavior
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.Grid.SelectionMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.GridMultiSelectionModel.SelectAllCheckboxVisibility
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.vaadin.flow.component.grid.GridVariant
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VISIBLE - Enum constant in enum class com.vaadin.flow.component.grid.GridMultiSelectionModel.SelectAllCheckboxVisibility
-
Shows the select all checkbox, if in-memory data is used.
All Classes and Interfaces|All Packages|Serialized Form
Grid.getDefaultColumnFactory()should be used instead.