org.zkoss.zul

Class SimpleDateConstraint

java.lang.Object

org.zkoss.zul.SimpleConstraint

org.zkoss.zul.SimpleDateConstraint

All Implemented Interfaces:

java.io.Serializable, ClientConstraint, Constraint

public class SimpleDateConstraint
extends SimpleConstraint

A simple date constraint.

Since:

3.0.2

Author:

tomyeh

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.zul.SimpleConstraint

_finishParseCst, _flags, AFTER_END, AFTER_POINTER, AFTER_START, AT_POINTER, BEFORE_END, BEFORE_START, END_AFTER, END_BEFORE, NO_EMPTY, NO_FUTURE, NO_NEGATIVE, NO_PAST, NO_POSITIVE, NO_TODAY, NO_ZERO, OVERLAP, OVERLAP_AFTER, OVERLAP_BEFORE, OVERLAP_END, SERVER, START_AFTER, START_BEFORE, STRICT

Constructor Summary

Constructors

Constructor and Description
SimpleDateConstraint(int flags)
SimpleDateConstraint(int flags, java.util.Date begin, java.util.Date end, java.lang.String errmsg) Constructs a constraint with beginning and ending date.
SimpleDateConstraint(int flags, java.util.regex.Pattern regex, java.lang.String errmsg) Constructs a constraint combining regular expression.
SimpleDateConstraint(int flags, java.lang.String errmsg) Constraints a constraint.
SimpleDateConstraint(int flags, java.lang.String regex, java.lang.String errmsg) Deprecated. As of release 8.0.1, replaced with SimpleDateConstraint(int, Pattern, String)
SimpleDateConstraint(java.util.regex.Pattern regex, java.lang.String errmsg) Constructs a regular-expression constraint.
SimpleDateConstraint(java.lang.String constraint) Constructs a constraint with a list of constraints separated by comma.
SimpleDateConstraint(java.lang.String regex, java.lang.String errmsg) Deprecated. As of release 8.0.1, replaced with SimpleDateConstraint(Pattern, String)

Method Summary

Modifier and Type	Method and Description
java.util.Date	getBeginDate() Returns the beginning date, or null if there is no constraint of the beginning date.
java.util.Date	getEndDate() Returns the ending date, or null if there is no constraint of the ending date.
protected int	parseConstraint(java.lang.String constraint) Parses a constraint into an integer value.
void	setTimeZone(java.util.TimeZone tzone) Sets time zone that this date constraint belongs to
void	validate(Component comp, java.lang.Object value) Verifies whether the value is acceptable.

Methods inherited from class org.zkoss.zul.SimpleConstraint

getClientConstraint, getClientPackages, getErrorMessage, getFlags, getInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleDateConstraint

public SimpleDateConstraint(int flags)

SimpleDateConstraint

public SimpleDateConstraint(int flags,
                            java.lang.String errmsg)

Constraints a constraint.

Parameters:

flags - a combination of SimpleConstraint.NO_POSITIVE, SimpleConstraint.NO_NEGATIVE, SimpleConstraint.NO_ZERO, and so on.

errmsg - the error message to display. Ignored if null or empty.

SimpleDateConstraint

public SimpleDateConstraint(java.lang.String regex,
                            java.lang.String errmsg)

Deprecated. As of release 8.0.1, replaced with SimpleDateConstraint(Pattern, String)

Constructs a regular-expression constraint.

Parameters:

regex - ignored if null or empty. Unlike constraint, the regex doesn't need to enclose with '/'.

errmsg - the error message to display. Ignored if null or empty.

SimpleDateConstraint

public SimpleDateConstraint(java.util.regex.Pattern regex,
                            java.lang.String errmsg)

Constructs a regular-expression constraint.

Parameters:

regex - ignored if null or empty

errmsg - the error message to display. Ignored if null or empty.

Since:

8.0.1

SimpleDateConstraint

public SimpleDateConstraint(int flags,
                            java.lang.String regex,
                            java.lang.String errmsg)

Deprecated. As of release 8.0.1, replaced with SimpleDateConstraint(int, Pattern, String)

Constructs a constraint combining regular expression.

Parameters:

flags - a combination of SimpleConstraint.NO_POSITIVE, SimpleConstraint.NO_NEGATIVE, SimpleConstraint.NO_ZERO, and so on.

regex - ignored if null or empty. Unlike constraint, the regex doesn't need to enclose with '/'.

errmsg - the error message to display. Ignored if null or empty.

SimpleDateConstraint

public SimpleDateConstraint(int flags,
                            java.util.regex.Pattern regex,
                            java.lang.String errmsg)

Constructs a constraint combining regular expression.

Parameters:

flags - a combination of SimpleConstraint.NO_POSITIVE, SimpleConstraint.NO_NEGATIVE, SimpleConstraint.NO_ZERO, and so on.

regex - ignored if null or empty

errmsg - the error message to display. Ignored if null or empty.

Since:

8.0.1

SimpleDateConstraint

public SimpleDateConstraint(int flags,
                            java.util.Date begin,
                            java.util.Date end,
                            java.lang.String errmsg)

Constructs a constraint with beginning and ending date.

Parameters:

flags - a combination of SimpleConstraint.NO_POSITIVE, SimpleConstraint.NO_NEGATIVE, SimpleConstraint.NO_ZERO, and so on.

begin - the beginning date, or null if no constraint at the beginning date.

end - the ending date, or null if no constraint at the ending date.

errmsg - the error message to display. Ignored if null or empty.

SimpleDateConstraint

public SimpleDateConstraint(java.lang.String constraint)

Constructs a constraint with a list of constraints separated by comma.

Parameters:

constraint - a list of constraints separated by comma. Example: "between 20071012 and 20071223", "before 20080103"

Method Detail

setTimeZone

public void setTimeZone(java.util.TimeZone tzone)

Sets time zone that this date constraint belongs to

getBeginDate

public java.util.Date getBeginDate()

Returns the beginning date, or null if there is no constraint of the beginning date.

getEndDate

public java.util.Date getEndDate()

Returns the ending date, or null if there is no constraint of the ending date.

parseConstraint

protected int parseConstraint(java.lang.String constraint)
                       throws UiException

Description copied from class: SimpleConstraint

Parses a constraint into an integer value. For example, "no positive" is parsed to SimpleConstraint.NO_POSITIVE.

Deriving classes might override this to provide more constraints.

Overrides:

parseConstraint in class SimpleConstraint

Throws:

UiException

validate

public void validate(Component comp,
                     java.lang.Object value)
              throws WrongValueException

Description copied from interface: Constraint

Verifies whether the value is acceptable.

Specified by:

validate in interface Constraint

Overrides:

validate in class SimpleConstraint

Parameters:

comp - the component being validated

Throws:

WrongValueException