Package com.vaadin.flow.data.renderer

Class LocalDateTimeRenderer<SOURCE>

java.lang.Object

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

com.vaadin.flow.data.renderer.ComponentRenderer<Component,SOURCE>

com.vaadin.flow.data.renderer.BasicRenderer<SOURCE,LocalDateTime>

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

Type Parameters:

SOURCE - the type of the input item, from which the LocalDateTime is extracted

All Implemented Interfaces:

Serializable

public class LocalDateTimeRenderer<SOURCE>
extends BasicRenderer<SOURCE,LocalDateTime>

A template renderer for presenting LocalDateTime objects.

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, SerializableSupplier<DateTimeFormatter> formatter)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, SerializableSupplier<DateTimeFormatter> formatter, String nullRepresentation)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, String formatPattern)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, String formatPattern, Locale locale)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, String formatPattern, Locale locale, String nullRepresentation)	Creates a new LocalDateTimeRenderer.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, DateTimeFormatter formatter)	Deprecated. Via this constructor renderer is not serializable, use LocalDateTimeRenderer(com.vaadin.flow.function.ValueProvider<SOURCE,java.time.LocalDateTime>,com.vaadin.flow.function.SerializableSupplier<java.time.format.DateTimeFormatter>) instead.
LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider, DateTimeFormatter formatter, String nullRepresentation)	Deprecated. Via this constructor renderer is not serializable, use LocalDateTimeRenderer(com.vaadin.flow.function.ValueProvider<SOURCE,java.time.LocalDateTime>,com.vaadin.flow.function.SerializableSupplier<java.time.format.DateTimeFormatter>,java.lang.String) instead.

Method Summary

Modifier and Type	Method	Description
protected String	getFormattedValue(LocalDateTime dateTime)	Gets the String representation of the target object, to be used inside the template.

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

createComponent, getTemplateForProperty, getTemplatePropertyName, getValueProvider, render

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

setComponentRendererTag, updateComponent

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

getEventHandlers, getValueProviders, render, setEventHandler, setProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalDateTimeRenderer

public LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider)

Creates a new LocalDateTimeRenderer.

The renderer is configured to render with the format style FormatStyle.LONG for the date and FormatStyle.SHORT for time, with an empty string as its null representation.

Parameters:

valueProvider - the callback to provide a LocalDateTime to the renderer, not null

See Also:

FormatStyle.LONG, FormatStyle.SHORT

LocalDateTimeRenderer

@Deprecated
public LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider,
                             DateTimeFormatter formatter)

Deprecated.

Via this constructor renderer is not serializable, use LocalDateTimeRenderer(com.vaadin.flow.function.ValueProvider<SOURCE,java.time.LocalDateTime>,com.vaadin.flow.function.SerializableSupplier<java.time.format.DateTimeFormatter>) instead.

Creates a new LocalDateTimeRenderer.

The renderer is configured to render with the given formatter, with the empty string as its null representation.

Parameters:

valueProvider - the callback to provide a LocalDateTime to the renderer, not null

formatter - the formatter to use, not null

LocalDateTimeRenderer

public LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider,
                             SerializableSupplier<DateTimeFormatter> formatter)

Creates a new LocalDateTimeRenderer.

The renderer is configured to render with the given formatter, with the empty string as its null representation.

Parameters:

valueProvider - the callback to provide a LocalDateTime to the renderer, not null

formatter - the formatter to use, not null

LocalDateTimeRenderer

@Deprecated
public LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider,
                             DateTimeFormatter formatter,
                             String nullRepresentation)

Deprecated.

Via this constructor renderer is not serializable, use LocalDateTimeRenderer(com.vaadin.flow.function.ValueProvider<SOURCE,java.time.LocalDateTime>,com.vaadin.flow.function.SerializableSupplier<java.time.format.DateTimeFormatter>,java.lang.String) instead.

Creates a new LocalDateTimeRenderer.

The renderer is configured to render with the given formatter.

Parameters:

valueProvider - the callback to provide a LocalDateTime to the renderer, not null

formatter - the formatter to use, not null

nullRepresentation - the textual representation of the null value

LocalDateTimeRenderer

public LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider,
                             SerializableSupplier<DateTimeFormatter> formatter,
                             String nullRepresentation)

Creates a new LocalDateTimeRenderer.

The renderer is configured to render with the given formatter.

Parameters:

valueProvider - the callback to provide a LocalDateTime to the renderer, not null

formatter - the formatter to use, not null

nullRepresentation - the textual representation of the null value

LocalDateTimeRenderer

public LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider,
                             String formatPattern)

Creates a new LocalDateTimeRenderer.

The renderer is configured to render with the given string format, with an empty string as its null representation.

Parameters:

valueProvider - the callback to provide a LocalDateTime to the renderer, not null

formatPattern - the format pattern to format the date with, not null

See Also:

Format Pattern Syntax

LocalDateTimeRenderer

public LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider,
                             String formatPattern,
                             Locale locale)

Creates a new LocalDateTimeRenderer.

The renderer is configured to render with the given string format, as displayed in the given locale, with an empty string as its null representation.

Parameters:

valueProvider - the callback to provide a LocalDateTime to the renderer, not null

formatPattern - the format pattern to format the date with, not null

locale - the locale to use, not null

See Also:

Format Pattern Syntax

LocalDateTimeRenderer

public LocalDateTimeRenderer(ValueProvider<SOURCE,LocalDateTime> valueProvider,
                             String formatPattern,
                             Locale locale,
                             String nullRepresentation)

Creates a new LocalDateTimeRenderer.

The renderer is configured to render with the given string format, as displayed in the given locale.

Parameters:

valueProvider - the callback to provide a LocalDateTime to the renderer, not null

formatPattern - the format pattern to format the date with, not null

locale - the locale to use, not null

nullRepresentation - the textual representation of the null value

See Also:

Format Pattern Syntax

Method Detail

getFormattedValue

protected String getFormattedValue(LocalDateTime dateTime)

Description copied from class: BasicRenderer

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

By default it uses String.valueOf(Object) of the object.

Overrides:

getFormattedValue in class BasicRenderer<SOURCE,LocalDateTime>

Parameters:

dateTime - the target object

Returns:

the string representation of the object