Index
All Classes and Interfaces|All Packages|Serialized Form
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
NumberRendererandLocalDateRenderer. - BasicRenderer(ValueProvider<SOURCE, TARGET>) - Constructor for class com.vaadin.flow.data.renderer.BasicRenderer
-
Builds a new 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
DataGeneratorthat manages the creation and passivation of components generated byComponentRenderers. - 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(SerializableFunction<SOURCE, COMPONENT>) - Constructor for class com.vaadin.flow.data.renderer.ComponentRenderer
-
Creates a new ComponentRenderer that uses the componentFunction to generate new
Componentinstances. - 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
Componentinstances, and a componentUpdateFunction to update existingComponentinstances. - ComponentRenderer(SerializableSupplier<COMPONENT>) - Constructor for class com.vaadin.flow.data.renderer.ComponentRenderer
-
Creates a new ComponentRenderer that uses the componentSupplier to generate new
Componentinstances. - 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
Componentinstances, and the itemConsumer to set the related items. - createComponent(ITEM) - Method in class com.vaadin.flow.data.renderer.IconRenderer
- createComponent(ITEM) - Method in class com.vaadin.flow.data.renderer.TextRenderer
- createComponent(SOURCE) - Method in class com.vaadin.flow.data.renderer.BasicRenderer
- createComponent(SOURCE) - Method in class com.vaadin.flow.data.renderer.ComponentRenderer
-
Creates a component for a given object model item.
- createComponent(SOURCE) - Method in class com.vaadin.flow.data.renderer.NativeButtonRenderer
- createComponent(T) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator
- createElement(String) - Method in class com.vaadin.flow.data.renderer.TextRenderer
-
Creates a new
Elementthat represent the rendereditem.
G
- generateData(T, ObjectNode) - 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
DataGeneratorassociated with the renderer. - getFormattedValue(ITEM) - Method in class com.vaadin.flow.data.renderer.TextRenderer
- getFormattedValue(Number) - Method in class com.vaadin.flow.data.renderer.NumberRenderer
- getFormattedValue(LocalDate) - Method in class com.vaadin.flow.data.renderer.LocalDateRenderer
- getFormattedValue(LocalDateTime) - Method in class com.vaadin.flow.data.renderer.LocalDateTimeRenderer
- 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.
- 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
Registrationthat can be used to clean up resources associated with the renderer when it's no longer used. - getTemplateExpression() - Method in class com.vaadin.flow.data.renderer.BasicRenderer
- getTemplateExpression() - Method in class com.vaadin.flow.data.renderer.ComponentRenderer
- getTemplateExpression() - Method in class com.vaadin.flow.data.renderer.LitRenderer
-
Returns the Lit template expression used to render items.
- getTemplateExpression() - Method in class com.vaadin.flow.data.renderer.NativeButtonRenderer
- getTemplateExpression() - Method in class com.vaadin.flow.data.renderer.TextRenderer
- getValueProvider() - Method in class com.vaadin.flow.data.renderer.BasicRenderer
- getValueProviders() - Method in class com.vaadin.flow.data.renderer.LitRenderer
-
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::valueOfand the providediconGenerator. - IconRenderer(SerializableFunction<ITEM, ? extends Component>, ItemLabelGenerator<ITEM>) - Constructor for class com.vaadin.flow.data.renderer.IconRenderer
-
Creates a new renderer instance using the provided
iconGeneratoranditemLabelGenerator.
L
- LitRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer
-
LitRenderer is a
Rendererthat 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 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>, SerializableSupplier<DateTimeFormatter>) - Constructor for class com.vaadin.flow.data.renderer.LocalDateRenderer
-
Creates a new LocalDateRenderer.
- LocalDateRenderer(ValueProvider<SOURCE, LocalDate>, SerializableSupplier<DateTimeFormatter>, String) - 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.
- LocalDateTimeRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer
-
A renderer for presenting
LocalDateTimeobjects. - LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>) - Constructor for class com.vaadin.flow.data.renderer.LocalDateTimeRenderer
-
Creates a new LocalDateTimeRenderer.
- LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>, SerializableSupplier<DateTimeFormatter>) - Constructor for class com.vaadin.flow.data.renderer.LocalDateTimeRenderer
-
Creates a new LocalDateTimeRenderer.
- LocalDateTimeRenderer(ValueProvider<SOURCE, LocalDateTime>, SerializableSupplier<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 renderer to create a clickable button.
- 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
ClickableRenderer.ItemClickListenerto receive events. - 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
ClickableRenderer.ItemClickListenerto receive events. - NumberRenderer<SOURCE> - Class in com.vaadin.flow.data.renderer
-
A 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>, String) - 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, Locale, String) - 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.
O
- of(String) - Static method in class com.vaadin.flow.data.renderer.LitRenderer
-
Creates a new LitRenderer based on the provided template expression.
- 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
- render(Element, DataKeyMapper<SOURCE>) - Method in class com.vaadin.flow.data.renderer.Renderer
-
Registers a renderer function to the given container element.
- render(Element, DataKeyMapper<SOURCE>, String) - Method in class com.vaadin.flow.data.renderer.ComponentRenderer
- render(Element, DataKeyMapper<SOURCE>, String) - Method in class com.vaadin.flow.data.renderer.LitRenderer
- render(Element, DataKeyMapper<SOURCE>, String) - Method in class com.vaadin.flow.data.renderer.Renderer
-
Registers a renderer function with the given name to the given container element.
- Renderer<SOURCE> - Class in com.vaadin.flow.data.renderer
-
Base class for all renderers - classes that take a given model object as input and handles their rendering to the client side when requested.
- Renderer() - Constructor for class com.vaadin.flow.data.renderer.Renderer
- Rendering<SOURCE> - Interface in com.vaadin.flow.data.renderer
-
Defines the context of a given
Rendererwhen building the output elements.
S
- setContainer(Element) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator
- setNodeIdPropertyName(String) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator
T
- 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, SOURCE) - Method in class com.vaadin.flow.data.renderer.ComponentRenderer
-
Called when the item is updated.
- updateComponent(Component, T) - Method in class com.vaadin.flow.data.renderer.ComponentDataGenerator
W
- withFunction(String, SerializableBiConsumer<SOURCE, ArrayNode>) - Method in class com.vaadin.flow.data.renderer.LitRenderer
-
Adds a function that can be called from within the template expression.
- 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.
- withProperty(String, ValueProvider<SOURCE, ?>) - Method in class com.vaadin.flow.data.renderer.LitRenderer
-
Makes a property available to the template expression.
All Classes and Interfaces|All Packages|Serialized Form