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>
jfxtras.icalendarfx.components.VLocatable<T>
- All Implemented Interfaces:
VAttendee<T>
,VComponent
,VDescribable<T>
,VDescribable2<T>
,VDuration<T>
,VLastModified<T>
,VRepeatable<T>
,VChild
,VElement
,VParent
- Direct Known Subclasses:
NonStandardComponent
,VEvent
,VTodo
public abstract class VLocatable<T>
extends VDisplayable<T>
implements VDescribable2<T>, VDuration<T>
-
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 Description
private DurationProp
DURATION RFC 5545 iCalendar 3.8.2.5 page 99, 3.3.6 page 34 Can't be used if DTEND is used.private GeographicPosition
GEO: Geographic Position RFC 5545 iCalendar 3.8.1.6 page 85, 3.3.6 page 85 This property specifies information related to the global position for the activity specified by a calendar component.private Location
LOCATION: RFC 5545 iCalendar 3.8.1.12.private Priority
PRIORITY RFC 5545 iCalendar 3.8.1.6 page 85, 3.3.6 page 85 This property defines the relative priority for a calendar component.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) void
addSubcomponent
(VComponent subcomponent) Hook to add subcomponent such as#VAlarm
,#StandardTime
and#DaylightSavingTime
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 parentabstract TemporalAmount
A convenience method that returns either Duration property value, or a calculated duration based on start and end valuesDESCRIPTION RFC 5545 iCalendar 3.8.1.5.Gets the value of theDurationProp
RESOURCES: RFC 5545 iCalendar 3.8.1.10.VALARM Alarm Component RFC 5545 iCalendar 3.6.6.int
hashCode()
void
setDescription
(Description description) void
setDuration
(DurationProp duration) Sets the value of theDurationProp
abstract 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
setGeographicPosition
(double latitude, double longitude) void
setGeographicPosition
(String geographicPosition) void
setGeographicPosition
(GeographicPosition geographicPosition) void
setLocation
(String location) void
setLocation
(Location location) void
setPriority
(int priority) void
setPriority
(String priority) void
setPriority
(Priority priority) void
setResources
(List<Resources> resources) void
setVAlarms
(List<VAlarm> vAlarms) streamRecurrences
(Temporal start) Stream recurrence dates with adjustment to include recurrences that don't end before start parameterwithGeographicPosition
(double latitude, double longitude) withGeographicPosition
(String geographicPosition) withGeographicPosition
(GeographicPosition geographicPosition) withLocation
(String location) withLocation
(Location location) withPriority
(int priority) withPriority
(String priority) withPriority
(Priority priority) withResources
(String... resources) withResources
(List<Resources> resources) withResources
(Resources... resources) withVAlarms
(String... vAlarms) withVAlarms
(List<VAlarm> vAlarms) withVAlarms
(VAlarm... vAlarms) 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
calendarList, toString
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
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, isRecurrence, isRecurrenceSetEmpty, lastRecurrence, previousStreamValue, setRecurrenceRule, setRecurrenceRule, streamRecurrences, streamRecurrences, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceRule, withRecurrenceRule, withRecurrenceRule
-
Field Details
-
description
-
duration
DURATION RFC 5545 iCalendar 3.8.2.5 page 99, 3.3.6 page 34 Can't be used if DTEND is used. Must be one or the other. Example: DURATION:PT15M -
geographicPosition
GEO: Geographic Position RFC 5545 iCalendar 3.8.1.6 page 85, 3.3.6 page 85 This property specifies information related to the global position for the activity specified by a calendar component. This property value specifies latitude and longitude, in that order (i.e., "LAT LON" ordering). Example: GEO:37.386013;-122.082932 -
location
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 -
priority
PRIORITY RFC 5545 iCalendar 3.8.1.6 page 85, 3.3.6 page 85 This property defines the relative priority for a calendar component. This priority is specified as an integer in the range 0 to 9. Example: The following is an example of a property with the highest priority: PRIORITY:1 -
resources
-
vAlarms
-
-
Constructor Details
-
VLocatable
public VLocatable() -
VLocatable
-
-
Method Details
-
getDescription
DESCRIPTION RFC 5545 iCalendar 3.8.1.5. 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. Note: Only VJournal allows multiple instances of DESCRIPTION- Specified by:
getDescription
in interfaceVDescribable2<T>
-
setDescription
- Specified by:
setDescription
in interfaceVDescribable2<T>
-
getDuration
Description copied from interface:VDuration
Gets the value of theDurationProp
- Specified by:
getDuration
in interfaceVDuration<T>
-
setDuration
Description copied from interface:VDuration
Sets the value of theDurationProp
- Specified by:
setDuration
in interfaceVDuration<T>
-
getGeographicPosition
-
setGeographicPosition
-
setGeographicPosition
-
setGeographicPosition
public void setGeographicPosition(double latitude, double longitude) -
withGeographicPosition
-
withGeographicPosition
-
withGeographicPosition
-
getLocation
-
setLocation
-
setLocation
-
withLocation
-
withLocation
-
getPriority
-
setPriority
-
setPriority
-
setPriority
public void setPriority(int priority) -
withPriority
-
withPriority
-
withPriority
-
getResources
RESOURCES: RFC 5545 iCalendar 3.8.1.10. page 91 This property defines the equipment or resources anticipated for an activity specified by a calendar component. More than one resource can be specified as a COMMA-separated list Example: RESOURCES:EASEL,PROJECTOR,VCR RESOURCES;LANGUAGE=fr:Nettoyeur haute pression -
setResources
-
withResources
-
withResources
-
withResources
-
getVAlarms
VALARM Alarm Component RFC 5545 iCalendar 3.6.6. page 71 Provide a grouping of component properties that define an alarm. The "VALARM" calendar component MUST only appear within either a "VEVENT" or "VTODO" calendar component. -
setVAlarms
-
withVAlarms
-
withVAlarms
-
withVAlarms
-
addSubcomponent
Description copied from class:VComponentBase
Hook to add subcomponent such as#VAlarm
,#StandardTime
and#DaylightSavingTime
- Overrides:
addSubcomponent
in classVComponentBase<T>
-
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 classVDisplayable<T>
- Returns:
- - list of error messages
-
hashCode
public int hashCode()- Overrides:
hashCode
in classVParentBase<T>
-
streamRecurrences
Stream recurrence dates with adjustment to include recurrences that don't end before start parameter- Specified by:
streamRecurrences
in interfaceVRepeatable<T>
- Overrides:
streamRecurrences
in classVDisplayable<T>
- Parameters:
start
- - include recurrences that END before this value- Returns:
- - stream of start dates or date/times for the recurrence set
-
eraseDateTimeProperties
public void eraseDateTimeProperties()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 classVDisplayable<T>
-
getActualDuration
A convenience method that returns either Duration property value, or a calculated duration based on start and end values -
setEndOrDuration
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.- Parameters:
startRecurrence
-endRecurrence
-
-