|
||||||||||
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.Timebox
public class Timebox
An input box for holding a time (a java.util.Date Object , but only Hour & Minute are used.
Default getZclass()
: z-timebox. (since 3.5.0)
timebox doens't support customized format. It support HH:mm formate, where HH is hour of day and mm is minute of hour.
timebox supports below key events.
Like Combobox
and Datebox
,
the value of a read-only time box (InputElement.isReadonly()
) can be changed
by clicking the up or down button (though users cannot type anything
in the input box).
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 | |
---|---|
Timebox()
|
|
Timebox(java.util.Date date)
|
Method Summary | |
---|---|
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 time only, Default: it uses SimpleDateFormat to format the date. |
java.util.TimeZone |
getTimeZone()
Returns the time zone that this time 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. |
protected void |
renderProperties(ContentRenderer renderer)
Renders the content of this component, excluding the enclosing tags and children. |
void |
setButtonVisible(boolean visible)
Sets whether the button (on the right of the textbox) is visible. |
void |
setFormat(java.lang.String format)
Sets the date format. |
void |
setTimeZone(java.util.TimeZone tzone)
Sets the time zone that this time box belongs to, or null if the default time zone is used. |
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, service, setCols, setConstraint, 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.InputElement |
---|
clearErrorMessage, clearErrorMessage, getCols, getErrorMessage, getMaxlength, getName, getRawText, getRawValue, getTabindex, getText, getType, isDisabled, isMultiline, isReadonly, isValid, select, setCols, setConstraint, 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 Timebox()
public Timebox(java.util.Date date) throws WrongValueException
WrongValueException
Method Detail |
---|
public void setFormat(java.lang.String format) throws WrongValueException
The following pattern letters are defined:
Letter | Date or Time Component | Presentation | Examples |
---|---|---|---|
a
| Am/pm marker | Text | PM
|
H
| Hour in day (0-23) | Number | 0
|
k
| Hour in day (1-24) | Number | 24
|
K
| Hour in am/pm (0-11) | Number | 0
|
h
| Hour in am/pm (1-12) | Number | 12
|
m
| Minute in hour | Number | 30
|
s
| Second in minute | Number | 55
|
setFormat
in class FormatInputElement
WrongValueException
public java.util.Date getValue() throws WrongValueException
getValue
in interface Timebox
WrongValueException
- if user entered a wrong valuepublic void setValue(java.util.Date value) throws WrongValueException
setValue
in interface Timebox
WrongValueException
- if value is wrongpublic boolean isButtonVisible()
Default: true.
isButtonVisible
in interface Timebox
public void setButtonVisible(boolean visible)
setButtonVisible
in interface Timebox
public java.util.TimeZone getTimeZone()
The default time zone is determined by TimeZones.getCurrent()
.
getTimeZone
in interface Timebox
public void setTimeZone(java.util.TimeZone tzone)
The default time zone is determined by TimeZones.getCurrent()
.
setTimeZone
in interface Timebox
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.
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 |