| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Calendar |
| Handler Class | None |
| Renderer Type | org.primefaces.component.CalendarRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
rendered | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
binding | false | javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
value | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
converter | false | javax.el.ValueExpression
(must evaluate to java.faces.convert.Converter)
| An el expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
immediate | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component. Default is false. |
required | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
validator | false | javax.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validationg the input. |
valueChangeListener | false | javax.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
requiredMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
converterMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
validatorMessage | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
accesskey | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Access key to transfer focus to the input element. |
alt | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate textual description of the input element. |
autocomplete | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Controls browser autocomplete behavior. |
dir | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. |
disabled | false | javax.el.ValueExpression
(must evaluate to boolean)
| Disables the input element, default is false. |
label | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name. |
lang | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name. |
maxlength | false | javax.el.ValueExpression
(must evaluate to int)
| Maximum number of characters that may be entered in this field. |
onblur | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus. |
onchange | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus and its value has been modified since gaining focus. |
onclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is clicked. |
ondblclick | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is double clicked. |
onfocus | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element receives focus. |
onkeydown | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed down over input element. |
onkeypress | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed and released over input element. |
onkeyup | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is released over input element. |
onmousedown | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is pressed down over input element. |
onmousemove | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved within input element. |
onmouseout | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved away from input element. |
onmouseover | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved onto input element. |
onmouseup | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is released over input element. |
onselect | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when text within input element is selected by user. |
readonly | false | javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that this input element will prevent changes by the user. |
size | false | javax.el.ValueExpression
(must evaluate to int)
| Number of characters used to determine the width of the input element. |
style | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the component. |
styleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
tabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the element in the tabbing order. |
title | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
placeholder | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| The placeholder attribute specifies a short hint that describes the expected value of an input field. |
widgetVar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
mindate | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Sets calendar's minimum visible date. |
maxdate | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Sets calendar's maximum visible date. |
pages | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Enables multiple page rendering. |
mode | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines how the calendar will be displayed. Default is popup |
pattern | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| DateFormat pattern for localization. |
locale | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Locale to be used for labels and conversion. |
navigator | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables month/year navigator. Default is false. |
timeZone | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| String or a java.util.TimeZone instance to specify the timezone used for date conversion, defaults to TimeZone.getDefault() |
readonlyInput | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Makes input text of a popup calendar readonly. Default is false. |
showButtonPanel | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Visibility of button panel containing today and done buttons. Default is false. |
effect | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Effect to use when displaying and showing the popup calendar. |
effectDuration | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Duration of the effect. Default is normal. |
showOn | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side event that displays the popup calendar. |
showWeek | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays the week number next to each week. Default is false. |
disabledWeekends | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Disables weekend columns. Default is false. |
showOtherMonths | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays days belonging to other months. Default is false. |
selectOtherMonths | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables selection of days belonging to other months. Default is false. |
yearRange | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Year range for the navigator, default is "c-10:c+10" |
timeOnly | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Shows only time picker without date. |
stepHour | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Hour steps, default is 1. |
stepMinute | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Minute steps, default is 1. |
stepSecond | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Second steps, default is 1. |
minHour | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Minimum boundary for hour selection. Default is 0. |
maxHour | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum boundary for hour selection. Default is 23. |
minMinute | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Minimum boundary for minute selection. Default is 0. |
maxMinute | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum boundary for minute selection. Default is 59. |
minSecond | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Minimum boundary for second selection. Default is 0. |
maxSecond | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Maximum boundary for second selection. Default is 59. |
pagedate | false | javax.el.ValueExpression
(must evaluate to java.lang.Object)
| Sets the initial date when value is not populated. |
beforeShowDay | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute before displaying a date, used to customize date display. |
mask | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines if a mask should be applied to the input field. Default value is "false" and valid values to enable are "true" that uses the pattern as the mask or a custom template. Refer to inputMask component for more information about custom templates. |
timeControlType | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Defines the type of element to use for time picker, valid values are "slider" , "select" and "custom"(with "timeControlObject" attribute). |
beforeShow | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Callback to execute before displaying calendar, element and calendar instance are passed as parameters. |
maskSlotChar | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| PlaceHolder in mask template. |
maskAutoClear | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Clears the field on blur when incomplete input is entered. |
timeControlObject | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Client side object to use in custom timeControlType. |
timeInput | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Allows direct input in time field. Default is false. |
showHour | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Whether to show the hour control, valid values are "true" and "false". |
showMinute | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Whether to show the minute control, valid values are "true" and "false". |
showSecond | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Whether to show the second control, valid values are "true" and "false". |
showMillisec | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Whether to show the millisecond control, valid values are "true" and "false". |
showTodayButton | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether to show the "Current Date" button if showButtonPanel is rendered. Default is "true". |
buttonTabindex | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the button in the tabbing order. |
inputStyle | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the input element. Used when mode is popup. |
inputStyleClass | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the input element. Used when mode is popup. |
type | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Input field type. Default is text. |
focusOnSelect | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If enabled, the input is focused again after selecting a date. Default is false. |
oneLine | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Try to show the time dropdowns all on one line. This should be used with controlType 'select'. |
Output generated by Vdldoc View Declaration Language Documentation Generator.