Package com.vaadin.flow.data.renderer
Interface Rendering<SOURCE>
-
- Type Parameters:
SOURCE
- the type of the object model
- All Superinterfaces:
Serializable
public interface Rendering<SOURCE> extends Serializable
Defines the context of a givenRenderer
when building the output elements. Components that support Renderers can use the context to customize the rendering according to their needs.- Author:
- Vaadin Ltd
- See Also:
Renderer.render(Element, com.vaadin.flow.data.provider.DataKeyMapper)
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description Optional<DataGenerator<SOURCE>>
getDataGenerator()
Gets aDataGenerator
associated with the renderer.default Registration
getRegistration()
Gets aRegistration
that can be used to clean up resources associated with the renderer when it's no longer used.Element
getTemplateElement()
Deprecated.since Vaadin 22
-
-
-
Method Detail
-
getDataGenerator
Optional<DataGenerator<SOURCE>> getDataGenerator()
Gets aDataGenerator
associated with the renderer. The DataGenerator is used in components that support in asynchronous loading of items.- Returns:
- the associated DataGenerator, if any
-
getTemplateElement
@Deprecated Element getTemplateElement()
Deprecated.since Vaadin 22Gets the<template>
element associated with the rendering. This can be used to set specific attributes to the template, or change its contents before it is stamped on the client-side.- Returns:
- the associated template element, or
null
if no template element is associated with the rendering
-
getRegistration
default Registration getRegistration()
Gets aRegistration
that can be used to clean up resources associated with the renderer when it's no longer used.- Returns:
- the Registration
- See Also:
Registration.remove()
-
-