org.apache.myfaces.commons.converter
Class AbstractTypedNumberConverter

java.lang.Object
  extended by org.apache.myfaces.commons.converter.ConverterBase
      extended by org.apache.myfaces.commons.converter.AbstractTypedNumberConverter
All Implemented Interfaces:
javax.faces.component.StateHolder, javax.faces.convert.Converter

@JSFConverter(name="mcc:convertNumber",
              clazz="org.apache.myfaces.commons.converter.TypedNumberConverter",
              tagClass="org.apache.myfaces.commons.converter.TypedNumberConverterTag",
              tagHandler="org.apache.myfaces.commons.converter.TypedNumberConverterTagHandler")
public abstract class AbstractTypedNumberConverter
extends ConverterBase

Converter which uses either the manually set destType or the value binding to determine the correct destination type to convert the number to This tag creates a number formatting converter and associates it with the nearest parent UIComponent. It uses either the manually set destType or the value binding to determine the correct destination type to convert the number to. Unless otherwise specified, all attributes accept static values or EL expressions.

Author:
imario@apache.org

Field Summary
static String CONVERTER_ID
           
 
Constructor Summary
AbstractTypedNumberConverter()
           
 
Method Summary
 Object _getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, String value)
           
 void _restoreState(javax.faces.context.FacesContext facesContext, Object state)
           
 Object _saveState(javax.faces.context.FacesContext facesContext)
           
 Object getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, String value)
           
 String getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent uiComponent, Object value)
           
 String getCurrencyCode()
          ISO 4217 currency code
 String getCurrencySymbol()
          The currency symbol used to format a currency value.
 Class getDestType()
          The java class name the value should be converted to.
protected  String getLocalCurrencyCode()
           
 String getLocalCurrencySymbol()
           
 Locale getLocale()
          The name of the locale to be used, instead of the default as specified in the faces configuration file.
abstract  Integer getMaxFractionDigits()
          The maximum number of digits in the fractional portion of the number.
abstract  Integer getMaxIntegerDigits()
          The maximum number of digits in the integer portion of the number.
abstract  Integer getMinFractionDigits()
          The minimum number of digits in the fractional portion of the number.
abstract  Integer getMinIntegerDigits()
          The minimum number of digits in the integer portion of the number.
abstract  String getPattern()
          A custom Date formatting pattern, in the format used by java.text.SimpleDateFormat.
abstract  String getType()
          The type of formatting/parsing to be performed.
abstract  boolean isGroupingUsed()
          Specifies whether output will contain grouping separators.
abstract  boolean isIntegerOnly()
          Specifies whether only the integer part of the input will be parsed.
 boolean isTransient()
           
 void restoreState(javax.faces.context.FacesContext facesContext, Object state)
           
 Object saveState(javax.faces.context.FacesContext facesContext)
           
 void setCurrencyCode(String currencyCode)
           
 void setCurrencySymbol(String currencySymbol)
           
 void setDestType(Class destType)
           
 void setLocale(Locale locale)
           
 void setTransient(boolean aTransient)
           
 
Methods inherited from class org.apache.myfaces.commons.converter.ConverterBase
getDetailMessage, getFacesContext, getFacesMessage, getStringValue, getSummaryMessage, getValueBinding, restoreAttachedState, saveAttachedState, setDetailMessage, setSummaryMessage, setValueBinding
 
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
Constructor Detail

AbstractTypedNumberConverter

public AbstractTypedNumberConverter()
Method Detail

getAsObject

public Object getAsObject(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent uiComponent,
                          String value)

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class ConverterBase

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class ConverterBase

getDestType

@JSFProperty
public Class getDestType()
The java class name the value should be converted to. Default: automatically determined through valueBinding


setDestType

public void setDestType(Class destType)

_getAsObject

public Object _getAsObject(javax.faces.context.FacesContext facesContext,
                           javax.faces.component.UIComponent uiComponent,
                           String value)

getAsString

public String getAsString(javax.faces.context.FacesContext facesContext,
                          javax.faces.component.UIComponent uiComponent,
                          Object value)

_restoreState

public void _restoreState(javax.faces.context.FacesContext facesContext,
                          Object state)

_saveState

public Object _saveState(javax.faces.context.FacesContext facesContext)

getCurrencyCode

@JSFProperty
public String getCurrencyCode()
ISO 4217 currency code


getLocalCurrencyCode

protected String getLocalCurrencyCode()

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.


getLocalCurrencySymbol

public String getLocalCurrencySymbol()

setCurrencySymbol

public void setCurrencySymbol(String currencySymbol)

isGroupingUsed

@JSFProperty(defaultValue="true")
public abstract boolean isGroupingUsed()
Specifies whether output will contain grouping separators. Default: true.


isIntegerOnly

@JSFProperty(defaultValue="false")
public abstract boolean isIntegerOnly()
Specifies whether only the integer part of the input will be parsed. Default: false.


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 abstract Integer getMaxFractionDigits()
The maximum number of digits in the fractional portion of the number.


getMaxIntegerDigits

@JSFProperty
public abstract Integer getMaxIntegerDigits()
The maximum number of digits in the integer portion of the number.


getMinFractionDigits

@JSFProperty
public abstract Integer getMinFractionDigits()
The minimum number of digits in the fractional portion of the number.


getMinIntegerDigits

@JSFProperty
public abstract Integer getMinIntegerDigits()
The minimum number of digits in the integer portion of the number.


getPattern

@JSFProperty
public abstract String getPattern()
A custom Date formatting pattern, in the format used by java.text.SimpleDateFormat.


isTransient

public boolean isTransient()
Specified by:
isTransient in interface javax.faces.component.StateHolder
Overrides:
isTransient in class ConverterBase

setTransient

public void setTransient(boolean aTransient)
Specified by:
setTransient in interface javax.faces.component.StateHolder
Overrides:
setTransient in class ConverterBase

getType

@JSFProperty(defaultValue="number")
public abstract String getType()
The type of formatting/parsing to be performed. Values include: number, currency, and percentage. Default: number.



Copyright © 2007-2011 The Apache Software Foundation. All Rights Reserved.