com.vaadin.flow.component.crud.BinderCrudEditor Maven / Gradle / Ivy
/**
* Copyright 2000-2024 Vaadin Ltd.
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See {@literal } for the full
* license.
*/
package com.vaadin.flow.component.crud;
import com.vaadin.flow.component.Component;
import com.vaadin.flow.component.HasValue;
import com.vaadin.flow.data.binder.Binder;
import com.vaadin.flow.data.binder.ValidationException;
/**
* A CRUD editor that binds editor fields to bean properties using a
* {@link Binder}.
*
* @param
* the bean type
* @see Binder
*/
public class BinderCrudEditor implements CrudEditor {
private final Binder binder;
private final Component view;
private E item;
/**
* Initializes a BinderCrudEditor with the given binder and no form view
*
* @param binder
* the editor binder
*/
public BinderCrudEditor(Binder binder) {
this(binder, null);
}
/**
* Initializes a BinderCrudEditor with the given binder and form view
*
* @param binder
* the editor binder
* @param view
* the form view
*/
public BinderCrudEditor(Binder binder, Component view) {
this.binder = binder;
this.view = view;
}
@Override
public void setItem(E item, boolean validate) {
this.item = item;
binder.readBean(item);
if (validate) {
binder.validate();
}
}
@Override
public E getItem() {
return item;
}
@Override
public void writeItemChanges() {
try {
binder.writeBean(item);
} catch (ValidationException e) {
throw new IllegalStateException(e);
}
}
/**
* {@inheritDoc}
*
* Frees the item, and lazily clears all input fields.
*/
@Override
public void clear() {
this.item = null;
binder.readBean(null);
binder.getFields().forEach(HasValue::clear);
}
@Override
public boolean validate() {
return binder.validate().isOk();
}
/**
* @deprecated This method should not be used outside.
*/
@Override
@Deprecated
public Component getView() {
return view;
}
}