com.vaadin.ui

Interface Grid.RowDescriptionGenerator

All Superinterfaces:

Serializable

Enclosing class:

Grid

public static interface Grid.RowDescriptionGenerator
extends Serializable

A callback interface for generating optional descriptions (tooltips) for Grid rows. If a description is generated for a row, it is used for all the cells in the row for which a cell description is not generated.

Since:

7.6

See Also:

Grid.setRowDescriptionGenerator(com.vaadin.ui.Grid.RowDescriptionGenerator)

Method Summary

Modifier and Type	Method and Description
String	getDescription(Grid.RowReference row) Called by Grid to generate a description (tooltip) for a row.

Method Detail

getDescription

String getDescription(Grid.RowReference row)

Called by Grid to generate a description (tooltip) for a row. 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:

row - the row to generate a description for

Returns:

the row description or null for no description