com.vaadin.shared.ui.grid.

Interface GridServerRpc

  • All Superinterfaces:

    Serializable, ServerRpc

    public interface GridServerRpc
    extends ServerRpc

    Client-to-server RPC interface for the Grid component

    Since:

    7.4

    Author:

    Vaadin Ltd

    • Method Detail

      • sort

        void sort​(String[] columnIds,
                  SortDirection[] directions,
                  boolean userOriginated)
      • itemClick

        void itemClick​(String rowKey,
                       String columnId,
                       MouseEventDetails details)

        Informs the server that an item has been clicked in Grid.

        Parameters:

        rowKey - a key identifying the clicked item

        columnId - column id identifying the clicked property

        details - mouse event details

      • contextClick

        void contextClick​(int rowIndex,
                          String rowKey,
                          String columnId,
                          GridConstants.Section section,
                          MouseEventDetails details)

        Informs the server that a context click has happened inside of Grid.

        Parameters:

        rowIndex - index of clicked row in Grid section

        rowKey - a key identifying the clicked item

        columnId - column id identifying the clicked property

        section - grid section (header, footer, body)

        details - mouse event details

        Since:

        7.6

      • columnsReordered

        void columnsReordered​(List<String> newColumnOrder,
                              List<String> oldColumnOrder)

        Informs the server that the columns of the Grid have been reordered.

        Parameters:

        newColumnOrder - a list of column ids in the new order

        oldColumnOrder - a list of column ids in order before the change

        Since:

        7.5.0

      • columnVisibilityChanged

        void columnVisibilityChanged​(String id,
                                     boolean hidden,
                                     boolean userOriginated)

        Informs the server that a column's visibility has been changed.

        Parameters:

        id - the id of the column

        hidden - true if hidden, false if unhidden

        userOriginated - true if triggered by user, false if by code

        Since:

        7.5.0

      • columnResized

        void columnResized​(String id,
                           double pixels)

        Informs the server that a column has been resized by the user.

        Parameters:

        id - the id of the column

        pixels - the new width of the column in pixels

        Since:

        7.6