CRUD
API: TypeScript / Java
Source: TypeScript / Java
- Columns
- Editor
- Grid Replacement
- Toolbar
- Sorting and Filtering
- Item Initialization
- Localization
- Related Components
|
Note
|
Commercial feature
A commercial Vaadin subscription is required to use CRUD in your project. |
CRUD is a component for managing a dataset. It allows for easy displaying, editing, creating, and deleting of items.
Open in a
new tab
new tab
Source code
crud-basic.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/crud';
import '@vaadin/email-field';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-basic')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<vaadin-crud
include="firstName, lastName, email, profession"
.items="${this.items}"
></vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudBasic.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-basic")
public class CrudBasic extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EMAIL = "email";
private String PROFESSION = "profession";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudBasic() {
// tag::snippet[]
crud = new Crud<>(Person.class, createEditor());
setupGrid();
setupDataProvider();
add(crud);
// end::snippet[]
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
EmailField email = new EmailField("Email");
TextField profession = new TextField("Profession");
FormLayout form = new FormLayout(firstName, lastName, email,
profession);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EMAIL, PROFESSION, EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME), grid.getColumnByKey(EMAIL),
grid.getColumnByKey(PROFESSION),
grid.getColumnByKey(EDIT_COLUMN));
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
Columns
CRUD automatically generates columns for each field in the provided dataset. You can add columns with it and configure or remove existing ones.
Open in a
new tab
new tab
Source code
crud-columns.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/crud';
import '@vaadin/date-picker';
import '@vaadin/email-field';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-columns')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<!-- Use 'include' or 'exclude' to select which fields to show -->
<vaadin-crud
exclude="lastName, address, id, subscribe, membership, pictureUrl, manager"
.items="${this.items}"
></vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudColumns.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.datepicker.DatePicker;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.data.converter.LocalDateToDateConverter;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-columns")
public class CrudColumns extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String EMAIL = "email";
private String PROFESSION = "profession";
private String BIRTHDAY = "birthday";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudColumns() {
// tag::snippet[]
crud = new Crud<>(Person.class, createEditor());
setupGrid();
setupDataProvider();
add(crud);
// end::snippet[]
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
EmailField email = new EmailField("Email");
TextField profession = new TextField("Profession");
DatePicker birthday = new DatePicker("Birthday");
FormLayout form = new FormLayout(firstName, email, profession,
birthday);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
binder.forField(birthday).asRequired()
.withConverter(new LocalDateToDateConverter())
.bind(Person::getBirthday, Person::setBirthday);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// tag::snippet[]
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, EMAIL,
PROFESSION, BIRTHDAY, EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// end::snippet[]
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(EMAIL), grid.getColumnByKey(PROFESSION),
grid.getColumnByKey(BIRTHDAY),
grid.getColumnByKey(EDIT_COLUMN));
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
Editor
Data is edited using CRUD’s editor UI.
Opening the Editor
By default, the editor is opened by clicking the edit Button in the last column. However, this button column can be removed if you want to provide an alternative way to engage the editor. For example, you can have it open using a double click like so:
Open in a
new tab
new tab
Source code
crud-open-editor.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/crud';
import type { CrudEditedItemChangedEvent } from '@vaadin/crud';
import type { Grid } from '@vaadin/grid';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-open-editor')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
@state()
private editedItem?: Person;
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<vaadin-crud
include="firstName, lastName, email, profession"
.items="${this.items}"
.editedItem="${this.editedItem as any}"
@edited-item-changed="${(event: CrudEditedItemChangedEvent<Person>) => {
this.editedItem = event.detail.value;
}}"
>
<vaadin-grid slot="grid" @dblclick="${this.onDblClick}">
<vaadin-grid-column path="firstName" header="First name"></vaadin-grid-column>
<vaadin-grid-column path="lastName" header="Last name"></vaadin-grid-column>
<vaadin-grid-column path="email" header="Email"></vaadin-grid-column>
<vaadin-grid-column path="profession" header="Profession"></vaadin-grid-column>
</vaadin-grid>
</vaadin-crud>
<!-- end::snippet[] -->
`;
}
onDblClick(e: MouseEvent) {
const target = e.currentTarget as Grid<Person>;
this.editedItem = target.getEventContext(e).item;
}
}
CrudOpenEditor.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-open-editor")
public class CrudOpenEditor extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EMAIL = "email";
private String PROFESSION = "profession";
public CrudOpenEditor() {
crud = new Crud<>(Person.class, createEditor());
setupGrid();
setupDataProvider();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
EmailField email = new EmailField("Email");
TextField profession = new TextField("Profession");
FormLayout form = new FormLayout(firstName, lastName, email,
profession);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
// tag::snippet[]
Grid<Person> grid = crud.getGrid();
// Remove edit column
Crud.removeEditColumn(grid);
// grid.removeColumnByKey(EDIT_COLUMN);
// grid.removeColumn(grid.getColumnByKey(EDIT_COLUMN));
// Open editor on double click
grid.addItemDoubleClickListener(event -> crud.edit(event.getItem(),
Crud.EditMode.EXISTING_ITEM));
// end::snippet[]
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EMAIL, PROFESSION);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME), grid.getColumnByKey(EMAIL),
grid.getColumnByKey(PROFESSION));
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
Editor Position
The editor can be positioned in an overlay, on the side, or at the bottom.
Overlay (Default)
The overlay position renders the editor in a modal overlay. Overlays aren’t constrained to the CRUD’s size. This makes them ideal for complex forms. However, they block the user from viewing and interacting with the Grid beneath.
Aside
The aside position displays the editor as an overlay next to the grid.
Use this position when there is sufficient horizontal space to accommodate both the grid and the editor, and when it’s beneficial for the user to be able to view and interact with the grid while the editor is open.
Aside positioning is also a good fit for single-column forms.
Open in a
new tab
new tab
Source code
crud-editor-aside.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/crud';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-editor-aside')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<vaadin-crud
editor-position="aside"
include="firstName, lastName, email, profession"
.items="${this.items}"
></vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudEditorAside.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.crud.CrudEditorPosition;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-editor-aside")
public class CrudEditorAside extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EMAIL = "email";
private String PROFESSION = "profession";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudEditorAside() {
crud = new Crud<>(Person.class, createEditor());
// tag::snippet[]
crud.setEditorPosition(CrudEditorPosition.ASIDE);
// end::snippet[]
setupGrid();
setupDataProvider();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
EmailField email = new EmailField("Email");
TextField profession = new TextField("Profession");
FormLayout form = new FormLayout(firstName, lastName, email,
profession);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EMAIL, PROFESSION, EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME), grid.getColumnByKey(EMAIL),
grid.getColumnByKey(PROFESSION),
grid.getColumnByKey(EDIT_COLUMN));
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
|
Note
|
Grid Width
The opening and closing of an aside editor affects the grid’s width.
Fixed-width columns are recommended to prevent them from resizing each time.
|
Bottom
The bottom position can be useful when the user needs to see as many columns in the grid as possible while editing, when horizontal space is limited, or when a wider editor form is desired.
Open in a
new tab
new tab
Source code
crud-editor-bottom.ts
import { css, html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/crud';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-editor-bottom')
export class Example extends LitElement {
static override styles = css`
vaadin-crud {
--vaadin-crud-editor-max-height: 60%;
}
`;
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<vaadin-crud
editor-position="bottom"
include="firstName, lastName, email, profession"
.items="${this.items}"
></vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudEditorBottom.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.crud.CrudEditorPosition;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-editor-bottom")
public class CrudEditorBottom extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EMAIL = "email";
private String PROFESSION = "profession";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudEditorBottom() {
crud = new Crud<>(Person.class, createEditor());
// tag::snippet[]
crud.setEditorPosition(CrudEditorPosition.BOTTOM);
// end::snippet[]
setupGrid();
setupDataProvider();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
EmailField email = new EmailField("Email");
TextField profession = new TextField("Profession");
FormLayout form = new FormLayout(firstName, lastName, email,
profession);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EMAIL, PROFESSION, EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME), grid.getColumnByKey(EMAIL),
grid.getColumnByKey(PROFESSION),
grid.getColumnByKey(EDIT_COLUMN));
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
When using a bottom-positioned editor, make sure there is enough vertical space to fit both the grid and the editor comfortably. A bottom-positioned editor is an inappropriate option for longer forms.
|
Note
|
Small viewports
On small viewports, like mobile phones, the editor always opens up as a full-screen overlay, regardless of this configuration.
|
Editor Content
The editor’s content is fully configurable, except for the header and footer.
Open in a
new tab
new tab
Source code
crud-editor-content.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/combo-box';
import '@vaadin/crud';
import '@vaadin/form-layout';
import type { FormLayoutResponsiveStep } from '@vaadin/form-layout';
import '@vaadin/email-field';
import '@vaadin/text-field';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-editor-content')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
@state()
private professions: string[] = [];
@state()
private responsiveSteps: FormLayoutResponsiveStep[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
this.professions = [...new Set(people.map((i) => i.profession))];
this.responsiveSteps = [
{ minWidth: 0, columns: 1 },
{ minWidth: '30em', columns: 2 },
];
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<vaadin-crud include="firstName, lastName, email, profession" .items=${this.items}>
<vaadin-form-layout
slot="form"
style="max-width: 480px;"
.responsiveSteps=${this.responsiveSteps}
>
<vaadin-text-field label="First name" path="firstName" required></vaadin-text-field>
<vaadin-text-field label="Last name" path="lastName" required></vaadin-text-field>
<vaadin-email-field colspan="2" label="Email" path="email" required></vaadin-email-field>
<vaadin-combo-box
colspan="2"
label="Profession"
path="profession"
.items="${this.professions}"
></vaadin-combo-box>
</vaadin-form-layout>
</vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudEditorContent.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.combobox.ComboBox;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-editor-content")
public class CrudEditorContent extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EMAIL = "email";
private String PROFESSION = "profession";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
private List<String> professions = DataService.getProfessions();
public CrudEditorContent() {
// tag::snippet1[]
crud = new Crud<>(Person.class, createEditor());
// end::snippet1[]
setupGrid();
setupDataProvider();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
EmailField email = new EmailField("Email");
ComboBox<String> profession = new ComboBox<>("Profession");
profession.setItems(professions);
FormLayout form = new FormLayout(firstName, lastName, email,
profession);
form.setColspan(email, 2);
form.setColspan(profession, 2);
form.setMaxWidth("480px");
form.setResponsiveSteps(new FormLayout.ResponsiveStep("0", 1),
new FormLayout.ResponsiveStep("30em", 2));
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EMAIL, PROFESSION, EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME), grid.getColumnByKey(EMAIL),
grid.getColumnByKey(PROFESSION),
grid.getColumnByKey(EDIT_COLUMN));
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
Editor Actions
The editor contains three Buttons:
-
"Delete" shows a confirmation dialog asking the user to verify whether they wish to delete the item.
-
"Cancel" closes the editor unless there are unsaved changes. If there are, a confirmation dialog is shown and the user can either discard the changes or go back to editing.
-
"Save" saves the changes and closes the editor. This is disabled until a change is made.
Grid Replacement
CRUD’s default Grid is replaceable. This is useful when you wish to customize the Grid. An example might be if you want to place the edit Button in the first column, or to apply tooltips. See Grid documentation for details on configuring grids.
Open in a
new tab
new tab
Source code
crud-grid-replacement.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/crud';
import '@vaadin/grid';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-grid-replacement')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<vaadin-crud include="firstName, lastName, email, profession" .items="${this.items}">
<vaadin-grid slot="grid">
<vaadin-crud-edit-column></vaadin-crud-edit-column>
<vaadin-grid-column path="firstName" header="First name"></vaadin-grid-column>
<vaadin-grid-column path="lastName" header="Last name"></vaadin-grid-column>
<vaadin-grid-column path="email" header="Email"></vaadin-grid-column>
<vaadin-grid-column path="profession" header="Profession"></vaadin-grid-column>
</vaadin-grid>
</vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudGridReplacement.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
@Route("crud-grid-replacement")
public class CrudGridReplacement extends Div {
private Crud<Person> crud;
public CrudGridReplacement() {
// tag::snippet1[]
crud = new Crud<>(Person.class, createGrid(), createEditor());
// end::snippet1[]
setupDataProvider();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
EmailField email = new EmailField("Email");
TextField profession = new TextField("Profession");
FormLayout form = new FormLayout(firstName, lastName, email,
profession);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private Grid<Person> createGrid() {
Grid<Person> grid = new Grid<>();
Crud.addEditColumn(grid);
grid.addColumn(Person::getFirstName).setHeader("First name");
grid.addColumn(Person::getLastName).setHeader("Last name");
grid.addColumn(Person::getEmail).setHeader("Email");
grid.addColumn(Person::getProfession).setHeader("Profession");
return grid;
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
|
Note
|
Edit Column
You need to add explicitly an edit column to the replacement Grid to edit items.
Additionally, Grid doesn’t have sorting and filtering enabled by default.
|
Toolbar
Creating new items is done via the “New item” Button in CRUD’s toolbar. Both the toolbar and its Button are customizable. For example, you can use the toolbar to display statistics such as the size of the dataset or the number of search results.
Open in a
new tab
new tab
Source code
crud-toolbar.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/button';
import '@vaadin/crud';
import '@vaadin/horizontal-layout';
import '@vaadin/icon';
import '@vaadin/icons';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-toolbar')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<vaadin-crud
include="firstName, lastName"
.items="${this.items}"
@size-changed="${() => this.requestUpdate()}"
>
<vaadin-horizontal-layout
slot="toolbar"
style="align-items: center; flex-grow: 1; justify-content: space-between;"
>
<span>Total: <b>${this.items.length}</b> employees</span>
<vaadin-button theme="tertiary" new-button>
<vaadin-icon slot="prefix" icon="vaadin:plus"></vaadin-icon>
New employee
</vaadin-button>
</vaadin-horizontal-layout>
</vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudToolbar.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.Html;
import com.vaadin.flow.component.button.Button;
import com.vaadin.flow.component.button.ButtonVariant;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.icon.VaadinIcon;
import com.vaadin.flow.component.orderedlayout.FlexComponent;
import com.vaadin.flow.component.orderedlayout.HorizontalLayout;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-toolbar")
public class CrudToolbar extends Div {
private Crud<Person> crud;
private PersonDataProvider dataProvider;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudToolbar() {
crud = new Crud<>(Person.class, createEditor());
setupGrid();
setupDataProvider();
setupToolbar();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
FormLayout form = new FormLayout(firstName, lastName);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME),
grid.getColumnByKey(EDIT_COLUMN));
}
private void setupDataProvider() {
dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
private void setupToolbar() {
// tag::snippet[]
Html total = new Html("<span>Total: <b>" + dataProvider.DATABASE.size()
+ "</b> employees</span>");
Button button = new Button("New employee", VaadinIcon.PLUS.create());
button.addClickListener(event -> {
crud.edit(new Person(), Crud.EditMode.NEW_ITEM);
});
button.addThemeVariants(ButtonVariant.LUMO_TERTIARY);
HorizontalLayout toolbar = new HorizontalLayout(total, button);
toolbar.setAlignItems(FlexComponent.Alignment.CENTER);
toolbar.setFlexGrow(1, toolbar);
toolbar.setJustifyContentMode(FlexComponent.JustifyContentMode.BETWEEN);
toolbar.setSpacing(false);
crud.setToolbar(toolbar);
// end::snippet[]
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
Hiding the Toolbar
The toolbar can be hidden if it isn’t needed.
Open in a
new tab
new tab
Source code
crud-hidden-toolbar.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/crud';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-hidden-toolbar')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<!-- Adding the no-toolbar attribute hides the toolbar -->
<vaadin-crud
include="firstName, lastName"
.items="${this.items}"
@size-changed="${() => this.requestUpdate()}"
no-toolbar
></vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudHiddenToolbar.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-hidden-toolbar")
public class CrudHiddenToolbar extends Div {
private Crud<Person> crud;
private PersonDataProvider dataProvider;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudHiddenToolbar() {
// tag::snippet[]
crud = new Crud<>(Person.class, createEditor());
crud.setToolbarVisible(false);
// end::snippet[]
setupGrid();
setupDataProvider();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
FormLayout form = new FormLayout(firstName, lastName);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME),
grid.getColumnByKey(EDIT_COLUMN));
}
private void setupDataProvider() {
dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
Sorting and Filtering
By default, CRUD allows sorting and filtering of any column. For more information about sorting and filtering, see the Grid documentation.
Disabling Sorting and Filtering
Sorting and filtering can be disabled.
Open in a
new tab
new tab
Source code
crud-sorting-filtering.ts
import { html, LitElement } from 'lit';
import { customElement, state } from 'lit/decorators.js';
import '@vaadin/crud';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-sorting-filtering')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
protected override render() {
return html`
<!-- tag::snippet[] -->
<vaadin-crud
include="firstName, lastName, profession"
no-sort
no-filter
.items="${this.items}"
></vaadin-crud>
<!-- end::snippet[] -->
`;
}
}
CrudSortingFiltering.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.crud.CrudGrid;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-sorting-filtering")
public class CrudSortingFiltering extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String PROFESSION = "profession";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudSortingFiltering() {
// tag::snippet1[]
crud = new Crud<>(Person.class, createGrid(), createEditor());
// end::snippet1[]
setupDataProvider();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
TextField profession = new TextField("Profession");
FormLayout form = new FormLayout(firstName, lastName, profession);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private CrudGrid<Person> createGrid() {
// Create a new CrudGrid to disable filtering (last boolean parameter)
CrudGrid<Person> grid = new CrudGrid<>(Person.class, false);
// Disable sorting
grid.setSortableColumns();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
PROFESSION, EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME), grid.getColumnByKey(PROFESSION),
grid.getColumnByKey(EDIT_COLUMN));
return grid;
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}
PersonDataProvider.java
Item Initialization
Newly created items can be initialized with data.
Open in a
new tab
new tab
Source code
crud-item-initialization.ts
import { html, LitElement } from 'lit';
import { customElement, query, state } from 'lit/decorators.js';
import '@vaadin/crud';
import type { Crud, CrudNewEvent } from '@vaadin/crud';
import '@vaadin/email-field';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-item-initialization')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@query('vaadin-crud')
private crud!: Crud<Partial<Person>>;
@state()
private items: Person[] = [];
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
}
// tag::snippet[]
handleNewItem(e: CrudNewEvent) {
// Cancel event to allow setting a custom item instance
e.preventDefault();
this.crud.editedItem = {
email: '@vaadin.com',
profession: 'Developer',
};
}
protected override render() {
return html`
<vaadin-crud
include="firstName, lastName, email, profession"
.items="${this.items}"
@new="${this.handleNewItem}"
></vaadin-crud>
`;
}
// end::snippet[]
}
CrudItemInitialization.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-item-initialization")
public class CrudItemInitialization extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EMAIL = "email";
private String PROFESSION = "profession";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudItemInitialization() {
// tag::snippet[]
crud = new Crud<>(Person.class, createEditor());
crud.addNewListener(event -> {
Person person = event.getItem();
person.setEmail("@vaadin.com");
person.setProfession("Developer");
crud.getEditor().setItem(person);
});
// end::snippet[]
setupGrid();
setupDataProvider();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
EmailField email = new EmailField("Email");
TextField profession = new TextField("Profession");
FormLayout form = new FormLayout(firstName, lastName, email,
profession);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EMAIL, PROFESSION, EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME), grid.getColumnByKey(EMAIL),
grid.getColumnByKey(PROFESSION),
grid.getColumnByKey(EDIT_COLUMN));
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
}
Localization
CRUD supports full localization through customizable labels for its buttons and the title of the editor.
Open in a
new tab
new tab
Source code
crud-localization.ts
import { html, LitElement } from 'lit';
import { customElement, query, state } from 'lit/decorators.js';
import '@vaadin/crud';
import type { Crud } from '@vaadin/crud';
import { getPeople } from 'Frontend/demo/domain/DataService';
import type Person from 'Frontend/generated/com/vaadin/demo/domain/Person';
import { applyTheme } from 'Frontend/generated/theme';
@customElement('crud-localization')
export class Example extends LitElement {
protected override createRenderRoot() {
const root = super.createRenderRoot();
// Apply custom theme (only supported if your app uses one)
applyTheme(root);
return root;
}
@state()
private items: Person[] = [];
@query('vaadin-crud')
private crud!: Crud<Person>;
protected override async firstUpdated() {
const { people } = await getPeople();
this.items = people;
this.crud.i18n = {
newItem: 'Luo uusi',
editItem: 'Muuta tietoja',
saveItem: 'Tallenna',
cancel: 'Peruuta',
deleteItem: 'Poista...',
editLabel: 'Muokkaa',
confirm: {
delete: {
title: 'Poista kohde',
content: 'Haluatko varmasti poistaa tämän kohteen? Poistoa ei voi perua.',
button: {
confirm: 'Poista',
dismiss: 'Peruuta',
},
},
cancel: {
title: 'Hylkää muutokset',
content: 'Kohteessa on tallentamattomia muutoksia',
button: {
confirm: 'Hylkää',
dismiss: 'Peruuta',
},
},
},
};
}
protected override render() {
return html`
<!-- tag::snippethtml[] -->
<vaadin-crud
editor-position="aside"
include="firstName, lastName, email, profession"
.items="${this.items}"
>
<vaadin-grid slot="grid">
<vaadin-grid-column path="firstName" header="Etunimi"></vaadin-grid-column>
<vaadin-grid-column path="lastName" header="Sukunimi"></vaadin-grid-column>
<vaadin-grid-column path="email" header="Sähköposti"></vaadin-grid-column>
<vaadin-grid-column path="profession" header="Ammatti"></vaadin-grid-column>
<vaadin-crud-edit-column></vaadin-crud-edit-column>
</vaadin-grid>
<vaadin-form-layout slot="form">
<vaadin-text-field path="firstName" label="Etunimi" required></vaadin-text-field>
<vaadin-text-field path="lastName" label="Sukunimi" required></vaadin-text-field>
<vaadin-email-field path="email" label="Sähköposti" required></vaadin-email-field>
<vaadin-combo-box
path="profession"
label="Ammatti"
.items="${[...new Set(this.items.map((i) => i.profession))]}"
></vaadin-combo-box>
</vaadin-form-layout>
</vaadin-crud>
<!-- end::snippethtml[] -->
`;
}
}
CrudLocalization.java
package com.vaadin.demo.component.crud;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.BinderCrudEditor;
import com.vaadin.flow.component.crud.Crud;
import com.vaadin.flow.component.crud.CrudEditor;
import com.vaadin.flow.component.crud.CrudI18n;
import com.vaadin.flow.component.formlayout.FormLayout;
import com.vaadin.flow.component.grid.Grid;
import com.vaadin.flow.component.html.Div;
import com.vaadin.flow.component.textfield.EmailField;
import com.vaadin.flow.component.textfield.TextField;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.router.Route;
import java.util.Arrays;
import java.util.List;
@Route("crud-localization")
public class CrudLocalization extends Div {
private Crud<Person> crud;
private String FIRST_NAME = "firstName";
private String LAST_NAME = "lastName";
private String EMAIL = "email";
private String PROFESSION = "profession";
private String EDIT_COLUMN = "vaadin-crud-edit-column";
public CrudLocalization() {
crud = new Crud<>(Person.class, createEditor());
setupGrid();
setupDataProvider();
setupI18n();
add(crud);
}
private CrudEditor<Person> createEditor() {
TextField firstName = new TextField("First name");
TextField lastName = new TextField("Last name");
EmailField email = new EmailField("Email");
TextField profession = new TextField("Profession");
FormLayout form = new FormLayout(firstName, lastName, email,
profession);
Binder<Person> binder = new Binder<>(Person.class);
binder.forField(firstName).asRequired().bind(Person::getFirstName,
Person::setFirstName);
binder.forField(lastName).asRequired().bind(Person::getLastName,
Person::setLastName);
binder.forField(email).asRequired().bind(Person::getEmail,
Person::setEmail);
binder.forField(profession).asRequired().bind(Person::getProfession,
Person::setProfession);
return new BinderCrudEditor<>(binder, form);
}
private void setupGrid() {
Grid<Person> grid = crud.getGrid();
// Only show these columns (all columns shown by default):
List<String> visibleColumns = Arrays.asList(FIRST_NAME, LAST_NAME,
EMAIL, PROFESSION, EDIT_COLUMN);
grid.getColumns().forEach(column -> {
String key = column.getKey();
if (!visibleColumns.contains(key)) {
grid.removeColumn(column);
}
});
// Reorder the columns (alphabetical by default)
grid.setColumnOrder(grid.getColumnByKey(FIRST_NAME),
grid.getColumnByKey(LAST_NAME), grid.getColumnByKey(EMAIL),
grid.getColumnByKey(PROFESSION),
grid.getColumnByKey(EDIT_COLUMN));
// Translate headers
grid.getColumnByKey(FIRST_NAME).setHeader("Etunimi");
grid.getColumnByKey(LAST_NAME).setHeader("Sukunimi");
grid.getColumnByKey(EMAIL).setHeader("Sähköposti");
grid.getColumnByKey(PROFESSION).setHeader("Ammatti");
}
private void setupDataProvider() {
PersonDataProvider dataProvider = new PersonDataProvider();
crud.setDataProvider(dataProvider);
crud.addDeleteListener(
deleteEvent -> dataProvider.delete(deleteEvent.getItem()));
crud.addSaveListener(
saveEvent -> dataProvider.persist(saveEvent.getItem()));
}
private void setupI18n() {
// tag::snippet[]
CrudI18n i18n = CrudI18n.createDefault();
i18n.setNewItem("Luo uusi");
i18n.setEditItem("Muuta tietoja");
i18n.setSaveItem("Tallenna");
i18n.setCancel("Peruuta");
i18n.setDeleteItem("Poista...");
i18n.setEditLabel("Muokkaa");
CrudI18n.Confirmations.Confirmation delete = i18n.getConfirm()
.getDelete();
delete.setTitle("Poista kohde");
delete.setContent(
"Haluatko varmasti poistaa tämän kohteen? Poistoa ei voi perua.");
delete.getButton().setConfirm("Poista");
delete.getButton().setDismiss("Peruuta");
CrudI18n.Confirmations.Confirmation cancel = i18n.getConfirm()
.getCancel();
cancel.setTitle("Hylkää muutokset");
cancel.setContent("Kohteessa on tallentamattomia muutoksia.");
cancel.getButton().setConfirm("Hylkää");
cancel.getButton().setDismiss("Peruuta");
crud.setI18n(i18n);
// end::snippet[]
}
}
PersonDataProvider.java
package com.vaadin.demo.component.crud;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;
import java.util.Optional;
import java.util.function.Consumer;
import java.util.function.Predicate;
import java.util.stream.Stream;
import com.vaadin.demo.domain.DataService;
import com.vaadin.demo.domain.Person;
import com.vaadin.flow.component.crud.CrudFilter;
import com.vaadin.flow.data.provider.AbstractBackEndDataProvider;
import com.vaadin.flow.data.provider.Query;
import com.vaadin.flow.data.provider.SortDirection;
import static java.util.Comparator.naturalOrder;
// Person data provider
public class PersonDataProvider
extends AbstractBackEndDataProvider<Person, CrudFilter> {
// A real app should hook up something like JPA
final List<Person> DATABASE = new ArrayList<>(DataService.getPeople());
private Consumer<Long> sizeChangeListener;
@Override
protected Stream<Person> fetchFromBackEnd(Query<Person, CrudFilter> query) {
int offset = query.getOffset();
int limit = query.getLimit();
Stream<Person> stream = DATABASE.stream();
if (query.getFilter().isPresent()) {
stream = stream.filter(predicate(query.getFilter().get()))
.sorted(comparator(query.getFilter().get()));
}
return stream.skip(offset).limit(limit);
}
@Override
protected int sizeInBackEnd(Query<Person, CrudFilter> query) {
// For RDBMS just execute a SELECT COUNT(*) ... WHERE query
long count = fetchFromBackEnd(query).count();
if (sizeChangeListener != null) {
sizeChangeListener.accept(count);
}
return (int) count;
}
void setSizeChangeListener(Consumer<Long> listener) {
sizeChangeListener = listener;
}
private static Predicate<Person> predicate(CrudFilter filter) {
// For RDBMS just generate a WHERE clause
return filter.getConstraints().entrySet().stream()
.map(constraint -> (Predicate<Person>) person -> {
try {
Object value = valueOf(constraint.getKey(), person);
return value != null && value.toString().toLowerCase()
.contains(constraint.getValue().toLowerCase());
} catch (Exception e) {
e.printStackTrace();
return false;
}
}).reduce(Predicate::and).orElse(e -> true);
}
private static Comparator<Person> comparator(CrudFilter filter) {
// For RDBMS just generate an ORDER BY clause
return filter.getSortOrders().entrySet().stream().map(sortClause -> {
try {
Comparator<Person> comparator = Comparator.comparing(
person -> (Comparable) valueOf(sortClause.getKey(),
person));
if (sortClause.getValue() == SortDirection.DESCENDING) {
comparator = comparator.reversed();
}
return comparator;
} catch (Exception ex) {
return (Comparator<Person>) (o1, o2) -> 0;
}
}).reduce(Comparator::thenComparing).orElse((o1, o2) -> 0);
}
private static Object valueOf(String fieldName, Person person) {
try {
Field field = Person.class.getDeclaredField(fieldName);
field.setAccessible(true);
return field.get(person);
} catch (Exception ex) {
throw new RuntimeException(ex);
}
}
void persist(Person item) {
if (item.getId() == null) {
item.setId(DATABASE.stream().map(Person::getId).max(naturalOrder())
.orElse(0) + 1);
}
final Optional<Person> existingItem = find(item.getId());
if (existingItem.isPresent()) {
int position = DATABASE.indexOf(existingItem.get());
DATABASE.remove(existingItem.get());
DATABASE.add(position, item);
} else {
DATABASE.add(item);
}
}
Optional<Person> find(Integer id) {
return DATABASE.stream().filter(entity -> entity.getId().equals(id))
.findFirst();
}
void delete(Person item) {
DATABASE.removeIf(entity -> entity.getId().equals(item.getId()));
}
}