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

Interface EditorClientRpc

  • All Superinterfaces:

    ClientRpc, Serializable

    public interface EditorClientRpc
    extends ClientRpc

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

    Since:

    8.0

    Author:

    Vaadin Ltd

    • Method Summary

      All Methods
      Modifier and Type Method Description
      void bind​(int rowIndex)

      Tells the client to open the editor and bind data to it.

      void cancel()

      Tells the client to cancel editing and hide the editor.

      void confirmBind​(boolean bindSucceeded)

      Confirms a pending bind request sent by the client.

      void confirmSave​(boolean saveSucceeded)

      Confirms a pending save request sent by the client.

      void confirmValidity​(boolean isValid)

      Confirms whether the binder's validation has passed so as to determine whether to allow the pending navigation action.

      void setErrorMessage​(String errorMessage, List<String> errorColumnsIds)

      Sets the displayed error messages for editor.

    • Method Detail

      • bind

        void bind​(int rowIndex)

        Tells the client to open the editor and bind data to it.

        Parameters:

        rowIndex - the index of the edited row

      • cancel

        void cancel()

        Tells the client to cancel editing and hide the editor.

      • confirmBind

        void confirmBind​(boolean bindSucceeded)

        Confirms a pending bind request sent by the client.

        Parameters:

        bindSucceeded - true if and only if the bind action was successful

      • confirmSave

        void confirmSave​(boolean saveSucceeded)

        Confirms a pending save request sent by the client.

        Parameters:

        saveSucceeded - true if and only if the save action was successful

      • setErrorMessage

        void setErrorMessage​(String errorMessage,
                             List<String> errorColumnsIds)

        Sets the displayed error messages for editor.

        Parameters:

        errorMessage - the error message to show the user; null to clear

        errorColumnsIds - a list of column ids that should get error markers; empty list to clear

      • confirmValidity

        void confirmValidity​(boolean isValid)

        Confirms whether the binder's validation has passed so as to determine whether to allow the pending navigation action.

        Parameters:

        isValid - true if the binder value is valid