public class Timebox extends DateTimeFormatInputElement
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_locale, _tzone_value_zclassAPPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPEAFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE| Constructor and Description |
|---|
Timebox() |
Timebox(java.util.Date date) |
Timebox(java.time.LocalDateTime value) |
Timebox(java.time.LocalTime value) |
Timebox(java.time.ZonedDateTime value) |
| 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.
|
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.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 |
setConstraint(java.lang.String constr) |
void |
setFormat(java.lang.String format)
Sets the date format.
|
void |
setValueInLocalDate(java.time.LocalDate value)
It is meaningless to set only LocalDate in timebox.
|
getLocale, getTimeZone, getValue, getValueInLocalDate, getValueInLocalDateTime, getValueInLocalTime, getValueInZonedDateTime, getZoneId, setConstraint, setLocale, setLocale, setTimeZone, setTimeZone, setValue, setValueInLocalDateTime, setValueInLocalTime, setValueInZonedDateTime, toDate, toDate, toDate, toZonedDateTimegetFormatcheckUserError, clearErrorMessage, clearErrorMessage, clone, getCols, getConstraint, getErrorboxIconSclass, getErrorboxSclass, getErrorMessage, getInputAttributes, getInstant, getMaxlength, getName, getPlaceholder, getRawText, getRawValue, getTargetValue, getText, getType, isChildable, isDisabled, isInplace, isInstant, isMultiline, isReadonly, isValid, marshall, onWrongValue, select, service, setCols, setDisabled, setErrorboxIconSclass, setErrorboxSclass, setErrorMessage, setInplace, setInputAttributes, setInputAttributes, setInsertedText, setInstant, setMaxlength, setName, setPlaceholder, setRawValue, setReadonly, setSelectedText, setSelectionRange, setText, setValueDirectly, showCustomError, unmarshall, validategetContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributesaddSclass, evalCSSFlex, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, 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, 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, invalidatePartial, isInitialized, 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, willSerializeequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitinvalidatePartialpublic Timebox()
public Timebox(java.util.Date date)
throws WrongValueException
WrongValueExceptionpublic Timebox(java.time.ZonedDateTime value)
throws WrongValueException
WrongValueExceptionpublic Timebox(java.time.LocalDateTime value)
throws WrongValueException
WrongValueExceptionpublic Timebox(java.time.LocalTime value)
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 void setValueInLocalDate(java.time.LocalDate value)
throws WrongValueException
setValueInLocalDate in class DateTimeFormatInputElementvalue - the date to be assigned to this component.TimeZones.getCurrent()), so it is easier
to work with other libraries, such as SQL.
Dates has a set of utilities to simplify the task.WrongValueException - if value is wrongpublic boolean isButtonVisible()
Default: true.
public void setButtonVisible(boolean visible)
public void setConstraint(java.lang.String constr)
setConstraint in class InputElementconstr - a list of constraints separated by comma.
Example: between 093000 and 183000, before 210000protected 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 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 DateTimeFormatInputElementjava.io.IOExceptionpublic PropertyAccess getPropertyAccess(java.lang.String prop)
ComponentCtrlgetPropertyAccess in interface ComponentCtrlgetPropertyAccess in class DateTimeFormatInputElementprop - the name of the propertyCopyright © 2005-2021 Potix Corporation. All Rights Reserved.