jfxtras.icalendarfx.components

Class VLocatable<T>

java.lang.Object

jfxtras.icalendarfx.VParentBase

jfxtras.icalendarfx.components.VComponentBase

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>

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<Description>	description DESCRIPTION RFC 5545 iCalendar 3.8.1.5.
javafx.beans.property.ObjectProperty<DurationProp>	duration DURATION RFC 5545 iCalendar 3.8.2.5 page 99, 3.3.6 page 34 Can’t be used if DTEND is used.
javafx.beans.property.ObjectProperty<GeographicPosition>	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.
javafx.beans.property.ObjectProperty<Location>	location LOCATION: RFC 5545 iCalendar 3.8.1.12.
javafx.beans.property.ObjectProperty<Priority>	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.
javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<Resources>>	resources RESOURCES: RFC 5545 iCalendar 3.8.1.10.

Properties inherited from class jfxtras.icalendarfx.components.VDisplayable

attachmentsProperty, categoriesProperty, classificationProperty, contactsProperty, dateTimeCreatedProperty, dateTimeLastModifiedProperty, exceptionDatesProperty, recurrenceDatesProperty, recurrenceIdProperty, recurrenceRuleProperty, relatedToProperty, sequenceProperty, statusProperty, summaryProperty

Properties inherited from class jfxtras.icalendarfx.components.VPersonal

attendeesProperty, dateTimeStampProperty, organizerProperty, requestStatusProperty, uniformResourceLocatorProperty, uniqueIdentifierProperty

Properties inherited from class jfxtras.icalendarfx.components.VPrimary

commentsProperty, dateTimeStartProperty

Properties inherited from class jfxtras.icalendarfx.components.VCommon

nonStandardProperty

Properties inherited from interface jfxtras.icalendarfx.components.VDescribable

attachmentsProperty, summaryProperty

Nested Class Summary

Nested classes/interfaces inherited from interface jfxtras.icalendarfx.components.VRepeatable

VRepeatable.MergedIterator<T>

Field Summary

Fields inherited from class jfxtras.icalendarfx.components.VPrimary

DTSTART_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
VLocatable()
VLocatable(VLocatable<T> source)

Method Summary

Modifier and Type	Method and Description
void	copyInto(VParent destination) Copy this VParent into destination VParent
javafx.beans.property.ObjectProperty<Description>	descriptionProperty() DESCRIPTION RFC 5545 iCalendar 3.8.1.5.
javafx.beans.property.ObjectProperty<DurationProp>	durationProperty() DURATION RFC 5545 iCalendar 3.8.2.5 page 99, 3.3.6 page 34 Can’t be used if DTEND is used.
boolean	equals(java.lang.Object obj)
void	eraseDateTimeProperties() Erase all date/time properties such as DTSTART, DTEND, DURATION, and DUE (which ever exist).
java.util.List<java.lang.String>	errors() Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent
javafx.beans.property.ObjectProperty<GeographicPosition>	geographicPositionProperty() 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.
abstract java.time.temporal.TemporalAmount	getActualDuration() A convenience method that returns either Duration property value, or a calculated duration based on start and end values
Description	getDescription()
GeographicPosition	getGeographicPosition()
Location	getLocation()
Priority	getPriority()
javafx.collections.ObservableList<Resources>	getResources()
javafx.collections.ObservableList<VAlarm>	getVAlarms() VALARM Alarm Component RFC 5545 iCalendar 3.6.6.
int	hashCode()
javafx.beans.property.ObjectProperty<Location>	locationProperty() LOCATION: RFC 5545 iCalendar 3.8.1.12.
javafx.beans.property.ObjectProperty<Priority>	priorityProperty() 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.
javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<Resources>>	resourcesProperty() RESOURCES: RFC 5545 iCalendar 3.8.1.10.
abstract void	setEndOrDuration(java.time.temporal.Temporal startRecurrence, java.time.temporal.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(GeographicPosition geographicPosition)
void	setGeographicPosition(java.lang.String geographicPosition)
void	setLocation(Location location)
void	setLocation(java.lang.String location)
void	setPriority(int priority)
void	setPriority(Priority priority)
void	setPriority(java.lang.String priority)
void	setResources(javafx.collections.ObservableList<Resources> resources)
void	setVAlarms(javafx.collections.ObservableList<VAlarm> vAlarms)
java.util.stream.Stream<java.time.temporal.Temporal>	streamRecurrences(java.time.temporal.Temporal start) Stream recurrence dates with adjustment to include recurrences that don’t end before start parameter
T	withGeographicPosition(double latitude, double longitude)
T	withGeographicPosition(GeographicPosition geographicPosition)
T	withGeographicPosition(java.lang.String geographicPosition)
T	withLocation(Location location)
T	withLocation(java.lang.String location)
T	withPriority(int priority)
T	withPriority(Priority priority)
T	withPriority(java.lang.String priority)
T	withResources(javafx.collections.ObservableList<Resources> resources)
T	withResources(Resources... resources)
T	withResources(java.lang.String... resources)
T	withVAlarms(javafx.collections.ObservableList<VAlarm> vAlarms)
T	withVAlarms(VAlarm... vAlarms)

Methods inherited from class jfxtras.icalendarfx.components.VDisplayable

attachmentsProperty, categoriesProperty, classificationProperty, contactsProperty, dateTimeCreatedProperty, dateTimeLastModifiedProperty, exceptionDatesProperty, getAttachments, getCategories, getClassification, getContacts, getDateTimeCreated, getDateTimeLastModified, getExceptionDates, getRecurrenceDates, getRecurrenceId, getRecurrenceRule, getRelatedTo, getSequence, getStatus, getSummary, incrementSequence, orphanedRecurrenceChildren, recurrenceCache, recurrenceChildren, recurrenceDatesProperty, recurrenceIdProperty, recurrenceParent, recurrenceRuleProperty, relatedToProperty, sequenceProperty, setAttachments, setCategories, setClassification, setClassification, setClassification, setContacts, setDateTimeCreated, setDateTimeCreated, setDateTimeCreated, setExceptionDates, setRecurrenceChildrenListCallBack, setRecurrenceDates, setRecurrenceId, setRecurrenceId, setRecurrenceId, setRecurrenceParentListCallBack, setRelatedTo, setSequence, setSequence, setSequence, setStatus, setStatus, setStatus, statusProperty, summaryProperty, 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

attendeesProperty, dateTimeStampProperty, getAttendees, getDateTimeStamp, getOrganizer, getRequestStatus, getUidGeneratorCallback, getUniformResourceLocator, getUniqueIdentifier, organizerProperty, parseContent, requestStatusProperty, setAttendees, setDateTimeStamp, setDateTimeStamp, setDateTimeStamp, setOrganizer, setOrganizer, setRequestStatus, setUidGeneratorCallback, setUniformResourceLocator, setUniformResourceLocator, setUniformResourceLocator, setUniqueIdentifier, setUniqueIdentifier, setUniqueIdentifier, uniformResourceLocatorProperty, uniqueIdentifierProperty, withDateTimeStamp, withDateTimeStamp, withDateTimeStamp, withOrganizer, withOrganizer, withRequestStatus, withRequestStatus, withRequestStatus, withUidGeneratorCallback, withUniformResourceLocator, withUniformResourceLocator, withUniformResourceLocator, withUniqueIdentifier, withUniqueIdentifier, withUniqueIdentifier

Methods inherited from class jfxtras.icalendarfx.components.VPrimary

commentsProperty, dateTimeStartProperty, getComments, getDateTimeStart, isWholeDay, setComments, setDateTimeStart, setDateTimeStart, setDateTimeStart, withComments, withComments, withComments, withDateTimeStart, withDateTimeStart, withDateTimeStart

Methods inherited from class jfxtras.icalendarfx.components.VCommon

getNonStandard, nonStandardProperty, setNonStandard, withNonStandard, withNonStandard, withNonStandard

Methods inherited from class jfxtras.icalendarfx.components.VComponentBase

getParent, name, parseContent, parseContent, setParent, toString

Methods inherited from class jfxtras.icalendarfx.VParentBase

childrenUnmodifiable, copyIntoCallback, orderer, setContentLineGenerator, toContent

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jfxtras.icalendarfx.components.VDescribable2

setDescription, setDescription, withDescription, withDescription

Methods inherited from interface jfxtras.icalendarfx.components.VDescribable

attachmentsProperty, getAttachments, getSummary, setAttachments, setSummary, setSummary, summaryProperty, withAttachments, withAttachments, withAttachments, withSummary, withSummary

Methods inherited from interface jfxtras.icalendarfx.components.VComponent

parseContent, toContent

Methods inherited from interface jfxtras.icalendarfx.VParent

childrenUnmodifiable

Methods inherited from interface jfxtras.icalendarfx.VChild

getParent, setParent

Methods inherited from interface jfxtras.icalendarfx.VElement

isValid, name, parseContent

Methods inherited from interface jfxtras.icalendarfx.components.VDuration

getDuration, setDuration, setDuration, setDuration, withDuration, withDuration, withDuration

Methods inherited from interface jfxtras.icalendarfx.components.VRepeatable

checkDateTimeStartConsistency, checkPotentialRecurrencesConsistency, checkRecurrencesConsistency, errorsRepeatable, getDateTimeStart, getRecurrencesConsistencyWithDateTimeStartListener, isRecurrence, isRecurrenceSetEmpty, lastRecurrence, merge, previousStreamValue, setRecurrenceRule, setRecurrenceRule, setRecurrenceRule, streamRecurrences, streamRecurrences, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceRule, withRecurrenceRule, withRecurrenceRule

Methods inherited from interface jfxtras.icalendarfx.components.VLastModified

setDateTimeLastModified, setDateTimeLastModified, setDateTimeLastModified, withDateTimeLastModified, withDateTimeLastModified, withDateTimeLastModified

Methods inherited from interface jfxtras.icalendarfx.components.VAttendee

withAttendees, withAttendees, withAttendees

Property Detail

description

public javafx.beans.property.ObjectProperty<Description> descriptionProperty

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:

descriptionProperty in interface VDescribable2<T>

See Also:

getDescription()

duration

public javafx.beans.property.ObjectProperty<DurationProp> durationProperty

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

Specified by:

durationProperty in interface VDuration<T>

See Also:

VDuration.getDuration(), VDuration.setDuration(DurationProp)

geographicPosition

public javafx.beans.property.ObjectProperty<GeographicPosition> geographicPositionProperty

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

See Also:

getGeographicPosition(), setGeographicPosition(GeographicPosition)

location

public javafx.beans.property.ObjectProperty<Location> 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(Location)

priority

public javafx.beans.property.ObjectProperty<Priority> priorityProperty

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

See Also:

getPriority(), setPriority(Priority)

resources

public javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<Resources>> resourcesProperty

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

See Also:

getResources(), setResources(ObservableList)

Constructor Detail

VLocatable

public VLocatable()

VLocatable

public VLocatable(VLocatable<T> source)

Method Detail

descriptionProperty

public javafx.beans.property.ObjectProperty<Description> descriptionProperty()

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:

descriptionProperty in interface VDescribable2<T>

See Also:

getDescription()

getDescription

public Description getDescription()

Specified by:

getDescription in interface VDescribable2<T>

durationProperty

public javafx.beans.property.ObjectProperty<DurationProp> durationProperty()

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

Specified by:

durationProperty in interface VDuration<T>

See Also:

VDuration.getDuration(), VDuration.setDuration(DurationProp)

geographicPositionProperty

public javafx.beans.property.ObjectProperty<GeographicPosition> geographicPositionProperty()

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

See Also:

getGeographicPosition(), setGeographicPosition(GeographicPosition)

getGeographicPosition

public GeographicPosition getGeographicPosition()

setGeographicPosition

public void setGeographicPosition(GeographicPosition geographicPosition)

setGeographicPosition

public void setGeographicPosition(java.lang.String geographicPosition)

setGeographicPosition

public void setGeographicPosition(double latitude,
                                  double longitude)

withGeographicPosition

public T withGeographicPosition(GeographicPosition geographicPosition)

withGeographicPosition

public T withGeographicPosition(java.lang.String geographicPosition)

withGeographicPosition

public T withGeographicPosition(double latitude,
                                double longitude)

locationProperty

public javafx.beans.property.ObjectProperty<Location> 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(Location)

getLocation

public Location getLocation()

setLocation

public void setLocation(Location location)

setLocation

public void setLocation(java.lang.String location)

withLocation

public T withLocation(Location location)

withLocation

public T withLocation(java.lang.String location)

priorityProperty

public javafx.beans.property.ObjectProperty<Priority> priorityProperty()

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

See Also:

getPriority(), setPriority(Priority)

getPriority

public Priority getPriority()

setPriority

public void setPriority(Priority priority)

setPriority

public void setPriority(java.lang.String priority)

setPriority

public void setPriority(int priority)

withPriority

public T withPriority(Priority priority)

withPriority

public T withPriority(java.lang.String priority)

withPriority

public T withPriority(int priority)

resourcesProperty

public javafx.beans.property.ObjectProperty<javafx.collections.ObservableList<Resources>> resourcesProperty()

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

See Also:

getResources(), setResources(ObservableList)

getResources

public javafx.collections.ObservableList<Resources> getResources()

setResources

public void setResources(javafx.collections.ObservableList<Resources> resources)

withResources

public T withResources(javafx.collections.ObservableList<Resources> resources)

withResources

public T withResources(java.lang.String... resources)

withResources

public T withResources(Resources... resources)

getVAlarms

public javafx.collections.ObservableList<VAlarm> 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

public void setVAlarms(javafx.collections.ObservableList<VAlarm> vAlarms)

withVAlarms

public T withVAlarms(javafx.collections.ObservableList<VAlarm> vAlarms)

withVAlarms

public T withVAlarms(VAlarm... vAlarms)

copyInto

public void copyInto(VParent destination)

Description copied from interface: VParent

Copy this VParent into destination VParent

Specified by:

copyInto in interface VParent

Overrides:

copyInto in class VComponentBase

errors

public java.util.List<java.lang.String> errors()

Description copied from interface: VElement

Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent

Specified by:

errors in interface VElement

Overrides:

errors in class VDisplayable<T>

Returns:

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class VParentBase

hashCode

public int hashCode()

Overrides:

hashCode in class VParentBase

streamRecurrences

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

Stream recurrence dates with adjustment to include recurrences that don’t end before start parameter

Specified by:

streamRecurrences in interface VRepeatable<T>

Overrides:

streamRecurrences in class VDisplayable<T>

Parameters:

start - - include recurrences that END before this value

Returns:

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 class VDisplayable<T>

getActualDuration

public abstract java.time.temporal.TemporalAmount getActualDuration()

A convenience method that returns either Duration property value, or a calculated duration based on start and end values

setEndOrDuration

public abstract void setEndOrDuration(java.time.temporal.Temporal startRecurrence,
                                      java.time.temporal.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. 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 -