| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Schedule |
| Handler Class | None |
| Renderer Type | org.primefaces.component.ScheduleRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
allDaySlot | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Determines if all-day slot will be displayed in agendaWeek or agendaDay views. Default is true. |
aspectRatio | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Double)
| Ratio of calendar width to height, higher the value shorter the height is. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
centerHeaderTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Content of center of header. Default is title. |
clientTimeZone | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Timezone to define how to interpret the dates at browser. Valid values are "local", "UTC" and ids like "America/Chicago", defaults to "local". |
columnFormat | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Deprecated, use columnHeaderFormat instead. Format for column headers. |
columnHeaderFormat | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Format for column headers. (eg `timeGridWeek: {weekday: 'narrow'}` or `timeGridWeek: {weekday: 'short'}, timeGridDay: {day: 'numeric'}`) |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Defines direction of schedule. Valid values are "ltr" (default) and "rtl". |
displayEventEnd | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Whether or not to display an event's end time text when it is rendered on the calendar. Value can be a boolean to globally configure for all views or a comma separated list such as "month:false,basicWeek:true" to configure per view. |
draggable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, events are draggable. Default is true. |
extender | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of javascript function to extend the options of the underlying fullcalendar plugin. |
height | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Sets the height of the entire calendar, including header and footer. By default, this option is unset and the calendar's height is calculated by aspectRatio. If "auto" is specified, the view's contents will assume a natural height and no scrollbars will be used. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
initialDate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| The initial date that is used when schedule loads. If ommitted, the schedule starts on the current date. |
leftHeaderTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Content of left side of header. Default is "prev, next today" |
locale | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| User locale for i18n localization messages. The attribute can be either a String or java.util.Locale object. |
maxTime | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Maximum time to display in a day view. Default is 24:00:00. |
minTime | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Minimum time to display in a day view. Default is 00:00:00. |
nextDayThreshold | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| When an event's end time spans into another day, the minimum time it must be in order for it to render as if it were on that day. Default is 09:00:00. |
noOpener | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Whether for URL events access to the opener window from the target site should be prevented (phishing protection), default value is true. |
rendered | false | jakarta.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. |
resizable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When true, events are resizable. Default is true. |
rightHeaderTemplate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Content of right side of header. Default is "dayGridMonth,timeGridWeek,timeGridDay" |
scrollTime | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Determines how far down the scroll pane is initially scrolled down. Default is 06:00:00. |
selectable | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Enables selection of time ranges by clicking and dragging on the schedule, see https://fullcalendar.io/docs/select-callback. Uses the ajax-event "rangeSelect" instead of "dateSelect". |
showHeader | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies visibility of header content. Default is true. |
showWeekends | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Specifies inclusion Saturday/Sunday columns in any of the views. Default is true. |
showWeekNumbers | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Display week numbers in schedule. |
slotDuration | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The frequency for displaying time slots. Default is 00:30:00. |
slotEventOverlap | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true contemporary events will be rendered one overlapping the other, else they will be rendered side by side. |
slotLabelFormat | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Determines the text that will be displayed within a time slot. |
slotLabelInterval | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| TThe frequency that the time slots should be labelled with text. Example: like "01:00" or "{hours:1}". |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style of the main container element of schedule. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the main container element of schedule. |
timeFormat | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Determines the time-text that will be displayed on each event. (Moment.js - format) |
timeZone | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| String or a java.util.TimeZone instance to specify the timezone used for date conversion to ISO_8601 format, defaults to ZoneId.systemDefault(). |
tooltip | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays description of events on a tooltip, default value is false. |
urlTarget | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Target for events with urls. Clicking on such events in the schedule will not trigger the selectEvent but open the url using this target instead. Default is "_blank". |
value | false | jakarta.el.ValueExpression
(must evaluate to org.primefaces.model.ScheduleModel)
| An org.primefaces.model.ScheduleModel instance representing the backed model. |
view | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The view type to use, possible values are 'dayGridMonth', 'dayGridWeek', 'dayGridDay', 'timeGridWeek', 'timeGridDay', 'listYear' , 'listMonth', 'listWeek', 'listDay'. Default is 'dayGridMonth'. |
weekNumberCalculation | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The method for calculating week numbers that are displayed. Valid values are "local" (default), "ISO" and "custom". |
weekNumberCalculator | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side function to use in custom weekNumberCalculation. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.