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)
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 false false javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
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)
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 false false javax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component 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))
MethodExpression 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. Default value is "MMM d, yyyy".
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
defaultTime false false javax.el.ValueExpression
(must evaluate to java.lang.Object)
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 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"). Default value is "bottom-right".
disabled false false javax.el.ValueExpression
(must evaluate to boolean)
If "true", rendered is disabled. In "popup" mode both controls are disabled. Default value is "false".
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. Default value is "false".
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.)
firstWeekDay false false javax.el.ValueExpression
(must evaluate to int)
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 false false javax.el.ValueExpression
(must evaluate to java.lang.String)
ID of an element to set focus after request is 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. Default value is "0".
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)
Assigns one or more space-separated CSS class names to the component input 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)
CSS style rules to be applied to the component input 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). Default value is "bottom-left".
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", 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 false false javax.el.ValueExpression
(must evaluate to java.lang.Object)
Used for locale definition. Default value is "getDefaultLocale()".
minDaysInFirstWeek false false javax.el.ValueExpression
(must evaluate to int)
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 false false javax.el.ValueExpression
(must evaluate to java.lang.String)
Valid values: ajax or client. Default value is "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)
The client-side script method to be called before DOM is updated
onchanged false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the date or time is changed and applied to input
oncollapse false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before the calendar popup is closed
oncomplete false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called after the request is completed
oncurrentdateselect false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the current month or year is changed
oncurrentdateselected false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called after the current month or year is changed
ondatemouseout false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved away from the date cell
ondatemouseover false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved onto the date cell
ondateselect false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when some date cell is selected
ondateselected false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called after some date cell is selected
onexpand false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before the calendar popup is opened
oninputblur false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the input field loses the focus
oninputchange false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the input field value is changed manually
oninputclick false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the input field is clicked
oninputfocus false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the input field gets the focus
oninputkeydown false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is pressed down in the input field
oninputkeypress false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is pressed and released in the input field
oninputkeyup false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a key is released in the input field
oninputmouseout false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved away from the input field
oninputmouseover false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when a pointer is moved onto the input field
oninputselect false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called when the input field value is selected
ontimeselect false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called before new time is selected
ontimeselected false false javax.el.ValueExpression
(must evaluate to java.lang.String)
The client-side script method to be called after time is selected
popup false false javax.el.ValueExpression
(must evaluate to boolean)
If "true", the calendar will be rendered initially as hidden with additional elements for calling as popup. Default value is "true".
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. Default value is "getDefaultPreloadBegin(getCurrentDateOrDefault())".
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. Default value is "getDefaultPreloadEnd(getCurrentDateOrDefault())".
process false false javax.el.ValueExpression
(must evaluate to java.lang.Object)
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
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
readonly false false javax.el.ValueExpression
(must evaluate to boolean)
If "true". Date and time are not selectable. In "popup" mode input is disabled and button is enabled. Default value is "false".
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 which defines text of validation message to show, if a required field is missing
resetTimeOnDateSelect false false javax.el.ValueExpression
(must evaluate to boolean)
If value is true then calendar should change time to defaultTime for newly-selected dates. Default value is "false"
showApplyButton false false javax.el.ValueExpression
(must evaluate to boolean)
If false ApplyButton should not be shown. Default value is "false".
showFooter false false javax.el.ValueExpression
(must evaluate to boolean)
If false Calendar's footer should not be shown. Default value is "true".
showHeader false false javax.el.ValueExpression
(must evaluate to boolean)
If false Calendar's header should not be shown. Default value is "true".
showInput false false javax.el.ValueExpression
(must evaluate to boolean)
"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 false false javax.el.ValueExpression
(must evaluate to boolean)
If false this bar should not be shown. Default value is "true".
showWeeksBar false false javax.el.ValueExpression
(must evaluate to boolean)
If false this bar should not be shown. Default value is "true".
similarityGroupingId false false javax.el.ValueExpression
(must evaluate to java.lang.String)
If there are any component requests with identical IDs then these requests will be grouped.
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 rules to be applied to the component
styleClass false false javax.el.ValueExpression
(must evaluate to java.lang.String)
Assigns one or more space-separated CSS class names to the component. Corresponds to the HTML "class" attribute.
tabindex false false javax.el.ValueExpression
(must evaluate to java.lang.String)
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
timeZone false false javax.el.ValueExpression
(must evaluate to java.util.TimeZone)
Used for current date calculations. Default value is "getDefaultTimeZone()".
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)
This attribute defines the mode for "today" control. Possible values are "scroll", "select", "hidden". Default value is "select".
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 current value of this component
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. Default value is "0".
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. Default value is "3".