Project Documentation


Tag name: <t:schedule>
UIComponent class: org.apache.myfaces.custom.schedule.HtmlSchedule
Tag class: org.apache.myfaces.custom.schedule.ScheduleTag
Component type: org.apache.myfaces.Schedule
Component family: javax.faces.Panel
Renderer type: org.apache.myfaces.Schedule
Renderer class: org.apache.myfaces.custom.schedule.ScheduleDelegatingRenderer

A schedule component similar to the ones found in Outlook or Evolution

Renders a schedule component, showing appointments and events in a day, workweek, week or month view, similar to the schedule part of MS Outlook or Evolution.

The component is backed by an implementation of the ScheduleModel interface. Creating a custom model can be easily achieved by implementing this interface, or by overriding the AbstractScheduleModel class.

AbstractHtmlSchedule class holds all properties specific to the HTML version of the Schedule component.

Screen Shot

Month mode

schedule month mode

Workweek mode

schedule workweek mode


<s:schedule [ UI component attributes ]
               [ UI command attributes ]


see the schedule.jsp example.


Name Type Supports EL? Description
action javax.faces.el.MethodBinding Yes
actionListener javax.faces.el.MethodBinding Only EL
backgroundClass String Yes
binding String Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
columnClass String Yes
compactMonthDayOfWeekDateFormat String Yes
compactMonthRowHeight int Yes
compactWeekRowHeight int Yes
contentClass String Yes
converter javax.faces.convert.Converter Yes
dateClass String Yes
dayClass String Yes
detailedRowHeight int Yes
enabledOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
entryClass String Yes
entryRenderer Object Yes
evenClass String Yes
expandToFitEntries boolean Yes
foregroundClass String Yes
freeClass String Yes
gutterClass String Yes
headerClass String Yes
headerDateFormat String Yes
holidayClass String Yes
hourNotation String Yes

Show dates in 24 hour notation or 12 hour notation.

hoursClass String Yes
id String Yes An identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

immediate boolean Yes
inactiveDayClass String Yes
minutesClass String Yes
monthClass String Yes
mouseListener javax.faces.el.MethodBinding Only EL
readonly boolean Yes
renderZeroLengthEntries boolean Yes
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
selectedClass String Yes
selectedEntryClass String Yes
splitWeekend boolean Yes
submitOnClick boolean Yes Should the parent form of this schedule be submitted when the user clicks on a day? Note that this will only work when the readonly property is set to false.
subtitleClass String Yes
textClass String Yes
theme String Yes
titleClass String Yes
tooltip boolean Yes
unevenClass String Yes
value Object Yes
visibleEndHour int Yes
visibleOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
visibleStartHour int Yes
weekClass String Yes the css class of the table representing a week in the compact mode (default: week)
workingEndHour int Yes
workingStartHour int Yes