org.josef.web.jsf.converter

Class DateConverter

java.lang.Object

org.josef.web.jsf.AbstractStateHolder

org.josef.web.jsf.converter.DateConverter

All Implemented Interfaces:

Serializable, javax.faces.component.StateHolder, javax.faces.convert.Converter

public class DateConverter
extends AbstractStateHolder
implements javax.faces.convert.Converter, Serializable

Date Converter.
A standard converter for objects of type Date. What differentiates this converter from the standard Date Converter is its ability to process dates without separators for fast data entry.
Usage: <jf:dateConverter [pattern="pattern"] />
The pattern used, defaults to the standard date pattern of the user.

Version:

1.0 $Revision: 5792 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DateConverter()

Method Summary

Modifier and Type	Method and Description
Object	getAsObject(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, String stringDate) Converts the supplied stringDate to an object of type Date.
String	getAsString(javax.faces.context.FacesContext facesContext, javax.faces.component.UIComponent component, Object date) Converts the supplied date to a String.
String	getPattern() Gets the pattern used for conversion.
void	restoreState(javax.faces.context.FacesContext facesContext, Object state) Restores the state saved by saveState(FacesContext).
Object	saveState(javax.faces.context.FacesContext facesContext) Saves the state of this converter.
void	setPattern(String pattern) Sets the pattern used for conversion..

Methods inherited from class org.josef.web.jsf.AbstractStateHolder

isTransient, setTransient

Methods inherited from class java.lang.Object

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

Constructor Detail

DateConverter

public DateConverter()

Method Detail

getPattern

public String getPattern()

Gets the pattern used for conversion.
For valid patterns see: SimpleDateFormat.

Returns:

The pattern used for conversion.

setPattern

public void setPattern(String pattern)

Sets the pattern used for conversion..
For valid patterns see: SimpleDateFormat.

Parameters:

pattern - The pattern used for conversion.

getAsObject

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

Converts the supplied stringDate to an object of type Date.

Specified by:

getAsObject in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the date.

stringDate - The Date in String format to convert to a Date.

Returns:

The supplied stringDate converted to a Date.
Null is returned when the supplied stringDate is either null or empty.

getAsString

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

Converts the supplied date to a String.

Specified by:

getAsString in interface javax.faces.convert.Converter

Parameters:

facesContext - Faces Context.

component - The UI component that stores the date.

date - The date to convert to a String.

Returns:

The String value of the supplied date.
Null is returned when either the supplied date is null or when the supplied date is not of type Date.

saveState

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

Saves the state of this converter.

Specified by:

saveState in interface javax.faces.component.StateHolder

Parameters:

facesContext - The FacesContext.

Returns:

The saved state of this converter.

restoreState

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

Restores the state saved by saveState(FacesContext).

Specified by:

restoreState in interface javax.faces.component.StateHolder

Parameters:

facesContext - The FacesContext.

state - The state saved by saveState(FacesContext).