java.lang.Object
- All Implemented Interfaces:
VAttendee<VTodo>
,VComponent
,VDescribable<VTodo>
,VDescribable2<VTodo>
,VDuration<VTodo>
,VLastModified<VTodo>
,VRepeatable<VTodo>
,VChild
,VElement
,VParent
VTODO
To-Do Component
RFC 5545, 3.6.2, page 55
A "VTODO" calendar component is a grouping of component
properties and possibly "VALARM" calendar components that
represent an action-item or assignment. For example, it can be
used to represent an item of work assigned to an individual; such
as "turn in travel expense today".
The "VTODO" calendar component cannot be nested within another
calendar component. However, "VTODO" calendar components can be
related to each other or to a "VEVENT" or to a "VJOURNAL" calendar
component with the "RELATED-TO" property.
A "VTODO" calendar component without the "DTSTART" and "DUE" (or
"DURATION") properties specifies a to-do that will be associated
with each successive calendar date, until it is completed.
Examples: The following is an example of a "VTODO" calendar
component that needs to be completed before May 1st, 2007. On
midnight May 1st, 2007 this to-do would be considered overdue.
BEGIN:VTODO
UID:20070313T123432Z-456553@example.com
DTSTAMP:20070313T123432Z
DUE;VALUE=DATE:20070501
SUMMARY:Submit Quebec Income Tax Return for 2006
CLASS:CONFIDENTIAL
CATEGORIES:FAMILY,FINANCE
STATUS:NEEDS-ACTION
END:VTODO
-
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 DateTimeCompleted
COMPLETED: Date-Time Completed RFC 5545 iCalendar 3.8.2.1 page 94 This property defines the date and time that a to-do was actually completed.private DateTimeDue
DUE: Date-Time Due RFC 5545 iCalendar 3.8.2.3 page 96 This property defines the date and time that a to-do is expected to be completed.private PercentComplete
PERCENT-COMPLETE RFC 5545 iCalendar 3.8.1.8.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
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 parentA convenience method that returns either Duration property value, or a calculated duration based on start and end valuesstatic VTodo
Creates a new VTodo calendar component by parsing a String of iCalendar content linesvoid
setDateTimeCompleted
(String dateTimeCompleted) void
setDateTimeCompleted
(ZonedDateTime dateTimeCompleted) void
setDateTimeCompleted
(DateTimeCompleted dateTimeCompleted) void
setDateTimeDue
(String dateTimeDue) void
setDateTimeDue
(Temporal dateTimeDue) void
setDateTimeDue
(DateTimeDue dateTimeDue) void
setDuration
(DurationProp duration) Sets the value of theDurationProp
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
setPercentComplete
(Integer percentComplete) void
setPercentComplete
(String percentComplete) void
setPercentComplete
(PercentComplete percentComplete) withDateTimeCompleted
(String dateTimeCompleted) withDateTimeCompleted
(ZonedDateTime dateTimeCompleted) withDateTimeCompleted
(DateTimeCompleted dateTimeCompleted) withDateTimeDue
(String dateTimeDue) withDateTimeDue
(Temporal dateTimeDue) withDateTimeDue
(DateTimeDue dateTimeDue) withPercentComplete
(Integer percentComplete) withPercentComplete
(String percentComplete) withPercentComplete
(PercentComplete percentComplete) Methods inherited from class jfxtras.icalendarfx.components.VLocatable
addSubcomponent, getDescription, getDuration, getGeographicPosition, getLocation, getPriority, getResources, getVAlarms, hashCode, setDescription, 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.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, isRecurrence, isRecurrenceSetEmpty, lastRecurrence, previousStreamValue, setRecurrenceRule, setRecurrenceRule, streamRecurrences, streamRecurrences, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceRule, withRecurrenceRule, withRecurrenceRule
-
Field Details
-
dateTimeCompleted
COMPLETED: Date-Time Completed RFC 5545 iCalendar 3.8.2.1 page 94 This property defines the date and time that a to-do was actually completed. The value MUST be specified in the UTC time format. Example: COMPLETED:19960401T150000Z -
dateTimeDue
DUE: Date-Time Due RFC 5545 iCalendar 3.8.2.3 page 96 This property defines the date and time that a to-do is expected to be completed. the value type of this property MUST be the same as the "DTSTART" property Example: DUE:TZID=America/Los_Angeles:19970512T090000 -
percentComplete
PERCENT-COMPLETE RFC 5545 iCalendar 3.8.1.8. page 88 This property is used by an assignee or delegatee of a to-do to convey the percent completion of a to-do to the "Organizer". The property value is a positive integer between 0 and 100. A value of "0" indicates the to-do has not yet been started. A value of "100" indicates that the to-do has been completed. Example: The following is an example of this property to show 39% completion: PERCENT-COMPLETE:39
-
-
Constructor Details
-
VTodo
public VTodo() -
VTodo
-
-
Method Details
-
getDateTimeCompleted
-
setDateTimeCompleted
-
setDateTimeCompleted
-
setDateTimeCompleted
-
withDateTimeCompleted
-
withDateTimeCompleted
-
withDateTimeCompleted
-
getDateTimeDue
-
setDateTimeDue
-
setDateTimeDue
-
setDateTimeDue
-
withDateTimeDue
-
withDateTimeDue
-
withDateTimeDue
-
setDuration
Description copied from interface:VDuration
Sets the value of theDurationProp
- Specified by:
setDuration
in interfaceVDuration<VTodo>
- Overrides:
setDuration
in classVLocatable<VTodo>
-
getPercentComplete
-
setPercentComplete
-
setPercentComplete
-
setPercentComplete
-
withPercentComplete
-
withPercentComplete
-
withPercentComplete
-
calendarList
- Specified by:
calendarList
in interfaceVComponent
-
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<VTodo>
-
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<VTodo>
-
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<VTodo>
- Returns:
- - list of error messages
-
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 classVLocatable<VTodo>
-
parse
Creates a new VTodo calendar component by parsing a String of iCalendar content lines- Parameters:
content
- the text to parse, not null- Returns:
- the parsed VTodo
-