] > org.richfaces.Schedule org.richfaces.Schedule org.richfaces.component.html.HtmlSchedule org.richfaces.component.UISchedule org.richfaces.renderkit.ScheduleRenderer org.richfaces.renderkit.ScheduleRendererBase schedule org.richfaces.taglib.ScheduleTag org.ajax4jsf.webapp.taglib.HtmlComponentTagBase org.richfaces.taglib.ScheduleTagHandler org.richfaces.taglib.ScheduleTagHandlerBase &ui_component_attributes; &commonViewAttributes; &ajax_component_attributes; switchType java.lang.String Available options:
  • ajax
  • server
  • client
 "ajax" widgetVar java.lang.String Variable name of JavaScript component. default: null null view java.lang.String Schedule has a number of different "views", or ways of displaying days and events. The following 5 views are all built in to schedule:
  • month
  • basicWeek
  • basicDay
  • agendaWeek
  • agendaDay
default: 'month' null headerLeft java.lang.String Defines the buttons and title at the top of the calendar. Values separated by a comma will be displayed adjacently. Values separated by a space will be displayed with a small gap in between. Strings can contain any of the following values:
  • title - text containing the current month/week/day
  • prev - button for moving the calendar back one month/week/day
  • next - button for moving the calendar forward one month/week/day
  • prevYear - button for moving the calendar back on year
  • nextYear - button for moving the calendar forward one year
  • today - button for moving the calendar to the current month/week/day
  • a view name - button that will switch the calendar to any of the available views; see defaultView
default: 'title' null headerCenter java.lang.String Defines the buttons and title at the top of the calendar. Values separated by a comma will be displayed adjacently. Values separated by a space will be displayed with a small gap in between. Strings can contain any of the following values:
  • title - text containing the current month/week/day
  • prev - button for moving the calendar back one month/week/day
  • next - button for moving the calendar forward one month/week/day
  • prevYear - button for moving the calendar back on year
  • nextYear - button for moving the calendar forward one year
  • today - button for moving the calendar to the current month/week/day
  • a view name - button that will switch the calendar to any of the available views; see defaultView
default: '' null headerRight java.lang.String Defines the buttons and title at the top of the calendar. Values separated by a comma will be displayed adjacently. Values separated by a space will be displayed with a small gap in between. Strings can contain any of the following values:
  • title - text containing the current month/week/day
  • prev - button for moving the calendar back one month/week/day
  • next - button for moving the calendar forward one month/week/day
  • prevYear - button for moving the calendar back on year
  • nextYear - button for moving the calendar forward one year
  • today - button for moving the calendar to the current month/week/day
  • a view name - button that will switch the calendar to any of the available views; see defaultView
default: 'today prev,next' null allDaySlot java.lang.Boolean Determines if the "all-day" slot is displayed at the top of the calendar. When hidden with false, all-day events will not be displayed in agenda views. default: true null allDayText java.lang.String The text titling the "all-day" slot at the top of the calendar. default: 'all-day' null axisFormat java.lang.String Determines the time-text that will be displayed on the vertical axis of the agenda views. The default value will produce times that look like "5pm" and "5:30pm". default: 'h(:mm)tt' null slotMinutes java.lang.Integer The frequency for displaying time slots, in minutes. The default will make a slot every half hour. default: 30 null defaultEventMinutes java.lang.Integer Determines the length (in minutes) an event appears to be when it has an unspecified end date. By default, if an Event Object has no end, it will appear to be 2 hours. This option only affects events that appear in the agenda slots, meaning they have allDay set to true. default: 120 null firstHour java.lang.Integer Determines the first hour that will be visible in the scroll pane. Values must be from 0-23, where 0=midnight, 1=1am, etc. The user will be able to scroll upwards to see events before this time. If you want to prevent users from doing this, use the minTime option instead. default: 6 null minTime java.lang.String Determines the first hour/time that will be displayed, even when the scrollbars have been scrolled all the way up. This can be a number like 5 (which means 5am), a string like '5:30' (which means 5:30am) or a string like '5:30am'. default: 0 null maxTime java.lang.String Determines the last hour/time (exclusively) that will be displayed, even when the scrollbars have been scrolled all the way down. This can be a number like 22 (which means 10pm), a string like '22:30' (which means 10:30pm) or a string like '10:30pm'. default: 24 null firstDay java.lang.Integer The day that each week begins. The value must be a number that represents the day of the week. Sunday=0, Monday=1, Tuesday=2, etc. default: 0 null isRTL java.lang.Boolean Displays the calendar in right-to-left mode. default: false null showWeekends java.lang.Boolean Whether to include Saturday/Sunday columns in any of the calendar views. default: true null height java.lang.Integer Will make the entire calendar (including header) a pixel height. By default, this option is unset and the calendar's height is calculated by aspectRatio. null contentHeight java.lang.Integer Will make the calendar's content area a pixel height. By default, this option is unset and the calendar's height is calculated by aspectRatio. null aspectRatio java.lang.Double Determines the width-to-height aspect ratio of the calendar. A calendar is a block-level element that fills its entire avaiable width. The calendar’s height, however, is determined by this ratio of width-to-height. (Hint: larger numbers make smaller heights). default: 1.35 null allDayByDefault java.lang.Boolean Determines the default value for each Event Object's allDay property, when it is unspecified. default: true null editable java.lang.Boolean Determines whether the events on the calendar can be modified. This determines if the events can be dragged and resized. Enables/disables both at the same time. If you don't want both, use editable in conjunction with disableDragging and disableResizing. This option can be overridden on a per-event basis with the Event Object editable property. default: false null selectable java.lang.Boolean Allows a user to highlight multiple days or timeslots by clicking and dragging. To let the user make selections by clicking and dragging, this option must be set to true. default: false null selectHelper java.lang.Boolean Whether to draw a "placeholder" event while the user is dragging. A value of true will draw a "placeholder" event while the user is dragging (similar to what Google Calendar does for its week and day views). A value of false (the default) will draw the standard highlighting over each cell. default: false null unselectAuto java.lang.Boolean Whether clicking elsewhere on the page will cause the current selection to be cleared. This option can only take effect when selectable is set to true. default: true null unselectCancel java.lang.String A way to specify elements that will ignore the unselectAuto option. Clicking on elements that match this jQuery selector will prevent the current selection from being cleared (due to the unselectAuto option). This option is useful if you have a "Create an event" form that shows up in response to the user making a selection. When the user clicks on this form, you probably don't want to the current selection to go away. Thus, you should add a class to your form such as "my-form", and set the unselectAuto option to ".my-form". default: '' null disableDragging java.lang.Boolean Disables all event dragging, even when events are editable. default: false null disableResizing java.lang.Boolean Disables all event resizing, even when events are editable. default: false null dragRevertDuration java.lang.Integer Time in millisecond it takes for an event to revert to its original position after an unsuccessful drag. default: 500 null date java.util.Date The initial date when schedule loads. default: current date null onbeforeitemselect java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • event - javascript event
  • view - object representing current view
 null onitemselect java.lang.String JavaScript code called when ajax request triggered when item is selected has finished. Following data will be available in context:
  • item - selected item
  • event - javascript event
  • view - object representing current view
  • request - ajax request
  • data - data returned by ajax request
 null onitemdragstart java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • event - javascript event
  • ui - jQuery UI object
  • view - object representing current view
 null onitemdragstop java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • event - javascript event
  • ui - jQuery UI object
  • view - object representing current view
 null onitemresizestart java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • event - javascript event
  • ui - jQuery UI object
  • view - object representing current view
 null onitemresizestop java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • event - javascript event
  • ui - jQuery UI object
  • view - object representing current view
 null onbeforeitemdrop java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • dayDelta - holds the number of days the event was moved forward (a positive number) or backwards (a negative number)
  • minuteDelta - holds the number of minutes the event was moved forward (a positive number) or backwards (a negative number). Only useful for the agenda views. In other views, 0 is passed in.
  • allDay - is true if the event has been dropped on a day in month view, or the "all-day" slot in the agenda views. It will be false if dropped on a slot in the agenda views (meaning it has been assigned a time).
  • event - javascript event
  • ui - jQuery UI object
  • view - object representing current view
 null onitemdrop java.lang.String JavaScript code called when ajax request triggered when item is dropped has finished. Following data will be available in context:
  • item - selected item
  • dayDelta - holds the number of days the event was moved forward (a positive number) or backwards (a negative number)
  • minuteDelta - holds the number of minutes the event was moved forward (a positive number) or backwards (a negative number). Only useful for the agenda views. In other views, 0 is passed in.
  • allDay - is true if the event has been dropped on a day in month view, or the "all-day" slot in the agenda views. It will be false if dropped on a slot in the agenda views (meaning it has been assigned a time).
  • vetoed - is true if server side listener has raised veto and modification has been reverted
  • event - javascript event
  • ui - jQuery UI object
  • view - object representing current view
  • request - ajax request
  • data - data returned by ajax request
 null onbeforeitemresize java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • dayDelta - holds the number of days the event was moved forward (a positive number) or backwards (a negative number)holds the number of minutes the event was moved forward (a positive number) or backwards (a negative number). Only useful for the agenda views. In other views, 0 is passed in.
  • minuteDelta - holds the number of minutes the event was moved forward (a positive number) or backwards (a negative number). Only useful for the agenda views. In other views, 0 is passed in.
  • event - javascript event
  • ui - jQuery UI object
  • view - object representing current view
 null onitemresize java.lang.String JavaScript code called when ajax request triggered when item is resized has finished. Following data will be available in context:
  • item - selected item
  • dayDelta - holds the number of days the event was moved forward (a positive number) or backwards (a negative number)
  • minuteDelta - holds the number of minutes the event was moved forward (a positive number) or backwards (a negative number). Only useful for the agenda views. In other views, 0 is passed in.
  • vetoed - is true if server side listener has raised veto and modification has been reverted
  • event - javascript event
  • ui - jQuery UI object
  • view - object representing current view
  • request - ajax request
  • data - data returned by ajax request
 null onitemmouseover java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • event - javascript event
  • view - object representing current view
 null onitemmouseout java.lang.String JavaScript code for handling event. Following data will be available in context:
  • item - selected item
  • event - javascript event
  • view - object representing current view
 null onbeforeviewchange java.lang.String JavaScript code for handling event. Any return instruction will be ignored so this code cannot block anything. Following data will be available in context:
  • view - object representing current view
 null onviewchange java.lang.String JavaScript code called when ajax request triggered when view changes has finished. Following data will be available in context:
  • view - object representing current view
  • request - ajax request
  • data - data returned by ajax request
 null onbeforedateselect java.lang.String JavaScript code for handling event. Following data will be available in context:
  • date - selected date
  • allDay - is true if the event has been dropped on a day in month view, or the "all-day" slot in the agenda views.
  • event - javascript event
  • view - object representing current view
 null ondateselect java.lang.String JavaScript code called when ajax request triggered when date is selected has finished. Following data will be available in context:
  • date - selected date
  • allDay - is true if the event has been dropped on a day in month view, or the "all-day" slot in the agenda views.
  • event - javascript event
  • view - object representing current view
  • request - ajax request
  • data - data returned by ajax request
 null onbeforedaterangeselect java.lang.String JavaScript code for handling event. Following data will be available in context:
  • startDate - selection start date
  • endDate - selection end date
  • allDay - is true if the event has been dropped on a day in month view, or the "all-day" slot in the agenda views.
  • view - object representing current view
 null ondaterangeselect java.lang.String JavaScript code called when ajax request triggered when date range is selected has finished. Following data will be available in context:
  • startDate - selection start date
  • endDate - selection end date
  • allDay - is true if the event has been dropped on a day in month view, or the "all-day" slot in the agenda views.
  • view - object representing current view
  • request - ajax request
  • data - data returned by ajax request
 null onbeforedaterangechange java.lang.String JavaScript code for handling event. Any return instruction will be ignored so this code cannot block anything. Following data will be available in context:
  • startDate - start date
  • endDate - end date
 null ondaterangechange java.lang.String JavaScript code called when ajax request triggered when displayed date range is changed has finished. Following data will be available in context:
  • startDate - selection start date
  • endDate - selection end date
  • request - ajax request
  • data - data returned by ajax request
 null onviewdisplay java.lang.String JavaScript code called when the schedule loads and every time a different date-range is displayed. Following data will be available in context:
  • view - object representing current view
 null styleClass java.lang.String null itemMoveListener javax.faces.el.MethodBinding boolean itemResizeListener javax.faces.el.MethodBinding itemSelectListener javax.faces.el.MethodBinding viewChangeListener javax.faces.el.MethodBinding dateRangeChangeListener javax.faces.el.MethodBinding dateRangeSelectListener javax.faces.el.MethodBinding dateSelectListener javax.faces.el.MethodBinding &listeners;