Package com.vaadin.server.communication.data

Interface DataGenerator

All Superinterfaces:

Serializable

All Known Implementing Classes:

Grid.AbstractSelectionModel, Grid.DetailComponentManager, Grid.MultiSelectionModel, Grid.NoSelectionModel, Grid.SingleSelectionModel

public interface DataGenerator
extends Serializable

Interface for Grid.AbstractGridExtensions that allows adding data to row objects being sent to client by the RpcDataProviderExtension.

This class also provides a way to remove any unneeded data once the data object is no longer used on the client-side.

Since:

7.6

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method	Description
void	destroyData(Object itemId)	Informs the DataGenerator that an item id has been dropped and is no longer needed.
void	generateData(Object itemId, Item item, elemental.json.JsonObject rowData)	Adds data to row object for given item and item id being sent to client.

Method Detail

generateData

void generateData(Object itemId,
                  Item item,
                  elemental.json.JsonObject rowData)

Adds data to row object for given item and item id being sent to client.

Parameters:

itemId - item id of item

item - item being sent to client

rowData - row object being sent to client

destroyData

void destroyData(Object itemId)

Informs the DataGenerator that an item id has been dropped and is no longer needed. This method should clean up any unneeded stored data related to the item.

Parameters:

itemId - removed item id