com.jgoodies.validation.formatter
Class RelativeDateFormatter

java.lang.Object
  javax.swing.JFormattedTextField.AbstractFormatter
      javax.swing.text.DefaultFormatter
          javax.swing.text.InternationalFormatter
              javax.swing.text.DateFormatter
                  com.jgoodies.validation.formatter.EmptyDateFormatter
                      com.jgoodies.validation.formatter.RelativeDateFormatter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class RelativeDateFormatter
extends EmptyDateFormatter

Adds relative dates and output shortcuts to its superclass EmptyDateFormatter.

If output shortcuts are enabled, Yesterday, Today and Tomorrow are formatted using their localized human-language print strings.

If relative input is allowed, the parser accepts signed integers that encode a date relative to today; this input would otherwise be considered invalid.

Version:

$Revision: 1.9 $

Author:

Karsten Lentzsch

See Also:

ValidationUtils, JFormattedTextField, Serialized Form

Field Summary

static java.lang.String	KEY_TODAY The resource bundle key used to localize 'Today'.
static java.lang.String	KEY_TOMORROW The resource bundle key used to localize 'Tomorrow'.
static java.lang.String	KEY_YESTERDAY The resource bundle key used to localize 'Yesterday'.

Constructor Summary

RelativeDateFormatter()
Constructs a RelativeDateFormatter using the default DateFormat with output shortcuts and relative input enabled.

RelativeDateFormatter(boolean useOutputShortcuts, boolean allowRelativeInput)
Constructs a RelativeDateFormatter using the default DateFormat with output shortcuts and relative input configured as specified.

RelativeDateFormatter(java.text.DateFormat format)
Constructs a RelativeDateFormatter using the given DateFormat with output shortcuts and relative input enabled.

RelativeDateFormatter(java.text.DateFormat format, boolean useOutputShortcuts, boolean allowRelativeInput)
Constructs a RelativeDateFormatter using the given DateFormat with output shortcuts and relative input configured as specified.

Method Summary

static java.util.ResourceBundle	getDefaultResourceBundle() Returns the ResourceBundle that is used as default unless overridden by an individual bundle.
java.util.ResourceBundle	getResourceBundle() Returns the ResourceBundle used to lookup localized texts for Yesterday, Today, and Tomorrow.
static void	setDefaultResourceBundle(java.util.ResourceBundle newDefaultBundle) Sets the ResourceBundle that is used as default for all RelativeDateFormatters that have no individual bundle set.
void	setResourceBundle(java.util.ResourceBundle newBundle) Sets a ResourceBundle that will be used to lookup localized texts for Yesterday, Today, and Tomorrow.
java.lang.Object	stringToValue(java.lang.String text) Returns the Object representation of the String text.
java.lang.String	valueToString(java.lang.Object value) Returns a String representation of the Object value.

Methods inherited from class javax.swing.text.DateFormatter

setFormat

Methods inherited from class javax.swing.text.InternationalFormatter

clone, getActions, getFields, getFormat, getMaximum, getMinimum, install, setFormat, setMaximum, setMinimum

Methods inherited from class javax.swing.text.DefaultFormatter

getAllowsInvalid, getCommitsOnValidEdit, getDocumentFilter, getNavigationFilter, getOverwriteMode, getValueClass, setAllowsInvalid, setCommitsOnValidEdit, setOverwriteMode, setValueClass

Methods inherited from class javax.swing.JFormattedTextField.AbstractFormatter

getFormattedTextField, invalidEdit, setEditValid, uninstall

Methods inherited from class java.lang.Object

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

Field Detail

KEY_YESTERDAY

public static final java.lang.String KEY_YESTERDAY

The resource bundle key used to localize 'Yesterday'.

See Also:

Constant Field Values

KEY_TODAY

public static final java.lang.String KEY_TODAY

The resource bundle key used to localize 'Today'.

See Also:

Constant Field Values

KEY_TOMORROW

public static final java.lang.String KEY_TOMORROW

The resource bundle key used to localize 'Tomorrow'.

See Also:

Constant Field Values

Constructor Detail

RelativeDateFormatter

public RelativeDateFormatter()

Constructs a RelativeDateFormatter using the default DateFormat with output shortcuts and relative input enabled.

RelativeDateFormatter

public RelativeDateFormatter(java.text.DateFormat format)

Constructs a RelativeDateFormatter using the given DateFormat with output shortcuts and relative input enabled.

Parameters:

format - the DateFormat used to format and parse dates

RelativeDateFormatter

public RelativeDateFormatter(boolean useOutputShortcuts,
                             boolean allowRelativeInput)

Constructs a RelativeDateFormatter using the default DateFormat with output shortcuts and relative input configured as specified.

Parameters:

useOutputShortcuts - true indicates that dates are formatted with shortcuts for yesterday, today, and tomorrow, where false always converts using absolute numbers for day, month and year.

allowRelativeInput - true indicates that the parser accepts signed integers that encode a date relative to today; if false such input is considered invalid

RelativeDateFormatter

public RelativeDateFormatter(java.text.DateFormat format,
                             boolean useOutputShortcuts,
                             boolean allowRelativeInput)

Constructs a RelativeDateFormatter using the given DateFormat with output shortcuts and relative input configured as specified.

Parameters:

format - the DateFormat used to format and parse dates

useOutputShortcuts - true indicates that dates are formatted with shortcuts for yesterday, today, and tomorrow, where false always converts using absolute numbers for day, month and year.

allowRelativeInput - true indicates that the parser accepts signed integers that encode a date relative to today; if false such input is considered invalid

Method Detail

stringToValue

public java.lang.Object stringToValue(java.lang.String text)
                               throws java.text.ParseException

Returns the Object representation of the String text.

In addition to the delegate's behavior, this methods accepts signed integers interpreted as days relative to today.

Overrides:

stringToValue in class EmptyDateFormatter

Parameters:

text - the String to convert

Returns:

the Object representation of text

Throws:

java.text.ParseException - if there is an error in the conversion

valueToString

public java.lang.String valueToString(java.lang.Object value)
                               throws java.text.ParseException

Returns a String representation of the Object value. This invokes format on the current DateFormat.

In addition to the superclass behavior, this method formats the dates for yesterday, today and tomorrow to the natural language strings.

Overrides:

valueToString in class EmptyDateFormatter

Parameters:

value - The value to convert

Returns:

a String representation for the value

Throws:

java.text.ParseException - if there is an error in the conversion

getDefaultResourceBundle

public static java.util.ResourceBundle getDefaultResourceBundle()

Returns the ResourceBundle that is used as default unless overridden by an individual bundle.

Returns:

the ResourceBundle that is used as default

setDefaultResourceBundle

public static void setDefaultResourceBundle(java.util.ResourceBundle newDefaultBundle)

Sets the ResourceBundle that is used as default for all RelativeDateFormatters that have no individual bundle set.

Parameters:

newDefaultBundle - the ResourceBundle to be used as default

getResourceBundle

public final java.util.ResourceBundle getResourceBundle()

Returns the ResourceBundle used to lookup localized texts for Yesterday, Today, and Tomorrow. In case no bundle is set, these 3 dates will be formatted using the English texts.

Returns:

the ResourceBundle used to lookup localized texts

See Also:

setResourceBundle(ResourceBundle), getDefaultResourceBundle(), setDefaultResourceBundle(ResourceBundle)

setResourceBundle

public final void setResourceBundle(java.util.ResourceBundle newBundle)

Sets a ResourceBundle that will be used to lookup localized texts for Yesterday, Today, and Tomorrow. In case no bundle is set, the default bundle will be used.

Parameters:

newBundle - the ResourceBundle to set

See Also:

getResourceBundle(), getDefaultResourceBundle(), setDefaultResourceBundle(ResourceBundle)