io.jmix.ui.component.formatter

Class DateFormatter

java.lang.Object

io.jmix.ui.component.formatter.DateFormatter

All Implemented Interfaces:

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

@Component(value="ui_DateFormatter")
 @Scope(value="prototype")
public class DateFormatter
extends java.lang.Object
implements Formatter<java.util.Date>

Date formatter to be used in screen descriptors and controllers.

This formatter formats the Date 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 java.lang.String	format
protected io.jmix.core.metamodel.datatype.FormatStringsRegistry	formatStringsRegistry
protected io.jmix.core.Messages	messages
protected java.lang.String	type
protected boolean	useUserTimezone

Constructor Summary

Constructors

Constructor and Description
DateFormatter()

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply(java.util.Date value) Formats a value to a string.
void	setFormat(java.lang.String format) Sets the format string describing the date format which will be used to create SimpleDateFormat instance.
void	setType(java.lang.String type) Sets the formatter type, which can have a DATE or DATETIME value.
void	setUseUserTimezone(boolean useUserTimezone) Sets whether formatter should display the date and time in the current user's timezone.

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

currentAuthentication

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

messages

@Autowired
protected io.jmix.core.Messages messages

formatStringsRegistry

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

format

protected java.lang.String format

type

protected java.lang.String type

useUserTimezone

protected boolean useUserTimezone

Constructor Detail

DateFormatter

public DateFormatter()

Method Detail

setFormat

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

Sets the format string describing the date format which will be used to create SimpleDateFormat 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

setType

@StudioProperty(type=ENUMERATION,
                options={"DATE","DATETIME"})
public void setType(java.lang.String type)

Sets the formatter type, which can have a DATE or DATETIME value. If specified, the value will be formatted by means of DateDatatype or DateTimeDatatype respectively.

Parameters:

type - a formatter type

setUseUserTimezone

@StudioProperty(defaultValue="false")
public void setUseUserTimezone(boolean useUserTimezone)

Sets whether formatter should display the date and time in the current user's timezone.

Parameters:

useUserTimezone - true if the formatter displays the date and time in the current user's timezone, false otherwise

apply

@Nullable
public java.lang.String apply(@Nullable
                                        java.util.Date value)

Description copied from interface: Formatter

Formats a value to a string.

Specified by:

apply in interface Formatter<java.util.Date>

Specified by:

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

Parameters:

value - a value

Returns:

formatted string