com.calendarfx.model

Class CalendarEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

com.calendarfx.model.CalendarEvent

All Implemented Interfaces:

Serializable, Cloneable

public class CalendarEvent
extends Event

An event class used to signal changes done within a calendar or changes done to a calendar entry. Events of this type can be received by adding an event handler to a calendar.

Example

 
 Calendar calendar = new Calendar("Home");
 calendar.addEventHandler(CalendarEvent.ENTRY_ADDED, evt -> {...});
 
 

See Also:

Calendar.addEventHandler(javafx.event.EventHandler), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static EventType<CalendarEvent>	ANY The supertype of all event types in this event class.
static EventType<CalendarEvent>	CALENDAR_CHANGED An event type used to inform the application that "something" inside the calendar has changed and that the views need to update their visuals accordingly (brute force update).
static EventType<CalendarEvent>	ENTRY_CALENDAR_CHANGED An event type used to inform the application that an entry has been moved from one calendar to another.
static EventType<CalendarEvent>	ENTRY_CHANGED The supertype of all events that a related to an entry itself and not the calendar.
static EventType<CalendarEvent>	ENTRY_FULL_DAY_CHANGED An event type used to inform the application that an entry has become a "full day" entry, meaning its start and end time are no longer relevant.
static EventType<CalendarEvent>	ENTRY_INTERVAL_CHANGED An event type used to inform the application that the time bounds of an entry have been changed.
static EventType<CalendarEvent>	ENTRY_LOCATION_CHANGED An event type used to inform the application that an entry has been assigned a new user object.
static EventType<CalendarEvent>	ENTRY_RECURRENCE_RULE_CHANGED An event type used to inform the application that an entry has been assigned a new user object.
static EventType<CalendarEvent>	ENTRY_TITLE_CHANGED An event type used to inform the application that an entry has been assigned a new title.
static EventType<CalendarEvent>	ENTRY_USER_OBJECT_CHANGED An event type used to inform the application that an entry has been assigned a new user object.

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CalendarEvent(EventType<? extends CalendarEvent> eventType, Calendar calendar) Constructs a new event for subclass.
	CalendarEvent(EventType<? extends CalendarEvent> eventType, Calendar calendar, Entry<?> entry) Constructs a new event.
	CalendarEvent(EventType<CalendarEvent> eventType, Calendar calendar, Entry<?> entry, boolean oldFullDay) Constructs a new event used for signaling that an entry was set to full day.
	CalendarEvent(EventType<CalendarEvent> eventType, Calendar calendar, Entry<?> entry, Calendar oldCalendar) Constructs a new event used for signalling that an entry was assigned to a new calendar.
	CalendarEvent(EventType<CalendarEvent> eventType, Calendar calendar, Entry<?> entry, Interval oldInterval) Constructs a new event used for signalling that an entry was assigned a new start end date / time.
	CalendarEvent(EventType<CalendarEvent> eventType, Calendar calendar, Entry<?> entry, Object oldUserObject) Constructs a new event used for signalling that an entry has been assigned a new user object.
	CalendarEvent(EventType<CalendarEvent> eventType, Calendar calendar, Entry<?> entry, String oldText) Constructs a new event used for signalling that an entry was assigned a new text (normally the title).

Method Summary

Modifier and Type	Method and Description
Calendar	getCalendar() Returns the calendar for which the event was fired.
Entry<?>	getEntry() Returns the entry for which the event was fired.
Calendar	getOldCalendar() Returns the old calendar.
boolean	getOldFullDay() Returns the old value of the "full day" flag.
Interval	getOldInterval() Returns the old time interval of the modified entry.
String	getOldText() Returns the old text.
Object	getOldUserObject() Returns the old user object of the modified entry.
boolean	isDayChange() Determines whether the event will have an impact on different days.
boolean	isEntryAdded() A utility method to determine if the event describes the creation of a new entry.
boolean	isEntryRemoved() A utility method to determine if the event describes the removal of an entry.
String	toString()

Methods inherited from class javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ANY

public static final EventType<CalendarEvent> ANY

The supertype of all event types in this event class.

CALENDAR_CHANGED

public static final EventType<CalendarEvent> CALENDAR_CHANGED

An event type used to inform the application that "something" inside the calendar has changed and that the views need to update their visuals accordingly (brute force update).

ENTRY_CHANGED

public static final EventType<CalendarEvent> ENTRY_CHANGED

The supertype of all events that a related to an entry itself and not the calendar.

ENTRY_CALENDAR_CHANGED

public static final EventType<CalendarEvent> ENTRY_CALENDAR_CHANGED

An event type used to inform the application that an entry has been moved from one calendar to another.

ENTRY_FULL_DAY_CHANGED

public static final EventType<CalendarEvent> ENTRY_FULL_DAY_CHANGED

An event type used to inform the application that an entry has become a "full day" entry, meaning its start and end time are no longer relevant. The entry should be visualized in a way that signals that the entry will take all day (e.g. a birthday).

ENTRY_RECURRENCE_RULE_CHANGED

public static final EventType<CalendarEvent> ENTRY_RECURRENCE_RULE_CHANGED

An event type used to inform the application that an entry has been assigned a new user object.

ENTRY_TITLE_CHANGED

public static final EventType<CalendarEvent> ENTRY_TITLE_CHANGED

An event type used to inform the application that an entry has been assigned a new title.

ENTRY_USER_OBJECT_CHANGED

public static final EventType<CalendarEvent> ENTRY_USER_OBJECT_CHANGED

An event type used to inform the application that an entry has been assigned a new user object.

ENTRY_LOCATION_CHANGED

public static final EventType<CalendarEvent> ENTRY_LOCATION_CHANGED

An event type used to inform the application that an entry has been assigned a new user object.

ENTRY_INTERVAL_CHANGED

public static final EventType<CalendarEvent> ENTRY_INTERVAL_CHANGED

An event type used to inform the application that the time bounds of an entry have been changed. One or several of start / end date, start / end time.

Constructor Detail

CalendarEvent

protected CalendarEvent(EventType<? extends CalendarEvent> eventType,
                        Calendar calendar)

Constructs a new event for subclass.

Parameters:

eventType - the event type

calendar - the calendar where the event occurred.

CalendarEvent

public CalendarEvent(EventType<? extends CalendarEvent> eventType,
                     Calendar calendar,
                     Entry<?> entry)

Constructs a new event.

Parameters:

eventType - the event type

calendar - the calendar where the event occured

entry - the affected entry

CalendarEvent

public CalendarEvent(EventType<CalendarEvent> eventType,
                     Calendar calendar,
                     Entry<?> entry,
                     Calendar oldCalendar)

Constructs a new event used for signalling that an entry was assigned to a new calendar. The entry already carries a reference to new calendar and the event object will know the old calendar.

Parameters:

eventType - the event type

calendar - the calendar where the event occured

entry - the affected entry

oldCalendar - the calendar to which the event belonged before

CalendarEvent

public CalendarEvent(EventType<CalendarEvent> eventType,
                     Calendar calendar,
                     Entry<?> entry,
                     Object oldUserObject)

Constructs a new event used for signalling that an entry has been assigned a new user object. The entry already carries a reference to the new user object and the event object will know the old user object.

Parameters:

eventType - the event type

calendar - the calendar where the event occured

entry - the affected entry

oldUserObject - the calendar to which the event belonged before

CalendarEvent

public CalendarEvent(EventType<CalendarEvent> eventType,
                     Calendar calendar,
                     Entry<?> entry,
                     Interval oldInterval)

Constructs a new event used for signalling that an entry was assigned a new start end date / time. The entry already carries the new values, while the old values can be retrieved from the event object.

Parameters:

eventType - the event type

calendar - the calendar where the event occured

entry - the affected entry

oldInterval - the previous time interval

CalendarEvent

public CalendarEvent(EventType<CalendarEvent> eventType,
                     Calendar calendar,
                     Entry<?> entry,
                     String oldText)

Constructs a new event used for signalling that an entry was assigned a new text (normally the title). The entry already carries a reference to new text and the event object will know the old one.

Parameters:

eventType - the event type

calendar - the calendar where the event occured

entry - the affected entry

oldText - the previous value of the text

CalendarEvent

public CalendarEvent(EventType<CalendarEvent> eventType,
                     Calendar calendar,
                     Entry<?> entry,
                     boolean oldFullDay)

Constructs a new event used for signaling that an entry was set to full day. The entry already carries a reference to new full day value and the event object will know the old one.

Parameters:

eventType - the event type

calendar - the calendar where the event occured

entry - the affected entry

oldFullDay - the previous value of the full day

Method Detail

getEntry

public Entry<?> getEntry()

Returns the entry for which the event was fired.

Returns:

the affected entry

getCalendar

public final Calendar getCalendar()

Returns the calendar for which the event was fired.

Returns:

the affected calendar

getOldUserObject

public Object getOldUserObject()

Returns the old user object of the modified entry.

Returns:

the old user object

getOldInterval

public Interval getOldInterval()

Returns the old time interval of the modified entry.

Returns:

the old time interval

getOldText

public final String getOldText()

Returns the old text.

Returns:

the old text

getOldFullDay

public final boolean getOldFullDay()

Returns the old value of the "full day" flag.

Returns:

the old value of "full day"

getOldCalendar

public final Calendar getOldCalendar()

Returns the old calendar.

Returns:

the old calendar

isEntryAdded

public final boolean isEntryAdded()

A utility method to determine if the event describes the creation of a new entry. This is the case when the event type is ENTRY_CALENDAR_CHANGED and the old calendar was null.

Returns:

true if the event describes the creation of a new entry

isEntryRemoved

public final boolean isEntryRemoved()

A utility method to determine if the event describes the removal of an entry. This is the case when the event type is ENTRY_CALENDAR_CHANGED and the old calendar was not null but the new calendar is null.

Returns:

true if the event describes the removal of a new entry

isDayChange

public final boolean isDayChange()

Determines whether the event will have an impact on different days. The method will return false if the user simply changed the start and / or end time of an entry within the current day. However, when the user drags the entry from one day to another then this method will return true.

Returns:

true if the new time interval of the entry touches other days than the old time interval of the entry

toString

public String toString()

Overrides:

toString in class EventObject