calendar (RichFaces JSF components library Tag library documentation)
Keywords: $title

Overview | Library | Tag | Help
| FRAMES NO FRAMES

## RichFaces
Tag calendar

Tag Information
Tag Class | org.richfaces.taglib.CalendarTag
TagExtraInfo Class | None
Body Content | JSP
Display Name | None

Attributes
Name | Required | Request-time | Type | Description
ajaxSingle | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | if "true", submits ONLY one field/link, instead of all form controls
binding | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | The attribute takes a value-binding expression for a component property of a backing bean
boundaryDatesMode | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Used for the dates boundaries in the list. Valid values are "inactive" (Default) dates inactive and gray colored, "scroll" boundaries work as month scrolling controls, and "select" boundaries work in the same way as "scroll" but with the date clicked selection
buttonClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Style Class attribute for the popup button
buttonIcon | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines icon for the popup button element. The attribute is ignored if the "buttonLabel" is set
buttonIconDisabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines disabled icon for the popup button element. The attribute is ignored if the "buttonLabel" is set
buttonLabel | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines label for the popup button element. If the attribute is set "buttonIcon" and "buttonIconDisabled" are ignored
bypassUpdates | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
cellHeight | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | attribute to set fixed cells height
cellWidth | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | attribute to set fixed cells width
converter | false | false | `javax.el.ValueExpression` (must evaluate to `javax.faces.convert.Converter`) | Id of Converter to be used or reference to a Converter
converterMessage | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter
currentDate | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Defines current date
currentDateChangeListener | false | false | `javax.el.MethodExpression` (signature must match `void currentDateChangeListener(org.richfaces.event.CurrentDateChangeEvent)`) | MethodBinding representing an action listener method that will be notified after date selection
dataModel | false | false | `javax.el.ValueExpression` (must evaluate to `org.richfaces.model.CalendarDataModel`) | Used to provide data for calendar elements. If data is not provided, all Data Model related functions are disabled
datePattern | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines date pattern
dayStyleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Should be binded to some JS function that will provide style classes for special sets of days highlighting.
direction | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Defines direction of the calendar popup (top-left, top-right, bottom-left, bottom-right (Default), auto)
disabled | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", rendered is disabled. In "popup" mode both controls are disabled
enableManualInput | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true" calendar input will be editable and it will be possible to change the date manualy. If "false" value for this attribute makes a text field "read-only", so the value can be changed only from a handle
eventsQueue | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Name of requests queue to avoid send next request before complete other from same event. Can be used to reduce number of requests of frequently events (key press, mouse move etc.)
focus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | id of element to set focus after request completed on client side
horizontalOffset | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Sets the horizontal offset between button and calendar element conjunction point
id | false | false | `java.lang.String` | Every component may have a unique id that is automatically created if omitted
ignoreDupResponses | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | Attribute allows to ignore an Ajax Response produced by a request if the newest 'similar' request is in a queue already. ignoreDupResponses="true" does not cancel the request while it is processed on the server, but just allows to avoid unnecessary updates on the client side if the response isn't actual now
immediate | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase
inputClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Style Class attribute for the text field
inputSize | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Defines the size of an input field. Similar to the "size" attribute of h:inputText
inputStyle | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Style attribute for text field
isDayEnabled | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Should be binded to some JS function that returns day state.
jointPoint | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Set the corner of the button for the popup to be connected with (top-left, top-right, bottom-left (Default), bottom-right, auto)
label | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A localized user presentable name for this component.
limitToList | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", updates on client side ONLY elements from this 'reRender' property. If "false" (default) updates all rendered by ajax region components
locale | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Used for locale definition
mode | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Valid values = ajax or client
monthLabels | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Attribute that allows to customize names of the months. Should accept list with the month names
monthLabelsShort | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Attribute that allows to customize short names of the months. Should accept list with the month names
onbeforedomupdate | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call before DOM has been updated on client side
onchanged | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onChanged event handler
oncollapse | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onCollapse event handler
oncomplete | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | JavaScript code for call after request completed on client side
oncurrentdateselect | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onCurrentDateSelect event handler
ondatemouseout | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onDateMouseOut event handler
ondatemouseover | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onDateMouseOver event handler
ondateselect | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onDateSelect event handler
ondateselected | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onDateSelected event handler
onexpand | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onExpand event handler
oninputblur | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | input onBlur event handler
oninputchange | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | input onChange event handler
oninputclick | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | input onClick event handler
oninputfocus | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | input onFocus event handler
oninputkeydown | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | input onKeyDown event handler
oninputkeypress | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | input onKeyPress event handler
oninputkeyup | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | input onKeyUp event handler
oninputselect | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | input onSelect event handler
ontimeselect | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onTimeSelect event handler
ontimeselected | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | onTimeSelected event handler
popup | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true" calendar will be rendered initially as hidden with additional elements for calling as popup
preloadDateRangeBegin | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Define the initial range of date which will be loaded to client from dataModel under rendering
preloadDateRangeEnd | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Defines the last range of date which will be loaded to client from dataModel under rendering
reRender | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Id['s] (in format of call UIComponent.findComponent()) of components, rendered in case of AjaxRequest caused by this component. Can be single id, comma-separated list of Id's, or EL Expression with array or Collection
rendered | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "false", this component is not rendered
requestDelay | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Attribute defines the time (in ms.) that the request will be wait in the queue before it is ready to send. When the delay time is over, the request will be sent to the server or removed if the newest 'similar' request is in a queue already
required | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If "true", this component is checked for non-empty input
requiredMessage | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used
showApplyButton | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If false ApplyButton should not be shown
showFooter | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If false Calendar's footer should not be shown
showHeader | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If false Calendar's header should not be shown
showInput | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | "false" value for this attribute makes text field invisible. If "true" - input field will be shown
showWeekDaysBar | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If false this bar should not be shown
showWeeksBar | false | false | `javax.el.ValueExpression` (must evaluate to `boolean`) | If false this bar should not be shown
status | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | ID (in format of call UIComponent.findComponent()) of Request status component
style | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | CSS style(s) is/are to be applied when this component is rendered
styleClass | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Corresponds to the HTML class attribute
timeZone | false | false | `javax.el.ValueExpression` (must evaluate to `java.util.TimeZone`) | Used for current date calculations
timeout | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Response waiting time on a particular request. If a response is not received during this time, the request is aborted
todayControlMode | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Possible values are "scroll", "select", "hidden"
toolTipMode | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | Used to specify mode to load tooltips. Valid values are "none", "single" and "batch"
validator | false | false | `javax.el.MethodExpression` (signature must match `void validator(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)`) | MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component
validatorMessage | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.String`) | A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator
value | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | The initial value to set when rendered for the first time
valueChangeListener | false | false | `javax.el.MethodExpression` (signature must match `void valueChangeListener(javax.faces.event.ValueChangeEvent)`) | Listener for value changes
verticalOffset | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Sets the vertical offset between button and calendar element conjunction point
weekDayLabels | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | List of the day names displays on the days bar in the following way "Sun, Mon, Tue, Wed, "
weekDayLabelsShort | false | false | `javax.el.ValueExpression` (must evaluate to `java.lang.Object`) | Attribute that allows to customize short names of the weeks. Should accept list with the weeks names.
zindex | false | false | `javax.el.ValueExpression` (must evaluate to `int`) | Attribute is similar to the standard HTML attribute and can specify window placement relative to the content

Variables
| No Variables Defined.

Overview | Library | Tag | Help
| FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.