io.jmix.ui.component.formatter

Class NumberFormatter

java.lang.Object

io.jmix.ui.component.formatter.NumberFormatter

All Implemented Interfaces:

Formatter<java.lang.Number>, java.util.function.Function<java.lang.Number,java.lang.String>

@Component(value="ui_NumberFormatter")
 @Scope(value="prototype")
public class NumberFormatter
extends java.lang.Object
implements Formatter<java.lang.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 and Description
protected io.jmix.core.security.CurrentAuthentication	currentAuthentication
protected io.jmix.core.metamodel.datatype.DatatypeRegistry	datatypeRegistry
protected java.lang.String	format
protected io.jmix.core.metamodel.datatype.FormatStringsRegistry	formatStringsRegistry
protected io.jmix.core.Messages	messages

Constructor Summary

Constructors

Constructor and Description
NumberFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply(java.lang.Number value) Formats a value to a string.
void	setFormat(java.lang.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, identity

Field Detail

format

protected java.lang.String format

currentAuthentication

@Autowired
protected io.jmix.core.security.CurrentAuthentication currentAuthentication

messages

@Autowired
protected io.jmix.core.Messages messages

datatypeRegistry

@Autowired
protected io.jmix.core.metamodel.datatype.DatatypeRegistry datatypeRegistry

formatStringsRegistry

@Autowired
protected io.jmix.core.metamodel.datatype.FormatStringsRegistry formatStringsRegistry

Constructor Detail

NumberFormatter

public NumberFormatter()

Method Detail

setFormat

@StudioProperty(type=LOCALIZED_STRING)
public void setFormat(java.lang.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 java.lang.String apply(@Nullable
                                        java.lang.Number value)

Description copied from interface: Formatter

Formats a value to a string.

Specified by:

apply in interface Formatter<java.lang.Number>

Specified by:

apply in interface java.util.function.Function<java.lang.Number,java.lang.String>

Parameters:

value - a value

Returns:

formatted string