A B C G I L N O R S T U W

A

addItemClickListener(ClickableRenderer.ItemClickListener<SOURCE>) - Method in interface com.vaadin.flow.data.renderer.ClickableRenderer

Adds a click listener to the renderer.

addItemClickListener(ClickableRenderer.ItemClickListener<SOURCE>) - Method in class com.vaadin.flow.data.renderer.NativeButtonRenderer

B

BasicRenderer<SOURCE,TARGET> - Class in com.vaadin.flow.data.renderer

Abstract renderer used as the base implementation for renderers that outputs a simple value in the UI, such as NumberRenderer and LocalDateRenderer.

BasicRenderer(ValueProvider<SOURCE, TARGET>) - Constructor for class com.vaadin.flow.data.renderer.BasicRenderer

Builds a new template renderer using the value provider as the source of values to be rendered.

C

ClickableRenderer<SOURCE> - Interface in com.vaadin.flow.data.renderer

Represents a clickable renderer.

ClickableRenderer.ItemClickListener<SOURCE> - Interface in com.vaadin.flow.data.renderer

Listener that receives the clicked item (or tapped item, in touch devices).

com.vaadin.flow.data.renderer - package com.vaadin.flow.data.renderer

ComponentDataGenerator<T> - Class in com.vaadin.flow.data.renderer

A DataGenerator that manages the creation and passivation of components generated by ComponentRenderers.

ComponentDataGenerator(ComponentRenderer<? extends Component, T>, ValueProvider<T, String>) - Constructor for class com.vaadin.flow.data.renderer.ComponentDataGenerator

Creates a new generator.

ComponentRenderer<COMPONENT extends com.vaadin.flow.component.Component,SOURCE> - Class in com.vaadin.flow.data.renderer

Base class for all renderers that support arbitrary Components.

ComponentRenderer(SerializableSupplier<COMPONENT>, SerializableBiConsumer<COMPONENT, SOURCE>) - Constructor for class com.vaadin.flow.data.renderer.ComponentRenderer

Creates a new ComponentRenderer that uses the componentSupplier to generate new Component instances, and the itemConsumer to set the related items.

ComponentRenderer(SerializableSupplier<COMPONENT>) - Constructor for class com.vaadin.flow.data.renderer.ComponentRenderer

Creates a new ComponentRenderer that uses the componentSupplier to generate new Component instances.

ComponentRenderer(SerializableFunction<SOURCE, COMPONENT>) - Constructor for class com.vaadin.flow.data.renderer.ComponentRenderer

Creates a new ComponentRenderer that uses the componentFunction to generate new Component instances.

ComponentRenderer(SerializableFunction<SOURCE, COMPONENT>, SerializableBiFunction<Component, SOURCE, Component>) - Constructor for class com.vaadin.flow.data.renderer.ComponentRenderer

Creates a new ComponentRenderer that uses the componentFunction to generate new Component instances, and a componentUpdateFunction to update existing Component instances.

ComponentRenderer() - Constructor for class com.vaadin.flow.data.renderer.ComponentRenderer

Default constructor, that can be used by subclasses which supports different ways of creating components, other than those defined in the other constructors.

createComponent(SOURCE) - Method in class com.vaadin.flow.data.renderer.BasicRenderer

createComponent(T) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

createComponent(SOURCE) - Method in class com.vaadin.flow.data.renderer.ComponentRenderer

Creates a component for a given object model item.

createComponent(ITEM) - Method in class com.vaadin.flow.data.renderer.IconRenderer

createComponent(SOURCE) - Method in class com.vaadin.flow.data.renderer.NativeButtonRenderer

createComponent(ITEM) - Method in class com.vaadin.flow.data.renderer.TextRenderer

createElement(String) - Method in class com.vaadin.flow.data.renderer.TextRenderer

Creates a new Element that represent the rendered item.

G

generateData(T, JsonObject) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

getComponentRenderer() - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

getContainer() - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

getDataGenerator() - Method in interface com.vaadin.flow.data.renderer.Rendering

Gets a DataGenerator associated with the renderer.

getEventHandlers() - Method in class com.vaadin.flow.data.renderer.LitRenderer

Deprecated.

LitRenderer doesn't support getting the event handlers. Don't use.

getEventHandlers() - Method in class com.vaadin.flow.data.renderer.Renderer

Deprecated.

since Vaadin 22

getFormattedValue(TARGET) - Method in class com.vaadin.flow.data.renderer.BasicRenderer

Gets the String representation of the target object, to be used inside the template.

getFormattedValue(LocalDate) - Method in class com.vaadin.flow.data.renderer.LocalDateRenderer

getFormattedValue(LocalDateTime) - Method in class com.vaadin.flow.data.renderer.LocalDateTimeRenderer

getFormattedValue(Number) - Method in class com.vaadin.flow.data.renderer.NumberRenderer

getItemClickListeners() - Method in interface com.vaadin.flow.data.renderer.ClickableRenderer

Gets all registered listeners.

getItemClickListeners() - Method in class com.vaadin.flow.data.renderer.NativeButtonRenderer

getItemKey(T) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

getNodeIdPropertyName() - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

getRegistration() - Method in interface com.vaadin.flow.data.renderer.Rendering

Gets a Registration that can be used to clean up resources associated with the renderer when it's no longer used.

getTemplateElement() - Method in interface com.vaadin.flow.data.renderer.Rendering

Deprecated.

since Vaadin 22

getTemplateForProperty(String, Rendering<SOURCE>) - Method in class com.vaadin.flow.data.renderer.BasicRenderer

Gets the template String for a given property.

getTemplateForProperty(String, Rendering<SOURCE>) - Method in class com.vaadin.flow.data.renderer.NativeButtonRenderer

getTemplatePropertyName(Rendering<SOURCE>) - Method in class com.vaadin.flow.data.renderer.BasicRenderer

Gets the name of the property to be transmitted and used inside the template.

getValueProvider() - Method in class com.vaadin.flow.data.renderer.BasicRenderer

getValueProviders() - Method in class com.vaadin.flow.data.renderer.Renderer

Gets the property mapped to ValueProviders in this renderer.

I

IconRenderer<ITEM> - Class in com.vaadin.flow.data.renderer

A renderer that renders each item as a text following by an icon using provided icon generator and label generator.

IconRenderer(SerializableFunction<ITEM, ? extends Component>) - Constructor for class com.vaadin.flow.data.renderer.IconRenderer

Creates a new renderer instance using the default ItemLabelGenerator: String::valueOf and the provided iconGenerator.

IconRenderer(SerializableFunction<ITEM, ? extends Component>, ItemLabelGenerator<ITEM>) - Constructor for class com.vaadin.flow.data.renderer.IconRenderer

Creates a new renderer instance using the provided iconGenerator and itemLabelGenerator.

L

LitRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer

LitRenderer is a Renderer that uses a Lit-based template literal to render given model objects in the components that support the JS renderer functions API.

LocalDateRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer

A template renderer for presenting date values.

LocalDateRenderer(ValueProvider<SOURCE, LocalDate>) - Constructor for class com.vaadin.flow.data.renderer.LocalDateRenderer

Creates a new LocalDateRenderer.

LocalDateRenderer(ValueProvider<SOURCE, LocalDate>, String) - Constructor for class com.vaadin.flow.data.renderer.LocalDateRenderer

Creates a new LocalDateRenderer.

LocalDateRenderer(ValueProvider<SOURCE, LocalDate>, String, Locale) - Constructor for class com.vaadin.flow.data.renderer.LocalDateRenderer

Creates a new LocalDateRenderer.

LocalDateRenderer(ValueProvider<SOURCE, LocalDate>, String, Locale, String) - Constructor for class com.vaadin.flow.data.renderer.LocalDateRenderer

Creates a new LocalDateRenderer.

LocalDateRenderer(ValueProvider<SOURCE, LocalDate>, DateTimeFormatter) - Constructor for class com.vaadin.flow.data.renderer.LocalDateRenderer

Creates a new LocalDateRenderer.

LocalDateRenderer(ValueProvider<SOURCE, LocalDate>, DateTimeFormatter, String) - Constructor for class com.vaadin.flow.data.renderer.LocalDateRenderer

Creates a new LocalDateRenderer.

LocalDateTimeRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer

A template renderer for presenting LocalDateTime objects.

LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>) - Constructor for class com.vaadin.flow.data.renderer.LocalDateTimeRenderer

Creates a new LocalDateTimeRenderer.

LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>, DateTimeFormatter) - Constructor for class com.vaadin.flow.data.renderer.LocalDateTimeRenderer

Creates a new LocalDateTimeRenderer.

LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>, DateTimeFormatter, String) - Constructor for class com.vaadin.flow.data.renderer.LocalDateTimeRenderer

Creates a new LocalDateTimeRenderer.

LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>, String) - Constructor for class com.vaadin.flow.data.renderer.LocalDateTimeRenderer

Creates a new LocalDateTimeRenderer.

LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>, String, Locale) - Constructor for class com.vaadin.flow.data.renderer.LocalDateTimeRenderer

Creates a new LocalDateTimeRenderer.

LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>, String, Locale, String) - Constructor for class com.vaadin.flow.data.renderer.LocalDateTimeRenderer

Creates a new LocalDateTimeRenderer.

N

NativeButtonRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer

A template renderer to create a clickable button.

NativeButtonRenderer(String) - Constructor for class com.vaadin.flow.data.renderer.NativeButtonRenderer

Creates a new button renderer with the specified label.

NativeButtonRenderer(String, ClickableRenderer.ItemClickListener<SOURCE>) - Constructor for class com.vaadin.flow.data.renderer.NativeButtonRenderer

Creates a new button renderer with the specified label and registers a ItemClickListener to receive events.

NativeButtonRenderer(ValueProvider<SOURCE, String>) - Constructor for class com.vaadin.flow.data.renderer.NativeButtonRenderer

Creates a new button renderer with a dynamic label.

NativeButtonRenderer(ValueProvider<SOURCE, String>, ClickableRenderer.ItemClickListener<SOURCE>) - Constructor for class com.vaadin.flow.data.renderer.NativeButtonRenderer

Creates a new button renderer with a dynamic label and registers a ItemClickListener to receive events.

NumberRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer

A template renderer for presenting number values.

NumberRenderer(ValueProvider<SOURCE, Number>) - Constructor for class com.vaadin.flow.data.renderer.NumberRenderer

Creates a new number renderer.

NumberRenderer(ValueProvider<SOURCE, Number>, NumberFormat) - Constructor for class com.vaadin.flow.data.renderer.NumberRenderer

Creates a new number renderer.

NumberRenderer(ValueProvider<SOURCE, Number>, NumberFormat, String) - Constructor for class com.vaadin.flow.data.renderer.NumberRenderer

Creates a new number renderer.

NumberRenderer(ValueProvider<SOURCE, Number>, Locale) - Constructor for class com.vaadin.flow.data.renderer.NumberRenderer

Creates a new number renderer.

NumberRenderer(ValueProvider<SOURCE, Number>, String, Locale) - Constructor for class com.vaadin.flow.data.renderer.NumberRenderer

Creates a new number renderer.

NumberRenderer(ValueProvider<SOURCE, Number>, String) - Constructor for class com.vaadin.flow.data.renderer.NumberRenderer

Creates a new number renderer.

NumberRenderer(ValueProvider<SOURCE, Number>, String, Locale, String) - Constructor for class com.vaadin.flow.data.renderer.NumberRenderer

Creates a new number renderer.

O

of(String) - Static method in class com.vaadin.flow.data.renderer.LitRenderer

Creates a new LitRenderer based on the provided template expression.

of(String) - Static method in class com.vaadin.flow.data.renderer.TemplateRenderer

Deprecated.

Creates a new TemplateRenderer based on the provided template.

onClick(SOURCE) - Method in interface com.vaadin.flow.data.renderer.ClickableRenderer

Invoked when an item is clicked or tapped.

onItemClicked(SOURCE) - Method in interface com.vaadin.flow.data.renderer.ClickableRenderer.ItemClickListener

Notifies when an item is clicked or tapped in the target component.

R

registerEventHandlers(Renderer<T>, Element, Element, ValueProvider<String, T>) - Static method in class com.vaadin.flow.data.renderer.RendererUtil

Registers the event handlers associated to a TemplateRenderer, if any.

render(Element, DataKeyMapper<SOURCE>, Element) - Method in class com.vaadin.flow.data.renderer.BasicRenderer

render(Element, DataKeyMapper<SOURCE>, Element) - Method in class com.vaadin.flow.data.renderer.ComponentRenderer

render(Element, DataKeyMapper<SOURCE>, Element) - Method in class com.vaadin.flow.data.renderer.LitRenderer

Deprecated.

LitRenderer doesn't support <template> elements. Don't use.

render(Element, DataKeyMapper<SOURCE>) - Method in class com.vaadin.flow.data.renderer.LitRenderer

Sets up rendering of model objects inside a given Element container element.

render(Element, DataKeyMapper<SOURCE>, String) - Method in class com.vaadin.flow.data.renderer.LitRenderer

Sets up rendering of model objects inside a given Element container element.

render(Element, DataKeyMapper<SOURCE>) - Method in class com.vaadin.flow.data.renderer.Renderer

Handles the rendering of the model objects by creating a new <template> element in the given container.

render(Element, DataKeyMapper<SOURCE>, Element) - Method in class com.vaadin.flow.data.renderer.Renderer

Deprecated.

since Vaadin 22

Renderer<SOURCE> - Class in com.vaadin.flow.data.renderer

Base class for all renderers - classes that take a given model object as input and outputs a set of elements that represents that item in the UI.

Renderer() - Constructor for class com.vaadin.flow.data.renderer.Renderer

Default constructor.

Renderer(String) - Constructor for class com.vaadin.flow.data.renderer.Renderer

Deprecated.

since Vaadin 22

RendererUtil - Class in com.vaadin.flow.data.renderer

Contains helper methods to register events triggered by rendered templates.

Rendering<SOURCE> - Interface in com.vaadin.flow.data.renderer

Defines the context of a given Renderer when building the output elements.

S

setComponentRendererTag(String) - Method in class com.vaadin.flow.data.renderer.ComponentRenderer

Sets the tag of the webcomponent used at the client-side to manage component rendering inside <template>.

setContainer(Element) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

setEventHandler(String, SerializableConsumer<SOURCE>) - Method in class com.vaadin.flow.data.renderer.Renderer

Deprecated.

since Vaadin 22

setNodeIdPropertyName(String) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

setProperty(String, ValueProvider<SOURCE, ?>) - Method in class com.vaadin.flow.data.renderer.Renderer

Deprecated.

since Vaadin 22

T

TemplateRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer

Deprecated.

since Vaadin 22, TemplateRenderer is deprecated in favor of LitRenderer

TextRenderer<ITEM> - Class in com.vaadin.flow.data.renderer

A renderer that renders each item as a text using provided ItemLabelGenerator.

TextRenderer() - Constructor for class com.vaadin.flow.data.renderer.TextRenderer

Creates a new renderer instance using the default ItemLabelGenerator: String::valueOf.

TextRenderer(ItemLabelGenerator<ITEM>) - Constructor for class com.vaadin.flow.data.renderer.TextRenderer

Creates a new renderer instance using the provided itemLabelGenerator.

U

updateComponent(Component, T) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator

updateComponent(Component, SOURCE) - Method in class com.vaadin.flow.data.renderer.ComponentRenderer

Called when the item is updated.

W

withEventHandler(String, SerializableConsumer<SOURCE>) - Method in class com.vaadin.flow.data.renderer.LitRenderer

Deprecated.

Use LitRenderer.withFunction(String, SerializableConsumer) instead.

withEventHandler(String, SerializableConsumer<SOURCE>) - Method in class com.vaadin.flow.data.renderer.TemplateRenderer

Deprecated.

Sets an event handler for events from elements inside the template.

withFunction(String, SerializableConsumer<SOURCE>) - Method in class com.vaadin.flow.data.renderer.LitRenderer

Adds a function that can be called from within the template expression.

withFunction(String, SerializableBiConsumer<SOURCE, JsonArray>) - Method in class com.vaadin.flow.data.renderer.LitRenderer

Adds a function that can be called from within the template expression.

withProperty(String, ValueProvider<SOURCE, ?>) - Method in class com.vaadin.flow.data.renderer.LitRenderer

Makes a property available to the template expression.

withProperty(String, ValueProvider<SOURCE, ?>) - Method in class com.vaadin.flow.data.renderer.TemplateRenderer

Deprecated.

Sets a property to be used inside the template.

A B C G I L N O R S T U W