Package com.vaadin.ui

Class Grid.AbstractGridExtension<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

com.vaadin.ui.AbstractListing.AbstractListingExtension<T>

com.vaadin.ui.Grid.AbstractGridExtension<T>

Type Parameters:

T -

All Implemented Interfaces:

DataGenerator<T>, MethodEventSource, ClientConnector, Extension, Connector, Serializable

Direct Known Subclasses:

AbstractSelectionModel, EditorImpl, Grid.DetailsManager

Enclosing class:

Grid<T>

public abstract static class Grid.AbstractGridExtension<T>
extends AbstractListing.AbstractListingExtension<T>

A helper base class for creating extensions for the Grid component.

See Also:

Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
AbstractGridExtension()

Method Summary

Modifier and Type	Method	Description
protected void	addComponentToGrid(Component c)	Adds given component to the connector hierarchy of Grid.
void	extend(AbstractListing<T> grid)	Adds this extension to the given parent listing.
protected String	getInternalIdForColumn(Grid.Column<T,?> column)	Returns the internal id for given column.
Grid<T>	getParent()
protected AbstractGridExtensionState	getState()	Returns the shared state for this connector.
protected AbstractGridExtensionState	getState(boolean markAsDirty)	Returns the shared state for this connector.
protected void	removeComponentFromGrid(Component c)	Removes given component from the connector hierarchy of Grid.

Methods inherited from class com.vaadin.ui.AbstractListing.AbstractListingExtension

getData, refresh, remove

Methods inherited from class com.vaadin.server.AbstractExtension

extend, getSupportedParentType, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

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

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, beforeClientResponse, 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

Methods inherited from interface com.vaadin.data.provider.DataGenerator

destroyAllData, destroyData, generateData, refreshData

Constructor Detail

AbstractGridExtension

public AbstractGridExtension()

Method Detail

extend

public void extend(AbstractListing<T> grid)

Description copied from class: AbstractListing.AbstractListingExtension

Adds this extension to the given parent listing.

Overrides:

extend in class AbstractListing.AbstractListingExtension<T>

Parameters:

grid - the parent component to add to

addComponentToGrid

protected void addComponentToGrid(Component c)

Adds given component to the connector hierarchy of Grid.

Parameters:

c - the component to add

removeComponentFromGrid

protected void removeComponentFromGrid(Component c)

Removes given component from the connector hierarchy of Grid.

Parameters:

c - the component to remove

getParent

public Grid<T> getParent()

Specified by:

getParent in interface ClientConnector

Specified by:

getParent in interface Connector

Overrides:

getParent in class AbstractListing.AbstractListingExtension<T>

getState

protected AbstractGridExtensionState getState()

Description copied from class: AbstractClientConnector

Returns the shared state for this connector. The shared state object is shared between the server connector and the client connector. Changes are only communicated from the server to the client and not in the other direction.

As a side effect, marks the connector dirty so any changes done to the state will be sent to the client. Use getState(false) to avoid marking the connector as dirty.

Overrides:

getState in class AbstractListing.AbstractListingExtension<T>

Returns:

The shared state for this connector. Never null.

getState

protected AbstractGridExtensionState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class AbstractListing.AbstractListingExtension<T>

Parameters:

markAsDirty - true if the connector should automatically be marked dirty, false otherwise

Returns:

The shared state for this connector. Never null.

See Also:

AbstractClientConnector.getState()

getInternalIdForColumn

protected String getInternalIdForColumn(Grid.Column<T,?> column)

Returns the internal id for given column. This id should not be confused with the user-defined identifier.

Parameters:

column - the column

Returns:

internal id of given column