Package com.vaadin.flow.component.grid

Class ColumnPathRenderer<SOURCE>

java.lang.Object

com.vaadin.flow.data.renderer.Renderer<SOURCE>

com.vaadin.flow.component.grid.ColumnPathRenderer<SOURCE>

Type Parameters:

SOURCE - the object model type

All Implemented Interfaces:

Serializable

public class ColumnPathRenderer<SOURCE>
extends Renderer<SOURCE>

Renderer for columns that doesn't use a renderer function for rendering its contents (only the value from the object model). In such cases, a renderer function is not needed on the client-side, only the path property.

Author:

Vaadin Ltd.

See Also:

• Grid.addColumn(ValueProvider)
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ColumnPathRenderer(String property, ValueProvider<SOURCE,?> provider)	Creates a new renderer based on the property and the value provider for that property.

Method Summary

Modifier and Type	Method	Description
Rendering<SOURCE>	render(Element container, DataKeyMapper<SOURCE> keyMapper, String rendererName)	Registers a renderer function with the given name to the given container element.

Methods inherited from class com.vaadin.flow.data.renderer.Renderer

render

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ColumnPathRenderer

public ColumnPathRenderer(String property,
 ValueProvider<SOURCE,?> provider)

Creates a new renderer based on the property and the value provider for that property.

Parameters:

property - the property name

provider - the value provider for the property

Method Details

render

public Rendering<SOURCE> render(Element container,
 DataKeyMapper<SOURCE> keyMapper,
 String rendererName)

Description copied from class: Renderer

Registers a renderer function with the given name to the given container element. Creates the setup to handle rendering of individual data items as requested by the renderer function invocation.

Specified by:

render in class Renderer<SOURCE>

Parameters:

container - the element which accepts the renderer function on the client.

keyMapper - mapper used internally to fetch items by key and to provide keys for given items.

rendererName - name of the renderer function the container element accepts

Returns:

the context of the rendering, that can be used by the components to provide extra customization