javax.faces.convert
Class NumberConverter

java.lang.Object
  javax.faces.convert.NumberConverter

All Implemented Interfaces:

StateHolder, Converter

@JSFConverter(name="f:convertNumber",
              bodyContent="empty",
              tagClass="org.apache.myfaces.taglib.core.ConvertNumberTag")
@JSFJspProperty(name="binding",
                returnType="javax.faces.convert.NumberConverter",
                longDesc="A ValueExpression that evaluates to a NumberConverter.")
public class NumberConverter
extends Object
implements Converter, StateHolder

This tag creates a number formatting converter and associates it with the nearest parent UIComponent. Unless otherwise specified, all attributes accept static values or EL expressions. see Javadoc of JSF Specification

Version:

$Revision: 1034000 $ $Date: 2010-11-11 12:04:25 -0500 (Thu, 11 Nov 2010) $

Author:

Thomas Spiegl (latest modification by $Author: lu4242 $)

Field Summary

static String	CONVERTER_ID
static String	CURRENCY_ID
static String	NUMBER_ID
static String	PATTERN_ID
static String	PERCENT_ID
static String	STRING_ID

Constructor Summary

NumberConverter()

Method Summary

Object	getAsObject(FacesContext facesContext, UIComponent uiComponent, String value)
String	getAsString(FacesContext facesContext, UIComponent uiComponent, Object value)
String	getCurrencyCode() ISO 4217 currency code
String	getCurrencySymbol() The currency symbol used to format a currency value.
Locale	getLocale() The name of the locale to be used, instead of the default as specified in the faces configuration file.
int	getMaxFractionDigits() The maximum number of digits in the fractional portion of the number.
int	getMaxIntegerDigits() The maximum number of digits in the integer portion of the number.
int	getMinFractionDigits() The minimum number of digits in the fractional portion of the number.
int	getMinIntegerDigits() The minimum number of digits in the integer portion of the number.
String	getPattern() A custom Date formatting pattern, in the format used by java.text.SimpleDateFormat.
String	getType() The type of formatting/parsing to be performed.
boolean	isGroupingUsed() Specifies whether output will contain grouping separators.
boolean	isIntegerOnly() Specifies whether only the integer part of the input will be parsed.
boolean	isTransient()
void	restoreState(FacesContext facesContext, Object state)
Object	saveState(FacesContext facesContext)
void	setCurrencyCode(String currencyCode)
void	setCurrencySymbol(String currencySymbol)
void	setGroupingUsed(boolean groupingUsed)
void	setIntegerOnly(boolean integerOnly)
void	setLocale(Locale locale)
void	setMaxFractionDigits(int maxFractionDigits)
void	setMaxIntegerDigits(int maxIntegerDigits)
void	setMinFractionDigits(int minFractionDigits)
void	setMinIntegerDigits(int minIntegerDigits)
void	setPattern(String pattern)
void	setTransient(boolean aTransient)
void	setType(String type)

Methods inherited from class java.lang.Object

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

Field Detail

CONVERTER_ID

public static final String CONVERTER_ID

See Also:

Constant Field Values

STRING_ID

public static final String STRING_ID

See Also:

Constant Field Values

CURRENCY_ID

public static final String CURRENCY_ID

See Also:

Constant Field Values

NUMBER_ID

public static final String NUMBER_ID

See Also:

Constant Field Values

PATTERN_ID

public static final String PATTERN_ID

See Also:

Constant Field Values

PERCENT_ID

public static final String PERCENT_ID

See Also:

Constant Field Values

Constructor Detail

NumberConverter

public NumberConverter()

Method Detail

getAsObject

public Object getAsObject(FacesContext facesContext,
                          UIComponent uiComponent,
                          String value)

Specified by:

getAsObject in interface Converter

getAsString

public String getAsString(FacesContext facesContext,
                          UIComponent uiComponent,
                          Object value)

Specified by:

getAsString in interface Converter

restoreState

public void restoreState(FacesContext facesContext,
                         Object state)

Specified by:

restoreState in interface StateHolder

saveState

public Object saveState(FacesContext facesContext)

Specified by:

saveState in interface StateHolder

getCurrencyCode

@JSFProperty
public String getCurrencyCode()

ISO 4217 currency code

setCurrencyCode

public void setCurrencyCode(String currencyCode)

getCurrencySymbol

@JSFProperty
public String getCurrencySymbol()

The currency symbol used to format a currency value. Defaults to the currency symbol for locale.

setCurrencySymbol

public void setCurrencySymbol(String currencySymbol)

isGroupingUsed

@JSFProperty
public boolean isGroupingUsed()

Specifies whether output will contain grouping separators. Default: true.

setGroupingUsed

public void setGroupingUsed(boolean groupingUsed)

isIntegerOnly

@JSFProperty
public boolean isIntegerOnly()

Specifies whether only the integer part of the input will be parsed. Default: false.

setIntegerOnly

public void setIntegerOnly(boolean integerOnly)

getLocale

@JSFProperty
public Locale getLocale()

The name of the locale to be used, instead of the default as specified in the faces configuration file.

setLocale

public void setLocale(Locale locale)

getMaxFractionDigits

@JSFProperty
public int getMaxFractionDigits()

The maximum number of digits in the fractional portion of the number.

setMaxFractionDigits

public void setMaxFractionDigits(int maxFractionDigits)

getMaxIntegerDigits

@JSFProperty
public int getMaxIntegerDigits()

The maximum number of digits in the integer portion of the number.

setMaxIntegerDigits

public void setMaxIntegerDigits(int maxIntegerDigits)

getMinFractionDigits

@JSFProperty
public int getMinFractionDigits()

The minimum number of digits in the fractional portion of the number.

setMinFractionDigits

public void setMinFractionDigits(int minFractionDigits)

getMinIntegerDigits

@JSFProperty
public int getMinIntegerDigits()

The minimum number of digits in the integer portion of the number.

setMinIntegerDigits

public void setMinIntegerDigits(int minIntegerDigits)

getPattern

@JSFProperty
public String getPattern()

A custom Date formatting pattern, in the format used by java.text.SimpleDateFormat.

setPattern

public void setPattern(String pattern)

isTransient

public boolean isTransient()

Specified by:

isTransient in interface StateHolder

setTransient

public void setTransient(boolean aTransient)

Specified by:

setTransient in interface StateHolder

getType

@JSFProperty
public String getType()

The type of formatting/parsing to be performed. Values include: number, currency, and percent. Default: number.

setType

public void setType(String type)