public class Timebox extends FormatInputElement
Default getZclass(): z-timebox. (since 3.5.0)
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).
HtmlBasedComponent.ExtraCtrlAbstractComponent.Children_value_zclassAFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHEDAPPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPECE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE| Modifier and Type | Method and Description |
|---|---|
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.
|
protected java.lang.String |
getDefaultFormat()
Returns the default format, which is used when constructing a timebox.
|
java.util.Locale |
getLocale()
Returns the locale associated with this timebox,
or null if
Locales.getCurrent() is preferred. |
PropertyAccess |
getPropertyAccess(java.lang.String prop)
Returns the corresponding property access object from the given property
name, if any.
|
java.lang.String |
getRealFormat()
Returns the real format, i.e., the combination of the format patterns,
such as hh:mm.
|
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 java.lang.Object |
marshall(java.lang.Object value)
Marshall value to be sent to the client if needed.
|
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 |
setLocale(java.util.Locale locale)
Sets the locale used to identify the format of this timebox.
|
void |
setLocale(java.lang.String locale)
Sets the locale used to identify the format of this timebox.
|
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).
|
protected java.lang.Object |
unmarshall(java.lang.Object value)
Unmarshall value returned from client if needed.
|
getFormatcheckUserError, clearErrorMessage, clearErrorMessage, clone, getCols, getConstraint, getErrorboxIconSclass, getErrorboxSclass, getErrorMessage, getInstant, getMaxlength, getName, getPlaceholder, getRawText, getRawValue, getTargetValue, getText, getType, isChildable, isDisabled, isInplace, isInstant, isMultiline, isReadonly, isValid, onWrongValue, select, service, setCols, setConstraint, setConstraint, setDisabled, setErrorboxIconSclass, setErrorboxSclass, setErrorMessage, setInplace, setInstant, setMaxlength, setName, setPlaceholder, setRawValue, setReadonly, setSelectedText, setSelectionRange, setText, setValueDirectly, showCustomError, validategetContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributesfocus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectlyaddAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerializepublic Timebox()
public Timebox(java.util.Date date)
throws WrongValueException
WrongValueExceptionpublic void setFormat(java.lang.String format)
throws WrongValueException
If null or empty is specified, getDefaultFormat() is assumed.
Since 5.0.7, you could specify one of the following reserved words,
and DateFormats.getTimeFormat(int, java.util.Locale, java.lang.String)
will be used to retrieve the real format.
| short | DateFormats.getTimeFormat(int, java.util.Locale, java.lang.String) with DateFormat.SHORT |
| medium | DateFormats.getTimeFormat(int, java.util.Locale, java.lang.String) with DateFormat.MEDIUM |
| long | DateFormats.getTimeFormat(int, java.util.Locale, java.lang.String) with DateFormat.LONG |
| full | DateFormats.getTimeFormat(int, java.util.Locale, java.lang.String) with DateFormat.FULL |
In additions, the format could be a combination of the following pattern letters:
| 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 FormatInputElementWrongValueExceptionpublic java.lang.String getRealFormat()
As described in setFormat(java.lang.String), a developer could specify
an abstract name, such as short, or an empty string as the format,
and this method will convert it to a real time format.
getRealFormat in class FormatInputElementpublic java.util.Date getValue()
throws WrongValueException
WrongValueException - if user entered a wrong valuepublic void setValue(java.util.Date value)
throws WrongValueException
WrongValueException - if value is wrongpublic boolean isButtonVisible()
Default: true.
public void setButtonVisible(boolean visible)
public java.util.TimeZone getTimeZone()
The default time zone is determined by TimeZones.getCurrent().
public void setTimeZone(java.util.TimeZone tzone)
The default time zone is determined by TimeZones.getCurrent().
public java.util.Locale getLocale()
Locales.getCurrent() is preferred.public void setLocale(java.util.Locale locale)
Default: null (i.e., Locales.getCurrent(), the current locale
is assumed)
public void setLocale(java.lang.String locale)
Default: null (i.e., Locales.getCurrent(), the current locale
is assumed)
protected java.lang.String getDefaultFormat()
Default: DateFormats.getTimeFormat(DEFAULT, null, "HH:mm")
(see DateFormats.getTimeFormat(int, java.util.Locale, java.lang.String)).
Though you might override this method to provide your own default format,
it is suggested to specify the format for the current thread
with DateFormats.setLocalFormatInfo(org.zkoss.text.DateFormatInfo).
protected java.lang.Object marshall(java.lang.Object value)
InputElementOverrides it if the value to be sent to the client is not JSON Compatible.
marshall in class InputElementvalue - the value to be sent to the clientprotected java.lang.Object unmarshall(java.lang.Object value)
InputElementOverrides it if the value returned is not JSON Compatible.
unmarshall in class InputElementvalue - the value returned from clientprotected java.lang.Object coerceFromString(java.lang.String value)
throws WrongValueException
InputElementInputElement.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 InputElementWrongValueExceptionprotected java.lang.String coerceToString(java.lang.Object value)
InputElementInputElement.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 InputElementprotected java.text.DateFormat getDateFormat(java.lang.String fmt)
Default: it uses SimpleDateFormat to format the date.
public java.lang.String getZclass()
HtmlBasedComponentAbstractComponent.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.
getZclass in class HtmlBasedComponentHtmlBasedComponent.getSclass()protected void renderProperties(ContentRenderer renderer) throws java.io.IOException
HtmlBasedComponentrenderProperties in class FormatInputElementjava.io.IOExceptionpublic PropertyAccess getPropertyAccess(java.lang.String prop)
ComponentCtrlgetPropertyAccess in interface ComponentCtrlgetPropertyAccess in class FormatInputElementprop - the name of the propertyCopyright © 2005-2011 Potix Corporation. All Rights Reserved.