Package com.vaadin.flow.data.renderer

Class NumberRenderer<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,Number>

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

Type Parameters:

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

All Implemented Interfaces:

Serializable

public class NumberRenderer<SOURCE>
extends BasicRenderer<SOURCE,Number>

A template renderer for presenting number values.

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NumberRenderer(ValueProvider<SOURCE,Number> valueProvider)	Creates a new number renderer.
	NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, String formatString)	Creates a new number renderer.
	NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, String formatString, Locale locale)	Creates a new number renderer.
	NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, String formatString, Locale locale, String nullRepresentation)	Creates a new number renderer.
	NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, NumberFormat numberFormat)	Creates a new number renderer.
	NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, NumberFormat numberFormat, String nullRepresentation)	Creates a new number renderer.
	NumberRenderer(ValueProvider<SOURCE,Number> valueProvider, Locale locale)	Creates a new number renderer.

Method Summary

Modifier and Type	Method	Description
protected String	getFormattedValue(Number value)	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

NumberRenderer

protected NumberRenderer(ValueProvider<SOURCE,Number> valueProvider)

Creates a new number renderer.

The renderer is configured to render with the number's natural string representation in the default locale.

Parameters:

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

NumberRenderer

public NumberRenderer(ValueProvider<SOURCE,Number> valueProvider,
                      NumberFormat numberFormat)

Creates a new number renderer.

The renderer is configured to render the number as defined with the given number format.

Parameters:

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

numberFormat - the number format with which to display numbers, not null

NumberRenderer

public NumberRenderer(ValueProvider<SOURCE,Number> valueProvider,
                      NumberFormat numberFormat,
                      String nullRepresentation)

Creates a new number renderer.

The renderer is configured to render the number as defined with the given number format.

Parameters:

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

numberFormat - the number format with which to display numbers, not null

nullRepresentation - the textual representation of null value

NumberRenderer

public NumberRenderer(ValueProvider<SOURCE,Number> valueProvider,
                      Locale locale)

Creates a new number renderer.

The renderer is configured to render with the number's natural string representation in the given locale.

Parameters:

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

locale - the locale in which to display numbers

NumberRenderer

public NumberRenderer(ValueProvider<SOURCE,Number> valueProvider,
                      String formatString,
                      Locale locale)

Creates a new number renderer.

The renderer is configured to render with the number's natural string representation in the given locale.

Parameters:

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

formatString - the format string with which to format the number, not null

locale - the locale in which to display numbers, not null

NumberRenderer

public NumberRenderer(ValueProvider<SOURCE,Number> valueProvider,
                      String formatString)

Creates a new number renderer.

The renderer is configured to render with the given format string in the default locale.

Parameters:

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

formatString - the format string with which to format the number, not null

See Also:

Format String Syntax

NumberRenderer

public NumberRenderer(ValueProvider<SOURCE,Number> valueProvider,
                      String formatString,
                      Locale locale,
                      String nullRepresentation)

Creates a new number renderer.

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

Parameters:

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

formatString - the format string with which to format the number, not null

locale - the locale in which to present numbers, not null

nullRepresentation - the textual representation of null value

See Also:

Format String Syntax

Method Detail

getFormattedValue

protected String getFormattedValue(Number value)

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,Number>

Parameters:

value - the target object

Returns:

the string representation of the object