com.vaadin.ui

Class Grid.DetailsManager<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

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

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

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

Type Parameters:

T - the grid bean type

All Implemented Interfaces:

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

Enclosing class:

Grid<T>

public static class Grid.DetailsManager<T>
extends Grid.AbstractGridExtension<T>

Class for managing visible details rows.

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 and Description
DetailsManager()

Method Summary

Modifier and Type	Method and Description
void	destroyData(T item) Informs the DataGenerator that the given data item has been dropped and is no longer needed.
void	generateData(T item, JsonObject jsonObject) Adds custom data for the given item to its serialized JsonObject representation.
Grid<T>	getParent()
protected DetailsManagerState	getState() Returns the shared state for this connector.
protected DetailsManagerState	getState(boolean markAsDirty) Returns the shared state for this connector.
boolean	isDetailsVisible(T item) Returns the visibility of details component for given item.
void	remove() Remove this extension from its target.
void	setDetailsGenerator(DetailsGenerator<T> generator) Sets the details component generator.
void	setDetailsVisible(T item, boolean visible) Sets the visibility of details component for given item.

Methods inherited from class com.vaadin.ui.Grid.AbstractGridExtension

addComponentToGrid, extend, getInternalIdForColumn, removeComponentFromGrid

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

getData, refresh

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, 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, 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.data.provider.DataGenerator

destroyAllData, refreshData

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

Constructor Detail

DetailsManager

public DetailsManager()

Method Detail

setDetailsGenerator

public void setDetailsGenerator(DetailsGenerator<T> generator)

Sets the details component generator.

Parameters:

generator - the generator for details components

remove

public void remove()

Description copied from interface: Extension

Remove this extension from its target. After an extension has been removed, it cannot be attached again.

Specified by:

remove in interface Extension

Overrides:

remove in class AbstractListing.AbstractListingExtension<T>

generateData

public void generateData(T item,
                         JsonObject jsonObject)

Description copied from interface: DataGenerator

Adds custom data for the given item to its serialized JsonObject representation. This JSON object will be sent to client-side DataProvider.

Parameters:

item - the data item being serialized

jsonObject - the JSON object being sent to the client

destroyData

public void destroyData(T item)

Description copied from interface: DataGenerator

Informs the DataGenerator that the given data item has been dropped and is no longer needed. This method should clean up any unneeded information stored for this item.

Parameters:

item - the dropped data item

setDetailsVisible

public void setDetailsVisible(T item,
                              boolean visible)

Sets the visibility of details component for given item.

Parameters:

item - the item to show details for

visible - true if details component should be visible; false if it should be hidden

isDetailsVisible

public boolean isDetailsVisible(T item)

Returns the visibility of details component for given item.

Parameters:

item - the item to show details for

Returns:

true if details component should be visible; false if it should be hidden

getParent

public Grid<T> getParent()

Specified by:

getParent in interface ClientConnector

Specified by:

getParent in interface Connector

Overrides:

getParent in class Grid.AbstractGridExtension<T>

getState

protected DetailsManagerState 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 Grid.AbstractGridExtension<T>

Returns:

The shared state for this connector. Never null.

getState

protected DetailsManagerState getState(boolean markAsDirty)

Description copied from class: AbstractClientConnector

Returns the shared state for this connector.

Overrides:

getState in class Grid.AbstractGridExtension<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()