org.jdesktop.swingx.calendar
Class DatePickerFormatter

java.lang.Object
  javax.swing.JFormattedTextField.AbstractFormatter
      org.jdesktop.swingx.calendar.DatePickerFormatter

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DatePickerFormatter.DatePickerFormatterUIResource

public class DatePickerFormatter
extends JFormattedTextField.AbstractFormatter

Default formatter for the JXDatePicker component. It can handle a variety of date formats.

See Also:

Serialized Form

Nested Class Summary

static class

DatePickerFormatter.DatePickerFormatterUIResource Same as DatePickerFormatter, but tagged as UIResource.

Constructor Summary

DatePickerFormatter()
Instantiates a formatter with the localized format patterns defined in the swingx.properties.

DatePickerFormatter(DateFormat[] formats)
Instantiates a formatter with the given date formats.

DatePickerFormatter(DateFormat[] formats, Locale locale)
Instantiates a formatter with the given formats and locale.

DatePickerFormatter(Locale locale)
Instantiates a formatter with default date formats in the given locale.

Method Summary

protected DateFormat[]	createDefaultFormats(Locale locale) Creates and returns the localized default formats.
DateFormat[]	getFormats() Returns an array of the formats used by this formatter.
Object	stringToValue(String text) Parses text returning an arbitrary Object.
String	valueToString(Object value) Returns the string value to display for value.

Methods inherited from class javax.swing.JFormattedTextField.AbstractFormatter

clone, getActions, getDocumentFilter, getFormattedTextField, getNavigationFilter, install, invalidEdit, setEditValid, uninstall

Methods inherited from class java.lang.Object

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

Constructor Detail

DatePickerFormatter

public DatePickerFormatter()

Instantiates a formatter with the localized format patterns defined in the swingx.properties. These formats are localizable and fields may be re-arranged, such as swapping the month and day fields. The keys for localizing these fields are:

• JXDatePicker.longFormat
• JXDatePicker.mediumFormat
• JXDatePicker.shortFormat

DatePickerFormatter

public DatePickerFormatter(DateFormat[] formats)

Instantiates a formatter with the given date formats. If the array is null, default formats are created from the localized patterns in swingx.properties. If empty?

Parameters:

formats - the array of formats to use. May be null to use defaults or empty to do nothing (?), but must not contain null formats.

DatePickerFormatter

public DatePickerFormatter(Locale locale)

Instantiates a formatter with default date formats in the given locale. The default formats are created from the localized patterns in swingx.properties.

Parameters:

locale - the Locale the use for the default formats.

DatePickerFormatter

public DatePickerFormatter(DateFormat[] formats,
                           Locale locale)

Instantiates a formatter with the given formats and locale. PENDING JW: makes no sense as a public constructor because the locale is ignored if the formats are null. So has same public behaviour as the constructor with formats only ...

Parameters:

formats -

locale -

Method Detail

getFormats

public DateFormat[] getFormats()

Returns an array of the formats used by this formatter.

Returns:

the formats used by this formatter, guaranteed to be not null.

stringToValue

public Object stringToValue(String text)
                     throws ParseException

Parses text returning an arbitrary Object. Some formatters may return null.

Specified by:

stringToValue in class JFormattedTextField.AbstractFormatter

Parameters:

text - String to convert

Returns:

Object representation of text

Throws:

ParseException - if there is an error in the conversion

valueToString

public String valueToString(Object value)
                     throws ParseException

Returns the string value to display for value.

Specified by:

valueToString in class JFormattedTextField.AbstractFormatter

Parameters:

value - Value to convert

Returns:

String representation of value

Throws:

ParseException - if there is an error in the conversion

createDefaultFormats

protected DateFormat[] createDefaultFormats(Locale locale)

Creates and returns the localized default formats. First tries to add formats created using the patterns stored in the UIManager. If there are no patterns, use the DateFormat's instance with style DateFormat.SHORT.

Returns:

the localized default formats.