java.lang.Object
jfxtras.icalendarfx.VElementBase
jfxtras.icalendarfx.VParentBase<T>
jfxtras.icalendarfx.components.VComponentBase<T>
jfxtras.icalendarfx.components.VCommon<T>
jfxtras.icalendarfx.components.VPrimary<T>
jfxtras.icalendarfx.components.VPersonal<T>
jfxtras.icalendarfx.components.VDisplayable<T>
- Type Parameters:
T
- concrete subclass
- All Implemented Interfaces:
VAttendee<T>
,VComponent
,VDescribable<T>
,VLastModified<T>
,VRepeatable<T>
,VChild
,VElement
,VParent
- Direct Known Subclasses:
VJournal
,VLocatable
public abstract class VDisplayable<T>
extends VPersonal<T>
implements VRepeatable<T>, VDescribable<T>, VLastModified<T>
VComponent
with the following properties
-
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 List
<Attachment<?>> private List
<Categories> private Classification
private DateTimeCreated
private List
<ExceptionDates> private LastModified
private RecurrenceRuleCache
private List
<RecurrenceDates> private RecurrenceId
private RecurrenceRule
private Sequence
private Status
private Summary
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 TypeMethodDescription(package private) String
Checks if RecurrenceId has same date-time type as DateTimeStart.(package private) void
DTSTART: Date-Time Start, from RFC 5545 iCalendar 3.8.2.4 page 97 Start date/time of repeat rule.void
Erase all date/time properties such as DTSTART, DTEND, DURATION, and DUE (which ever exist).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 parentList
<Attachment<?>> This property provides the capability to associate a document object with a calendar component.CATEGORIES: RFC 5545 iCalendar 3.8.1.12.CLASS Classification RFC 5545, 3.8.1.3, page 82 This property defines the access classification for a calendar component.CONTACT: RFC 5545 iCalendar 3.8.4.2.CREATED: Date-Time Created RFC 5545 iCalendar 3.8.7.1 page 136 This property specifies the date and time that the calendar information was created.LAST-MODIFIED RFC 5545, 3.8.7.3, page 138 This property specifies the date and time that the information associated with the calendar component was last revised in the calendar store.EXDATE Exception Date-Times RFC 5545 iCalendar 3.8.5.1, page 117.RDATE Recurrence Date-Times RFC 5545 iCalendar 3.8.5.2, page 120.RECURRENCE-ID: Recurrence Identifier RFC 5545 iCalendar 3.8.4.4 page 112 The property value is the original value of the "DTSTART" property of the recurrence instance before an edit that changed the value.RRULE, Recurrence Rule RFC 5545 iCalendar 3.8.5.3, page 122.RELATED-TO: 3.8.4.5, RFC 5545 iCalendar, page 115 This property is used to represent a relationship or reference between one calendar component and another.SEQUENCE: RFC 5545 iCalendar 3.8.7.4.STATUS RFC 5545 iCalendar 3.8.1.11.SUMMARY RFC 5545 iCalendar 3.8.1.12.void
List
<VDisplayable<?>> returns list of orphaned recurrence components due to a change.Handles caching of recurrence start Temporal values.List
<VDisplayable<?>> VDisplayable
<?> void
setAttachments
(List<Attachment<?>> attachments) void
setCategories
(List<Categories> categories) void
setClassification
(String classification) void
setClassification
(Classification classification) void
setClassification
(Classification.ClassificationType classification) void
setContacts
(List<Contact> contacts) void
setDateTimeCreated
(String dateTimeCreated) void
setDateTimeCreated
(ZonedDateTime dateTimeCreated) void
setDateTimeCreated
(DateTimeCreated dateTimeCreated) void
setDateTimeLastModified
(LastModified lastModified) void
setExceptionDates
(List<ExceptionDates> exceptionDates) void
setRecurrenceDates
(List<RecurrenceDates> recurrenceDates) void
setRecurrenceId
(String recurrenceId) void
setRecurrenceId
(Temporal temporal) void
setRecurrenceId
(RecurrenceId recurrenceId) void
setRecurrenceRule
(RecurrenceRule recurrenceRule) void
setRelatedTo
(List<RelatedTo> relatedTo) void
setSequence
(Integer sequence) void
setSequence
(String sequence) void
setSequence
(Sequence sequence) void
void
void
setStatus
(Status.StatusType status) void
setSummary
(Summary summary) streamRecurrences
(Temporal start) Deprecated.withCategories
(String... categories) withCategories
(List<Categories> categories) withCategories
(Categories... categories) withClassification
(String classification) withClassification
(Classification classification) withClassification
(Classification.ClassificationType classification) withContacts
(String... contacts) withContacts
(List<Contact> contacts) withContacts
(Contact... contacts) withDateTimeCreated
(String dateTimeCreated) withDateTimeCreated
(ZonedDateTime dateTimeCreated) withDateTimeCreated
(DateTimeCreated dateTimeCreated) withExceptionDates
(String... exceptions) withExceptionDates
(Temporal... exceptions) withExceptionDates
(List<ExceptionDates> exceptions) withExceptionDates
(ExceptionDates... exceptions) withRecurrenceId
(String recurrenceId) withRecurrenceId
(Temporal recurrenceId) withRecurrenceId
(RecurrenceId recurrenceId) withRelatedTo
(String... relatedTo) withRelatedTo
(List<RelatedTo> relatedTo) withRelatedTo
(RelatedTo... relatedTo) withSequence
(Integer sequence) withSequence
(String sequence) withSequence
(Sequence sequence) withStatus
(String status) withStatus
(Status status) withStatus
(Status.StatusType status) 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
addSubcomponent, 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, hashCode, 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
calendarList, toString
Methods inherited from interface jfxtras.icalendarfx.components.VDescribable
setSummary, withAttachments, withAttachments, withAttachments, withSummary, withSummary
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, isRecurrence, isRecurrenceSetEmpty, lastRecurrence, previousStreamValue, setRecurrenceRule, setRecurrenceRule, streamRecurrences, streamRecurrences, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceRule, withRecurrenceRule, withRecurrenceRule
-
Field Details
-
attachments
-
categories
-
classification
-
contacts
-
dateTimeCreated
-
exceptionDates
-
lastModified
-
recurrenceDates
-
recurrenceId
-
recurrenceRule
-
sequence
-
status
-
summary
-
recurrenceCache
-
-
Constructor Details
-
VDisplayable
public VDisplayable() -
VDisplayable
-
-
Method Details
-
getAttachments
This property provides the capability to associate a document object with a calendar component.Example: The following is an example of this property:
- ATTACH:CID:jsmith.part3.960817T083000.xyzMail@example.com
- ATTACH;FMTTYPE=application/postscript:ftp://example.com/pub/
reports/r-960812.ps
- Specified by:
getAttachments
in interfaceVDescribable<T>
-
setAttachments
- Specified by:
setAttachments
in interfaceVDescribable<T>
-
getCategories
CATEGORIES: RFC 5545 iCalendar 3.8.1.12. page 81 This property defines the categories for a calendar component. Example: CATEGORIES:APPOINTMENT,EDUCATION CATEGORIES:MEETING -
setCategories
-
withCategories
-
withCategories
-
withCategories
-
getClassification
CLASS Classification RFC 5545, 3.8.1.3, page 82 This property defines the access classification for a calendar component. Example: CLASS:PUBLIC -
setClassification
-
setClassification
-
setClassification
-
withClassification
-
withClassification
-
withClassification
-
getContacts
CONTACT: RFC 5545 iCalendar 3.8.4.2. page 109 This property is used to represent contact information or alternately a reference to contact information associated with the calendar component. Example: CONTACT;ALTREP="ldap://example.com:6666/o=ABC%20Industries\, c=US???(cn=Jim%20Dolittle)":Jim Dolittle\, ABC Industries\, +1-919-555-1234 -
setContacts
-
withContacts
-
withContacts
-
withContacts
-
getDateTimeCreated
CREATED: Date-Time Created RFC 5545 iCalendar 3.8.7.1 page 136 This property specifies the date and time that the calendar information was created. This is analogous to the creation date and time for a file in the file system. The value MUST be specified in the UTC time format. Example: CREATED:19960329T133000Z -
setDateTimeCreated
-
setDateTimeCreated
-
setDateTimeCreated
-
withDateTimeCreated
-
withDateTimeCreated
-
withDateTimeCreated
-
getExceptionDates
EXDATE Exception Date-Times RFC 5545 iCalendar 3.8.5.1, page 117. This property defines the list of DATE-TIME exceptions for recurring events, to-dos, journal entries, or time zone definitions. -
setExceptionDates
-
withExceptionDates
-
withExceptionDates
-
withExceptionDates
-
withExceptionDates
-
getDateTimeLastModified
LAST-MODIFIED RFC 5545, 3.8.7.3, page 138 This property specifies the date and time that the information associated with the calendar component was last revised in the calendar store. Note: This is analogous to the modification date and time for a file in the file system. The value MUST be specified as a date with UTC time. Example: LAST-MODIFIED:19960817T133000Z- Specified by:
getDateTimeLastModified
in interfaceVLastModified<T>
-
setDateTimeLastModified
- Specified by:
setDateTimeLastModified
in interfaceVLastModified<T>
-
getRecurrenceDates
RDATE Recurrence Date-Times RFC 5545 iCalendar 3.8.5.2, page 120. This property defines the list of DATE-TIME values for recurring events, to-dos, journal entries, or time zone definitions. NOTE: DOESN'T CURRENTLY SUPPORT PERIOD VALUE TYPE- Specified by:
getRecurrenceDates
in interfaceVRepeatable<T>
-
setRecurrenceDates
- Specified by:
setRecurrenceDates
in interfaceVRepeatable<T>
-
getRecurrenceId
RECURRENCE-ID: Recurrence Identifier RFC 5545 iCalendar 3.8.4.4 page 112 The property value is the original value of the "DTSTART" property of the recurrence instance before an edit that changed the value. Example: RECURRENCE-ID;VALUE=DATE:19960401 -
setRecurrenceId
-
setRecurrenceId
-
setRecurrenceId
-
withRecurrenceId
-
withRecurrenceId
-
withRecurrenceId
-
checkRecurrenceIdConsistency
String checkRecurrenceIdConsistency()Checks if RecurrenceId has same date-time type as DateTimeStart. Returns String containing error message if there is a problem, null otherwise. -
getRelatedTo
RELATED-TO: 3.8.4.5, RFC 5545 iCalendar, page 115 This property is used to represent a relationship or reference between one calendar component and another. By default, the property value points to another calendar component's UID that has a PARENT relationship to the referencing object. This field is null unless the object contains as RECURRENCE-ID value. Example: RELATED-TO:19960401-080045-4000F192713-0052@example.com -
setRelatedTo
-
withRelatedTo
-
withRelatedTo
-
withRelatedTo
-
getRecurrenceRule
RRULE, Recurrence Rule RFC 5545 iCalendar 3.8.5.3, page 122. This property defines a rule or repeating pattern for recurring events, to-dos, journal entries, or time zone definitions If component is not repeating the value is null. Examples: RRULE:FREQ=DAILY;COUNT=10 RRULE:FREQ=WEEKLY;UNTIL=19971007T000000Z;WKST=SU;BYDAY=TU,TH- Specified by:
getRecurrenceRule
in interfaceVRepeatable<T>
-
setRecurrenceRule
- Specified by:
setRecurrenceRule
in interfaceVRepeatable<T>
-
getSequence
SEQUENCE: RFC 5545 iCalendar 3.8.7.4. page 138 This property defines the revision sequence number of the calendar component within a sequence of revisions. Example: The following is an example of this property for a calendar component that was just created by the "Organizer": SEQUENCE:0 The following is an example of this property for a calendar component that has been revised two different times by the "Organizer": SEQUENCE:2 -
setSequence
-
setSequence
-
setSequence
-
withSequence
-
withSequence
-
withSequence
-
incrementSequence
public void incrementSequence() -
getStatus
STATUS RFC 5545 iCalendar 3.8.1.11. page 92 This property defines the overall status or confirmation for the calendar component. Example: STATUS:TENTATIVE -
setStatus
-
setStatus
-
setStatus
-
withStatus
-
withStatus
-
withStatus
-
getSummary
SUMMARY RFC 5545 iCalendar 3.8.1.12. page 93 This property defines a short summary or subject for the calendar component. Example: SUMMARY:Department Party- Specified by:
getSummary
in interfaceVDescribable<T>
-
setSummary
- Specified by:
setSummary
in interfaceVDescribable<T>
-
dateTimeStartListenerHook
void dateTimeStartListenerHook()Description copied from class:VPrimary
DTSTART: Date-Time Start, from RFC 5545 iCalendar 3.8.2.4 page 97 Start date/time of repeat rule. Used as a starting point for making the Streamof valid start date/times of the repeating events. Can contain either a LocalDate (DATE) or LocalDateTime (DATE-TIME) - Overrides:
dateTimeStartListenerHook
in classVPrimary<T>
-
streamRecurrences
Deprecated.Description copied from interface:VRepeatable
Produces a stream of dates or date-times (depending on DTSTART) that represents the start of each element in the recurrence set. The values are calculated after applying DTSTART, RDATE, RRULE, and EXDATE properties. If the RRULE is forever, then the stream has no end as well. For a VEvent without RRULE or RDATE the stream will contain only one element.- Specified by:
streamRecurrences
in interfaceVRepeatable<T>
- Parameters:
start
- - include recurrences that END before this value- Returns:
- - stream of start dates or date/times for the recurrence set
-
recurrenceCache
Description copied from interface:VRepeatable
Handles caching of recurrence start Temporal values.- Specified by:
recurrenceCache
in interfaceVRepeatable<T>
-
recurrenceChildren
-
recurrenceParent
-
orphanedRecurrenceChildren
returns list of orphaned recurrence components due to a change. These components should be deleted -
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 -
eraseDateTimeProperties
public void eraseDateTimeProperties()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.
-