/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.wicket.extensions.yui.calendar;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;
import java.util.TimeZone;
import org.apache.wicket.Session;
import org.apache.wicket.datetime.markup.html.form.DateTextField;
import org.apache.wicket.markup.html.form.DropDownChoice;
import org.apache.wicket.markup.html.form.FormComponentPanel;
import org.apache.wicket.markup.html.form.TextField;
import org.apache.wicket.model.IModel;
import org.apache.wicket.model.Model;
import org.apache.wicket.model.PropertyModel;
import org.apache.wicket.protocol.http.request.WebClientInfo;
import org.apache.wicket.request.ClientInfo;
import org.apache.wicket.util.convert.IConverter;
import org.apache.wicket.util.convert.converters.ZeroPaddingIntegerConverter;
import org.apache.wicket.util.lang.EnumeratedType;
import org.apache.wicket.validation.validator.NumberValidator;
import org.joda.time.DateTimeFieldType;
import org.joda.time.DateTimeZone;
import org.joda.time.MutableDateTime;
/**
* Works on a {@link java.util.Date} object. Displays a date field and a date
* picker, a field for hours and a field for minutes, and a AM/ PM field.
*
* @author eelcohillenius
* @see DateField for a variant with just the date field and date picker
*/
// TODO AM/PM should really be locale dependent; some locales have 12 hour
// systems with AM/PM, others have 24 hour systems
public class DateTimeField extends FormComponentPanel
{
/**
* Enumerated type for different ways of handling the render part of
* requests.
*/
// enums are mucho nicer, but let's keep this project at 1.4 for now
private static class AM_PM extends EnumeratedType
{
private static final long serialVersionUID = 1L;
static final AM_PM AM = new AM_PM("AM");
static final AM_PM PM = new AM_PM("PM");
public static AM_PM[] values()
{
return new AM_PM[] { AM, PM };
}
private AM_PM(final String name)
{
super(name);
}
}
private static final IConverter MINUTES_CONVERTER = new ZeroPaddingIntegerConverter(2);
private static final long serialVersionUID = 1L;
private AM_PM amOrPm = AM_PM.AM;
private DropDownChoice amOrPmChoice;
private MutableDateTime date;
private DateTextField dateField;
private Integer hours;
private TextField hoursField;
private Integer minutes;
private TextField minutesField;
/**
* Construct.
*
* @param id
*/
public DateTimeField(String id)
{
this(id, null);
}
/**
* Construct.
*
* @param id
* @param model
*/
public DateTimeField(String id, IModel model)
{
super(id, model);
setType(Date.class);
PropertyModel dateFieldModel = new PropertyModel(this, "date");
add(dateField = newDateTextField("date", dateFieldModel));
dateField.add(new DatePicker() {
private static final long serialVersionUID = 1L;
protected void configure(Map widgetProperties)
{
super.configure(widgetProperties);
DateTimeField.this.configure(widgetProperties);
}
});
add(hoursField = new TextField("hours", new PropertyModel(this, "hours"), Integer.class));
hoursField.add(NumberValidator.range(0, 12));
hoursField.setLabel(new Model("hours"));
add(minutesField = new TextField("minutes", new PropertyModel(this, "minutes"),
Integer.class)
{
private static final long serialVersionUID = 1L;
public IConverter getConverter(Class type)
{
return MINUTES_CONVERTER;
}
});
minutesField.add(NumberValidator.range(0, 59));
minutesField.setLabel(new Model("minutes"));
add(amOrPmChoice = new DropDownChoice("amOrPmChoice", new PropertyModel(this, "amOrPm"),
Arrays.asList(AM_PM.values())));
}
/**
* Gets amOrPm.
*
* @return amOrPm
*/
public AM_PM getAmOrPm()
{
return amOrPm;
}
/**
* Gets date.
*
* @return date
*/
public Date getDate()
{
return (date != null) ? date.toDate() : null;
}
/**
* Gets hours.
*
* @return hours
*/
public Integer getHours()
{
return hours;
}
protected void configure(Map widgetProperties) {
}
/**
* @see org.apache.wicket.markup.html.form.FormComponent#getInput()
*/
public String getInput()
{
// since we override convertInput, we can let this method return a value
// that is just suitable for error reporting
return dateField.getInput() + ", " + hoursField.getInput() + ":" + minutesField.getInput();
}
/**
* Gets minutes.
*
* @return minutes
*/
public Integer getMinutes()
{
return minutes;
}
/**
* Sets amOrPm.
*
* @param amOrPm
* amOrPm
*/
public void setAmOrPm(AM_PM amOrPm)
{
this.amOrPm = amOrPm;
}
/**
* Sets date.
*
* @param date
* date
*/
public void setDate(Date date)
{
this.date = (date != null) ? new MutableDateTime(date) : null;
setModelObject(date);
}
/**
* Sets hours.
*
* @param hours
* hours
*/
public void setHours(Integer hours)
{
this.hours = hours;
}
/**
* Sets minutes.
*
* @param minutes
* minutes
*/
public void setMinutes(Integer minutes)
{
this.minutes = minutes;
}
/**
* Gets the client's time zone.
*
* @return The client's time zone or null
*/
private TimeZone getClientTimeZone()
{
ClientInfo info = Session.get().getClientInfo();
if (info instanceof WebClientInfo)
{
return ((WebClientInfo)info).getProperties().getTimeZone();
}
return null;
}
/**
* Sets the converted input, which is an instance of {@link Date}, possibly
* null. It combines the inputs of the nested date, hours, minutes and am/pm
* fields and constructs a date from it.
* <p>
* Note that overriding this method is a better option than overriding
* {@link #updateModel()} like the first versions of this class did. The
* reason for that is that this method can be used by form validators
* without having to depend on the actual model being updated, and this
* method is called by the default implementation of {@link #updateModel()}
* anyway (so we don't have to override that anymore).
* </p>
*
* @see org.apache.wicket.markup.html.form.FormComponent#convertInput()
*/
protected void convertInput()
{
Object dateFieldInput = dateField.getConvertedInput();
if (dateFieldInput != null)
{
MutableDateTime date = new MutableDateTime(dateFieldInput);
Integer hours = (Integer)hoursField.getConvertedInput();
Integer minutes = (Integer)minutesField.getConvertedInput();
AM_PM amOrPm = (AM_PM)amOrPmChoice.getConvertedInput();
try
{
TimeZone zone = getClientTimeZone();
if (zone != null)
{
date.setZone(DateTimeZone.forTimeZone(zone));
}
if (hours != null)
{
date.set(DateTimeFieldType.hourOfHalfday(), hours.intValue() % 12);
date.setMinuteOfHour((minutes != null) ? minutes.intValue() : 0);
}
if (amOrPm == AM_PM.PM)
{
date.set(DateTimeFieldType.halfdayOfDay(), 1);
}
else
{
date.set(DateTimeFieldType.halfdayOfDay(), 0);
}
// the date will be in the server's timezone
setConvertedInput(date.toDate());
}
catch (RuntimeException e)
{
DateTimeField.this.error(e.getMessage());
invalid();
}
}
else
{
setConvertedInput(null);
}
}
/**
* @deprecated replaced by {@link #newDateTextField(String, PropertyModel)}
*/
// TODO remove after deprecation release
protected final DateTextField newDateTextField(PropertyModel dateFieldModel)
{
throw new UnsupportedOperationException();
}
/**
* create a new {@link DateTextField} instance to be added to this panel.
*
* @param dateFieldModel
* model that should be used by the {@link DateTextField}
* @return a new date text field instance
*/
protected DateTextField newDateTextField(String id, PropertyModel dateFieldModel)
{
return DateTextField.forShortStyle(id, dateFieldModel);
}
/**
* @see org.apache.wicket.Component#onBeforeRender()
*/
protected void onBeforeRender()
{
dateField.setRequired(isRequired());
Date d = (Date)getModelObject();
if (d != null)
{
date = new MutableDateTime(d);
}
else
{
date = null;
}
if (date != null)
{
// convert date to the client's time zone if we have that info
TimeZone zone = getClientTimeZone();
// instantiate with the previously set date
if (zone != null)
{
date.setZone(DateTimeZone.forTimeZone(zone));
}
int hourOfHalfDay = date.get(DateTimeFieldType.hourOfHalfday());
hours = new Integer(hourOfHalfDay == 0 ? 12 : hourOfHalfDay);
minutes = new Integer(date.getMinuteOfHour());
amOrPm = (date.get(DateTimeFieldType.halfdayOfDay()) == 0) ? AM_PM.AM : AM_PM.PM;
// we don't really have to reset the date field to the server's
// timezone, as it's the same milis from EPOCH anyway, and toDate
// will always get the Date object initialized for the time zone
// of the server
}
super.onBeforeRender();
}
}