com.vaadin.shared.ui.grid.editor.

Interface EditorServerRpc

  • All Superinterfaces:

    Serializable, ServerRpc

    public interface EditorServerRpc
    extends ServerRpc

    An RPC interface for the grid editor client-to-server communications.

    Since:

    8.0

    Author:

    Vaadin Ltd

    • Method Summary

      All Methods
      Modifier and Type Method Description
      void bind​(String key)

      Asks the server to open the editor and bind data to it.

      void cancel​(boolean afterBeingSaved)

      Tells the server to cancel editing.

      void checkValidity()

      Asks the server to check the validity of the current values in the editor.

      void save()

      Asks the server to save unsaved changes in the editor to the bean.

    • Method Detail

      • bind

        void bind​(String key)

        Asks the server to open the editor and bind data to it. When a bind request is sent, it must be acknowledged with a confirm call before the client can open the editor.

        Parameters:

        key - the identifier key for edited item

      • save

        void save()

        Asks the server to save unsaved changes in the editor to the bean. When a save request is sent, it must be acknowledged with a confirm call.

      • cancel

        void cancel​(boolean afterBeingSaved)

        Tells the server to cancel editing. When sending a cancel request, the client does not need to wait for confirmation by the server before hiding the editor.

        Parameters:

        afterBeingSaved - if true then this method is called to close editor after save action, otherwise it represents a cancel action

      • checkValidity

        void checkValidity()

        Asks the server to check the validity of the current values in the editor. When a check-validity request is sent, the server must respond with a confirm call.