| Info | Value |
|---|---|
| Component Type | org.primefaces.component.Schedule |
| Display Name | None |
| Handler Class | None |
| Renderer Type | org.primefaces.component.ScheduleRenderer |
| 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. |
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)
| Locale for localization, can be String or a java.util.Locale instance. |
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 'month', 'agendaDay', 'agendaWeek', 'basicWeek', 'basicDay'. Default is month. |
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 "month, agendaWeek, agendaDay" |
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. |
slotMinutes | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| Interval in minutes in an hour to create a slot. Default is 30. |
firstHour | false | javax.el.ValueExpression
(must evaluate to java.lang.Integer)
| First hour to display in day view. Default is 6. |
minTime | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Minimum time to display in a day view. |
maxTime | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Maximum time to display in a day view. |
axisFormat | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Determines the time-text that will be displayed on the vertical axis of the agenda views. |
timeFormat | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Determines the time-text that will be displayed on each event. |
columnFormat | false | javax.el.ValueExpression
(must evaluate to java.lang.String)
| Format for column headers. |
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 "UTC". |
ignoreTimezone | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When parsing dates, whether UTC offsets should be ignored while processing event data. Default is true |
tooltip | false | javax.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Displays description of events on a tooltip, default value is false. |
Output generated by Vdldoc View Declaration Language Documentation Generator.