Package com.vaadin.v7.client.connectors

Class GridConnector

java.lang.Object

com.vaadin.client.ui.AbstractConnector

com.vaadin.client.ui.AbstractComponentConnector

com.vaadin.client.ui.AbstractHasComponentsConnector

com.vaadin.v7.client.connectors.GridConnector

All Implemented Interfaces:

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

public class GridConnector
extends AbstractHasComponentsConnector
implements SimpleManagedLayout, DeferredWorker

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:

7.4

Author:

Vaadin Ltd

See Also:

Serialized Form

Field Summary

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

SIGNIFICANT_MOVE_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
GridConnector()

Method Summary

Modifier and Type	Method	Description
String	getColumnId(Grid.Column<?,?> column)
com.vaadin.v7.client.connectors.RpcDataSourceConnector.DetailsListener	getDetailsListener()	Gets the listener used by this connector for tracking when row detail visibility changes.
String	getRowKey(elemental.json.JsonObject row)	Gets the row key for a row object.
GridState	getState()
TooltipInfo	getTooltipInfo(com.google.gwt.dom.client.Element element)
Grid<elemental.json.JsonObject>	getWidget()
boolean	hasTooltip()
protected void	init()
boolean	isReadOnly()	Checks if the Grid is in read-only mode.
boolean	isWorkPending()
void	layout()
void	onConnectorHierarchyChange(ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent)
void	onStateChanged(StateChangeEvent stateChangeEvent)
protected void	sendContextClickEvent(com.vaadin.shared.MouseEventDetails details, com.google.gwt.dom.client.EventTarget eventTarget)
void	setDataSource(RpcDataSourceConnector.RpcDataSource dataSource)
void	updateCaption(ComponentConnector connector)

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, isErrorIndicatorVisible, isRealUpdate, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, onDragSourceAttached, onDragSourceDetached, onDropTargetAttached, onDropTargetDetached, onUnregister, registerTouchHandlers, setWidgetEnabled, setWidgetStyleName, setWidgetStyleNameWithPrefix, shouldHandleLongTap, unregisterTouchHandlers, 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, getTag, hasEventListener, isEnabled, registerRpc, removeStateChangeHandler, removeStateChangeHandler, setChildren, setParent, setTag, 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, isRelativeHeight, isRelativeWidth, isUndefinedHeight, isUndefinedWidth, setWidgetEnabled

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.client.ServerConnector

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

Constructor Detail

GridConnector

public GridConnector()

Method Detail

getWidget

public Grid<elemental.json.JsonObject> getWidget()

Specified by:

getWidget in interface HasWidget

Overrides:

getWidget in class AbstractComponentConnector

getState

public GridState getState()

Specified by:

getState in interface ComponentConnector

Specified by:

getState in interface ServerConnector

Overrides:

getState in class AbstractComponentConnector

init

protected void init()

Overrides:

init in class AbstractConnector

onStateChanged

public void onStateChanged(StateChangeEvent stateChangeEvent)

Specified by:

onStateChanged in interface StateChangeEvent.StateChangeHandler

Overrides:

onStateChanged in class AbstractComponentConnector

setDataSource

public void setDataSource(RpcDataSourceConnector.RpcDataSource dataSource)

getRowKey

public String getRowKey(elemental.json.JsonObject row)

Gets the row key for a row object.

Parameters:

row - the row object

Returns:

the key for the given row

updateCaption

public void updateCaption(ComponentConnector connector)

Specified by:

updateCaption in interface HasComponentsConnector

onConnectorHierarchyChange

public void onConnectorHierarchyChange(ConnectorHierarchyChangeEvent connectorHierarchyChangeEvent)

Specified by:

onConnectorHierarchyChange in interface ConnectorHierarchyChangeEvent.ConnectorHierarchyChangeHandler

getColumnId

public String getColumnId(Grid.Column<?,?> column)

layout

public void layout()

Specified by:

layout in interface SimpleManagedLayout

isWorkPending

public boolean isWorkPending()

Specified by:

isWorkPending in interface DeferredWorker

getDetailsListener

public com.vaadin.v7.client.connectors.RpcDataSourceConnector.DetailsListener getDetailsListener()

Gets the listener used by this connector for tracking when row detail visibility changes.

Returns:

the used details listener

Since:

7.5.0

isReadOnly

public boolean isReadOnly()

Checks if the Grid is in read-only mode.

Returns:

true if read-only, false otherwise

Since:

8.22

hasTooltip

public boolean hasTooltip()

Specified by:

hasTooltip in interface ComponentConnector

Overrides:

hasTooltip in class AbstractComponentConnector

getTooltipInfo

public TooltipInfo getTooltipInfo(com.google.gwt.dom.client.Element element)

Specified by:

getTooltipInfo in interface ComponentConnector

Overrides:

getTooltipInfo in class AbstractComponentConnector

sendContextClickEvent

protected void sendContextClickEvent(com.vaadin.shared.MouseEventDetails details,
                                     com.google.gwt.dom.client.EventTarget eventTarget)

Overrides:

sendContextClickEvent in class AbstractComponentConnector