schedule (VDL Documentation Generator - Generated Documentation)

Description:

Schedule provides an Outlook Calendar, iCal like JSF component to manage events. Schedule is highly customizable featuring various views (month, day, week), built-in I18N, drag-drop, resize, customizable event dialog and skinning.

Component Information
Info	Value
Component Type	`org.primefaces.component.Schedule`
Handler Class	None
Renderer Type	`org.primefaces.component.ScheduleRenderer`
Description	None

Attributes
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.
`widgetVar`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of the client side widget.
`value`	`false`	`javax.el.ValueExpression` (must evaluate to `org.primefaces.model.ScheduleModel`)	An org.primefaces.model.ScheduleModel instance representing the backed model.
`locale`	`false`	`javax.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.
`aspectRatio`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Double`)	Ratio of calendar width to height, higher the value shorter the height is.
`view`	`false`	`javax.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'.
`initialDate`	`false`	`javax.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.
`showWeekends`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies inclusion Saturday/Sunday columns in any of the views. Default is true.
`style`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Style of the main container element of schedule.
`styleClass`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Style class of the main container element of schedule.
`draggable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When true, events are draggable. Default is true.
`resizable`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	When true, events are resizable. Default is true.
`showHeader`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Specifies visibility of header content. Default is true.
`leftHeaderTemplate`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Content of left side of header. Default is "prev, next today"
`centerHeaderTemplate`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Content of center of header. Default is title.
`rightHeaderTemplate`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Content of right side of header. Default is "dayGridMonth,timeGridWeek,timeGridDay"
`allDaySlot`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Determines if all-day slot will be displayed in agendaWeek or agendaDay views. Default is true.
`slotDuration`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	The frequency for displaying time slots. Default is 00:30:00.
`scrollTime`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Determines how far down the scroll pane is initially scrolled down. Default is 06:00:00.
`minTime`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Minimum time to display in a day view. Default is 00:00:00.
`maxTime`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Maximum time to display in a day view. Default is 24:00:00.
`slotLabelInterval`	`false`	`javax.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}".
`timeFormat`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Determines the time-text that will be displayed on each event. (Moment.js - format)
`columnFormat`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Deprecated, use columnHeaderFormat instead. Format for column headers.
`columnHeaderFormat`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Format for column headers. (eg "week:'dd DD MMM'" or "timeGridWeek: 'DD MM', timeGridDay: 'dd'")
`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 to ISO_8601 format, defaults to ZoneId.systemDefault().
`clientTimeZone`	`false`	`javax.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".
`tooltip`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Displays description of events on a tooltip, default value is false.
`showWeekNumbers`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Display week numbers in schedule.
`extender`	`false`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Name of javascript function to extend the options of the underlying fullcalendar plugin.
`displayEventEnd`	`false`	`javax.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.
`weekNumberCalculation`	`false`	`javax.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`	`javax.el.ValueExpression` (must evaluate to `java.lang.String`)	Client side function to use in custom weekNumberCalculation.
`nextDayThreshold`	`false`	`javax.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.
`slotEventOverlap`	`false`	`javax.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.
`urlTarget`	`false`	`javax.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".
`noOpener`	`false`	`javax.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.

primefaces-p

Tag schedule