org.springframework.beans.propertyeditors
Class CustomDateEditor

java.lang.Object
  |
  +--java.beans.PropertyEditorSupport
        |
        +--org.springframework.beans.propertyeditors.CustomDateEditor

public class CustomDateEditor
extends PropertyEditorSupport

PropertyEditor for Date, supporting a custom DateFormat.

This is not meant to be used as system PropertyEditor but rather as locale-specific date editor within custom controller code, to parse user-entered date strings into Date properties of beans, and render them in the UI form.

In web MVC code, this editor will typically be registered with binder.registerCustomEditor calls in an implementation of BaseCommandController's initBinder method.

Author:
Juergen Hoeller
Since: 28.04.2003
See Also: org.springframework.validation.DataBinder.registerCustomEditor(java.lang.Class,java.beans.PropertyEditor), org.springframework.web.servlet.mvc.BaseCommandController.initBinder(HttpServletRequest,org.springframework.web.bind.ServletRequestDataBinder), org.springframework.web.bind.BindInitializer.initBinder(ServletRequest,org.springframework.web.bind.ServletRequestDataBinder)

Constructor Summary
CustomDateEditor(DateFormat dateFormat, boolean allowEmpty)
          Create a new instance, using the given DateFormat for parsing and rendering.

Method Summary
 StringgetAsText()
          Format the Date as String, using the specified DateFormat.
 voidsetAsText(String text)
          Parse the Date from the given text, using the specified DateFormat.

Methods inherited from class java.beans.PropertyEditorSupport
firePropertyChange, isPaintable, supportsCustomEditor, getCustomEditor, addPropertyChangeListener, removePropertyChangeListener, getValue, setValue, getJavaInitializationString, getTags, paintValue

Methods inherited from class java.lang.Object
hashCode, notify, notifyAll, wait, wait, wait, getClass, equals, toString

Constructor Detail

CustomDateEditor

public CustomDateEditor(DateFormat dateFormat, boolean allowEmpty)
Create a new instance, using the given DateFormat for parsing and rendering.

The allowEmpty parameter states if an empty String should be allowed for parsing, i.e. get interpreted as null value. Else, an IllegalArgumentException gets thrown in that case.

Parameters:
dateFormat - DateFormat to use for parsing and rendering
allowEmpty - if empty strings should be allowed
Method Detail

getAsText

public String getAsText()
Format the Date as String, using the specified DateFormat.

setAsText

public void setAsText(String text)
throws java.lang.IllegalArgumentException
Parse the Date from the given text, using the specified DateFormat.

Association Links

to Class java.text.DateFormat