|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
public class 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)
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 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.ext.Scope |
---|
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute |
Methods inherited from interface org.zkoss.zul.ext.Constrainted |
---|
getConstraint, setConstraint |
Constructor Detail |
---|
public Datebox()
public Datebox(java.util.Date date) throws WrongValueException
WrongValueException
Method Detail |
---|
protected java.lang.String getDefaultFormat()
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.
public boolean isLenient()
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.
isLenient
in interface Datebox
public void setLenient(boolean 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.
setLenient
in interface Datebox
public boolean isCompact()
isCompact
in interface Datebox
public void setCompact(boolean compact)
setCompact
in interface Datebox
public boolean isButtonVisible()
Default: true.
isButtonVisible
in interface Datebox
public void setButtonVisible(boolean visible)
setButtonVisible
in interface Datebox
public java.util.Date getValue() throws WrongValueException
getValue
in interface Datebox
WrongValueException
- if user entered a wrong valuepublic void setValue(java.util.Date value) throws WrongValueException
setValue
in interface Datebox
WrongValueException
- if value is wrongpublic void setFormat(java.lang.String format) throws WrongValueException
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
|
setFormat
in interface FormatInputElement
setFormat
in class FormatInputElement
WrongValueException
public java.util.TimeZone getTimeZone()
The default time zone is determined by TimeZones.getCurrent()
.
getTimeZone
in interface Datebox
public void setTimeZone(java.util.TimeZone tzone)
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.
setTimeZone
in interface Datebox
public void setTimeZone(java.lang.String id)
The default time zone is determined by TimeZones.getCurrent()
.
id
- the time zone's ID, such as "America/Los_Angeles".
The time zone will be retrieved by calling TimeZone.getTimeZone(id).public java.util.List getDisplayedTimeZones()
Default: null
public void setDisplayedTimeZones(java.util.List dtzones)
If the getTimeZone()
is null,
the first time zone in the list is assumed.
dtzones
- a list of the time zones to display.
If empty, it assumed to be null.public void setDisplayedTimeZones(java.lang.String dtzones)
The time zone is retrieved by calling TimeZone.getTimeZone().
dtzones
- a catenation of a list of the timezones' ID, such as
"America/Los_Angeles,GMT+8"
setDisplayedTimeZones(List)
public boolean isTimeZonesReadonly()
public void setTimeZonesReadonly(boolean readonly)
public void setOpen(boolean open)
setOpen
in interface Datebox
open()
,
close()
public void open()
open
in interface Datebox
public void close()
close
in interface Datebox
public void service(AuRequest request, boolean everError)
Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean)
,
it also handles onTimeZoneChange, onChange, onChanging and onError.
service
in interface ComponentCtrl
service
in class InputElement
everError
- whether any error ever occured before
processing this request.AbstractComponent.setAuService(org.zkoss.zk.au.AuService)
public void setConstraint(java.lang.String constr)
setConstraint
in interface InputElement
setConstraint
in class InputElement
protected java.lang.Object coerceFromString(java.lang.String value) throws WrongValueException
InputElement
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.
coerceFromString
in class InputElement
WrongValueException
protected java.lang.String coerceToString(java.lang.Object value)
InputElement
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.
coerceToString
in class InputElement
protected java.text.DateFormat getDateFormat(java.lang.String fmt)
Default: it uses SimpleDateFormat to format the date.
fmt
- the pattern.public java.lang.String getZclass()
HtmlBasedComponent
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.
getZclass
in interface HtmlBasedComponent
getZclass
in class HtmlBasedComponent
HtmlBasedComponent.getSclass()
protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponent
See also Render Special Properties
renderProperties
in class FormatInputElement
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |