Package io.jmix.fullcalendarflowui.component.data

Interface CallbackCalendarDataProvider

All Superinterfaces:

CalendarDataProvider

All Known Implementing Classes:

CalendarDataRetriever, EntityCalendarDataRetriever

public interface CallbackCalendarDataProvider
extends CalendarDataProvider

Interface to be implemented by data providers that should load items by request.

The onItemsFetch(ItemsFetchContext) is called in the following cases:

• When the user switches to the calendar display mode that has wider date range than previous one.
• When FullCalendar's navigation methods are invoked, e.g. JmixFullCalendar.navigateToNext().
• When time zone of component is changed.

By default FullCalendar calls onItemsFetch(ItemsFetchContext) immediately after adding the provider. If calendar is not attached to the UI, the callback will be invoked after attaching component to the UI.

See Also:

• EntityCalendarDataRetriever
• CalendarDataRetriever

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CallbackCalendarDataProvider.ItemsFetchContext	A fetch context that is used for loading events.

Method Summary

Modifier and Type	Method	Description
List<CalendarEvent>	onItemsFetch(CallbackCalendarDataProvider.ItemsFetchContext context)	A callback method that is invoked by FullCalendar, for instance, when the user navigates to next/previous dates.

Methods inherited from interface io.jmix.fullcalendarflowui.component.data.CalendarDataProvider

getId

Method Details

onItemsFetch

List<CalendarEvent> onItemsFetch(CallbackCalendarDataProvider.ItemsFetchContext context)

A callback method that is invoked by FullCalendar, for instance, when the user navigates to next/previous dates.

Parameters:

context - context that contains information about date range

Returns:

a list of fetched calendar events