com.foreach.across.modules.bootstrapui.elements

Class NumericFormElementConfiguration

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

com.foreach.across.modules.bootstrapui.elements.NumericFormElementConfiguration

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class NumericFormElementConfiguration
extends HashMap<String,Object>

Configuration class for a NumericFormElement based on JQuery autoNumeric plugin. The order in which properties are set is important, as setting a format or currency will update several properties at once.

Author:

Arne Vandamme

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NumericFormElementConfiguration.Format Predefined formats defining decimal spaces, rounding methods, negative formatters and optionally a sign.

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_EMPTY
static String	EMPTY_SIGN
static String	EMPTY_ZERO
static String	NEGATIVE_ANGLES
static String	NEGATIVE_BRACES
static String	NEGATIVE_BRACKETS
static String	NEGATIVE_PARENTHESES
static String	ROUND_CEILING
static String	ROUND_DOWN
static String	ROUND_FLOOR
static String	ROUND_HALF_DOWN_ASYMMETRIC
static String	ROUND_HALF_DOWN_SYMMETRIC
static String	ROUND_HALF_EVEN
static String	ROUND_HALF_UP_ASYMMETRIC
static String	ROUND_HALF_UP_SYMMETRIC
static String	ROUND_SWISS
static String	ROUND_UP

Constructor Summary

Constructors

Constructor and Description
NumericFormElementConfiguration()
NumericFormElementConfiguration(Currency currency)
NumericFormElementConfiguration(Locale locale)
NumericFormElementConfiguration(NumericFormElementConfiguration.Format format)
NumericFormElementConfiguration(NumericFormElementConfiguration configuration)

Method Summary

Modifier and Type	Method and Description
NumberFormat	createNumberFormat() Create a NumberFormat that represents the same configuration.
static NumericFormElementConfiguration	currency(Currency currency, int decimalPositions, boolean forceWhitespaceAroundSign) Create a localizable configuration for a given currency.
Currency	getCurrency()
NumericFormElementConfiguration.Format	getFormat()
int	getMultiplier()
boolean	isForceWhitespaceAroundSign()
boolean	isLocalizeDecimalSymbols()
boolean	isLocalizeOutputFormat()
NumericFormElementConfiguration	localize(Locale locale) Create a localized version of this configuration.
static NumericFormElementConfiguration	percent(int decimalPositions, boolean forceWhitespaceAroundSign) Create a localizable configuration for percentages.
Object	put(String key, Object value)
void	setCurrency(Currency currency)
void	setCurrency(Currency currency, Locale locale) Set currency to use and locale for which to retrieve the currency signal.
void	setDecimalPadding(boolean padding)
void	setDecimalPositions(int positions)
void	setDecimalSeparator(char separator)
void	setEmptyBehaviour(String behaviour)
void	setForceWhitespaceAroundSign(boolean forceWhitespaceAroundSign) Ensure that whitespace is added between the sign and the number itself, no matter the localized format.
void	setFormat(NumericFormElementConfiguration.Format format)
void	setGroupingSeparator(Character separator)
void	setGroupingSize(int size)
void	setLocalizeDecimalSymbols(boolean localizeDecimalSymbols) Set to true if you want to have the decimal symbols modified when calling localize(Locale).
void	setLocalizeOutputFormat(boolean localizeOutputFormat) Set to true if the output format for currency or percentage should be determined using the output locale, this could modify both position and symbol for both currency and percent.
void	setMaxValue(Number maxValue)
void	setMinValue(Number minValue)
void	setMultiplier(int multiplier) Set the multiplier to apply to the value before formatting and when posting back.
void	setNegativeFormatter(String formatter) Set the format to be used when rendering negative values if the texbox is not in focus.
void	setRoundingMode(RoundingMode roundingMode)
void	setRoundingMode(String mode)
void	setSign(String sign)
void	setSignPositionRight(boolean positionRight)

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

ROUND_HALF_UP_SYMMETRIC

public static final String ROUND_HALF_UP_SYMMETRIC

See Also:

Constant Field Values

ROUND_HALF_UP_ASYMMETRIC

public static final String ROUND_HALF_UP_ASYMMETRIC

See Also:

Constant Field Values

ROUND_HALF_DOWN_SYMMETRIC

public static final String ROUND_HALF_DOWN_SYMMETRIC

See Also:

Constant Field Values

ROUND_HALF_DOWN_ASYMMETRIC

public static final String ROUND_HALF_DOWN_ASYMMETRIC

See Also:

Constant Field Values

ROUND_HALF_EVEN

public static final String ROUND_HALF_EVEN

See Also:

Constant Field Values

ROUND_UP

public static final String ROUND_UP

See Also:

Constant Field Values

ROUND_DOWN

public static final String ROUND_DOWN

See Also:

Constant Field Values

ROUND_CEILING

public static final String ROUND_CEILING

See Also:

Constant Field Values

ROUND_FLOOR

public static final String ROUND_FLOOR

See Also:

Constant Field Values

ROUND_SWISS

public static final String ROUND_SWISS

See Also:

Constant Field Values

NEGATIVE_PARENTHESES

public static final String NEGATIVE_PARENTHESES

See Also:

Constant Field Values

NEGATIVE_BRACKETS

public static final String NEGATIVE_BRACKETS

See Also:

Constant Field Values

NEGATIVE_BRACES

public static final String NEGATIVE_BRACES

See Also:

Constant Field Values

NEGATIVE_ANGLES

public static final String NEGATIVE_ANGLES

See Also:

Constant Field Values

EMPTY_EMPTY

public static final String EMPTY_EMPTY

See Also:

Constant Field Values

EMPTY_ZERO

public static final String EMPTY_ZERO

See Also:

Constant Field Values

EMPTY_SIGN

public static final String EMPTY_SIGN

See Also:

Constant Field Values

Constructor Detail

NumericFormElementConfiguration

public NumericFormElementConfiguration()

NumericFormElementConfiguration

public NumericFormElementConfiguration(NumericFormElementConfiguration.Format format)

NumericFormElementConfiguration

public NumericFormElementConfiguration(Currency currency)

NumericFormElementConfiguration

public NumericFormElementConfiguration(Locale locale)

NumericFormElementConfiguration

public NumericFormElementConfiguration(NumericFormElementConfiguration configuration)

Method Detail

getFormat

public NumericFormElementConfiguration.Format getFormat()

setFormat

public void setFormat(NumericFormElementConfiguration.Format format)

setCurrency

public void setCurrency(Currency currency)

setCurrency

public void setCurrency(Currency currency,
                        Locale locale)

Set currency to use and locale for which to retrieve the currency signal.

Parameters:

currency - instance

locale - to use the currency symbol from

getCurrency

public Currency getCurrency()

setDecimalPositions

public void setDecimalPositions(int positions)

setGroupingSeparator

public void setGroupingSeparator(Character separator)

setGroupingSize

public void setGroupingSize(int size)

setDecimalSeparator

public void setDecimalSeparator(char separator)

setSign

public void setSign(String sign)

setSignPositionRight

public void setSignPositionRight(boolean positionRight)

setMinValue

public void setMinValue(Number minValue)

setMaxValue

public void setMaxValue(Number maxValue)

setRoundingMode

public void setRoundingMode(RoundingMode roundingMode)

setMultiplier

public void setMultiplier(int multiplier)

Set the multiplier to apply to the value before formatting and when posting back. Useful if percentage values are below 1 as the javascript control expects them between 0 and 100.

Parameters:

multiplier - defaults to 1

getMultiplier

public int getMultiplier()

setRoundingMode

public void setRoundingMode(String mode)

setDecimalPadding

public void setDecimalPadding(boolean padding)

setNegativeFormatter

public void setNegativeFormatter(String formatter)

Set the format to be used when rendering negative values if the texbox is not in focus. See for example NEGATIVE_BRACES.

Parameters:

formatter - string

setEmptyBehaviour

public void setEmptyBehaviour(String behaviour)

isLocalizeOutputFormat

public boolean isLocalizeOutputFormat()

setLocalizeOutputFormat

public void setLocalizeOutputFormat(boolean localizeOutputFormat)

Set to true if the output format for currency or percentage should be determined using the output locale, this could modify both position and symbol for both currency and percent. Default is true.

Parameters:

localizeOutputFormat - true if parameters can be modified according to output locale

isLocalizeDecimalSymbols

public boolean isLocalizeDecimalSymbols()

setLocalizeDecimalSymbols

public void setLocalizeDecimalSymbols(boolean localizeDecimalSymbols)

Set to true if you want to have the decimal symbols modified when calling localize(Locale).

Parameters:

localizeDecimalSymbols - true if decimal symbols should be gotten from the locale

isForceWhitespaceAroundSign

public boolean isForceWhitespaceAroundSign()

setForceWhitespaceAroundSign

public void setForceWhitespaceAroundSign(boolean forceWhitespaceAroundSign)

Ensure that whitespace is added between the sign and the number itself, no matter the localized format.

Parameters:

forceWhitespaceAroundSign - true if space will be introduced

localize

public NumericFormElementConfiguration localize(Locale locale)

Create a localized version of this configuration. Meaning that number formatting specifications (decimal symbol, thousands separator etc) will be used from the current locale.

This is different from the NumericFormElementConfiguration(Locale) constructor as that one creates a configuration for the currency attached to the locale specified. Even though the currency could be USD, you usually still want to render in the output locale.

Properties isLocalizeOutputFormat() and isLocalizeDecimalSymbols() will determine which settings this method will modify.

Parameters:

locale - instance

Returns:

clone with altered settings if isLocalizeOutputFormat() is true

put

public Object put(String key,
                  Object value)

Specified by:

put in interface Map<String,Object>

Overrides:

put in class HashMap<String,Object>

createNumberFormat

public NumberFormat createNumberFormat()

Create a NumberFormat that represents the same configuration.

Returns:

numberformat instance

percent

public static NumericFormElementConfiguration percent(int decimalPositions,
                                                      boolean forceWhitespaceAroundSign)

Create a localizable configuration for percentages.

Parameters:

decimalPositions - number of decimal positions to show

forceWhitespaceAroundSign - true if whitespace should be added around the sign independent of the locale

Returns:

configuration

currency

public static NumericFormElementConfiguration currency(Currency currency,
                                                       int decimalPositions,
                                                       boolean forceWhitespaceAroundSign)

Create a localizable configuration for a given currency.

Parameters:

currency - currency to use

decimalPositions - number of decimal positions to show

forceWhitespaceAroundSign - true if whitespace should be added around the sign independent of the locale

Returns:

configuration