CalendarFXView 11.12.7 · com.calendarfx.model.LoadEvent

An event fired by the framework to inform the application that data will be required for the time interval defined by the given start and end date. This type of event can be used to implement a lazy loading strategy.

Code Example

The following code snippet was taken from the Google calendar application included in the distribution.

CalendarView calendarView = ...
calendarView.addEventFilter(LoadEvent.LOAD, evt -> {
   for (CalendarSource source : evt.getCalendarSources()) {
     if (source instanceof GoogleAccount) {
        GoogleAccount account = (GoogleAccount) source;

        Thread loadThread = new Thread() {
           public void run() {
              for (Calendar calendar : account.getCalendars()) {
                 GoogleCalendar googleCalendar = (GoogleCalendar) calendar;
                 googleCalendar.load(evt.getStartDate(), evt.getEndDate(), evt.getZoneId());
              }
           }
        };

        loadThread.setDaemon(true);
        loadThread.start();

        break;
     }
  }
});

Field Summary

Modifier and Type	Field and Description
private final List<CalendarSource>	calendarSources
private final LocalDate	endDate
public static final EventType<LoadEvent>	LOAD Gets fired frequently by the framework to indicate that data for the given date range is required to be present in the calendars.
private static final long	serialVersionUID Hides javafx.event.Event.serialVersionUID.
private final String	sourceName
private final LocalDate	startDate
private final ZoneId	zoneId

Inherited from javafx.event.Event:: ANY consumed eventType NULL_SOURCE_TARGET target

Constructor Summary

Access	Constructor and Description
public	LoadEvent(EventType<LoadEvent> the type of the load event eventType, String the name of the source where the event originated, e.g. "DayView" sourceName, List<CalendarSource> the affected calendar sources calendarSources, LocalDate the start date of the time interval startDate, LocalDate the end date of the time interval endDate, ZoneId the time zone zoneId) Constructs a new load event.

Method Summary

Modifier and Type	Method and Description
public List<CalendarSource>	Returns: the calendar sources getCalendarSources() The calendar sources that are affected by the load event.
public LocalDate	Returns: the end date getEndDate() The end of the loaded time interval.
public ZonedDateTime	Returns: the start time defined by this event getEndTime() Convenience method to return a zoned date time based on the given end date and time zone.
public String	Returns: the name of the control requesting the data getSourceName() A human readable name of the control that triggered the load event, e.g. "Day View" or "Month View".
public LocalDate	Returns: the start date getStartDate() The start of the loaded time interval.
public ZonedDateTime	Returns: the start time defined by this event getStartTime() Convenience method to return a zoned date time based on the given start date and time zone.
public ZoneId	Returns: the time zone getZoneId() The time zone used for the load.
public String	toString() Overrides java.util.EventObject.toString. Returns a String representation of this EventObject.

Inherited from javafx.event.Event:: clone consume copyFor fireEvent getEventType getTarget isConsumed

Field Detail

calendarSources	back to summary
private final List<CalendarSource> calendarSources

endDate	back to summary
private final LocalDate endDate

LOAD	back to summary
public static final EventType<LoadEvent> LOAD Gets fired frequently by the framework to indicate that data for the given date range is required to be present in the calendars.

serialVersionUID	back to summary
private static final long serialVersionUID Hides javafx.event.Event.serialVersionUID.

sourceName	back to summary
private final String sourceName

startDate	back to summary
private final LocalDate startDate

zoneId	back to summary
private final ZoneId zoneId

Constructor Detail

LoadEvent	back to summary
public LoadEvent(EventType<LoadEvent> eventType, String sourceName, List<CalendarSource> calendarSources, LocalDate startDate, LocalDate endDate, ZoneId zoneId) Constructs a new load event. Parameters eventType:EventType<LoadEvent> the type of the load event sourceName:String the name of the source where the event originated, e.g. "DayView" calendarSources:List<CalendarSource> the affected calendar sources startDate:LocalDate the start date of the time interval endDate:LocalDate the end date of the time interval zoneId:ZoneId the time zone

LoadEvent

back to summary

public LoadEvent(EventType<LoadEvent> eventType, String sourceName, List<CalendarSource> calendarSources, LocalDate startDate, LocalDate endDate, ZoneId zoneId)

Constructs a new load event.

Parameters

eventType:EventType<LoadEvent>: the type of the load event
sourceName:String: the name of the source where the event originated, e.g. "DayView"
calendarSources:List<CalendarSource>: the affected calendar sources
startDate:LocalDate: the start date of the time interval
endDate:LocalDate: the end date of the time interval
zoneId:ZoneId: the time zone

Method Detail

getCalendarSources	back to summary
public List<CalendarSource> getCalendarSources() The calendar sources that are affected by the load event. Returns:List<CalendarSource> the calendar sources

getCalendarSources

back to summary

public List<CalendarSource> getCalendarSources()

The calendar sources that are affected by the load event.

Returns:List<CalendarSource>: the calendar sources

getEndDate	back to summary
public LocalDate getEndDate() The end of the loaded time interval. Returns:LocalDate the end date

getEndDate

back to summary

public LocalDate getEndDate()

The end of the loaded time interval.

Returns:LocalDate: the end date

getEndTime back to summary

getEndTime	back to summary
public ZonedDateTime getEndTime() Convenience method to return a zoned date time based on the given end date and time zone. Uses `LocalTime#MAX` as time. Returns:ZonedDateTime the start time defined by this event

public ZonedDateTime getEndTime()

Convenience method to return a zoned date time based on the given end date and time zone. Uses LocalTime#MAX as time.

Returns:ZonedDateTime: the start time defined by this event

getSourceName	back to summary
public String getSourceName() A human readable name of the control that triggered the load event, e.g. "Day View" or "Month View". Mainly used for debugging purposes. Returns:String the name of the control requesting the data

getSourceName

back to summary

public String getSourceName()

A human readable name of the control that triggered the load event, e.g. "Day View" or "Month View". Mainly used for debugging purposes.

Returns:String: the name of the control requesting the data

getStartDate	back to summary
public LocalDate getStartDate() The start of the loaded time interval. Returns:LocalDate the start date

getStartDate

back to summary

public LocalDate getStartDate()

The start of the loaded time interval.

Returns:LocalDate: the start date

getStartTime back to summary

getStartTime	back to summary
public ZonedDateTime getStartTime() Convenience method to return a zoned date time based on the given start date and time zone. Uses `LocalTime#MIN` as time. Returns:ZonedDateTime the start time defined by this event

public ZonedDateTime getStartTime()

Convenience method to return a zoned date time based on the given start date and time zone. Uses LocalTime#MIN as time.

Returns:ZonedDateTime: the start time defined by this event

getZoneId	back to summary
public ZoneId getZoneId() The time zone used for the load. Returns:ZoneId the time zone

getZoneId

back to summary

public ZoneId getZoneId()

The time zone used for the load.

Returns:ZoneId: the time zone

toString	back to summary
public String toString() Overrides java.util.EventObject.toString. Doc from java.util.EventObject.toString. Returns a String representation of this EventObject. Returns:String a String representation of this EventObject Annotations @Override

toString

back to summary

public String toString()

Overrides java.util.EventObject.toString.

Doc from java.util.EventObject.toString.

Returns a String representation of this EventObject.

Returns:String

a String representation of this EventObject

Annotations

@Override

public final Class LoadEvent

Code Example

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail