Package com.vaadin.flow.component.crud

Class BinderCrudEditor<E>

java.lang.Object
com.vaadin.flow.component.crud.BinderCrudEditor<E>
Type Parameters:
E - the bean type
All Implemented Interfaces:
CrudEditor<E>, Serializable
public class BinderCrudEditor<E> extends Object implements CrudEditor<E>
A CRUD editor that binds editor fields to bean properties using a Binder.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    BinderCrudEditor(Binder<E> binder)
    Initializes a BinderCrudEditor with the given binder and no form view
    BinderCrudEditor(Binder<E> binder, Component view)
    Initializes a BinderCrudEditor with the given binder and form view

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Clears the editor.
    E
    getItem()
    Returns the item being edited.
    Component
    getView()
    Deprecated.
    This method should not be used outside.
    void
    setItem(E item, boolean validate)
    Sets an item to be edited.
    boolean
    validate()
    Runs validations on the data entered into an editor and returns their validity but could also have side-effects such as showing visual indicators for invalid fields.
    void
    writeItemChanges()
    Writes any pending input update (if any) to the item.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.crud.CrudEditor

    setItem

  • Constructor Details

    • BinderCrudEditor

      public BinderCrudEditor(Binder<E> binder)
      Initializes a BinderCrudEditor with the given binder and no form view
      Parameters:
      binder - the editor binder

    • BinderCrudEditor

      public BinderCrudEditor(Binder<E> binder, Component view)
      Initializes a BinderCrudEditor with the given binder and form view
      Parameters:
      binder - the editor binder
      view - the form view

  • Method Details

    • setItem

      public void setItem(E item, boolean validate)
      Description copied from interface: CrudEditor
      Sets an item to be edited. This could be a newly instantiated item or an existing item from the grid.
      Specified by:
      setItem in interface CrudEditor<E>
      Parameters:
      item - the item to edit
      validate - if true the item will be validated immediately

    • getItem

      public E getItem()
      Description copied from interface: CrudEditor
      Returns the item being edited.
      Specified by:
      getItem in interface CrudEditor<E>
      Returns:
      the item being edited

    • writeItemChanges

      public void writeItemChanges()
      Description copied from interface: CrudEditor
      Writes any pending input update (if any) to the item.
      Specified by:
      writeItemChanges in interface CrudEditor<E>

    • clear

      public void clear()
      Clears the editor. Frees the item, and lazily clears all input fields.
      Specified by:
      clear in interface CrudEditor<E>

    • validate

      public boolean validate()
      Description copied from interface: CrudEditor
      Runs validations on the data entered into an editor and returns their validity but could also have side-effects such as showing visual indicators for invalid fields.
      Specified by:
      validate in interface CrudEditor<E>
      Returns:
      true if valid or false if otherwise

    • getView

      @Deprecated public Component getView()
      Deprecated.
      This method should not be used outside.
      Description copied from interface: CrudEditor
      Returns the user interface of an editor.
      Specified by:
      getView in interface CrudEditor<E>
      Returns:
      the user interface