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).
_locale, _tzone
_value
Constructor and Description |
---|
Timebox() |
Timebox(Date date) |
Timebox(LocalDateTime value) |
Timebox(LocalTime value) |
Timebox(ZonedDateTime value) |
Modifier and Type | Method and Description |
---|---|
protected Object |
coerceFromString(String value)
Coerces the value passed to
InputElement.setText(java.lang.String) . |
protected String |
coerceToString(Object value)
Coerces the value passed to
InputElement.setText(java.lang.String) . |
protected DateFormat |
getDateFormat(String fmt)
Returns the date format of the time only,
|
protected String |
getDefaultFormat()
Returns the default format, which is used when constructing a timebox.
|
org.zkoss.zk.ui.sys.PropertyAccess |
getPropertyAccess(String prop) |
String |
getRealFormat()
Returns the real format, i.e., the combination of the format patterns,
such as hh:mm.
|
String |
getZclass() |
boolean |
isButtonVisible()
Returns whether the button (on the right of the textbox) is visible.
|
protected void |
renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) |
void |
setButtonVisible(boolean visible)
Sets whether the button (on the right of the textbox) is visible.
|
void |
setConstraint(String constr) |
void |
setFormat(String format)
Sets the date format.
|
void |
setValueInLocalDate(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, toZonedDateTime
getFormat
checkUserError, 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, validate
getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
addSclass, 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, setZIndexDirectly
addAnnotation, 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, willSerialize
public Timebox()
public Timebox(Date date) throws org.zkoss.zk.ui.WrongValueException
org.zkoss.zk.ui.WrongValueException
public Timebox(ZonedDateTime value) throws org.zkoss.zk.ui.WrongValueException
org.zkoss.zk.ui.WrongValueException
public Timebox(LocalDateTime value) throws org.zkoss.zk.ui.WrongValueException
org.zkoss.zk.ui.WrongValueException
public Timebox(LocalTime value) throws org.zkoss.zk.ui.WrongValueException
org.zkoss.zk.ui.WrongValueException
public void setFormat(String format) throws org.zkoss.zk.ui.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 FormatInputElement
org.zkoss.zk.ui.WrongValueException
public 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 FormatInputElement
public void setValueInLocalDate(LocalDate value) throws org.zkoss.zk.ui.WrongValueException
setValueInLocalDate
in class DateTimeFormatInputElement
value
- 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.org.zkoss.zk.ui.WrongValueException
- if value is wrongpublic boolean isButtonVisible()
Default: true.
public void setButtonVisible(boolean visible)
public void setConstraint(String constr)
setConstraint
in class InputElement
constr
- a list of constraints separated by comma.
Example: between 093000 and 183000, before 210000protected 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 Object coerceFromString(String value) throws org.zkoss.zk.ui.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
org.zkoss.zk.ui.WrongValueException
protected String coerceToString(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 DateFormat getDateFormat(String fmt)
Default: it uses SimpleDateFormat to format the date.
public String getZclass()
getZclass
in class org.zkoss.zk.ui.HtmlBasedComponent
protected void renderProperties(org.zkoss.zk.ui.sys.ContentRenderer renderer) throws IOException
renderProperties
in class DateTimeFormatInputElement
IOException
public org.zkoss.zk.ui.sys.PropertyAccess getPropertyAccess(String prop)
getPropertyAccess
in interface org.zkoss.zk.ui.sys.ComponentCtrl
getPropertyAccess
in class DateTimeFormatInputElement
Copyright © 2021. All rights reserved.