Package org.zkoss.zul

Class Calendar

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl, Constrainted
    public class Calendar
extends XulElement
implements Constrainted
    A calendar.

    Default getZclass(): z-calendar. (since 3.5.0)

    Support display the week number within the current year

    Events: onWeekClick

    For example 

    
 <calendar weekOfYear="true" onWeekClick='alert(event.data)'/>
    [ZK EE] [Since 6.5.0]
    Author:
    tomyeh
    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.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
      Calendar()  
      Calendar​(java.time.LocalDate value)  
      Calendar​(java.time.LocalDateTime value)  
      Calendar​(java.time.ZonedDateTime value)  
      Calendar​(java.util.Date value)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Constraint getConstraint()
      Returns the constraint, or null if no constraint at all.
      java.lang.String getName()
      Returns the name of this component.
      boolean getShowTodayLink()
      Returns whether enable to show the link that jump to today in day view
      java.lang.String getTodayLinkLabel()
      Returns the label of the link that jump to today in day view
      java.util.Date getValue()
      Returns the value that is assigned to this component, never null.
      java.time.LocalDate getValueInLocalDate()
      Returns the value (in LocalDate) that is assigned to this component, never null.
      java.time.LocalDateTime getValueInLocalDateTime()
      Returns the value (in LocalDateTime) that is assigned to this component, never null.
      java.time.LocalTime getValueInLocalTime()
      Returns the value (in LocalTime) that is assigned to this component, never null.
      java.time.ZonedDateTime getValueInZonedDateTime()
      Returns the value (in ZonedDateTime) that is assigned to this component, never null.
      java.lang.String getZclass()  
      boolean isWeekOfYear()
      Returns whether enable to show the week number within the current year or not.
      protected void renderProperties​(org.zkoss.zk.ui.sys.ContentRenderer renderer)  
      void service​(org.zkoss.zk.au.AuRequest request, boolean everError)
      Processes an AU request.
      void setConstraint​(java.lang.String constr)
      Sets a list of constraints separated by comma.
      void setConstraint​(Constraint constr)
      Sets the constraint.
      void setName​(java.lang.String name)
      Sets the name of this component.
      void setShowTodayLink​(boolean showTodayLink)
      Sets whether enable to show the link that jump to today in day view
      void setTodayLinkLabel​(java.lang.String todayLinkLabel)
      Sets the label of the link that jump to today in day view
      void setValue​(java.util.Date value)
      Assigns a value to this component.
      void setValueInLocalDate​(java.time.LocalDate value)
      Assigns a value (in LocalDate) to this component.
      void setValueInLocalDateTime​(java.time.LocalDateTime value)
      Assigns a value (in LocalDateTime) to this component.
      void setValueInLocalTime​(java.time.LocalTime value)
      It is meaningless to set only LocalTime in calendar.
      void setValueInZonedDateTime​(java.time.ZonedDateTime value)
      Assigns a value (in ZonedDateTime) to this component.
      void setWeekOfYear​(boolean weekOfYear)
      Sets whether enable to show the week number within the current year or not.

      • 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, isChildable, isDisabledHostChanged, isInitialized, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onChildRemoved, onPageAttached, onPageDetached, onParentChanged, onWrongValue, 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

      • Calendar

        public Calendar()

      • Calendar

        public Calendar​(java.util.Date value)

      • Calendar

        public Calendar​(java.time.ZonedDateTime value)

      • Calendar

        public Calendar​(java.time.LocalDateTime value)

      • Calendar

        public Calendar​(java.time.LocalDate value)

    • Method Detail

      • setWeekOfYear

        public void setWeekOfYear​(boolean weekOfYear)
        Sets whether enable to show the week number within the current year or not. [ZK EE]
        Since:
        6.5.0

      • isWeekOfYear

        public boolean isWeekOfYear()
        Returns whether enable to show the week number within the current year or not.

        Default: false

        Since:
        6.5.0

      • getValue

        public java.util.Date getValue()
        Returns the value that is assigned to this component, never null.

      • setValue

        public void setValue​(java.util.Date value)
        Assigns a value to this component.
        Parameters:
        value - the date to assign. If null, today is assumed.

      • getValueInZonedDateTime

        public java.time.ZonedDateTime getValueInZonedDateTime()
        Returns the value (in ZonedDateTime) that is assigned to this component, never null.
        Since:
        9.0.0

      • setValueInZonedDateTime

        public void setValueInZonedDateTime​(java.time.ZonedDateTime value)
        Assigns a value (in ZonedDateTime) to this component.
        Parameters:
        value - the date to assign. If null, today is assumed.
        Since:
        9.0.0

      • getValueInLocalDateTime

        public java.time.LocalDateTime getValueInLocalDateTime()
        Returns the value (in LocalDateTime) that is assigned to this component, never null.
        Since:
        9.0.0

      • setValueInLocalDateTime

        public void setValueInLocalDateTime​(java.time.LocalDateTime value)
        Assigns a value (in LocalDateTime) to this component.
        Parameters:
        value - the date to assign. If null, today is assumed.
        Since:
        9.0.0

      • getValueInLocalDate

        public java.time.LocalDate getValueInLocalDate()
        Returns the value (in LocalDate) that is assigned to this component, never null.
        Since:
        9.0.0

      • setValueInLocalDate

        public void setValueInLocalDate​(java.time.LocalDate value)
        Assigns a value (in LocalDate) to this component.
        Parameters:
        value - the date to assign. If null, today is assumed.
        Since:
        9.0.0

      • getValueInLocalTime

        public java.time.LocalTime getValueInLocalTime()
        Returns the value (in LocalTime) that is assigned to this component, never null.
        Since:
        9.0.0

      • setValueInLocalTime

        public void setValueInLocalTime​(java.time.LocalTime value)
                         throws org.zkoss.zk.ui.WrongValueException
        It is meaningless to set only LocalTime in calendar.
        Throws:
        org.zkoss.zk.ui.WrongValueException
        Since:
        9.0.0

      • getName

        public java.lang.String getName()
        Returns the name of this component.

        Default: null.

        The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.

        Don't use this method if your application is purely based on ZK's event-driven model.

        Since:
        3.0.0

      • setName

        public void setName​(java.lang.String name)
        Sets the name of this component.

        The name is used only to work with "legacy" Web application that handles user's request by servlets. It works only with HTTP/HTML-based browsers. It doesn't work with other kind of clients.

        Don't use this method if your application is purely based on ZK's event-driven model.

        Parameters:
        name - the name of this component.
        Since:
        3.0.0

      • getShowTodayLink

        public boolean getShowTodayLink()
        Returns whether enable to show the link that jump to today in day view

        Default: false

        Returns:
        boolean
        Since:
        8.0.0

      • setShowTodayLink

        public void setShowTodayLink​(boolean showTodayLink)
        Sets whether enable to show the link that jump to today in day view
        Parameters:
        showTodayLink - show or hidden
        Since:
        8.0.0

      • getTodayLinkLabel

        public java.lang.String getTodayLinkLabel()
        Returns the label of the link that jump to today in day view

        Default: Today

        Returns:
        String
        Since:
        8.0.4

      • setTodayLinkLabel

        public void setTodayLinkLabel​(java.lang.String todayLinkLabel)
        Sets the label of the link that jump to today in day view
        Parameters:
        todayLinkLabel - today link label
        Since:
        8.0.4

      • setConstraint

        public void setConstraint​(java.lang.String constr)
        Sets a list of constraints separated by comma. Example: "between 20071012 and 20071223", "before 20080103".
        Parameters:
        constr - a list of constraints separated by comma.

      • setConstraint

        public void setConstraint​(Constraint constr)
        Description copied from interface: Constrainted
        Sets the constraint.

        Default: null (means no constraint all all).

        Specified by:
        setConstraint in interface Constrainted

      • getZclass

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

      • service

        public void service​(org.zkoss.zk.au.AuRequest request,
                    boolean everError)
        Processes an AU request.

        Default: in addition to what are handled by HtmlBasedComponent.service(org.zkoss.zk.au.AuRequest, boolean), it also handles onChange, onChanging and onError.

        Specified by:
        service in interface org.zkoss.zk.ui.sys.ComponentCtrl
        Overrides:
        service in class org.zkoss.zk.ui.HtmlBasedComponent
        Since:
        5.0.0

      • renderProperties

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