/*---
Copyright 2006-2007 Visual Systems Corporation.
http://www.vscorp.com
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
---*/
package com.googlecode.wicketwebbeans.fields;
import java.sql.Time;
import java.sql.Timestamp;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.GregorianCalendar;
import java.util.Locale;
import java.util.TimeZone;
import org.apache.wicket.Component;
import org.apache.wicket.Localizer;
import org.apache.wicket.ResourceReference;
import org.apache.wicket.extensions.markup.html.form.DateTextField;
import org.apache.wicket.markup.html.basic.Label;
import org.apache.wicket.markup.html.form.FormComponent;
import org.apache.wicket.markup.html.panel.Fragment;
import org.apache.wicket.model.IModel;
import org.apache.wicket.util.convert.ConversionException;
import org.apache.wicket.util.convert.IConverter;
import org.apache.wicket.util.convert.converters.DateConverter;
import org.apache.wicket.util.string.Strings;
import com.googlecode.wicketwebbeans.model.ElementMetaData;
import com.googlecode.wicketwebbeans.datepicker.DatePicker;
import com.googlecode.wicketwebbeans.datepicker.DatePickerSettings;
import com.googlecode.wicketwebbeans.datepicker.PopupDatePicker;
/**
* Date/Time Field component. Implemented as a text field combined with a DatePicker.
* <p>
*
* The enclosing component's properties file may define standard date/time formats
* using the following keys:
* <ul>
* <li><code>DateTimeField.date.format</code> - Format for java.sql.Date.</li>
* <li><code>DateTimeField.datetime.format</code> - Format for java.sql.Timestamp or java.util.Date.</li>
* <li><code>DateTimeField.time.format</code> - Format for java.sql.Time.</li>
* <li><code>DateTimeField.datetimetz.format</code> - Format for java.util.Calendar types.</li>
* </ul>
*
* @author Dan Syrstad
*/
public class DateTimeField extends AbstractField
{
private static final long serialVersionUID = 3342855853289141120L;
public static final String DATE_FMT_STR = "yyyy-MM-dd";
public static final String TIME_FMT_STR = "HH:mm";
public static final String DATE_TIME_FMT_STR = DATE_FMT_STR + ' ' + TIME_FMT_STR;
public static final String DATE_TIME_ZONE_FMT_STR = DATE_TIME_FMT_STR + " z";
private static final String DATE_TIME_FIELD_PREFIX = "DateTimeField.";
private static final String FORMAT_SUFFIX = ".format";
private String fmt;
private Class<?> type;
/**
* Construct a new DateTimeField.
*
* @param id the Wicket id for the editor.
* @param model the model.
* @param metaData the meta data for the property.
* @param viewOnly true if the component should be view-only.
*/
public DateTimeField(String id, IModel<Date> model, ElementMetaData metaData, boolean viewOnly)
{
super(id, model, metaData, viewOnly);
type = metaData.getPropertyType();
boolean displayTz = false;
Component metaDataComponent = metaData.getBeanMetaData().getComponent();
Localizer localizer = metaDataComponent.getLocalizer();
if (Time.class.isAssignableFrom(type)) {
fmt = localizer.getString(DATE_TIME_FIELD_PREFIX + "time" + FORMAT_SUFFIX, metaDataComponent, TIME_FMT_STR);
}
else if (java.sql.Date.class.isAssignableFrom(type)) {
fmt = localizer.getString(DATE_TIME_FIELD_PREFIX + "date" + FORMAT_SUFFIX, metaDataComponent, DATE_FMT_STR);
}
else if (Calendar.class.isAssignableFrom(type)) {
fmt = viewOnly ? localizer.getString(DATE_TIME_FIELD_PREFIX + "datetimetz" + FORMAT_SUFFIX, metaDataComponent, DATE_TIME_ZONE_FMT_STR) :
localizer.getString(DATE_TIME_FIELD_PREFIX + "datetime" + FORMAT_SUFFIX, metaDataComponent, DATE_TIME_FMT_STR);
displayTz = true;
}
else { // if (Date.class.isAssignableFrom(type) || Timestamp.class.isAssignableFrom(type))
fmt = localizer.getString(DATE_TIME_FIELD_PREFIX + "datetime" + FORMAT_SUFFIX, metaDataComponent, DATE_TIME_FMT_STR);
}
String customFmt = getFormat();
if (customFmt != null) {
fmt = customFmt;
}
final InternalDateConverter converter = new InternalDateConverter();
Fragment fragment;
if (viewOnly) {
fragment = new Fragment("frag", "viewer");
Label label = new LabelWithMinSize("date", model) {
private static final long serialVersionUID = 1L;
@Override
public IConverter getConverter(Class type)
{
return converter;
}
};
fragment.add(label);
}
else {
fragment = new Fragment("frag", "editor");
final FormComponent dateField = new DateTextField("dateTextField", model) {
private static final long serialVersionUID = 1L;
@Override
public IConverter getConverter(Class type)
{
return converter;
}
};
setFieldParameters(dateField);
fragment.add(dateField);
DatePickerSettings settings = new DatePickerSettings();
settings.setStyle( settings.newStyleWinter() );
settings.setIcon( new ResourceReference(this.getClass(), "calendar.gif") );
DatePicker picker = new PopupDatePicker("datePicker", dateField, settings);
// This sucks! It expects a DateConverter. I've got my own.
DateConverter dateConverter = new DateConverter() {
private static final long serialVersionUID = 1L;
@Override
public DateFormat getDateFormat(Locale locale)
{
SimpleDateFormat dateFmt = new SimpleDateFormat(fmt);
dateFmt.setTimeZone(TimeZone.getTimeZone("GMT"));
return dateFmt;
}
@Override
protected Class getTargetType()
{
return type;
}
};
picker.setDateConverter(dateConverter);
fragment.add(picker);
if (displayTz) {
Label label = new Label("timezone", model) {
private static final long serialVersionUID = 1L;
@Override
public IConverter getConverter(Class type)
{
return new TimeZoneConverter();
}
};
fragment.add(label);
}
else {
fragment.add( new Label("timezone", "") );
}
}
add(fragment);
}
private final class InternalDateConverter implements IConverter
{
private static final long serialVersionUID = 1L;
public String convertToString(Object value, Locale locale)
{
SimpleDateFormat dateFmt = new SimpleDateFormat(fmt);
if (value instanceof Calendar) {
Calendar cal = (Calendar)value;
dateFmt.setTimeZone( cal.getTimeZone() );
return dateFmt.format( cal.getTime() );
}
if (value instanceof Date) {
dateFmt.setTimeZone(TimeZone.getTimeZone("GMT"));
return dateFmt.format((Date)value);
}
return null;
}
public Object convertToObject(String value, Locale locale)
{
if (Strings.isEmpty(value)) {
return null;
}
// Convert String to Calendar or sql.Date/Time/Timestamp
Date date = null;
// First convert it to a date. We think it's GMT because no TZ is specified in the String.
SimpleDateFormat dateFmt = new SimpleDateFormat(fmt);
dateFmt.setTimeZone(TimeZone.getTimeZone("GMT"));
try {
date = dateFmt.parse(value);
}
catch (ParseException e) {
throw new ConversionException("Cannot convert '" + value + "' to a Date.").setSourceValue(value)
.setTargetType(type).setConverter(this).setLocale(locale);
}
if (Timestamp.class == type) {
return new Timestamp(date.getTime());
}
if (java.sql.Date.class == type) {
return new java.sql.Date(date.getTime());
}
if (Time.class == type) {
return new Time(date.getTime());
}
if (Date.class == type) {
return date;
}
if (Calendar.class.isAssignableFrom(type)) {
Calendar cal = new GregorianCalendar( TimeZone.getTimeZone("GMT") );
cal.setTime(date);
return cal;
}
throw new RuntimeException("Don't know how to convert a String to " + type);
}
}
private final class TimeZoneConverter implements IConverter
{
private static final long serialVersionUID = 1L;
public String convertToString(Object value, Locale locale)
{
if (value instanceof Calendar) {
Calendar cal = (Calendar)value;
TimeZone zone = cal.getTimeZone();
return zone.getDisplayName( zone.inDaylightTime(cal.getTime()), TimeZone.SHORT, locale);
}
throw new RuntimeException("Don't know how to convert " + value.getClass() + " to a String");
}
public Object convertToObject(String value, Locale locale)
{
return null;
}
}
}