Overview     Library     Tag     Help  
  FRAMES     NO FRAMES  

rich
Tag calendar

The <rich:calendar> component allows the user to enter a date and time through an in-line or pop-up calendar. The pop-up calendar can navigate through months and years, and its look and feel can be highly customized.

@author amarkhel

Tag Information
Component type org.richfaces.Calendar
Tag Name rich:calendar
Renderer Type org.richfaces.CalendarRenderer
Handler Class org.richfaces.view.facelets.CalendarHandler

Attributes
Name Required Type Description
binding false javax.faces.component.UIComponent The value binding expression used to wire up this component to a component property of a JavaBean class
boundaryDatesMode false 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 java.lang.String Space-separated list of CSS style class(es) to be applied to the button element. This value must be passed through as the "class" attribute on generated markup.
buttonDisabledIcon false java.lang.String Defines disabled icon for the popup button element. The attribute is ignored if the "buttonLabel" is set
buttonIcon false java.lang.String Defines icon for the popup button element. The attribute is ignored if the "buttonLabel" is set
buttonLabel false java.lang.String Defines label for the popup button element. If the attribute is set "buttonIcon" and "buttonIconDisabled" are ignored
converter false javax.faces.convert.Converter Converter instance registered with this component.
converterMessage false 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 java.lang.Object Defines the current date
dataModel false 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 java.lang.String Used to format the date and time strings, according to ISO 8601 (for example, d/M/yy HH:mm a)
dayClassFunction false java.lang.String The javascript function that determines the CSS style class for each day cell
dayDisableFunction false java.lang.String

The javascript function that enables or disables a day cell

defaultLabel false java.lang.String The starting label can be set when in the initial view state. If the initial value is already set through the value attribute, this is displayed instead.
defaultTime false 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 org.richfaces.component.Positioning

Set the direction of the popup. Possible values are:
AA (auto), LT (topLeft), RT (topRight), LB (bottomLeft), RB (bottomRight, LA (autoLeft), RA (autoRight), AT (topAuto), AB (bottomAuto)

Default value is auto

disabled false boolean

If "true", rendered is disabled. In "popup" mode both controls are disabled

Default value is "false"

enableManualInput false boolean

If "true" calendar input will be editable and it will be possible to change the date manually. If "false" the text field will be "read-only", so the value can be changed only from a handle.

Default value is "false"

firstWeekDay false int

Determines the first day of the week is; e.g., SUNDAY in the U.S., MONDAY in France. Possible values should be integers from 0 to 6, 0 corresponds to Sunday

Default value is "getDefaultFirstWeekDay()"

horizontalOffset false int

Sets the horizontal offset between popup element and the conjunction point

Default value is 0

id false java.lang.String The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediate false boolean Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase.
inputClass false java.lang.String Space-separated list of CSS style class(es) to be applied to the input element. This value must be passed through as the "class" attribute on generated markup.
inputSize false java.lang.String Defines the size of an input field. Similar to the "size" attribute of <h:inputText/>
inputStyle false java.lang.String CSS style(s) to be applied to the input element
jointPoint false org.richfaces.component.Positioning

Set the corner attachment point with which the popup should be connected. Possible values are:
AA (auto), LT (topLeft), RT (topRight), LB (bottomLeft), RB (bottomRight, LA (autoLeft), RA (autoRight), AT (topAuto), AB (bottomAuto)

Default value is auto

locale false java.lang.Object

Used for locale definition

Default value is "getDefaultLocale()"

minDaysInFirstWeek false 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 org.richfaces.component.AbstractCalendar.Mode

Valid values: ajax or client

Default value is "client"

monthLabels false java.lang.Object Attribute that allows to customize names of the months. Should accept list with the month names
monthLabelsShort false java.lang.Object Attribute that allows to customize short names of the months. Should accept list with the month names
onbeforecurrentdateselect false java.lang.String The client-side script method to be called before the current month or year is changed
onbeforedateselect false java.lang.String The client-side script method to be called before some date cell is selected
onbeforetimeselect false java.lang.String The client-side script method to be called before time is selected
onchange false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus.
onclean false java.lang.String The client-side script method to be called before the component is cleaned
oncomplete false java.lang.String The client-side script method to be called after the DOM is updated
oncurrentdateselect false java.lang.String The client-side script method to be called when the current month or year is changed
ondatemouseout false java.lang.String The client-side script method to be called when a pointer is moved away from the date cell
ondatemouseover false java.lang.String The client-side script method to be called when a pointer is moved onto the date cell
ondateselect false java.lang.String The client-side script method to be called when some date cell is selected
onhide false java.lang.String The client-side code executed after the popup disappears.
oninputblur false java.lang.String Javascript code executed when the input element loses focus.
oninputchange false java.lang.String Javascript code executed when the input field value is changed manually
oninputclick false java.lang.String Javascript code executed when a pointer button is clicked over the input element.
oninputdblclick false java.lang.String Javascript code executed when a pointer button is double clicked over the input element.
oninputfocus false java.lang.String Javascript code executed when the input element receives focus.
oninputkeydown false java.lang.String Javascript code executed when a key is pressed down over the input element.
oninputkeypress false java.lang.String Javascript code executed when a key is pressed and released over the input element.
oninputkeyup false java.lang.String Javascript code executed when a key is released over the input element.
oninputmousedown false java.lang.String Javascript code executed when a pointer button is pressed down over the input element.
oninputmousemove false java.lang.String Javascript code executed when a pointer button is moved within the input element.
oninputmouseout false java.lang.String Javascript code executed when a pointer button is moved away from the input element.
oninputmouseover false java.lang.String Javascript code executed when a pointer button is moved onto the input element.
oninputmouseup false java.lang.String Javascript code executed when a pointer button is released over the input element.
oninputselect false java.lang.String Javascript code executed called when the input field value is selected
onshow false java.lang.String The client-side code executed after the popup is shown.
ontimeselect false java.lang.String The client-side script method to be called after time is selected
popup false boolean

If "true", the calendar will be rendered initially as hidden with additional elements for calling as popup

Default value is "true"

popupClass false java.lang.String Space-separated list of CSS style class(es) to be applied to the popup element. This value must be passed through as the "class" attribute on generated markup.
popupStyle false java.lang.String CSS style(s) to be applied to the popup element
preloadDateRangeBegin false java.lang.Object

Defines the last range of date which will be loaded to client from dataModel under rendering

Default value is "getDefaultPreloadEnd(getCurrentDateOrDefault())"

preloadDateRangeEnd false java.lang.Object

Define the initial range of date which will be loaded to client from dataModel under rendering

Default value is "getDefaultPreloadBegin(getCurrentDateOrDefault())"

rendered false boolean Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true.
required false boolean Flag indicating that the user is required to provide a submitted value for this input component.
requiredMessage false 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.
resetTimeOnDateSelect false boolean

If value is true then calendar should change time to defaultTime for newly-selected dates

Default value is "false"

showApplyButton false boolean

If false ApplyButton should not be shown

Default value is "false"

showFooter false boolean

If false Calendar's footer should not be shown

Default value is "true"

showHeader false boolean

If false Calendar's header should not be shown

Default value is "true"

showInput false 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 boolean

If false this bar should not be shown

Default value is "true"

showWeeksBar false boolean

If false this bar should not be shown

Default value is "true"

style false java.lang.String CSS style(s) to be applied when this component is rendered
styleClass false java.lang.String Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup.
tabindex false java.lang.String Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
timeZone false java.util.TimeZone

Used for current date calculations

Default value is "getDefaultTimeZone()"

todayControlMode false java.lang.String

This attribute defines the mode for "today" control. Possible values are "scroll", "select", "hidden"

Default value is "select"

validator false javax.faces.el.MethodBinding MethodExpression representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void.
validatorMessage false 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 java.lang.Object The current value of this component.
valueChangeListener false javax.faces.el.MethodBinding

MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed".

verticalOffset false int

Sets the vertical offset between popup element and the conjunction point

Default value is 0

weekDayLabels false java.lang.Object List of the day names displays on the days bar in the following way "Sun, Mon, Tue, Wed,"
weekDayLabelsShort false java.lang.Object Attribute that allows to customize short names of the weekdays. Should accept list with the weekday's names.
zindex false int Attribute is similar to the standard HTML attribute and can specify window placement relative to the content. Default value is "3".

  Overview     Library     Tag     Help  
  FRAMES     NO FRAMES  
Output Generated by Tag Library Documentation Generator.