com.vaadin.client.ui.grid
Class GridConnector

java.lang.Object
  com.vaadin.client.ui.AbstractConnector
      com.vaadin.client.ui.AbstractComponentConnector
          com.vaadin.client.ui.AbstractHasComponentsConnector
              com.vaadin.client.ui.grid.GridConnector

All Implemented Interfaces:

com.google.gwt.event.shared.EventHandler, StateChangeEvent.StateChangeHandler, ComponentConnector, ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler, HasComponentsConnector, ServerConnector, ManagedLayout, SimpleManagedLayout, com.vaadin.shared.Connector, java.io.Serializable

public class GridConnector
extends AbstractHasComponentsConnector
implements SimpleManagedLayout

Connects the client side Grid widget with the server side Grid component.

The Grid is typed to JSONObject. The structure of the JSONObject is described at DataProviderRpc.setRowData(int, List).

Since:

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

GridConnector()

Method Summary

java.lang.String	getRowKey(int index) Gets the row key for a row by index.
com.vaadin.shared.ui.grid.GridState	getState() Returns the shared state object for this connector.
Grid<JSONObject>	getWidget() Returns the widget associated with this paintable.
protected void	init() Called when the connector has been initialized.
void	layout()
void	onConnectorHierarchyChange(ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent)
void	onStateChanged(StateChangeEvent stateChangeEvent) Notifies the event handler that the state has changed.
void	setDataSource(RpcDataSourceConnector.RpcDataSource dataSource)
void	updateCaption(ComponentConnector connector) Update child components caption, description and error message.

Methods inherited from class com.vaadin.client.ui.AbstractHasComponentsConnector

addConnectorHierarchyChangeHandler, getChildComponents, setChildComponents

Methods inherited from class com.vaadin.client.ui.AbstractComponentConnector

createWidget, delegateCaptionHandling, flush, getIcon, getIconUri, getLayoutManager, getTooltipInfo, hasTooltip, isReadOnly, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onUnregister, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, updateComponentSize, updateComponentSize, updateEnabledState, updateWidgetSize, updateWidgetStyleNames

Methods inherited from class com.vaadin.client.ui.AbstractConnector

addStateChangeHandler, addStateChangeHandler, createState, doInit, ensureHandlerManager, fireEvent, forceStateChange, getChildren, getConnection, getConnectorId, getParent, getResourceUrl, getRpcImplementations, getRpcProxy, getStateType, hasEventListener, isEnabled, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, unregisterRpc

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.client.ComponentConnector

delegateCaptionHandling, flush, getLayoutManager, getTooltipInfo, hasTooltip, isReadOnly, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, setWidgetEnabled

Methods inherited from interface com.vaadin.client.ServerConnector

addStateChangeHandler, addStateChangeHandler, doInit, fireEvent, getChildren, getConnection, getParent, getRpcImplementations, hasEventListener, isEnabled, onUnregister, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, updateEnabledState

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

GridConnector

public GridConnector()

Method Detail

getWidget

public Grid<JSONObject> getWidget()

Description copied from class: AbstractComponentConnector

Returns the widget associated with this paintable. The widget returned by this method must not changed during the life time of the paintable.

Specified by:

getWidget in interface ComponentConnector

Overrides:

getWidget in class AbstractComponentConnector

Returns:

The widget associated with this paintable

getState

public com.vaadin.shared.ui.grid.GridState getState()

Description copied from class: AbstractConnector

Returns the shared state object for this connector. Override this method to define the shared state type for your connector.

Specified by:

getState in interface ComponentConnector

Specified by:

getState in interface ServerConnector

Overrides:

getState in class AbstractComponentConnector

Returns:

the current shared state (never null)

init

protected void init()

Description copied from class: AbstractConnector

Called when the connector has been initialized. Override this method to perform initialization of the connector.

Overrides:

init in class AbstractConnector

onStateChanged

public void onStateChanged(StateChangeEvent stateChangeEvent)

Description copied from interface: StateChangeEvent.StateChangeHandler

Notifies the event handler that the state has changed.

Specified by:

onStateChanged in interface StateChangeEvent.StateChangeHandler

Overrides:

onStateChanged in class AbstractComponentConnector

Parameters:

stateChangeEvent - the state change event with details about the change

setDataSource

public void setDataSource(RpcDataSourceConnector.RpcDataSource dataSource)

getRowKey

public java.lang.String getRowKey(int index)

Gets the row key for a row by index.

Parameters:

index - the index of the row for which to get the key

Returns:

the key for the row at index

updateCaption

public void updateCaption(ComponentConnector connector)

Description copied from interface: HasComponentsConnector

Update child components caption, description and error message.

Each component is responsible for maintaining its caption, description and error message. In most cases components doesn't want to do that and those elements reside outside of the component. Because of this layouts must provide service for it's childen to show those elements for them.

Specified by:

updateCaption in interface HasComponentsConnector

Parameters:

connector - Child component for which service is requested.

onConnectorHierarchyChange

public void onConnectorHierarchyChange(ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent)

Specified by:

onConnectorHierarchyChange in interface ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler

layout

public void layout()

Specified by:

layout in interface SimpleManagedLayout