Package io.jmix.flowui.component.formatter

Class DateFormatter<V>

java.lang.Object

io.jmix.flowui.component.formatter.DateFormatter<V>

All Implemented Interfaces:

Formatter<V>, Function<V,String>

@Component("flowui_DateFormatter")
@Scope("prototype")
public class DateFormatter<V>
extends Object
implements Formatter<V>

DateFormatter formatter to be used in view descriptors and controllers.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentAuthentication	currentAuthentication
protected DateTimeTransformations	dateTimeTransformations
protected String	format
protected FormatStringsRegistry	formatStringsRegistry
protected Messages	messages
protected String	type
protected boolean	useUserTimezone

Constructor Summary

Constructors

Constructor	Description
DateFormatter(CurrentAuthentication currentAuthentication, Messages messages, FormatStringsRegistry formatStringsRegistry, DateTimeTransformations dateTimeTransformations)

Method Summary

Modifier and Type	Method	Description
String	apply(V value)	Formats a value to a string.
protected String	applyFormatInternal(V value)
void	setFormat(String format)	Sets the format string describing the date format which will be used to create SimpleDateFormat instance.
void	setType(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

Field Details

currentAuthentication

protected CurrentAuthentication currentAuthentication

messages

protected Messages messages

formatStringsRegistry

protected FormatStringsRegistry formatStringsRegistry

dateTimeTransformations

protected DateTimeTransformations dateTimeTransformations

format

protected String format

type

protected String type

useUserTimezone

protected boolean useUserTimezone

Constructor Details

DateFormatter

public DateFormatter(CurrentAuthentication currentAuthentication,
 Messages messages,
 FormatStringsRegistry formatStringsRegistry,
 DateTimeTransformations dateTimeTransformations)

Method Details

setFormat

public void setFormat(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

public void setType(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

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 String apply(@Nullable
 V value)

Description copied from interface: Formatter

Formats a value to a string.

Specified by:

apply in interface Formatter<V>

Specified by:

apply in interface Function<V,String>

Parameters:

value - a value

Returns:

formatted string

applyFormatInternal

protected String applyFormatInternal(V value)