com.vaadin.data
Class RpcDataProviderExtension

java.lang.Object
  com.vaadin.server.AbstractClientConnector
      com.vaadin.server.AbstractExtension
          com.vaadin.data.RpcDataProviderExtension

All Implemented Interfaces:

MethodEventSource, ClientConnector, Extension, com.vaadin.shared.Connector, java.io.Serializable

public class RpcDataProviderExtension
extends AbstractExtension

Provides Vaadin server-side container data source to a com.vaadin.client.ui.grid.GridConnector. This is currently implemented as an Extension hardcoded to support a specific connector type. This will be changed once framework support for something more flexible has been implemented.

Since:

7.4

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary

class	RpcDataProviderExtension.DataProviderKeyMapper ItemId to Key to ItemId mapper.
static class	RpcDataProviderExtension.DetailComponentManager A class that makes detail component related internal communication possible between RpcDataProviderExtension and grid.

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Constructor Summary

RpcDataProviderExtension(Container.Indexed container)
Creates a new data provider using the given container.

Method Summary

void	beforeClientResponse(boolean initial) Called before the shared state and RPC invocations are sent to the client.
void	columnsAdded(java.util.List<Grid.Column> addedColumns) Informs this data provider that given columns have been added to grid.
void	columnsRemoved(java.util.List<Grid.Column> removedColumns) Informs this data provider that given columns have been removed from grid.
static <T> elemental.json.JsonValue	encodeValue(java.lang.Object modelValue, Renderer<T> renderer, Converter<?,?> converter, java.util.Locale locale) Converts and encodes the given data model property value using the given converter and renderer.
void	extend(Grid component, KeyMapper<java.lang.Object> columnKeys) Makes the data source available to the given Grid component.
RpcDataProviderExtension.DetailComponentManager	getDetailComponentManager() Gets the detail component manager for this data provider
protected Grid	getGrid()
RpcDataProviderExtension.DataProviderKeyMapper	getKeyMapper()
boolean	isDetailsVisible(java.lang.Object itemId) Checks whether the details for a row is marked as visible.
void	refreshCache() Pushes a new version of all the rows in the active cache range.
void	refreshDetails() Refreshes all visible detail sections.
void	setDetailsVisible(java.lang.Object itemId, boolean visible) Marks a row's details to be visible or hidden.
void	setParent(ClientConnector parent) Sets the parent connector of the connector.
void	updateRowData(java.lang.Object itemId) Informs the client side that data of a row has been modified in the data source.

Methods inherited from class com.vaadin.server.AbstractExtension

extend, getParent, getSupportedParentType, remove

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, attach, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getState, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

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.

This method must not alter the component hierarchy in any way. Calling ClientConnector.markAsDirty() from this method will have no effect.

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,
                   KeyMapper<java.lang.Object> columnKeys)

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

updateRowData

public void updateRowData(java.lang.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(java.util.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(java.util.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 RpcDataProviderExtension.DataProviderKeyMapper getKeyMapper()

getGrid

protected Grid getGrid()

encodeValue

public static <T> elemental.json.JsonValue encodeValue(java.lang.Object modelValue,
                                                       Renderer<T> renderer,
                                                       Converter<?,?> converter,
                                                       java.util.Locale locale)

Converts and encodes the given data model property value using the given converter and renderer. This method is public only for testing purposes.

Parameters:

renderer - the renderer to use

converter - the converter to use

modelValue - the value to convert and encode

locale - the locale to use in conversion

Returns:

an encoded value ready to be sent to the client

setDetailsVisible

public void setDetailsVisible(java.lang.Object itemId,
                              boolean visible)

Marks a row's details to be visible or hidden.

If that row is currently in the client side's cache, this information will be sent over to the client.

Parameters:

itemId - the id of the item of which to change the details visibility

visible - true to show the details, false to hide

Since:

7.5.0

isDetailsVisible

public boolean isDetailsVisible(java.lang.Object itemId)

Checks whether the details for a row is marked as visible.

Parameters:

itemId - the id of the item of which to check the visibility

Returns:

true iff the detials are visible for the item. This might return true even if the row is not currently visible in the DOM

Since:

7.5.0

refreshDetails

public void refreshDetails()

Refreshes all visible detail sections.

Since:

7.5.0

getDetailComponentManager

public RpcDataProviderExtension.DetailComponentManager getDetailComponentManager()

Gets the detail component manager for this data provider

Returns:

the detail component manager

Since:

7.5.0