public class CustomDateEditor extends PropertyEditorSupport
java.util.Date
,
supporting a custom java.text.DateFormat
.
This is not meant to be used as system PropertyEditor but rather as locale-specific date editor within custom controller code, parsing user-entered number strings into Date properties of beans and rendering them in the UI form.
In web MVC code, this editor will typically be registered with
binder.registerCustomEditor
.
Date
,
DateFormat
,
DataBinder.registerCustomEditor(java.lang.Class<?>, java.beans.PropertyEditor)
Constructor and Description |
---|
CustomDateEditor(DateFormat dateFormat,
boolean allowEmpty)
Create a new CustomDateEditor instance, using the given DateFormat
for parsing and rendering.
|
CustomDateEditor(DateFormat dateFormat,
boolean allowEmpty,
int exactDateLength)
Create a new CustomDateEditor instance, using the given DateFormat
for parsing and rendering.
|
Modifier and Type | Method and Description |
---|---|
String |
getAsText()
Format the Date as String, using the specified DateFormat.
|
void |
setAsText(String text)
Parse the Date from the given text, using the specified DateFormat.
|
addPropertyChangeListener, firePropertyChange, getCustomEditor, getJavaInitializationString, getSource, getTags, getValue, isPaintable, paintValue, removePropertyChangeListener, setSource, setValue, supportsCustomEditor
public CustomDateEditor(DateFormat dateFormat, boolean allowEmpty)
The "allowEmpty" parameter states if an empty String should be allowed for parsing, i.e. get interpreted as null value. Otherwise, an IllegalArgumentException gets thrown in that case.
dateFormat
- DateFormat to use for parsing and renderingallowEmpty
- if empty strings should be allowedpublic CustomDateEditor(DateFormat dateFormat, boolean allowEmpty, int exactDateLength)
The "allowEmpty" parameter states if an empty String should be allowed for parsing, i.e. get interpreted as null value. Otherwise, an IllegalArgumentException gets thrown in that case.
The "exactDateLength" parameter states that IllegalArgumentException gets
thrown if the String does not exactly match the length specified. This is useful
because SimpleDateFormat does not enforce strict parsing of the year part,
not even with setLenient(false)
. Without an "exactDateLength"
specified, the "01/01/05" would get parsed to "01/01/0005". However, even
with an "exactDateLength" specified, prepended zeros in the day or month
part may still allow for a shorter year part, so consider this as just
one more assertion that gets you closer to the intended date format.
dateFormat
- DateFormat to use for parsing and renderingallowEmpty
- if empty strings should be allowedexactDateLength
- the exact expected length of the date Stringpublic void setAsText(String text) throws IllegalArgumentException
setAsText
in interface PropertyEditor
setAsText
in class PropertyEditorSupport
IllegalArgumentException
public String getAsText()
getAsText
in interface PropertyEditor
getAsText
in class PropertyEditorSupport