Package net.sf.basedb.clients.web.formatter

Class FormatterSettings

java.lang.Object

net.sf.basedb.clients.web.formatter.FormatterSettings

public class FormatterSettings
extends Object

This is autility class for getting and setting formatter-related settings for the logged in user.

Version:

2.0

Author:

nicklas

See Also:

FormatterFactory

Last modified

$Date: 2023-04-20 09:47:14 +0200 (Thu, 20 Apr 2023) $

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_DATE_FORMAT	The default date format for a date formatter = @value
static String	DEFAULT_DATETIME_FORMAT	The default datetime format for a datetime formatter = @value
static int	DEFAULT_NUM_DECIMALS	The default number of decimals to display by a number formatter = @value

Constructor Summary

Constructors

Constructor	Description
FormatterSettings()

Method Summary

Modifier and Type	Method	Description
static String	getDateFormat(SessionControl sc)	Get format string for a date formatter.
static String	getDateTimeFormat(SessionControl sc)	Get format string for a datetime formatter.
static int	getNumDecimals(SessionControl sc)	Get the number of decimals a number formatter should display.
static Character	getThousandsSeparator(SessionControl sc)	Get the separator character to use as a "thousands" separator in large numbers.
static void	setDateFormat(SessionControl sc, String dateFormat)	Set the format string for a date formatter.
static void	setDateTimeFormat(SessionControl sc, String dateTimeFormat)	Set the format string for a datetime formatter.
static void	setNumDecimals(SessionControl sc, int numDecimals)	Set the number of decimals a number formatter should display.
static void	setThousandsSeparator(SessionControl sc, Character separator)	Set the separator character to use as a "thousands" separator in large numbers.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_NUM_DECIMALS

public static final int DEFAULT_NUM_DECIMALS

The default number of decimals to display by a number formatter = @value

See Also:

Constant Field Values

DEFAULT_DATE_FORMAT

public static final String DEFAULT_DATE_FORMAT

The default date format for a date formatter = @value

See Also:

Constant Field Values

DEFAULT_DATETIME_FORMAT

public static final String DEFAULT_DATETIME_FORMAT

The default datetime format for a datetime formatter = @value

See Also:

Constant Field Values

Constructor Details

FormatterSettings

public FormatterSettings()

Method Details

getNumDecimals

public static int getNumDecimals(SessionControl sc)

Get the number of decimals a number formatter should display.

Parameters:

sc - The logged in user's session control

Returns:

The number of decimals

See Also:

DEFAULT_NUM_DECIMALS, FormatterFactory.getNumberFormatter(SessionControl)

setNumDecimals

public static void setNumDecimals(SessionControl sc,
int numDecimals)

Set the number of decimals a number formatter should display.

Parameters:

sc - The logged in user's session control

numDecimals - The number of decimals

See Also:

DEFAULT_NUM_DECIMALS, FormatterFactory.getNumberFormatter(SessionControl)

getThousandsSeparator

public static Character getThousandsSeparator(SessionControl sc)

Get the separator character to use as a "thousands" separator in large numbers. Typically, a comma (,) or space ( ) is used. Returns null if no separator should be used.

Parameters:

sc - The logged in user's session control

Returns:

The separator character or null

Since:

3.19.8

setThousandsSeparator

public static void setThousandsSeparator(SessionControl sc,
Character separator)

Set the separator character to use as a "thousands" separator in large numbers. Typically, a comma (,) or space ( ) is used. Set to null if no separator should be used.

Parameters:

sc - The logged in user's session control

separator - The separator character or null

Since:

3.19.8

getDateFormat

public static String getDateFormat(SessionControl sc)

Get format string for a date formatter.

Parameters:

sc - The logged in user's session control

Returns:

The format string

See Also:

DEFAULT_DATE_FORMAT, FormatterFactory.getDateFormatter(SessionControl)

setDateFormat

public static void setDateFormat(SessionControl sc,
String dateFormat)

Set the format string for a date formatter.

Parameters:

sc - The logged in user's session control

dateFormat - The format string

See Also:

DEFAULT_DATE_FORMAT, FormatterFactory.getDateFormatter(SessionControl), SimpleDateFormat

getDateTimeFormat

public static String getDateTimeFormat(SessionControl sc)

Get format string for a datetime formatter.

Parameters:

sc - The logged in user's session control

Returns:

The format string

See Also:

DEFAULT_DATETIME_FORMAT, FormatterFactory.getDateTimeFormatter(SessionControl)

setDateTimeFormat

public static void setDateTimeFormat(SessionControl sc,
String dateTimeFormat)

Set the format string for a datetime formatter.

Parameters:

sc - The logged in user's session control

dateTimeFormat - The format string

See Also:

DEFAULT_DATETIME_FORMAT, FormatterFactory.getDateTimeFormatter(SessionControl), SimpleDateFormat