Module org.apache.wicket.core

Package org.apache.wicket.validation.validator

Class DateValidator

java.lang.Object

org.apache.wicket.behavior.Behavior

org.apache.wicket.validation.validator.AbstractRangeValidator<Z,Z>

org.apache.wicket.validation.validator.RangeValidator<Date>

org.apache.wicket.validation.validator.DateValidator

All Implemented Interfaces:

Serializable, IComponentAwareEventSink, IComponentAwareHeaderContributor, org.apache.wicket.util.io.IClusterable, IValidator<Date>

public class DateValidator
extends RangeValidator<Date>

Validator for checking if a given date falls within [min,max] range. If either min or max are null they are not checked.

Resource keys:

• DateValidator.exact if min==max
• DateValidator.range if both min and max are not null
• DateValidator.minimum if max is null
• DateValidator.maximum if min is null

Error Message Variables:

• name: the id of Component that failed
• label: the label of the Component (either comes from FormComponent.labelModel or resource key <form-id>.<form-component-id>
• input: the input value
• inputdate: the formatted input value
• minimum: the minimum allowed value
• maximum: the maximum allowed value

Author:

igor

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.validation.validator.AbstractRangeValidator

AbstractRangeValidator.Mode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DateValidator()	Constructor used for subclasses who want to set the range using AbstractRangeValidator.setRange(Comparable, Comparable)
	DateValidator(Date minimum, Date maximum)	Constructor that sets the minimum and maximum date values.
	DateValidator(Date minimum, Date maximum, String format)	Constructor that sets the minimum and maximum date values and a custom date formating.

Method Summary

Modifier and Type	Method	Description
protected IValidationError	decorate(IValidationError error, IValidatable<Date> validatable)	Allows subclasses to decorate reported errors
static DateValidator	maximum(Date maximum)
static DateValidator	maximum(Date maximum, String format)
static DateValidator	minimum(Date minimum)
static DateValidator	minimum(Date minimum, String format)
static DateValidator	range(Date minimum, Date maximum)
static DateValidator	range(Date minimum, Date maximum, String format)

Methods inherited from class org.apache.wicket.validation.validator.RangeValidator

getValue, maximum, minimum, range

Methods inherited from class org.apache.wicket.validation.validator.AbstractRangeValidator

getMaximum, getMinimum, getMode, setRange, validate

Methods inherited from class org.apache.wicket.behavior.Behavior

afterRender, beforeRender, bind, canCallListener, detach, getStatelessHint, isEnabled, isTemporary, onAttribute, onComponentTag, onConfigure, onEvent, onException, onRemove, onTag, renderHead, unbind

Methods inherited from class java.lang.Object

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

Constructor Detail

DateValidator

public DateValidator(Date minimum,
                     Date maximum,
                     String format)

Constructor that sets the minimum and maximum date values and a custom date formating.

Parameters:

minimum - the minimum date

maximum - the maximum date

format - The format string used to format the date with SimpleDateFormat

DateValidator

public DateValidator(Date minimum,
                     Date maximum)

Constructor that sets the minimum and maximum date values.

Parameters:

minimum - the minimum date

maximum - the maximum date

DateValidator

protected DateValidator()

Constructor used for subclasses who want to set the range using AbstractRangeValidator.setRange(Comparable, Comparable)

Method Detail

range

public static DateValidator range(Date minimum,
                                  Date maximum)

Parameters:

minimum - the minimum Date

maximum - the maximum Date

Returns:

a DateValidator that validates if a date is between (inclusive) a minimum and maximum

range

public static DateValidator range(Date minimum,
                                  Date maximum,
                                  String format)

Parameters:

minimum - the minimum Date

maximum - the maximum Date

format - The format string used to format the date with SimpleDateFormat

Returns:

a DateValidator that validates if a date is between (inclusive) a minimum and maximum

minimum

public static DateValidator minimum(Date minimum)

Parameters:

minimum - the minimum Date

Returns:

a DateValidator that validates if a date is after or equal to a minimum date

minimum

public static DateValidator minimum(Date minimum,
                                    String format)

Parameters:

minimum - the minimum Date

format - The format string used to format the date with SimpleDateFormat

Returns:

a DateValidator that validates if a date is after or equal to a minimum date

maximum

public static DateValidator maximum(Date maximum)

Parameters:

maximum - the maximum Date

Returns:

a DateValidator that validates if a date is before or equal to a maximum date

maximum

public static DateValidator maximum(Date maximum,
                                    String format)

Parameters:

maximum - the maximum Date

format - The format string used to format the date with SimpleDateFormat

Returns:

a DateValidator that validates if a date is before or equal to a maximum date

decorate

protected IValidationError decorate(IValidationError error,
                                    IValidatable<Date> validatable)

Description copied from class: AbstractRangeValidator

Allows subclasses to decorate reported errors

Overrides:

decorate in class AbstractRangeValidator<Date,Date>

Returns:

decorated error