java.lang.Object
- All Implemented Interfaces:
VAttendee<VEvent>
,VComponent
,VDateTimeEnd<VEvent>
,VDescribable<VEvent>
,VDescribable2<VEvent>
,VDuration<VEvent>
,VLastModified<VEvent>
,VRepeatable<VEvent>
,VChild
,VElement
,VParent
public class VEvent
extends VLocatable<VEvent>
implements VDateTimeEnd<VEvent>, VDescribable2<VEvent>, VRepeatable<VEvent>
VEVENT
Event Component
RFC 5545, 3.6.1, page 52
Description: A "VEVENT" calendar component is a grouping of
component properties, possibly including "VALARM" calendar
components, that represents a scheduled amount of time on a
calendar. For example, it can be an activity; such as a one-hour
long, department meeting from 8:00 AM to 9:00 AM, tomorrow.
Generally, an event will take up time on an individual calendar.
Hence, the event will appear as an opaque interval in a search for
busy time. Alternately, the event can have its Time Transparency
set to "TRANSPARENT" in order to prevent blocking of the event in
searches for busy time.
The "VEVENT" is also the calendar component used to specify an
anniversary or daily reminder within a calendar. These events
have a DATE value type for the "DTSTART" property instead of the
default value type of DATE-TIME. If such a "VEVENT" has a "DTEND"
property, it MUST be specified as a DATE value also. The
anniversary type of "VEVENT" can span more than one date (i.e.,
"DTEND" property value is set to a calendar date after the
"DTSTART" property value). If such a "VEVENT" has a "DURATION"
property, it MUST be specified as a "dur-day" or "dur-week" value.
The "DTSTART" property for a "VEVENT" specifies the inclusive
start of the event. For recurring events, it also specifies the
very first instance in the recurrence set. The "DTEND" property
for a "VEVENT" calendar component specifies the non-inclusive end
of the event. For cases where a "VEVENT" calendar component
specifies a "DTSTART" property with a DATE value type but no
"DTEND" nor "DURATION" property, the event's duration is taken to
be one day. For cases where a "VEVENT" calendar component
specifies a "DTSTART" property with a DATE-TIME value type but no
"DTEND" property, the event ends on the same calendar date and
time of day specified by the "DTSTART" property.
The "VEVENT" calendar component cannot be nested within another
calendar component. However, "VEVENT" calendar components can be
related to each other or to a "VTODO" or to a "VJOURNAL" calendar
component with the "RELATED-TO" property.
Example: The following is an example of the "VEVENT" calendar
component used to represent a meeting that will also be opaque to
searches for busy time:
BEGIN:VEVENT
UID:19970901T130000Z-123401@example.com
DTSTAMP:19970901T130000Z
DTSTART:19970903T163000Z
DTEND:19970903T190000Z
SUMMARY:Annual Employee Review
CLASS:PRIVATE
CATEGORIES:BUSINESS,HUMAN RESOURCES
END:VEVENT
-
Nested Class Summary
Nested classes/interfaces inherited from class jfxtras.icalendarfx.VElementBase
VElementBase.Message, VElementBase.MessageEffect
Nested classes/interfaces inherited from interface jfxtras.icalendarfx.components.VRepeatable
VRepeatable.MergedIterator<T>
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate DateTimeEnd
private TimeTransparency
TRANSP Time Transparency RFC 5545 iCalendar 3.8.2.7.Fields inherited from class jfxtras.icalendarfx.components.VPrimary
DTSTART_COMPARATOR
Fields inherited from class jfxtras.icalendarfx.components.VComponentBase
parent
Fields inherited from class jfxtras.icalendarfx.VParentBase
contentLineGenerator, orderer
Fields inherited from class jfxtras.icalendarfx.VElementBase
BEGIN, END
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Deprecated.errors()
Produces a list of error messages indicating problems with calendar elementVElement.errors()
is invoked recursively to return errors of child elements in addition to errors in parentA convenience method that returns either Duration property value, or a calculated duration based on start and end valuesDTEND Date-Time End RFC 5545, 3.8.2.2, page 95 This property specifies when the calendar component ends.static VEvent
Creates a new VEvent calendar component by parsing a String of iCalendar content linesvoid
setDateTimeEnd
(DateTimeEnd dateTimeEnd) void
setEndOrDuration
(Temporal startRecurrence, Temporal endRecurrence) A convenience method that sets DTEND, DURATION (VEvent) or DUE (VTodo) depending on which ever is already set to new value calculated by the duration or period between input parameters (depending on if the parameters are LocalDate or a date/time type (i.e.void
setTimeTransparency
(String timeTransparency) void
setTimeTransparency
(TimeTransparency timeTransparency) void
setTimeTransparency
(TimeTransparency.TimeTransparencyType timeTransparency) withTimeTransparency
(String timeTransparency) withTimeTransparency
(TimeTransparency timeTransparency) withTimeTransparency
(TimeTransparency.TimeTransparencyType timeTransparencyType) Methods inherited from class jfxtras.icalendarfx.components.VLocatable
addSubcomponent, getDescription, getDuration, getGeographicPosition, getLocation, getPriority, getResources, getVAlarms, hashCode, setDescription, setDuration, setGeographicPosition, setGeographicPosition, setGeographicPosition, setLocation, setLocation, setPriority, setPriority, setPriority, setResources, setVAlarms, streamRecurrences, withGeographicPosition, withGeographicPosition, withGeographicPosition, withLocation, withLocation, withPriority, withPriority, withPriority, withResources, withResources, withResources, withVAlarms, withVAlarms, withVAlarms
Methods inherited from class jfxtras.icalendarfx.components.VDisplayable
checkRecurrenceIdConsistency, dateTimeStartListenerHook, getAttachments, getCategories, getClassification, getContacts, getDateTimeCreated, getDateTimeLastModified, getExceptionDates, getRecurrenceDates, getRecurrenceId, getRecurrenceRule, getRelatedTo, getSequence, getStatus, getSummary, incrementSequence, orphanedRecurrenceChildren, recurrenceCache, recurrenceChildren, recurrenceParent, setAttachments, setCategories, setClassification, setClassification, setClassification, setContacts, setDateTimeCreated, setDateTimeCreated, setDateTimeCreated, setDateTimeLastModified, setExceptionDates, setRecurrenceDates, setRecurrenceId, setRecurrenceId, setRecurrenceId, setRecurrenceRule, setRelatedTo, setSequence, setSequence, setSequence, setStatus, setStatus, setStatus, setSummary, withCategories, withCategories, withCategories, withClassification, withClassification, withClassification, withContacts, withContacts, withContacts, withDateTimeCreated, withDateTimeCreated, withDateTimeCreated, withExceptionDates, withExceptionDates, withExceptionDates, withExceptionDates, withRecurrenceId, withRecurrenceId, withRecurrenceId, withRelatedTo, withRelatedTo, withRelatedTo, withSequence, withSequence, withSequence, withStatus, withStatus, withStatus
Methods inherited from class jfxtras.icalendarfx.components.VPersonal
getAttendees, getDateTimeStamp, getOrganizer, getRequestStatus, getUidGeneratorCallback, getUniqueIdentifier, getURL, setAttendees, setDateTimeStamp, setDateTimeStamp, setDateTimeStamp, setOrganizer, setOrganizer, setRequestStatus, setUidGeneratorCallback, setUniqueIdentifier, setUniqueIdentifier, setUniqueIdentifier, setURL, setURL, setURL, withDateTimeStamp, withDateTimeStamp, withDateTimeStamp, withOrganizer, withOrganizer, withRequestStatus, withRequestStatus, withRequestStatus, withUidGeneratorCallback, withUniqueIdentifier, withUniqueIdentifier, withUniqueIdentifier, withURL, withURL, withURL
Methods inherited from class jfxtras.icalendarfx.components.VPrimary
getComments, getDateTimeStart, isWholeDay, setComments, setDateTimeStart, setDateTimeStart, setDateTimeStart, withComments, withComments, withComments, withDateTimeStart, withDateTimeStart, withDateTimeStart
Methods inherited from class jfxtras.icalendarfx.components.VCommon
getNonStandard, setNonStandard, withNonStandard, withNonStandard, withNonStandard
Methods inherited from class jfxtras.icalendarfx.components.VComponentBase
getParent, isContentValid, name, setParent
Methods inherited from class jfxtras.icalendarfx.VParentBase
addChild, addChild, addChild, addChildInternal, checkChild, childrenUnmodifiable, collectGetterMap, collectSetterMap, copyChildrenInto, equals, getGetter, getGetters, getSetter, getSetters, orderChild, orderChild, orderChild, parseContent, parseContent, processInLineChild, removeChild, removeChild, replaceChild, replaceChild, toString, withChild
Methods inherited from class jfxtras.icalendarfx.VElementBase
elementName, newEmptyVElement, parse, throwMessageExceptions
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface jfxtras.icalendarfx.components.VAttendee
withAttendees, withAttendees, withAttendees
Methods inherited from interface jfxtras.icalendarfx.components.VComponent
toString
Methods inherited from interface jfxtras.icalendarfx.components.VDateTimeEnd
checkDateTimeEndConsistency, getDateTimeStart, setDateTimeEnd, setDateTimeEnd, withDateTimeEnd, withDateTimeEnd, withDateTimeEnd
Methods inherited from interface jfxtras.icalendarfx.components.VDescribable
getAttachments, getSummary, setAttachments, setSummary, setSummary, withAttachments, withAttachments, withAttachments, withSummary, withSummary
Methods inherited from interface jfxtras.icalendarfx.components.VDescribable2
getDescription, setDescription, setDescription, withDescription, withDescription
Methods inherited from interface jfxtras.icalendarfx.components.VDuration
setDuration, setDuration, withDuration, withDuration, withDuration
Methods inherited from interface jfxtras.icalendarfx.components.VLastModified
setDateTimeLastModified, setDateTimeLastModified, withDateTimeLastModified, withDateTimeLastModified, withDateTimeLastModified
Methods inherited from interface jfxtras.icalendarfx.VParent
addChild, addChild, addChild, childrenUnmodifiable, orderChild, orderChild, orderChild, removeChild, removeChild, replaceChild, replaceChild
Methods inherited from interface jfxtras.icalendarfx.components.VRepeatable
checkDateTimeStartConsistency, checkRecurrencesConsistency, getDateTimeStart, getRecurrenceDates, getRecurrenceRule, isRecurrence, isRecurrenceSetEmpty, lastRecurrence, previousStreamValue, recurrenceCache, setRecurrenceDates, setRecurrenceRule, setRecurrenceRule, setRecurrenceRule, streamRecurrences, streamRecurrences, streamRecurrences, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceRule, withRecurrenceRule, withRecurrenceRule
-
Field Details
-
dateTimeEnd
-
timeTransparency
TRANSP Time Transparency RFC 5545 iCalendar 3.8.2.7. page 101 This property defines whether or not an event is transparent to busy time searches. Events that consume actual time SHOULD be recorded as OPAQUE. Other events, which do not take up time SHOULD be recorded as TRANSPARENT. Example: TRANSP:TRANSPARENT
-
-
Constructor Details
-
VEvent
public VEvent() -
VEvent
Copy constructor
-
-
Method Details
-
getDateTimeEnd
DTEND Date-Time End RFC 5545, 3.8.2.2, page 95 This property specifies when the calendar component ends. The value type of this property MUST be the same as the "DTSTART" property, and its value MUST be later in time than the value of the "DTSTART" property. Example: DTEND;VALUE=DATE:19980704- Specified by:
getDateTimeEnd
in interfaceVDateTimeEnd<VEvent>
-
setDateTimeEnd
- Specified by:
setDateTimeEnd
in interfaceVDateTimeEnd<VEvent>
-
getTimeTransparency
-
setTimeTransparency
-
setTimeTransparency
-
setTimeTransparency
-
withTimeTransparency
-
withTimeTransparency
-
withTimeTransparency
-
getActualDuration
Description copied from class:VLocatable
A convenience method that returns either Duration property value, or a calculated duration based on start and end values- Specified by:
getActualDuration
in classVLocatable<VEvent>
-
setEndOrDuration
Description copied from class:VLocatable
A convenience method that sets DTEND, DURATION (VEvent) or DUE (VTodo) depending on which ever is already set to new value calculated by the duration or period between input parameters (depending on if the parameters are LocalDate or a date/time type (i.e. ZonedDateTime)) Note: In order to set DTEND, DTSTART must be assigned a value. DURATION and DUE doesn't require a DTSTART value.- Specified by:
setEndOrDuration
in classVLocatable<VEvent>
- Parameters:
startRecurrence
-endRecurrence
-
-
errors
Description copied from interface:VElement
Produces a list of error messages indicating problems with calendar elementVElement.errors()
is invoked recursively to return errors of child elements in addition to errors in parent- Specified by:
errors
in interfaceVElement
- Overrides:
errors
in classVLocatable<VEvent>
- Returns:
- - list of error messages
-
calendarList
- Specified by:
calendarList
in interfaceVComponent
-
eraseDateTimeProperties
Deprecated.Description copied from class:VDisplayable
Erase all date/time properties such as DTSTART, DTEND, DURATION, and DUE (which ever exist). This is necessary to prepare a CANCEL iTIP message for one recurrence instance.- Overrides:
eraseDateTimeProperties
in classVLocatable<VEvent>
-
parse
Creates a new VEvent calendar component by parsing a String of iCalendar content lines- Parameters:
content
- the text to parse, not null- Returns:
- the parsed VEvent
-