Create new RichFaces Documentation Jira issue

This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.orgCommunity Documentation

6.11.1.  < rich:calendar > available since 3.1.0

Table 6.317. rich : calendar attributes

Attribute Name Description
ajaxSingleboolean 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
boundaryDatesModeThis 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".
buttonClassAssigns one or more space-separated CSS class names to the component popup button
buttonIconDefines icon for the popup button element. The attribute is ignored if the "buttonLabel" is set
buttonIconDisabledDefines disabled icon for the popup button element. The attribute is ignored if the "buttonLabel" is set
buttonLabelDefines label for the popup button element. If the attribute is set "buttonIcon" and "buttonIconDisabled" are ignored
bypassUpdatesIf "true", after process validations phase it skips updates of model beans on a force render response. It can be used for validating components input
cellHeightattribute to set fixed cells height
cellWidthattribute to set fixed cells width
converter JSF: Id of Converter to be used or reference to a Converter
converterMessageA ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter
currentDateDefines current date
currentDateChangeListenerMethodExpression representing an action listener method that will be notified after date selection
dataModelUsed to provide data for calendar elements. If data is not provided, all Data Model related functions are disabled
datePatternDefines date pattern. Default value is "MMM d, yyyy".
dayStyleClassShould be binded to some JS function that will provide style classes for special sets of days highlighting
defaultTimeDefines 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()"
directionDefines direction of the calendar popup ("top-left", "top-right", "bottom-left", "bottom-right" (Default), "auto"). Default value is "bottom-right".
disabledHTML: If "true", rendered is disabled. In "popup" mode both controls are disabled. Default value is "false".
enableManualInputIf "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".
eventsQueueName 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.)
firstWeekDayGets 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
focusID of an element to set focus after request is completed on client side
horizontalOffsetSets 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
ignoreDupResponsesAttribute 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
immediateA 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
inputClassAssigns one or more space-separated CSS class names to the component input field
inputSizeDefines the size of an input field. Similar to the "size" attribute of <h:inputText/>
inputStyleCSS style rules to be applied to the component input field
isDayEnabledShould be binded to some JS function that returns day state
jointPointSet 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".
labelA localized user presentable name for this component.
limitToListIf "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.
localeUsed for locale definition. Default value is "getDefaultLocale()".
minDaysInFirstWeekGets 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()".
modeValid values: ajax or client. Default value is "client".
monthLabelsAttribute that allows to customize names of the months. Should accept list with the month names
monthLabelsShortAttribute that allows to customize short names of the months. Should accept list with the month names
onbeforedomupdateThe client-side script method to be called before DOM is updated
onchangedThe client-side script method to be called when the date or time is changed and applied to input
oncollapseThe client-side script method to be called before the calendar popup is closed
oncompleteThe client-side script method to be called after the request is completed
oncurrentdateselectThe client-side script method to be called when the current month or year is changed
oncurrentdateselectedThe client-side script method to be called after the current month or year is changed
ondatemouseoutThe client-side script method to be called when a pointer is moved away from the date cell
ondatemouseoverThe client-side script method to be called when a pointer is moved onto the date cell
ondateselectThe client-side script method to be called when some date cell is selected
ondateselectedThe client-side script method to be called after some date cell is selected
onexpandThe client-side script method to be called before the calendar popup is opened
oninputblurThe client-side script method to be called when the input field loses the focus
oninputchangeThe client-side script method to be called when the input field value is changed manually
oninputclickThe client-side script method to be called when the input field is clicked
oninputfocusThe client-side script method to be called when the input field gets the focus
oninputkeydownThe client-side script method to be called when a key is pressed down in the input field
oninputkeypressThe client-side script method to be called when a key is pressed and released in the input field
oninputkeyupThe client-side script method to be called when a key is released in the input field
oninputmouseoutThe client-side script method to be called when a pointer is moved away from the input field
oninputmouseoverThe client-side script method to be called when a pointer is moved onto the input field
oninputselectThe client-side script method to be called when the input field value is selected
ontimeselectThe client-side script method to be called before new time is selected
ontimeselectedThe client-side script method to be called after time is selected
popupIf "true", the calendar will be rendered initially as hidden with additional elements for calling as popup. Default value is "true".
preloadDateRangeBeginDefine the initial range of date which will be loaded to client from dataModel under rendering. Default value is "getDefaultPreloadBegin(getCurrentDateOrDefault())".
preloadDateRangeEndDefines the last range of date which will be loaded to client from dataModel under rendering. Default value is "getDefaultPreloadEnd(getCurrentDateOrDefault())".
processId['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
readonlyHTML: 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
requestDelayAttribute 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
requiredMessageA ValueExpression enabled attribute which defines text of validation message to show, if a required field is missing
reRenderId['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
resetTimeOnDateSelectIf value is true then calendar should change time to defaultTime for newly-selected dates. Default value is "false"
showApplyButtonIf false ApplyButton should not be shown. Default value is "false".
showFooterIf false Calendar's footer should not be shown. Default value is "true".
showHeaderIf 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".
showWeekDaysBarIf false this bar should not be shown. Default value is "true".
showWeeksBarIf false this bar should not be shown. Default value is "true".
similarityGroupingIdIf there are any component requests with identical IDs then these requests will be grouped.
statusID (in format of call UIComponent.findComponent()) of Request status component
styleHTML: 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.
tabindexHTML: 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
timeoutResponse waiting time on a particular request. If a response is not received during this time, the request is aborted
timeZoneUsed for current date calculations. Default value is "getDefaultTimeZone()".
todayControlModeThis 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
validatorMessageA 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
verticalOffsetSets the vertical offset between button and calendar element conjunction point. Default value is "0".
weekDayLabelsList of the day names displays on the days bar in the following way "Sun, Mon, Tue, Wed, "
weekDayLabelsShortAttribute that allows to customize short names of the weeks. Should accept list with the weeks names.
zindexAttribute is similar to the standard HTML attribute and can specify window placement relative to the content. Default value is "3".


The "popup" attribute defines calendar representation mode on a page. If it's "true" the calendar is represented on a page as an input field and a button. Clicking on the button calls the calendar popup as it's shown on the picture below. For popup rendering a "lazy" loading is implemented: after the request is completed a client side script method builds the popup. Such improvement speeds up page loading time.


Usage "currentDate" attribute isn't available in the popup mode.

With help of the "currentDate" attribute you can define month and year which will be displayed currently.

The "value" attribute stores selected date currently.

The difference between the value and currentDate attributes

The "todayControlMode" attribute defines the mode for "today" control. Possible values are:

  • "hidden" - in this mode "Today" button will not be displayed

  • "select" - (default) in this state "Today" button activation will scroll the calendar to the current date and it become selected date

  • "scroll" - in this mode "Today" activation will simply scroll the calendar to current month without changing selected day.

With the help of the "readonly" attribute you can make date, time and input field unavailable, but you can look through the next/previous month or the next/previous year.

In order to disable the component, use the "disabled" attribute. With its help both controls are disabled in the "popup" mode.


The <rich:calendar> component can render pages of days in two modes. A mode could be defined with the "mode" attribute with two possible parameters: "ajax" and "client". Default value is "client".

  • Ajax

Calendar requests portions of data from Data Model for a page rendering. If "dataModel" attribute has "null" value, data requests are not sent. In this case the "ajax" mode is equal to the "client".

  • Client

Calendar loads an initial portion of data in a specified range and use this data to render months. Additional data requests are not sent.

Note:

"preloadDateRangeBegin" and "preloadDateRangeEnd" attributes were designed only for the "client" mode to load some data initially.

"ondateselect" attribute is used to define an event that is triggered before date selection.

The "ondateselected" attribute is used to define an event that is triggered after date selection.

For example, to fire some event after date selection you should use <a4j:support> . And it should be bound to "ondateselected" event as it's shown in the example below:


...
<rich:calendar id="date" value="#{bean.dateTest}">
          <a4j:support event="ondateselected" reRender="mainTable"/>
</rich:calendar>
...

Note:

When a timePicker was fulfilled, the "ondateselected" attribute does not allow you to submit a selected date. It happens because this event rose when the date is selected but the input hasn't been updated with new value yet.

"ondateselect" could be used for possibility of date selection canceling. See an example below:


...
<rich:calendar id="date" value="#{bean.dateTest}" ondateselect="if (!confirm('Are you sure to change date?')){return false;}"/>
...

"oncurrentdateselected" event is fired when the "next/previous month" or "next/previous year" button is pressed, and the value is applied.

"oncurrentdateselect" event is fired when the "next/previous month" or "next/previous year" button is pressed, but the value is not applied yet (you can change the logic of applying the value). Also this event could be used for possibility of "next/previous month" or "next/previous year" selection canceling. See an example below:

Example:


...
<rich:calendar id="date" value="#{bean.dateTest}" oncurrentdateselect="if (!confirm('Are you sure to change month(year)?')){return false;}"
          oncurrentdateselected="alert('month(year) select:'+event.rich.date.toString());"/>
...

How to use these attributes see also on the RichFaces Users Forum.

Information about the "process" attribute usage you can find in the corresponding section .

There are three button-related attributes:

  • "buttonLabel" defines a label for the button. If the attribute is set "buttonIcon" and "buttonIconDisabled" are ignored

  • "buttonIcon" defines an icon for the button

  • "buttonIconDisabled" defines an icon for the disabled state of the button

The "direction" and "jointPoint" attributes are used for defining aspects of calendar appearance.

The possible values for the "direction" are:

  • "top-left" - a calendar drops to the top and left

  • "top-right" - a calendar drops to the top and right

  • "bottom-left" - a calendar drops to the bottom and left

  • "bottom-right" - a calendar drops to the bottom and right

  • "auto" - smart positioning activation

By default, the "direction" attribute is set to "bottom-right".

The possible values for the "jointPoint" are:

  • "top-left" - a calendar docked to the top-left point of the button element

  • "top-right" - a calendar docked to the top-right point of the button element

  • "bottom-left" - a calendar docked to the bottom-left point of the button element

  • "bottom-right" - a calendar docked to the bottom-right point of the button element

  • "auto" - smart positioning activation

By default, the "jointPoint" attribute is set to "bottom-left".

The "label" attribute is a generic attribute. The "label" attribute provides an association between a component, and the message that the component (indirectly) produced. This attribute defines the parameters of localized error and informational messages that occur as a result of conversion, validation, or other application actions during the request processing lifecycle. With the help of this attribute you can replace the last parameter substitution token shown in the messages. For example, {1} for "DoubleRangeValidator.MAXIMUM", {2} for "ShortConverter.SHORT".

The "defaultTime" attribute to set the default time value for the current date in two cases:

  • If time is not set

  • If another date is selected and the value of the "resetTimeOnDateSelect" attribute is set to "true"

The "enableManualInput" attribute enables/disables input field, so when enableManualInput = "false" , user can only pick the date manually and has no possibility to type in the date (default value is "false").

The <rich:calendar> component allows to use "header" , "footer" , "optionalHeader" , "optionalFooter" facets. The following elements are available in these facets: {currentMonthControl}, {nextMonthControl}, {nextYearControl}, {previousYearControl}, {previousMonthControl}, {todayControl}, {selectedDateControl}. These elements could be used for labels output.

Also you can use "weekNumber" facet with available {weekNumber}, {elementId} elements and "weekDay" facet with {weekDayLabel}, {weekDayLabelShort}, {weekDayNumber}, {isWeekend}, {elementId} elements. {weekNumber}, {weekDayLabel}, {weekDayLabelShort}, {weekDayNumber} elements could be used for labels output, {isWeekend}, {elementId} - for additional processing in JavaScript code.

These elements are shown on the picture below.


Simple example of usage is placed below.

Example:


...
<!-- Styles for cells -->
<style>
    
.width100{
        
width:100%;
    
}
    
.talign{
        
text-align:center;
    
}
</style>
...

...
<rich:calendar id="myCalendar" popup="true" locale="#{calendarBean.locale}" value="#{bean.date}"
                            preloadRangeBegin="#{bean.date}" preloadRangeEnd="#{bean.date}" cellWidth="40px" cellHeight="40px">

    <!-- Customization with usage of facets and accessible elements -->
    <f:facet name="header">
        <h:panelGrid columns="2" width="100%" columnClasses="width100, fake">
            <h:outputText value="{selectedDateControl}" />
            <h:outputText value="{todayControl}"  style="font-weight:bold; text-align:left"/>
        </h:panelGrid>
    </f:facet>
    <f:facet name="weekDay">
        <h:panelGroup style="width:60px; overflow:hidden;" layout="block">
            <h:outputText value="{weekDayLabelShort}"/>
        </h:panelGroup>
    </f:facet>
    <f:facet name="weekNumber">
         <h:panelGroup>
            <h:outputText value="{weekNumber}" style="color:red"/>
        </h:panelGroup>
     </f:facet>
     <f:facet name="footer">
        <h:panelGrid columns="3" width="100%" columnClasses="fake, width100 talign">
            <h:outputText value="{previousMonthControl}" style="font-weight:bold;"/>
            <h:outputText value="{currentMonthControl}" style="font-weight:bold;"/>
            <h:outputText value="{nextMonthControl}" style="font-weight:bold;"/>
        </h:panelGrid>
    </f:facet>
    <h:outputText value="{day}"></h:outputText>
</rich:calendar>
...

This is a result:


As it's shown on the picture above {selectedDateControl}, {todayControl} elements are placed in the "header" facet, {previousMonthControl}, {currentMonthControl}, {nextMonthControl} - in the "footer" facet, {weekDayLabelShort} - in the "weekDay" facet, {nextYearControl}, {previousYearControl} are absent. Numbers of weeks are red colored.

It is possible to show and manage date. Except scrolling controls you can use quick month and year selection feature. It's necessary to click on its field, i.e. current month control, and choose required month and year.


Also the <rich:calendar> component allows to show and manage time. It's necessary to define time in a pattern (for example, it could be defined as "d/M/yy HH:mm"). Then after you choose some data in the calendar, it becomes possible to manage time for this date. For time editing it's necessary to click on its field (see a picture below). To clean the field click on the "Clean".


It's possible to handle events for calendar from JavaScript code. A simplest example of usage JavaScript API is placed below:

Example:


...
<rich:calendar value="#{calendarBean.selectedDate}" id="calendarID"
                        locale="#{calendarBean.locale}"
                        popup="#{calendarBean.popup}"
                        datePattern="#{calendarBean.pattern}"
                        showApplyButton="#{calendarBean.showApply}" style="width:200px"/>
<a4j:commandLink onclick="$('formID:calendarID').component.doExpand(event)" value="Expand"/>
...

Also the discussion about this problem can be found on the RichFaces Users Forum.

The <rich:calendar> component provides the possibility to use a special Data Model to define data for element rendering. Data Model includes two major interfaces:

CalendarDataModel provides the following function:

  • CalendarDataModelItem[] getData(Date[]);

This method is called when it's necessary to represent the next block of CalendarDataModelItem. It happens during navigation to the next (previous) month or in any other case when calendar renders. This method is called in "Ajax" mode when the calendar renders a new page.

CalendarDataModelItem provides the following function:

  • Date getDate() - returns date from the item. Default implementation returns date.

  • Boolean isEnabled() - returns "true" if date is "selectable" on the calendar. Default implementation returns "true".

  • String getStyleClass() - returns string appended to the style class for the date span. For example it could be "relevant holyday". It means that the class could be defined like the "rich-cal-day-relevant-holyday" one. Default implementation returns empty string.

  • Object getData() - returns any additional payload that must be JSON-serializable object. It could be used in the custom date representation on the calendar (inside the custom facet).

The <rich:calendar> component provides the possibility to use internationalization method to redefine and localize the labels. You could use application resource bundle and define RICH_CALENDAR_APPLY_LABEL, RICH_CALENDAR_TODAY_LABEL, RICH_CALENDAR_CLOSE_LABEL, RICH_CALENDAR_OK_LABEL, RICH_CALENDAR_CLEAN_LABEL, RICH_CALENDAR_CANCEL_LABEL there.

You could also pack org.richfaces.renderkit.calendar resource bundle with your JARs defining the same properties.

Note:

Only for Internet Explorer 6 and later. To make <rich:calendar> inside <rich:modalPanel> rendered properly, enable the standards-compliant mode. Explore !DOCTYPE reference at MSDN to find out how to do this.






















On the screenshot there are classes names that define styles for component elements.










In order to redefine styles for all <rich:calendar> components on a page using CSS, it's enough to create classes with the same names (possible classes could be found in the tables above) and define necessary properties in them.

Example:


...
.rich-calendar-today {
    
background-color: #FF0000;
}
...

This is a result:


In the example an active cell background color was changed.

Also it's possible to change styles of particular <rich:calendar> component. In this case you should create own style classes and use them in corresponding <rich:calendar> styleClass attributes. An example is placed below:

Example:


...
.myFontClass{
    
font-style: italic;
}
...

The "inputClass" attribute for <rich:calendar> is defined as it's shown in the example below:

Example:


<rich:calendar ... inputClass="myFontClass"/>

This is a result:


As it could be seen on the picture above, the font style for output text was changed.

On the component LiveDemo page you can see the example of <rich:calendar> usage and sources for the given example.

How to use JavaScript API see on the RichFaces Users Forum.