Package org.zkoss.zkmax.zul

Class Timepicker

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Disable, org.zkoss.zk.ui.ext.Readonly, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.ext.Constrainted
    public class Timepicker
extends org.zkoss.zul.impl.DateTimeFormatInputElement
    An input box for holding a time (a Date Object), but only Hour, Minute, Second are used.

    Default getZclass(): z-timepicker.

    Since:
    8.0.0
    Author:
    James Chu
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

        org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

      • Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

        org.zkoss.zk.ui.AbstractComponent.Children, org.zkoss.zk.ui.AbstractComponent.ForwardInfo, org.zkoss.zk.ui.AbstractComponent.TargetInfo

    • Field Summary

      • Fields inherited from class org.zkoss.zul.impl.DateTimeFormatInputElement

        _locale, _tzone

      • Fields inherited from class org.zkoss.zul.impl.InputElement

        _cols, _value

      • Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

        _zclass

      • 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

        AFTER_CHILD_ADDED, AFTER_CHILD_REMOVED, AFTER_CLONED, AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED, AFTER_PARENT_CHANGED, CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

    • Constructor Summary

      Constructors 
      Constructor Description
      Timepicker()  
      Timepicker​(java.time.LocalDateTime value)  
      Timepicker​(java.time.LocalTime value)  
      Timepicker​(java.time.ZonedDateTime value)  
      Timepicker​(java.util.Date date)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.Object coerceFromString​(java.lang.String value)  
      protected java.lang.String coerceToString​(java.lang.Object value)  
      protected java.text.DateFormat getDateFormat​(java.lang.String fmt)
      Returns the date format of the time only,
      protected java.lang.String getDefaultFormat()
      Returns the default format, which is used when constructing a timepicker.
      int getInterval()
      Returns the interval time used to generate the options in Timepicker
      java.util.Date getMax()
      Returns the maximum time used to generate the options in Timepicker, or null if the default maximum time is used.
      java.time.LocalTime getMaxInLocalTime()
      Returns the maximum time used to generate the options in Timepicker, or null if the default maximum time is used.
      java.util.Date getMin()
      Returns the minimum time used to generate the options in Timepicker, or null if the default minimum time is used.(00:00:00 AM)
      java.time.LocalTime getMinInLocalTime()
      Returns the minimum time used to generate the options in Timepicker, or null if the default minimum time is used.(00:00:00 AM)
      java.lang.String getRealFormat()
      Returns the real format, i.e., the combination of the format patterns, such as hh:mm.
      java.lang.String getZclass()  
      boolean isReadonly()  
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void setConstraint​(java.lang.String constr)  
      void setFormat​(java.lang.String format)
      Sets the date format.
      void setInterval​(int interval)
      Sets the interval time used to generate the options in Timepicker
      void setMax​(java.util.Date max)
      Sets the maximum time used to generate the options in Timepicker
      void setMaxInLocalTime​(java.time.LocalTime max)
      Sets the maximum time used to generate the options in Timepicker
      void setMin​(java.util.Date min)
      Sets the minimum time used to generate the options in Timepicker
      void setMinInLocalTime​(java.time.LocalTime min)
      Sets the minimum time used to generate the options in Timepicker
      void setReadonly​(boolean readonly)  
      void setValueInLocalDate​(java.time.LocalDate value)
      It is meaningless to set only LocalDate in timepicker.

      • Methods inherited from class org.zkoss.zul.impl.DateTimeFormatInputElement

        getFormattedTimeZone, getLocale, getPropertyAccess, getTimeZone, getValue, getValueInLocalDate, getValueInLocalDateTime, getValueInLocalTime, getValueInZonedDateTime, getZoneId, setConstraint, setLocale, setLocale, setTimeZone, setTimeZone, setValue, setValueInLocalDateTime, setValueInLocalTime, setValueInZonedDateTime, toDate, toDate, toDate, toZonedDateTime

      • Methods inherited from class org.zkoss.zul.impl.FormatInputElement

        getFormat

      • Methods inherited from class org.zkoss.zul.impl.InputElement

        checkUserError, clearErrorMessage, clearErrorMessage, clone, getCols, getConstraint, getConstraintString, getErrorboxIconSclass, getErrorboxSclass, getErrorMessage, getInputAttributes, getInstant, getMaxlength, getName, getPlaceholder, getRawText, getRawValue, getTargetValue, getText, getType, isChildable, isDisabled, isInplace, isInstant, isMultiline, isValid, marshall, onWrongValue, select, service, setCols, setDisabled, setErrorboxIconSclass, setErrorboxSclass, setErrorMessage, setInplace, setInputAttributes, setInputAttributes, setInsertedText, setInstant, setMaxlength, setName, setPlaceholder, setRawValue, setSelectedText, setSelectionRange, setText, setValueDirectly, showCustomError, unmarshall, validate

      • Methods inherited from class org.zkoss.zul.impl.XulElement

        getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes

      • Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

        addSclass, evalCSSFlex, focus, getAction, getClientAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setClientAction, 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

      • Methods inherited from class org.zkoss.zk.ui.AbstractComponent

        addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildAdded, beforeChildRemoved, beforeParentChanged, destroyIndexCacheMap, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, disableHostChanged, enableBindingAnnotation, enableHostChanged, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, 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, getForwards, getId, getIndexCacheMap, getLastChild, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, initIndexCacheMap, insertBefore, invalidate, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onParentChanged, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, renderPropertiesOnly, 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, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize

      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • Timepicker

        public Timepicker()

      • Timepicker

        public Timepicker​(java.util.Date date)
           throws org.zkoss.zk.ui.WrongValueException
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • Timepicker

        public Timepicker​(java.time.ZonedDateTime value)
           throws org.zkoss.zk.ui.WrongValueException
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • Timepicker

        public Timepicker​(java.time.LocalDateTime value)
           throws org.zkoss.zk.ui.WrongValueException
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • Timepicker

        public Timepicker​(java.time.LocalTime value)
           throws org.zkoss.zk.ui.WrongValueException
        Throws:
        org.zkoss.zk.ui.WrongValueException

    • Method Detail

      • setFormat

        public void setFormat​(java.lang.String format)
               throws org.zkoss.zk.ui.WrongValueException
        Sets the date format.

        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

        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
        Overrides:
        setFormat in class org.zkoss.zul.impl.FormatInputElement
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • getRealFormat

        public java.lang.String getRealFormat()
        Returns the real format, i.e., the combination of the format patterns, such as hh:mm.

        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.

        Overrides:
        getRealFormat in class org.zkoss.zul.impl.FormatInputElement

      • setValueInLocalDate

        public void setValueInLocalDate​(java.time.LocalDate value)
                         throws org.zkoss.zk.ui.WrongValueException
        It is meaningless to set only LocalDate in timepicker.
        Overrides:
        setValueInLocalDate in class org.zkoss.zul.impl.DateTimeFormatInputElement
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • getMin

        public java.util.Date getMin()
        Returns the minimum time used to generate the options in Timepicker, or null if the default minimum time is used.(00:00:00 AM)

      • setMin

        public void setMin​(java.util.Date min)
        Sets the minimum time used to generate the options in Timepicker

      • getMinInLocalTime

        public java.time.LocalTime getMinInLocalTime()
        Returns the minimum time used to generate the options in Timepicker, or null if the default minimum time is used.(00:00:00 AM)
        Since:
        9.0.0

      • setMinInLocalTime

        public void setMinInLocalTime​(java.time.LocalTime min)
        Sets the minimum time used to generate the options in Timepicker
        Since:
        9.0.0

      • getMax

        public java.util.Date getMax()
        Returns the maximum time used to generate the options in Timepicker, or null if the default maximum time is used.

      • setMax

        public void setMax​(java.util.Date max)
        Sets the maximum time used to generate the options in Timepicker

      • getMaxInLocalTime

        public java.time.LocalTime getMaxInLocalTime()
        Returns the maximum time used to generate the options in Timepicker, or null if the default maximum time is used.
        Since:
        9.0.0

      • setMaxInLocalTime

        public void setMaxInLocalTime​(java.time.LocalTime max)
        Sets the maximum time used to generate the options in Timepicker
        Since:
        9.0.0

      • getInterval

        public int getInterval()
        Returns the interval time used to generate the options in Timepicker

        Unit: second

        Default: 3600, i.e. 1hr

      • setInterval

        public void setInterval​(int interval)
        Sets the interval time used to generate the options in Timepicker

        Unit: 1 second

      • isReadonly

        public boolean isReadonly()
        Specified by:
        isReadonly in interface org.zkoss.zk.ui.ext.Readonly
        Overrides:
        isReadonly in class org.zkoss.zul.impl.InputElement

      • setReadonly

        public void setReadonly​(boolean readonly)
        Specified by:
        setReadonly in interface org.zkoss.zk.ui.ext.Readonly
        Overrides:
        setReadonly in class org.zkoss.zul.impl.InputElement

      • setConstraint

        public void setConstraint​(java.lang.String constr)
        Overrides:
        setConstraint in class org.zkoss.zul.impl.InputElement
        Parameters:
        constr - a list of constraints separated by comma. Example: between 093000 and 183000, before 210000

      • getDefaultFormat

        protected java.lang.String getDefaultFormat()
        Returns the default format, which is used when constructing a timepicker.

        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).

      • coerceFromString

        protected java.lang.Object coerceFromString​(java.lang.String value)
                                     throws org.zkoss.zk.ui.WrongValueException
        Specified by:
        coerceFromString in class org.zkoss.zul.impl.InputElement
        Throws:
        org.zkoss.zk.ui.WrongValueException

      • coerceToString

        protected java.lang.String coerceToString​(java.lang.Object value)
        Specified by:
        coerceToString in class org.zkoss.zul.impl.InputElement

      • getDateFormat

        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.

      • getZclass

        public java.lang.String getZclass()
        Overrides:
        getZclass in class org.zkoss.zk.ui.HtmlBasedComponent

      • renderProperties

        protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)
                         throws java.io.IOException
        Overrides:
        renderProperties in class org.zkoss.zul.impl.DateTimeFormatInputElement
        Throws:
        java.io.IOException