### Create new RichFaces Documentation Jira issue

Summary
255 characters left
Description
Environment
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.org Community Documentation

- Prev
- Next

### 6.11.1. < rich:calendar > available since 3.1.0

expand all

#### 6.11.1.1. Description

The <rich:calendar> component is used to create inputs for date and time and enter them inline or using pup-up calendar that allows to navigate through monthes and years.

Figure 6.199. <rich:calendar> component

#### 6.11.1.2. Key Features

- Highly customizable look and feel

- Popup representation

- Disablement support

- Smart and user-defined positioning

- Cells customization

- Macro substitution based on tool bars customization

Table 6.294. rich : calendar attributes

Attribute Name | Description
--- | ---
ajaxSingle | boolean attribute which provides possibility to limit JSF tree processing(decoding, conversion/validation, value applying) to the component which send the request only. Default value is "true"
binding | JSF: The attribute takes a value-binding expression for a component property of a backing bean
boundaryDatesMode | This attribute is responsible for behaviour of dates from the previous and next months which are displayed in the current month. 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. Default value is "inactive".
buttonClass | Assigns one or more space-separated CSS class names to the component popup button
buttonIcon | Defines icon for the popup button element. The attribute is ignored if the "buttonLabel" is set
buttonIconDisabled | Defines disabled icon for the popup button element. The attribute is ignored if the "buttonLabel" is set
buttonLabel | Defines label for the popup button element. If the attribute is set "buttonIcon" and "buttonIconDisabled" are ignored
bypassUpdates | 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 | attribute to set fixed cells height
cellWidth | attribute to set fixed cells width
converter | JSF: Id of Converter to be used or reference to a Converter
converterMessage | 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 | Defines current date
currentDateChangeListener | MethodExpression representing an action listener method that will be notified after date selection
dataModel | Used to provide data for calendar elements. If data is not provided, all Data Model related functions are disabled
datePattern | Defines date pattern. Default value is "MMM d, yyyy".
dayStyleClass | Should be binded to some JS function that will provide style classes for special sets of days highlighting
defaultTime | Defines time that will be used: 1) to set time when the value is empty 2) to set time when date changes and flag "resetTimeOnDateSelect" is true. Default value is "getDefaultValueOfDefaultTime()"
direction | Defines direction of the calendar popup ("top-left", "top-right", "bottom-left", "bottom-right" (Default), "auto"). Default value is "bottom-right".
disabled | HTML: If "true", rendered is disabled. In "popup" mode both controls are disabled. Default value is "false".
enableManualInput | 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. Default value is "false".
eventsQueue | 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.)
firstWeekDay | Gets what the first day of the week is; e.g., SUNDAY in the U.S., MONDAY in France. Default value is "getDefaultFirstWeekDay()". Possible values should be integers from 0 to 6, 0 corresponds to Sunday
focus | ID of an element to set focus after request is completed on client side
horizontalOffset | Sets the horizontal offset between button and calendar element conjunction point. Default value is "0".
id | JSF: Every component may have a unique id that is automatically created if omitted
ignoreDupResponses | 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 | 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 | Assigns one or more space-separated CSS class names to the component input field
inputSize | Defines the size of an input field. Similar to the "size" attribute of <h:inputText/>
inputStyle | CSS style rules to be applied to the component input field
isDayEnabled | Should be binded to some JS function that returns day state
jointPoint | Set the corner of the button for the popup to be connected with (top-left, top-right, bottom-left (Default), bottom-right, auto). Default value is "bottom-left".
label | A localized user presentable name for this component.
limitToList | If "true", then of all AJAX-rendered on the page components only those will be updated, which ID's are passed to the "reRender" attribute of the describable component. "false"-the default value-means that all components with ajaxRendered="true" will be updated.
locale | Used for locale definition. Default value is "getDefaultLocale()".
minDaysInFirstWeek | Gets what the minimal days required in the first week of the year are; e.g., if the first week is defined as one that contains the first day of the first month of a year, this method returns 1. If the minimal days required must be a full week, this method returns 7. Default value is "getDefaultMinDaysInFirstWeek()".
mode | Valid values: ajax or client. Default value is "client".
monthLabels | Attribute that allows to customize names of the months. Should accept list with the month names
monthLabelsShort | Attribute that allows to customize short names of the months. Should accept list with the month names
onbeforedomupdate | The client-side script method to be called before DOM is updated
onchanged | The client-side script method to be called when the date or time is changed and applied to input
oncollapse | The client-side script method to be called before the calendar popup is closed
oncomplete | The client-side script method to be called after the request is completed
oncurrentdateselect | The client-side script method to be called when the current month or year is changed
oncurrentdateselected | The client-side script method to be called after the current month or year is changed
ondatemouseout | The client-side script method to be called when a pointer is moved away from the date cell
ondatemouseover | The client-side script method to be called when a pointer is moved onto the date cell
ondateselect | The client-side script method to be called when some date cell is selected
ondateselected | The client-side script method to be called after some date cell is selected
onexpand | The client-side script method to be called before the calendar popup is opened
oninputblur | The client-side script method to be called when the input field loses the focus
oninputchange | The client-side script method to be called when the input field value is changed manually
oninputclick | The client-side script method to be called when the input field is clicked
oninputfocus | The client-side script method to be called when the input field gets the focus
oninputkeydown | The client-side script method to be called when a key is pressed down in the input field
oninputkeypress | The client-side script method to be called when a key is pressed and released in the input field
oninputkeyup | The client-side script method to be called when a key is released in the input field
oninputmouseout | The client-side script method to be called when a pointer is moved away from the input field
oninputmouseover | The client-side script method to be called when a pointer is moved onto the input field
oninputselect | The client-side script method to be called when the input field value is selected
ontimeselect | The client-side script method to be called before new time is selected
ontimeselected | The client-side script method to be called after time is selected
popup | If "true", the calendar will be rendered initially as hidden with additional elements for calling as popup. Default value is "true".
preloadDateRangeBegin | Define the initial range of date which will be loaded to client from dataModel under rendering. Default value is "getDefaultPreloadBegin(getCurrentDateOrDefault())".
preloadDateRangeEnd | Defines the last range of date which will be loaded to client from dataModel under rendering. Default value is "getDefaultPreloadEnd(getCurrentDateOrDefault())".
process | Id['s] (in format of call UIComponent.findComponent()) of components, processed at the phases 2-5 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
readonly | HTML: If "true". Date and time are not selectable. In "popup" mode input is disabled and button is enabled. Default value is "false".
rendered | JSF: If "false", this component is not rendered
requestDelay | 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 | JSF: If "true", this component is checked for non-empty input
requiredMessage | A ValueExpression enabled attribute which defines text of validation message to show, if a required field is missing
reRender | 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
resetTimeOnDateSelect | If value is true then calendar should change time to defaultTime for newly-selected dates. Default value is "false"
showApplyButton | If false ApplyButton should not be shown. Default value is "false".
showFooter | If false Calendar's footer should not be shown. Default value is "true".
showHeader | If false Calendar's header should not be shown. Default value is "true".
showInput | "false" value for this attribute makes text field invisible. It works only if popupMode="true" If showInput is "true" - input field will be shown. Default value is "true".
showWeekDaysBar | If false this bar should not be shown. Default value is "true".
showWeeksBar | If false this bar should not be shown. Default value is "true".
similarityGroupingId | If there are any component requests with identical IDs then these requests will be grouped.
status | ID (in format of call UIComponent.findComponent()) of Request status component
style | HTML: CSS style rules to be applied to the component
styleClass | JSF: Assigns one or more space-separated CSS class names to the component. Corresponds to the HTML "class" attribute.
tabindex | HTML: This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
timeout | Response waiting time on a particular request. If a response is not received during this time, the request is aborted
timeZone | Used for current date calculations. Default value is "getDefaultTimeZone()".
todayControlMode | This attribute defines the mode for "today" control. Possible values are "scroll", "select", "hidden". Default value is "select".
validator | JSF: 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 | 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 | JSF: The current value of this component
valueChangeListener | JSF: Listener for value changes
verticalOffset | Sets the vertical offset between button and calendar element conjunction point. Default value is "0".
weekDayLabels | List of the day names displays on the days bar in the following way "Sun, Mon, Tue, Wed, "
weekDayLabelsShort | Attribute that allows to customize short names of the weeks. Should accept list with the weeks names.
zindex | Attribute is similar to the standard HTML attribute and can specify window placement relative to the content. Default value is "3".

- Prev6.11. Rich Input
- Top of page
- Front page
- Next6.11.2. < rich:colorPicker > ...