Package io.jmix.ui.component.formatter

Class NumberFormatter

java.lang.Object

io.jmix.ui.component.formatter.NumberFormatter

All Implemented Interfaces:

Formatter<Number>, Function<Number,String>

@Component("ui_NumberFormatter")
@Scope("prototype")
public class NumberFormatter
extends Object
implements Formatter<Number>

Number formatter to be used in screen descriptors and controllers.

This formatter formats the Number value into a string depending on the format string.

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentAuthentication	currentAuthentication
protected DatatypeRegistry	datatypeRegistry
protected String	format
protected FormatStringsRegistry	formatStringsRegistry
protected Messages	messages

Constructor Summary

Constructors

Constructor	Description
NumberFormatter()

Method Summary

Modifier and Type	Method	Description
String	apply(Number value)	Formats a value to a string.
void	setFormat(String format)	Sets the format string describing the number format which will be used to create DecimalFormat instance.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose

Field Details

format

protected String format

currentAuthentication

@Autowired
protected CurrentAuthentication currentAuthentication

messages

@Autowired
protected Messages messages

datatypeRegistry

@Autowired
protected DatatypeRegistry datatypeRegistry

formatStringsRegistry

@Autowired
protected FormatStringsRegistry formatStringsRegistry

Constructor Details

NumberFormatter

public NumberFormatter()

Method Details

setFormat

@StudioProperty(type=LOCALIZED_STRING)
public void setFormat(String format)

Sets the format string describing the number format which will be used to create DecimalFormat instance. It can be either a format string, or a key in message group.

Parameters:

format - a format string or a key in message group

apply

@Nullable
public String apply(@Nullable
 Number value)

Description copied from interface: Formatter

Formats a value to a string.

Specified by:

apply in interface Formatter<Number>

Specified by:

apply in interface Function<Number,String>

Parameters:

value - a value

Returns:

formatted string