org.apache.wicket.datetime
Class StyleDateConverter

java.lang.Object
  org.apache.wicket.datetime.DateConverter
      org.apache.wicket.datetime.StyleDateConverter

All Implemented Interfaces:

Serializable, IClusterable, IConverter

public class StyleDateConverter
extends DateConverter

Date converter that uses Joda Time and can be configured to take the time zone difference between clients and server into account, and that is configured for a certain date style. The pattern will always be locale specific.

This converter is especially suited on a per-component base.

Author:

eelcohillenius

See Also:

DateTextField, DateTime, DateTimeFormat, DateTimeZone, Serialized Form

Constructor Summary

StyleDateConverter(boolean applyTimeZoneDifference)
Construct.

StyleDateConverter(String dateStyle, boolean applyTimeZoneDifference)
Construct.

Method Summary

String	getDatePattern() Gets the optional date pattern.
protected org.joda.time.format.DateTimeFormatter	getFormat()

Methods inherited from class org.apache.wicket.datetime.DateConverter

convertToObject, convertToString, getApplyTimeZoneDifference, getClientTimeZone, getComponent, getLocale, getTimeZone, setComponent

Methods inherited from class java.lang.Object

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

Constructor Detail

StyleDateConverter

public StyleDateConverter(boolean applyTimeZoneDifference)

Construct. The dateStyle 'S-' (which is the same as DateTimeFormat.shortDate()) will be used for constructing the date format for the current locale.

When applyTimeZoneDifference is true, the current time is applied on the parsed date, and the date will be corrected for the time zone difference between the server and the client. For instance, if I'm in Seattle and the server I'm working on is in Amsterdam, the server is 9 hours ahead. So, if I'm inputting say 12/24 at a couple of hours before midnight, at the server it is already 12/25. If this boolean is true, it will be transformed to 12/25, while the client sees 12/24.

Parameters:

applyTimeZoneDifference - whether to apply the difference in time zones between client and server

StyleDateConverter

public StyleDateConverter(String dateStyle,
                          boolean applyTimeZoneDifference)

Construct. The provided pattern will be used as the base format (but they will be localized for the current locale) and if null, DateTimeFormat.shortDate() will be used.

When applyTimeZoneDifference is true, the current time is applied on the parsed date, and the date will be corrected for the time zone difference between the server and the client. For instance, if I'm in Seattle and the server I'm working on is in Amsterdam, the server is 9 hours ahead. So, if I'm inputting say 12/24 at a couple of hours before midnight, at the server it is already 12/25. If this boolean is true, it will be transformed to 12/25, while the client sees 12/24.

Parameters:

dateStyle - Date style to use. The first character is the date style, and the second character is the time style. Specify a character of 'S' for short style, 'M' for medium, 'L' for long, and 'F' for full. A date or time may be ommitted by specifying a style character '-'. See DateTimeFormat.forStyle(String).

applyTimeZoneDifference - whether to apply the difference in time zones between client and server

Throws:

IllegalArgumentException - in case dateStyle is null

Method Detail

getDatePattern

public final String getDatePattern()

Gets the optional date pattern.

Specified by:

getDatePattern in class DateConverter

Returns:

datePattern

getFormat

protected org.joda.time.format.DateTimeFormatter getFormat()

Specified by:

getFormat in class DateConverter

Returns:

formatter The formatter for the current conversion