com.vaadin.ui.components.calendar.event

Interface CalendarEventProvider

All Superinterfaces:

Serializable

All Known Subinterfaces:

CalendarEditableEventProvider

All Known Implementing Classes:

BasicEventProvider, Calendar, ContainerEventProvider

public interface CalendarEventProvider
extends Serializable

Interface for querying events. The Vaadin Calendar always has a CalendarEventProvider set.

Since:

7.1.0

Author:

Vaadin Ltd.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CalendarEventProvider.EventSetChangeEvent Event to signal that the set of events has changed and the calendar should refresh its view from the CalendarEventProvider .
static interface	CalendarEventProvider.EventSetChangeListener Listener for EventSetChange events.
static interface	CalendarEventProvider.EventSetChangeNotifier Notifier interface for EventSetChange events.

Method Summary

Modifier and Type	Method and Description
List<CalendarEvent>	getEvents(Date startDate, Date endDate) Gets all available events in the target date range between startDate and endDate.

Method Detail

getEvents

List<CalendarEvent> getEvents(Date startDate,
                              Date endDate)

Gets all available events in the target date range between startDate and endDate. The Vaadin Calendar queries the events from the range that is shown, which is not guaranteed to be the same as the date range that is set.

For example, if you set the date range to be monday 22.2.2010 - wednesday 24.2.2010, the used Event Provider will be queried for events between monday 22.2.2010 00:00 and sunday 28.2.2010 23:59. Generally you can expect the date range to be expanded to whole days and whole weeks.

Parameters:

startDate - Start date

endDate - End date

Returns:

List of events