jidefx.utils.converter

Class PercentConverter

java.lang.Object

javafx.util.StringConverter<T>

jidefx.utils.converter.DefaultObjectConverter<T>

jidefx.utils.converter.AbstractNumberConverter<java.lang.Double>

jidefx.utils.converter.DoubleConverter

jidefx.utils.converter.PercentConverter

All Implemented Interfaces:

ObjectConverter<java.lang.Double>

public class PercentConverter
extends DoubleConverter

ObjectConverter implementation for a percentage

Field Summary

Fields

Modifier and Type	Field and Description
static ConverterContext	CONTEXT

Fields inherited from class jidefx.utils.converter.AbstractNumberConverter

CONTEXT_FIXED_1_DIGIT_FRACTION, CONTEXT_FIXED_2_DIGIT_FRACTION, CONTEXT_FIXED_4_DIGIT_FRACTION, PROPERTY_NUMBER_FORMAT

Constructor Summary

Constructors

Constructor and Description
PercentConverter()
PercentConverter(java.util.Locale locale)
PercentConverter(java.text.NumberFormat format)

Method Summary

Modifier and Type	Method and Description
java.lang.Double	fromString(java.lang.String string, ConverterContext context) Converts the String to a Double.

Methods inherited from class jidefx.utils.converter.AbstractNumberConverter

getNumberFormat, numberFromString, toString

Methods inherited from class jidefx.utils.converter.DefaultObjectConverter

fromString, getObjectConverterManager, toString, toStringConverter

Methods inherited from class java.lang.Object

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

Field Detail

CONTEXT

public static final ConverterContext CONTEXT

Constructor Detail

PercentConverter

public PercentConverter()

PercentConverter

public PercentConverter(java.util.Locale locale)

PercentConverter

public PercentConverter(java.text.NumberFormat format)

Method Detail

fromString

public java.lang.Double fromString(java.lang.String string,
                                   ConverterContext context)

Converts the String to a Double. It will use the NumberFormat defined as AbstractNumberConverter.PROPERTY_NUMBER_FORMAT if any. If not there, it will use AbstractNumberConverter.getNumberFormat() to get the NumberFormat to do the conversion.

Different from a DoubleConverter, if the String doesn't have a percentage sign at the end, we will divide the number from DoubleConverter by 100 and return the value. That's because "50%" actually is 0.5. If user forgot to include a % sign, for example, pass in "50", we should still treat it as percentage and return 0.5 as they are using a PercentConverter.

Please note, the conversion may involve rounding or truncation.

Specified by:

fromString in interface ObjectConverter<java.lang.Double>

Overrides:

fromString in class DoubleConverter

Parameters:

string - the string to be converted.

context - the context

Returns:

the Number converted from the String.