com.vaadin.shared.ui.grid.
Interface GridServerRpc
-
All Superinterfaces:
public interface GridServerRpc extends ServerRpc
Client-to-server RPC interface for the Grid component.
Since:
7.4
Author:
Vaadin Ltd
-
-
Method Summary
All Methods Modifier and Type Method Description void
columnResized(String columnInternalId, double pixels)
Informs the server that a column has been resized by the user.
void
columnsReordered(List<String> newColumnOrder, List<String> oldColumnOrder)
Informs the server that the columns of the Grid have been reordered.
void
columnVisibilityChanged(String columnInternalId, boolean hidden)
Informs the server that a column's visibility has been changed.
void
contextClick(int rowIndex, String rowKey, String columnInternalId, GridConstants.Section section, MouseEventDetails details)
Informs the server that a context click has happened inside of Grid.
void
itemClick(String rowKey, String columnInternalId, MouseEventDetails details, int rowIndex)
Informs the server that an item has been clicked in Grid.
void
sort(String[] columnIds, SortDirection[] directions, boolean userOriginated)
-
-
-
Method Detail
-
sort
void sort(String[] columnIds, SortDirection[] directions, boolean userOriginated)
-
itemClick
void itemClick(String rowKey, String columnInternalId, MouseEventDetails details, int rowIndex)
Informs the server that an item has been clicked in Grid.
Parameters:
rowKey
- a key identifying the clicked itemcolumnInternalId
- column internal id identifying the clicked propertydetails
- mouse event detailsrowIndex
- the row index of the clicked item
-
contextClick
void contextClick(int rowIndex, String rowKey, String columnInternalId, 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 sectionrowKey
- a key identifying the clicked itemcolumnInternalId
- column internal id identifying the clicked propertysection
- grid section (header, footer, body)details
- mouse event detailsSince:
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 internal ids in the new orderoldColumnOrder
- a list of column internal ids in order before the changeSince:
7.5.0
-
columnVisibilityChanged
void columnVisibilityChanged(String columnInternalId, boolean hidden)
Informs the server that a column's visibility has been changed.
Parameters:
columnInternalId
- the internal id of the columnhidden
-true
if hidden,false
if unhiddenSince:
8.0
-
columnResized
void columnResized(String columnInternalId, double pixels)
Informs the server that a column has been resized by the user.
Parameters:
columnInternalId
- the internal id of the columnpixels
- the new width of the column in pixelsSince:
7.6
-
-