org.zkoss.zul
Class Datebox

java.lang.Object
  org.zkoss.zk.ui.AbstractComponent
      org.zkoss.zk.ui.HtmlBasedComponent
          org.zkoss.zul.impl.XulElement
              org.zkoss.zul.impl.InputElement
                  org.zkoss.zul.impl.FormatInputElement
                      org.zkoss.zul.Datebox

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, HtmlBasedComponent, Component, Scope, ComponentCtrl, Datebox, Constrainted, FormatInputElement, InputElement, XulElement

public class Datebox
extends FormatInputElement
implements Datebox

An edit box for holding a date.

The default format (FormatInputElement.getFormat()) depends on JVM's setting and the current user's locale. That is, DateFormat.getDateInstance(DateFormat,DEFAULT, Locales.getCurrent). You might override getDefaultFormat() to provide your own default format.

Default getZclass(): z-datebox.(since 3.5.0)

Author:

tomyeh

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

AbstractComponent.Children

Field Summary

Fields inherited from class org.zkoss.zul.impl.InputElement

_value

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_height, _left, _top, _width, _zclass

Fields inherited from class org.zkoss.zk.ui.AbstractComponent

_visible

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Datebox()

Datebox(java.util.Date date)

Method Summary

void	close() Closes the calendar if it was dropped down.
protected java.lang.Object	coerceFromString(java.lang.String value) Coerces the value passed to InputElement.setText(java.lang.String).
protected java.lang.String	coerceToString(java.lang.Object value) Coerces the value passed to InputElement.setText(java.lang.String).
protected java.text.DateFormat	getDateFormat(java.lang.String fmt) Returns the date format of the specified format Default: it uses SimpleDateFormat to format the date.
protected java.lang.String	getDefaultFormat() Returns the default format, which is used when contructing a datebox.
java.util.List	getDisplayedTimeZones() Returns a list of the time zones that will be displayed at the client and allow user to select.
java.util.TimeZone	getTimeZone() Returns the time zone that this date box belongs to, or null if the default time zone is used.
java.util.Date	getValue() Returns the value (in Date), might be null unless a constraint stops it.
java.lang.String	getZclass() Returns the ZK Cascading Style class(es) for this component.
boolean	isButtonVisible() Returns whether the button (on the right of the textbox) is visible.
boolean	isCompact() Deprecated. As of release 5.0.0, it is no longer supported.
boolean	isLenient() Returns whether or not date/time parsing is to be lenient.
boolean	isTimeZonesReadonly() Returns whether the list of the time zones to display is readonly.
void	open() Drops down the calendar to select a date.
protected void	renderProperties(ContentRenderer renderer) Renders the content of this component, excluding the enclosing tags and children.
void	service(AuRequest request, boolean everError) Processes an AU request.
void	setButtonVisible(boolean visible) Sets whether the button (on the right of the textbox) is visible.
void	setCompact(boolean compact) Deprecated. As of release 5.0.0, it is no longer supported.
void	setConstraint(java.lang.String constr)
void	setDisplayedTimeZones(java.util.List dtzones) Sets a list of the time zones that will be displayed at the client and allow user to select.
void	setDisplayedTimeZones(java.lang.String dtzones) Sets a catenation of a list of the time zones' ID, separated by comma, that will be displayed at the client and allow user to select.
void	setFormat(java.lang.String format) Sets the date format.
void	setLenient(boolean lenient) Sets whether or not date/time parsing is to be lenient.
void	setOpen(boolean open) Drops down or closes the calendar to select a date.
void	setTimeZone(java.lang.String id) Sets the time zone that this date box belongs to, or null if the default time zone is used.
void	setTimeZone(java.util.TimeZone tzone) Sets the time zone that this date box belongs to, or null if the default time zone is used.
void	setTimeZonesReadonly(boolean readonly) Sets whether the list of the time zones to display is readonly.
void	setValue(java.util.Date value) Sets the value (in Date).

Methods inherited from class org.zkoss.zul.impl.FormatInputElement

getFormat

Methods inherited from class org.zkoss.zul.impl.InputElement

checkUserError, clearErrorMessage, clearErrorMessage, getCols, getConstraint, getErrorMessage, getMaxlength, getName, getRawText, getRawValue, getTabindex, getTargetValue, getText, getType, isChildable, isDisabled, isInplace, isMultiline, isReadonly, isValid, onWrongValue, select, setCols, setConstraint, setDisabled, setInplace, setMaxlength, setName, setRawValue, setReadonly, setSelectedText, setSelectionRange, setTabindex, setText, setValueDirectly, showCustomError, validate

Methods inherited from class org.zkoss.zul.impl.XulElement

getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getDraggable, getDroppable, getHeight, getHflex, getLeft, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, newExtraCtrl, setClass, setDraggable, setDroppable, setFocus, setHeight, setHflex, setLeft, setSclass, setStyle, setTooltiptext, setTop, setVflex, setWidth, setZclass, setZindex, setZIndex

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, clone, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getClientEvents, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getExtraCtrl, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, newChildren, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zul.impl.api.FormatInputElement

getFormat

Methods inherited from interface org.zkoss.zul.impl.api.InputElement

clearErrorMessage, clearErrorMessage, getCols, getErrorMessage, getMaxlength, getName, getRawText, getRawValue, getTabindex, getText, getType, isDisabled, isMultiline, isReadonly, isValid, select, setCols, setDisabled, setMaxlength, setName, setRawValue, setReadonly, setSelectedText, setSelectionRange, setTabindex, setText

Methods inherited from interface org.zkoss.zul.impl.api.XulElement

getAction, getContext, getCtrlKeys, getPopup, getTooltip, setAction, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getUuid, getVariable, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setVariable, setVisible, setWidgetListener, setWidgetOverride, unsetVariable

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Methods inherited from interface org.zkoss.zul.ext.Constrainted

getConstraint, setConstraint

Constructor Detail

Datebox

public Datebox()

Datebox

public Datebox(java.util.Date date)
        throws WrongValueException

Throws:

WrongValueException

Method Detail

getDefaultFormat

protected java.lang.String getDefaultFormat()

Returns the default format, which is used when contructing a datebox.

The default format (FormatInputElement.getFormat()) depends on JVM's setting and the current user's locale. That is, DateFormat.getDateInstance(DateFormat,DEFAULT, Locales.getCurrent).

You might override this method to provide your own default format.

isLenient

public boolean isLenient()

Returns whether or not date/time parsing is to be lenient.

With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match this object's format. With strict parsing, inputs must match this object's format.

Specified by:

isLenient in interface Datebox

setLenient

public void setLenient(boolean lenient)

Sets whether or not date/time parsing is to be lenient.

Default: true.

With lenient parsing, the parser may use heuristics to interpret inputs that do not precisely match this object's format. With strict parsing, inputs must match this object's format.

Specified by:

setLenient in interface Datebox

isCompact

public boolean isCompact()

Deprecated. As of release 5.0.0, it is no longer supported.

Specified by:

isCompact in interface Datebox

setCompact

public void setCompact(boolean compact)

Deprecated. As of release 5.0.0, it is no longer supported.

Specified by:

setCompact in interface Datebox

isButtonVisible

public boolean isButtonVisible()

Returns whether the button (on the right of the textbox) is visible.

Default: true.

Specified by:

isButtonVisible in interface Datebox

Since:

2.4.1

setButtonVisible

public void setButtonVisible(boolean visible)

Sets whether the button (on the right of the textbox) is visible.

Specified by:

setButtonVisible in interface Datebox

Since:

2.4.1

getValue

public java.util.Date getValue()
                        throws WrongValueException

Returns the value (in Date), might be null unless a constraint stops it.

Specified by:

getValue in interface Datebox

Throws:

WrongValueException - if user entered a wrong value

setValue

public void setValue(java.util.Date value)
              throws WrongValueException

Sets the value (in Date).

Specified by:

setValue in interface Datebox

Throws:

WrongValueException - if value is wrong

setFormat

public void setFormat(java.lang.String format)
               throws WrongValueException

Sets the date format.

The following pattern letters are defined:

Letter	Date or Time Component	Presentation	Examples
G	Era designator	Text	AD
y	Year	Year	1996; 96
M	Month in year	Month	July; Jul; 07
w	Week in year (starting at 1)	Number	27
W	Week in month (starting at 1)	Number	2
D	Day in year (starting at 1)	Number	189
d	Day in month (starting at 1)	Number	10
F	Day of week in month	Number	2
E	Day in week	Text	Tuesday; Tue

Specified by:

setFormat in interface FormatInputElement

Overrides:

setFormat in class FormatInputElement

Throws:

WrongValueException

getTimeZone

public java.util.TimeZone getTimeZone()

Returns the time zone that this date box belongs to, or null if the default time zone is used.

The default time zone is determined by TimeZones.getCurrent().

Specified by:

getTimeZone in interface Datebox

setTimeZone

public void setTimeZone(java.util.TimeZone tzone)

Sets the time zone that this date box belongs to, or null if the default time zone is used.

The default time zone is determined by TimeZones.getCurrent().

Notice that if getDisplayedTimeZones() was called with a non-empty list, the time zone must be one of it. Otherwise (including tzone is null), the first timezone is selected.

Specified by:

setTimeZone in interface Datebox

setTimeZone

public void setTimeZone(java.lang.String id)

Sets the time zone that this date box belongs to, or null if the default time zone is used.

The default time zone is determined by TimeZones.getCurrent().

Parameters:

id - the time zone's ID, such as "America/Los_Angeles". The time zone will be retrieved by calling TimeZone.getTimeZone(id).

getDisplayedTimeZones

public java.util.List getDisplayedTimeZones()

Returns a list of the time zones that will be displayed at the client and allow user to select.

Default: null

Since:

3.6.3

setDisplayedTimeZones

public void setDisplayedTimeZones(java.util.List dtzones)

Sets a list of the time zones that will be displayed at the client and allow user to select.

If the getTimeZone() is null, the first time zone in the list is assumed.

Parameters:

dtzones - a list of the time zones to display. If empty, it assumed to be null.

Since:

3.6.3

setDisplayedTimeZones

public void setDisplayedTimeZones(java.lang.String dtzones)

Sets a catenation of a list of the time zones' ID, separated by comma, that will be displayed at the client and allow user to select.

The time zone is retrieved by calling TimeZone.getTimeZone().

Parameters:

dtzones - a catenation of a list of the timezones' ID, such as "America/Los_Angeles,GMT+8"

Since:

3.6.3

See Also:

setDisplayedTimeZones(List)

isTimeZonesReadonly

public boolean isTimeZonesReadonly()

Returns whether the list of the time zones to display is readonly. If readonly, the user cannot change the time zone at the client.

Since:

3.6.3

setTimeZonesReadonly

public void setTimeZonesReadonly(boolean readonly)

Sets whether the list of the time zones to display is readonly. If readonly, the user cannot change the time zone at the client.

Since:

3.6.3

setOpen

public void setOpen(boolean open)

Drops down or closes the calendar to select a date.

Specified by:

setOpen in interface Datebox

Since:

3.0.1

See Also:

open(), close()

open

public void open()

Drops down the calendar to select a date. The same as setOpen(true).

Specified by:

open in interface Datebox

Since:

3.0.1

close

public void close()

Closes the calendar if it was dropped down. The same as setOpen(false).

Specified by:

close in interface Datebox

Since:

3.0.1

service

public void service(AuRequest request,
                    boolean everError)

Processes an AU request.

Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onTimeZoneChange, onChange, onChanging and onError.

Specified by:

service in interface ComponentCtrl

Overrides:

service in class InputElement

everError - whether any error ever occured before processing this request.

Since:

5.0.0

See Also:

AbstractComponent.setAuService(org.zkoss.zk.au.AuService)

setConstraint

public void setConstraint(java.lang.String constr)

Specified by:

setConstraint in interface InputElement

Overrides:

setConstraint in class InputElement

coerceFromString

protected java.lang.Object coerceFromString(java.lang.String value)
                                     throws WrongValueException

Description copied from class: InputElement

Coerces the value passed to InputElement.setText(java.lang.String).

Deriving note:
If you want to store the value in other type, say BigDecimal, you have to override InputElement.coerceToString(java.lang.Object) and InputElement.coerceFromString(java.lang.String) to convert between a string and your targeting type.

Moreover, when Textbox is called, it calls this method with value = null. Derives shall handle this case properly.

Specified by:

coerceFromString in class InputElement

Throws:

WrongValueException

coerceToString

protected java.lang.String coerceToString(java.lang.Object value)

Description copied from class: InputElement

Coerces the value passed to InputElement.setText(java.lang.String).

Default: convert null to an empty string.

Deriving note:
If you want to store the value in other type, say BigDecimal, you have to override InputElement.coerceToString(java.lang.Object) and InputElement.coerceFromString(java.lang.String) to convert between a string and your targeting type.

Specified by:

coerceToString in class InputElement

getDateFormat

protected java.text.DateFormat getDateFormat(java.lang.String fmt)

Returns the date format of the specified format

Default: it uses SimpleDateFormat to format the date.

Parameters:

fmt - the pattern.

getZclass

public java.lang.String getZclass()

Description copied from class: HtmlBasedComponent

Returns the ZK Cascading Style class(es) for this component. It usually depends on the implementation of the mold (@{link #getMold}).

Default: null (the default value depends on element).

HtmlBasedComponent.setZclass(java.lang.String)) will completely replace the default style of a component. In other words, the default style of a component is associated with the default value of HtmlBasedComponent.getZclass(). Once it is changed, the default style won't be applied at all. If you want to perform small adjustments, use HtmlBasedComponent.setSclass(java.lang.String) instead.

Specified by:

getZclass in interface HtmlBasedComponent

Overrides:

getZclass in class HtmlBasedComponent

See Also:

HtmlBasedComponent.getSclass()

renderProperties

protected void renderProperties(ContentRenderer renderer)
                         throws java.io.IOException

Description copied from class: HtmlBasedComponent

Renders the content of this component, excluding the enclosing tags and children.

See also Render Special Properties

Overrides:

renderProperties in class FormatInputElement

Throws:

java.io.IOException