com.vaadin.ui
Interface Grid.CellDescriptionGenerator

All Superinterfaces:

java.io.Serializable

Enclosing class:

Grid

public static interface Grid.CellDescriptionGenerator
extends java.io.Serializable

A callback interface for generating optional descriptions (tooltips) for Grid cells. If a cell has both a row description and a cell description, the latter has precedence.

Since:

7.6

See Also:

Grid.setCellDescriptionGenerator(CellDescriptionGenerator)

Method Summary

java.lang.String

getDescription(Grid.CellReference cell) Called by Grid to generate a description (tooltip) for a cell.

Method Detail

getDescription

java.lang.String getDescription(Grid.CellReference cell)

Called by Grid to generate a description (tooltip) for a cell. The description may contain HTML which is rendered directly; if this is not desired the returned string must be escaped by the implementing method.

Parameters:

cell - the cell to generate a description for

Returns:

the cell description or null for no description