Class RpcDataProviderExtension

Constructor Detail

• RpcDataProviderExtension

  public RpcDataProviderExtension​(Container.Indexed container)

  Creates a new data provider using the given container.

  Parameters:

  container - the container to make available

Method Detail

• beforeClientResponse

  public void beforeClientResponse​(boolean initial)

  Called before the shared state and RPC invocations are sent to the client. Gives the connector an opportunity to set computed/dynamic state values or to invoke last minute RPC methods depending on other component features.

  RpcDataProviderExtension makes all actual RPC calls from this function based on changes in the container.

  Specified by:

  beforeClientResponse in interface ClientConnector

  Overrides:

  beforeClientResponse in class AbstractClientConnector

  Parameters:

  initial - true if the client-side connector will be created and initialized after this method has been invoked. false if there is already an initialized client-side connector.

• extend

  public void extend​(Grid component)

  Makes the data source available to the given Grid component.

  Parameters:

  component - the remote data grid component to extend

  columnKeys - the key mapper for columns

• addDataGenerator

  public void addDataGenerator​(DataGenerator generator)

  Adds a DataGenerator for this RpcDataProviderExtension. DataGenerators are called when sending row data to client. If given DataGenerator is already added, this method does nothing.

  Parameters:

  generator - generator to add

  Since:

  7.6

• removeDataGenerator

  public void removeDataGenerator​(DataGenerator generator)

  Removes a DataGenerator from this RpcDataProviderExtension. If given DataGenerator is not added to this data provider, this method does nothing.

  Parameters:

  generator - generator to remove

  Since:

  7.6

• updateRowData

  public void updateRowData​(Object itemId)

  Informs the client side that data of a row has been modified in the data source.

  Parameters:

  itemId - the item Id the row that was updated

• refreshCache

  public void refreshCache()

  Pushes a new version of all the rows in the active cache range.

• setParent

  public void setParent​(ClientConnector parent)

  Description copied from interface: Extension

  Sets the parent connector of the connector. This method automatically calls ClientConnector.attach() if the connector becomes attached to the session.

  This method is rarely called directly. AbstractClientConnector.addExtension(Extension) is normally used for adding extensions to a parent and it will call this method implicitly.

  Specified by:

  setParent in interface Extension

  Overrides:

  setParent in class AbstractExtension

  Parameters:

  parent - the parent connector

• columnsRemoved

  public void columnsRemoved​(List<Grid.Column> removedColumns)

  Informs this data provider that given columns have been removed from grid.

  Parameters:

  removedColumns - a list of removed columns

• columnsAdded

  public void columnsAdded​(List<Grid.Column> addedColumns)

  Informs this data provider that given columns have been added to grid.

  Parameters:

  addedColumns - a list of added columns

• getKeyMapper

  public KeyMapper<Object> getKeyMapper()

• getGrid

  protected Grid getGrid()