jfxtras.labs.icalendar.components

Class VEvent<I,T>

java.lang.Object

jfxtras.labs.icalendar.components.VComponentBase<I,T>

jfxtras.labs.icalendar.components.VEvent<I,T>

All Implemented Interfaces:

VComponent<I>

Direct Known Subclasses:

VEventImpl

public abstract class VEvent<I,T>
extends VComponentBase<I,T>

Parent calendar component, VEVENT Defined in RFC 5545 iCalendar 3.6.1, page 52.

The status of following component properties from RFC 5545:

3.8.1.  Descriptive Component Properties  . . . . . . . . . .  81
  3.8.1.1.  Attachment  . . . . . . . . . . . . . . . . . . .  81 - NO (from VComponent)
  3.8.1.2.  Categories  . . . . . . . . . . . . . . . . . . .  82 - Yes (from VComponent)
  3.8.1.3.  Classification  . . . . . . . . . . . . . . . . .  83 - TODO (from VComponent)
  3.8.1.4.  Comment . . . . . . . . . . . . . . . . . . . . .  84 - Yes (from VComponent)
  3.8.1.5.  Description . . . . . . . . . . . . . . . . . . .  85 - Yes
  3.8.1.6.  Geographic Position . . . . . . . . . . . . . . .  87 - NO
  3.8.1.7.  Location  . . . . . . . . . . . . . . . . . . . .  88 - Yes
  3.8.1.8.  Percent Complete  . . . . . . . . . . . . . . . .  89 - NO
  3.8.1.9.  Priority  . . . . . . . . . . . . . . . . . . . .  90 - NO
  3.8.1.10. Resources . . . . . . . . . . . . . . . . . . . .  92 - NO (from VComponent)
  3.8.1.11. Status  . . . . . . . . . . . . . . . . . . . . .  93 - TODO (from VComponent)
  3.8.1.12. Summary . . . . . . . . . . . . . . . . . . . . .  94 - Yes (from VComponent)
3.8.2.  Date and Time Component Properties  . . . . . . . . .  95
  3.8.2.1.  Date-Time Completed . . . . . . . . . . . . . . .  95 - NO
  3.8.2.2.  Date-Time End . . . . . . . . . . . . . . . . . .  96 - Yes
  3.8.2.3.  Date-Time Due . . . . . . . . . . . . . . . . . .  97 - NO
  3.8.2.4.  Date-Time Start . . . . . . . . . . . . . . . . .  99 - Yes (from VComponent)
  3.8.2.5.  Duration  . . . . . . . . . . . . . . . . . . . . 100 - Yes
  3.8.2.6.  Free/Busy Time  . . . . . . . . . . . . . . . . . 101 - NO
  3.8.2.7.  Time Transparency . . . . . . . . . . . . . . . . 102 - NO
3.8.3.  Time Zone Component Properties  . . . . . . . . . . . 103 - NO
  3.8.3.1.  Time Zone Identifier  . . . . . . . . . . . . . . 103 - NO
  3.8.3.2.  Time Zone Name  . . . . . . . . . . . . . . . . . 105 - NO
  3.8.3.3.  Time Zone Offset From . . . . . . . . . . . . . . 106 - NO
  3.8.3.4.  Time Zone Offset To . . . . . . . . . . . . . . . 106 - NO
  3.8.3.5.  Time Zone URL . . . . . . . . . . . . . . . . . . 107 - NO
3.8.4.  Relationship Component Properties . . . . . . . . . . 108
  3.8.4.1.  Attendee  . . . . . . . . . . . . . . . . . . . . 108 - NO (from VComponent)
  3.8.4.2.  Contact . . . . . . . . . . . . . . . . . . . . . 111 - TODO (from VComponent)
  3.8.4.3.  Organizer . . . . . . . . . . . . . . . . . . . . 113 - TODO (from VComponent)
  3.8.4.4.  Recurrence ID . . . . . . . . . . . . . . . . . . 114 - TODO (from VComponent)
  3.8.4.5.  Related To  . . . . . . . . . . . . . . . . . . . 117 - NO (from VComponent)
  3.8.4.6.  Uniform Resource Locator  . . . . . . . . . . . . 118 - NO (from VComponent)
  3.8.4.7.  Unique Identifier . . . . . . . . . . . . . . . . 119 - Yes (from VComponent)
3.8.5.  Recurrence Component Properties . . . . . . . . . . . 120
  3.8.5.1.  Exception Date-Times  . . . . . . . . . . . . . . 120 - Yes, in EXDate class
  3.8.5.2.  Recurrence Date-Times . . . . . . . . . . . . . . 122 - TODO, in RDate class
  3.8.5.3.  Recurrence Rule . . . . . . . . . . . . . . . . . 124 - TODO, in RRule class
3.8.6.  Alarm Component Properties  . . . . . . . . . . . . . 134
  3.8.6.1.  Action  . . . . . . . . . . . . . . . . . . . . . 134 - NO
  3.8.6.2.  Repeat Count  . . . . . . . . . . . . . . . . . . 135 - NO
  3.8.6.3.  Trigger . . . . . . . . . . . . . . . . . . . . . 135 - NO
3.8.7.  Change Management Component Properties  . . . . . . . 138
  3.8.7.1.  Date-Time Created . . . . . . . . . . . . . . . . 138 - TODO (from VComponent)
  3.8.7.2.  Date-Time Stamp . . . . . . . . . . . . . . . . . 139 - TODO (from VComponent)
  3.8.7.3.  Last Modified . . . . . . . . . . . . . . . . . . 140 - TODO (from VComponent)
  3.8.7.4.  Sequence Number . . . . . . . . . . . . . . . . . 141 - TODO (from VComponent)
3.8.8.  Miscellaneous Component Properties  . . . . . . . . . 142
  3.8.8.1.  IANA Properties . . . . . . . . . . . . . . . . . 142 - NO (from VComponent)
  3.8.8.2.  Non-Standard Properties . . . . . . . . . . . . . 142 - TODO (from VComponent, some X-properties may be defined here too)
  3.8.8.3.  Request Status  . . . . . . . . . . . . . . . . . 144 - NO (from VComponent)

See Also:

VEventImpl

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<java.time.temporal.Temporal>	dateTimeEnd
javafx.beans.property.StringProperty	description DESCRIPTION: RFC 5545 iCalendar 3.8.1.12.
javafx.beans.property.ObjectProperty<java.time.temporal.TemporalAmount>	duration
javafx.beans.property.StringProperty	location LOCATION: RFC 5545 iCalendar 3.8.1.12.

Properties inherited from class jfxtras.labs.icalendar.components.VComponentBase

categoriesProperty, commentProperty, dateTimeCreatedProperty, dateTimeLastModifiedProperty, dateTimeRecurrenceProperty, dateTimeStampProperty, dateTimeStartProperty, exDateProperty, organizerProperty, rDateProperty, relatedToProperty, rRuleProperty, sequenceProperty, summaryProperty, uniqueIdentifierProperty

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VEvent.EndType

Nested classes/interfaces inherited from interface jfxtras.labs.icalendar.components.VComponent

VComponent.StartEndRange

Field Summary

Fields inherited from interface jfxtras.labs.icalendar.components.VComponent

VCOMPONENT_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
VEvent()
VEvent(VEvent<I,T> vevent)

Method Summary

Modifier and Type	Method and Description
protected void	adjustDateTime(java.time.temporal.Temporal startOriginalInstance, java.time.temporal.Temporal startInstance, java.time.temporal.Temporal endInstance)
protected void	becomingIndividual(VComponent<I> vComponentOriginal, java.time.temporal.Temporal startInstance, java.time.temporal.Temporal endInstance) Part of handleEdit.
protected java.util.Collection<java.lang.String>	changedStartAndEndDateTime(java.time.temporal.Temporal startOriginalInstance, java.time.temporal.Temporal startInstance, java.time.temporal.Temporal endInstance) returns list of date-time properties that have been edited (DURATION or DTEND)
void	copyTo(VComponent<I> destination) Deep copy all fields from this to destination
javafx.beans.property.ObjectProperty<java.time.temporal.Temporal>	dateTimeEndProperty()
javafx.beans.property.StringProperty	descriptionProperty() DESCRIPTION: RFC 5545 iCalendar 3.8.1.12.
javafx.beans.property.ObjectProperty<java.time.temporal.TemporalAmount>	durationProperty()
protected java.util.Collection<I>	editOne(VComponent<I> vComponentOriginal, java.util.Collection<VComponent<I>> vComponents, java.time.temporal.Temporal startOriginalInstance, java.time.temporal.Temporal startInstance, java.time.temporal.Temporal endInstance, java.util.Collection<I> instances) Edit one instance of a VEvent with a RRule.
protected java.util.Collection<I>	editThisAndFuture(VComponent<I> vComponentOriginal, java.util.Collection<VComponent<I>> vComponents, java.time.temporal.Temporal startOriginalInstance, java.time.temporal.Temporal startInstance, java.time.temporal.Temporal endInstance, java.util.Collection<I> instances) Changing this and future instances in VComponent is done by ending the previous VComponent with a UNTIL date or date/time and starting a new VComponent from the selected instance.
VEvent.EndType	endType() Indicates end option, DURATION or DTEND.
java.lang.String	errorString() Checks that one, and only one, of DTEND or DURATION is set.
java.time.temporal.Temporal	getDateTimeEnd()
java.lang.String	getDescription()
java.time.temporal.TemporalAmount	getDuration()
java.lang.String	getLocation()
javafx.beans.property.StringProperty	locationProperty() LOCATION: RFC 5545 iCalendar 3.8.1.12.
protected java.util.List<java.lang.String>	makeContentLines() Needed by toString in subclasses.
void	setDateTimeEnd(java.time.temporal.Temporal dtEnd)
void	setDescription(java.lang.String description)
void	setDuration(java.time.temporal.TemporalAmount duration)
void	setLocation(java.lang.String location)
java.util.stream.Stream<java.time.temporal.Temporal>	streamLimitedByRange() Produces a stream of start dates or date/times by calling VComponent.stream(Temporal) using VComponent.getStartRange() as the temporal parameter, minus the duration if the VComponent has one.
java.lang.String	toComponentText() returns string of line-separated properties defining calendar component.
java.lang.String	toString() Make iCalendar compliant string of VEvent calendar component.
T	withDateTimeEnd(java.time.temporal.Temporal dtEnd)
T	withDescription(java.lang.String description)
T	withDuration(java.time.temporal.TemporalAmount duration)
T	withLocation(java.lang.String location)

Methods inherited from class jfxtras.labs.icalendar.components.VComponentBase

categoriesProperty, commentProperty, dateTimeCreatedProperty, dateTimeLastModifiedProperty, dateTimeRecurrenceProperty, dateTimeStampProperty, dateTimeStartProperty, exDateProperty, getCategories, getComment, getDateTimeCreated, getDateTimeLastModified, getDateTimeRecurrence, getDateTimeStamp, getDateTimeStart, getEndRange, getExDate, getOrganizer, getParent, getRDate, getRelatedTo, getRRule, getSequence, getStartRange, getSummary, getUidGeneratorCallback, getUniqueIdentifier, handleDelete, handleEdit, instances, isExDatesOnOneLine, isGoogleRecurrenceUID, lastDtStartDateTimeType, organizerProperty, previousStreamValue, rDateProperty, relatedToProperty, rRuleProperty, sequenceProperty, setCategories, setComment, setDateTimeCreated, setDateTimeLastModified, setDateTimeRecurrence, setDateTimeStamp, setDateTimeStart, setEndRange, setExDate, setExDatesOnOneLine, setGoogleRecurrenceUID, setOrganizer, setParent, setRDate, setRelatedTo, setRRule, setSequence, setStartRange, setSummary, setUidGeneratorCallback, setUniqueIdentifier, setUniqueIdentifier, stream, summaryProperty, uniqueIdentifierProperty, withCategories, withDateTimeCreated, withDateTimeLastModified, withDateTimeRecurrence, withDateTimeStamp, withDateTimeStart, withEndRange, withExDate, withOrganizer, withParent, withRDate, withRelatedTo, withRRule, withSequence, withStartRange, withSummary, withSummary, withUniqueIdentifier

Methods inherited from class java.lang.Object

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

Methods inherited from interface jfxtras.labs.icalendar.components.VComponent

countVComponents, findRelatedVComponents, findRelatedVComponents2, getDateTimeType, getZoneId, incrementSequence, isFirstRecurrence, isIndividual, isLastRecurrence, isRecurrenceSetEmpty, isStreamValue, isValid, isWholeDay, lastRecurrence, makeInstances, makeInstances

Property Detail

description

public javafx.beans.property.StringProperty descriptionProperty

DESCRIPTION: RFC 5545 iCalendar 3.8.1.12. page 84 This property provides a more complete description of the calendar component than that provided by the "SUMMARY" property. Example: DESCRIPTION:Meeting to provide technical review for "Phoenix" design.\nHappy Face Conference Room. Phoenix design team MUST attend this meeting.\nRSVP to team leader.

See Also:

getDescription(), setDescription(String)

duration

public javafx.beans.property.ObjectProperty<java.time.temporal.TemporalAmount> durationProperty

dateTimeEnd

public javafx.beans.property.ObjectProperty<java.time.temporal.Temporal> dateTimeEndProperty

location

public javafx.beans.property.StringProperty locationProperty

LOCATION: RFC 5545 iCalendar 3.8.1.12. page 87 This property defines the intended venue for the activity defined by a calendar component. Example: LOCATION:Conference Room - F123\, Bldg. 002

See Also:

getLocation(), setLocation(String)

Constructor Detail

VEvent

public VEvent(VEvent<I,T> vevent)

VEvent

public VEvent()

Method Detail

descriptionProperty

public javafx.beans.property.StringProperty descriptionProperty()

DESCRIPTION: RFC 5545 iCalendar 3.8.1.12. page 84 This property provides a more complete description of the calendar component than that provided by the "SUMMARY" property. Example: DESCRIPTION:Meeting to provide technical review for "Phoenix" design.\nHappy Face Conference Room. Phoenix design team MUST attend this meeting.\nRSVP to team leader.

See Also:

getDescription(), setDescription(String)

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

withDescription

public T withDescription(java.lang.String description)

durationProperty

public javafx.beans.property.ObjectProperty<java.time.temporal.TemporalAmount> durationProperty()

getDuration

public java.time.temporal.TemporalAmount getDuration()

setDuration

public void setDuration(java.time.temporal.TemporalAmount duration)

withDuration

public T withDuration(java.time.temporal.TemporalAmount duration)

dateTimeEndProperty

public javafx.beans.property.ObjectProperty<java.time.temporal.Temporal> dateTimeEndProperty()

setDateTimeEnd

public void setDateTimeEnd(java.time.temporal.Temporal dtEnd)

getDateTimeEnd

public java.time.temporal.Temporal getDateTimeEnd()

withDateTimeEnd

public T withDateTimeEnd(java.time.temporal.Temporal dtEnd)

endType

public VEvent.EndType endType()

Indicates end option, DURATION or DTEND. Getter and setter methods in EndPriority enum

locationProperty

public javafx.beans.property.StringProperty locationProperty()

LOCATION: RFC 5545 iCalendar 3.8.1.12. page 87 This property defines the intended venue for the activity defined by a calendar component. Example: LOCATION:Conference Room - F123\, Bldg. 002

See Also:

getLocation(), setLocation(String)

getLocation

public java.lang.String getLocation()

setLocation

public void setLocation(java.lang.String location)

withLocation

public T withLocation(java.lang.String location)

becomingIndividual

protected void becomingIndividual(VComponent<I> vComponentOriginal,
                                  java.time.temporal.Temporal startInstance,
                                  java.time.temporal.Temporal endInstance)

Description copied from class: VComponentBase

Part of handleEdit. Changes a VComponent with a RRULE to be an individual,

Overrides:

becomingIndividual in class VComponentBase<I,T>

See Also:

VComponentBase.handleEdit(VComponent, Collection, Temporal, Temporal, Temporal, Collection, Callback)

changedStartAndEndDateTime

protected java.util.Collection<java.lang.String> changedStartAndEndDateTime(java.time.temporal.Temporal startOriginalInstance,
                                                                            java.time.temporal.Temporal startInstance,
                                                                            java.time.temporal.Temporal endInstance)

returns list of date-time properties that have been edited (DURATION or DTEND)

Overrides:

changedStartAndEndDateTime in class VComponentBase<I,T>

adjustDateTime

protected void adjustDateTime(java.time.temporal.Temporal startOriginalInstance,
                              java.time.temporal.Temporal startInstance,
                              java.time.temporal.Temporal endInstance)

editOne

protected java.util.Collection<I> editOne(VComponent<I> vComponentOriginal,
                                          java.util.Collection<VComponent<I>> vComponents,
                                          java.time.temporal.Temporal startOriginalInstance,
                                          java.time.temporal.Temporal startInstance,
                                          java.time.temporal.Temporal endInstance,
                                          java.util.Collection<I> instances)

Description copied from class: VComponentBase

Edit one instance of a VEvent with a RRule. The instance becomes a new VEvent without a RRule as with the same UID as the parent and a recurrence-id for the replaced date or date/time.

Overrides:

editOne in class VComponentBase<I,T>

See Also:

#handleEdit(VComponent, Collection, Temporal, Temporal, Temporal, Collection)

editThisAndFuture

protected java.util.Collection<I> editThisAndFuture(VComponent<I> vComponentOriginal,
                                                    java.util.Collection<VComponent<I>> vComponents,
                                                    java.time.temporal.Temporal startOriginalInstance,
                                                    java.time.temporal.Temporal startInstance,
                                                    java.time.temporal.Temporal endInstance,
                                                    java.util.Collection<I> instances)

Description copied from class: VComponentBase

Changing this and future instances in VComponent is done by ending the previous VComponent with a UNTIL date or date/time and starting a new VComponent from the selected instance. EXDATE, RDATE and RECURRENCES are split between both VComponents. vEventNew has new settings, vEvent has former settings.

Overrides:

editThisAndFuture in class VComponentBase<I,T>

See Also:

VComponent#handleEdit(VComponent, Collection, Temporal, Temporal, Temporal, Collection)

copyTo

public void copyTo(VComponent<I> destination)

Deep copy all fields from this to destination

Specified by:

copyTo in interface VComponent<I>

Overrides:

copyTo in class VComponentBase<I,T>

toString

public java.lang.String toString()

Make iCalendar compliant string of VEvent calendar component. This method should be overridden by an implementing class if that class contains any extra properties.

Overrides:

toString in class java.lang.Object

toComponentText

public java.lang.String toComponentText()

Description copied from interface: VComponent

returns string of line-separated properties defining calendar component.

Example:<br> BEGIN:VEVENT<br> DTSTART;TZID=America/Los_Angeles:20160214T080000<br> DTEND;TZID=America/Los_Angeles:20160214T110000<br> RRULE:FREQ=WEEKLY;BYDAY=SU,TU,FR<br> DTSTAMP:20160214T022532Z<br> UID:im8hmpakeigu3d85j3vq9q8bcc@google.com<br> CREATED:20160214T022525Z<br> LAST-MODIFIED:20160214T022525Z<br> SUMMARY:test2<br> END:VEVENT

makeContentLines

protected java.util.List<java.lang.String> makeContentLines()

Description copied from class: VComponentBase

Needed by toString in subclasses. Make list of properties and string values for toString method in subclasses (like VEvent) Used by toString method in subclasses

streamLimitedByRange

public java.util.stream.Stream<java.time.temporal.Temporal> streamLimitedByRange()

Description copied from interface: VComponent

Produces a stream of start dates or date/times by calling VComponent.stream(Temporal) using VComponent.getStartRange() as the temporal parameter, minus the duration if the VComponent has one. This stream is used by VComponent.makeInstances() to produce the displayed instances of the recurrence set.

Returns:

errorString

public java.lang.String errorString()

Checks that one, and only one, of DTEND or DURATION is set.