zul.db

Class Calendar

java.lang.Object

zk.Object

zk.Widget

zul.Widget

zul.db.Calendar

public class Calendar
extends Widget

A calendar.

Default Widget.getZclass(): z-calendar.

Field Summary

Fields inherited from class zk.Widget

$weave, auDelay, autag, bindLevel, className, desktop, effects_, firstChild, id, insertingBefore_, inServer, lastChild, nChildren, nextSibling, parent, previousSibling, uuid, widgetName

Fields inherited from class zk.Object

$class, $oid

Method Summary

Modifier and Type	Method and Description
String	getConstraint() Returns the constraint of this component.
String	getDefaultTzone() Returns default time zone that this calendar belongs to.
String	getFormat() Returns the format of this component.
String	getName() Returns the name of this component.
Date	getTime() Returns the Date that is assigned to this component.
String	getTodayLinkLabel() Returns the label of the link that jump to today in day view
Date	getValue() Returns the value that is assigned to this component.
boolean	isOutOfRange(boolean left, Date date) Check whether the date is out of range between 1900~2100 years
boolean	isShowTodayLink() Returns whether enable to show the link that jump to today in day view Default: false
boolean	isWeekOfYear() Returns whether enable to show the week number within the current year or not.
void	setConstraint(String constraint) Set the date limit for this component with yyyyMMdd format, such as 20100101 is mean Jan 01 2010 Example: between 20091201 and 20091231 before 20091201 after 20091231
void	setDefaultTzone(String timezone) Sets default time zone that this calendar belongs to.
void	setName(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(String todayLinkLabel) Sets the label of the link that jump to today in day view
void	setValue(Date value) Assigns a value 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 zul.Widget

afterKeyDown_, beforeCtrlKeys_, getContext, getCtrlKeys, getOpenTooltip, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class zk.Widget

$, $f, $f, $f, $init, $n, $n, $o, $s, $service, afterAnima_, afterParentChanged_, appendChild, appendChild, beforeParentChanged_, beforeSendAU_, bind_, bind, bindChildren_, bindDoubleTap_, bindMissingAncestors, bindSwipe_, bindTapHold_, canActivate, cleanDrag_, clear, clearCache, cloneDrag_, deferRedraw_, deferRedrawHTML_, detach, doBlur_, doClick_, doDoubleClick_, doFocus_, doKeyDown_, doKeyPress_, doKeyUp_, domAttrs_, domClass_, domListen_, doMouseDown_, doMouseMove_, doMouseOut_, doMouseOver_, doMouseUp_, domStyle_, domTextStyleAttr_, domTooltiptext_, domUnlisten_, doPaste_, doResizeScroll_, doRightClick_, doSelect_, doSwipe_, doTooltipOut_, doTooltipOver_, dropEffect_, extraBind_, fire, fireX, focus_, focus, forcerender, fromPageCoord, get, getAction, getCaveNode, getChildAt, getChildIndex, getClass, getCssflex, getDraggable, getDragMessage_, getDragNode, getDragOptions_, getDrop_, getDroppable, getElementsById, getElementsByName, getFirstNode_, getFloatZIndex_, getHeight, getHflex, getId, getLeft, getMold, getOldWidget_, getPage, getRenderdefer, getSclass, getScrollLeft, getScrollTop, getStyle, getTabindex, getTextNode, getTooltiptext, getTop, getTopWidget, getVflex, getWidth, getZclass, getZIndex, hide, ignoreDescendantFloatUp_, ignoreDrag_, initDrag_, insertBefore, insertChildHTML_, isAutoId, isBinding, isFloating_, isListen, isRealElement, isRealVisible, isRealVisible, isVisible, isVisible, isWatchable_, listen, listenOnFitSize_, mimicMouseDown_, newInstance, nextUuid, onAfterSize, onChildAdded_, onChildRemoved_, onChildRenderDefer_, onChildReplaced_, onChildVisible_, onDrop_, redraw, redrawHTML_, register, removeChild, removeChild, removeChildHTML_, removeHTML_, replaceCavedChildren_, replaceChildHTML_, replaceHTML, replaceWidget, rerender, rerender, rerenderLater_, rerenderNow_, scrollIntoView, sendAU_, set, set, setAction, setChildren, setCssflex, setDomVisible_, setDraggable, setDroppable, setFloating_, setFloatZIndex_, setHeight, setHflex, setId, setLeft, setListener, setListener, setListeners, setMold, setRenderdefer, setSclass, setScrollLeft, setScrollTop, setStyle, setTabindex, setTooltiptext, setTop, setTopmost, setVflex, setVisible, setWidth, setZclass, setZIndex, shallChildROD_, shallFireSizedLaterWhenAddChd_, shallIgnoreClick_, show, smartUpdate, unbind_, unbind, unbindChildren_, unbindDoubleTap_, unbindSwipe_, unbindTapHold_, uncloneDrag_, unlisten, unlistenOnFitSize_, updateDomClass_, updateDomStyle_, uuid, zsync

Methods inherited from class zk.Object

$init, $instanceof, $super, $super, $supers, $supers, afterInit, isAssignableFrom, isInstance, proxy

Methods inherited from class java.lang.Object

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

Method Detail

getValue

public Date getValue()

Returns the value that is assigned to this component.

Returns:

Date

setValue

public void setValue(Date value)

Assigns a value to this component.

Parameters:

value - the date to assign. If null, today is assumed.

getDefaultTzone

public String getDefaultTzone()

Returns default time zone that this calendar belongs to.

Returns:

String the time zone's ID, such as "America/Los_Angeles".

setDefaultTzone

public void setDefaultTzone(String timezone)

Sets default time zone that this calendar belongs to.

Parameters:

timezone - the time zone's ID, such as "America/Los_Angeles".

getConstraint

public String getConstraint()

Returns the constraint of this component.

Returns:

String

setConstraint

public void setConstraint(String constraint)

Set the date limit for this component with yyyyMMdd format, such as 20100101 is mean Jan 01 2010

Example:

between 20091201 and 20091231

before 20091201

after 20091231

Parameters:

constraint -

getName

public String getName()

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

Default: null.

Returns:

String

setName

public void setName(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.

isWeekOfYear

public boolean isWeekOfYear()

Returns whether enable to show the week number within the current year or not.

Default: false

Returns:

boolean

Since:

6.5.0

setWeekOfYear

public void setWeekOfYear(boolean weekOfYear)

Sets whether enable to show the week number within the current year or not. [ZK EE]

Parameters:

weekOfYear -

Since:

6.5.0

isShowTodayLink

public boolean isShowTodayLink()

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 -

Since:

8.0.0

getTodayLinkLabel

public String getTodayLinkLabel()

Returns the label of the link that jump to today in day view

Returns:

String

Since:

8.0.4

setTodayLinkLabel

public void setTodayLinkLabel(String todayLinkLabel)

Sets the label of the link that jump to today in day view

Parameters:

todayLinkLabel -

Since:

8.0.4

getFormat

public String getFormat()

Returns the format of this component.

Returns:

String

getTime

public Date getTime()

Returns the Date that is assigned to this component.

returns today if value is null

Returns:

Date

isOutOfRange

public boolean isOutOfRange(boolean left,
                            Date date)

Check whether the date is out of range between 1900~2100 years

Parameters:

left - it is used for the left arrow button

date - the date object for the range if null, the current value of getTime() is assumed.

Returns:

boolean if true it means the date is out of range.

Since:

6.5.3