used to represent an item of work assigned to an individual; such as "turn in travel expense today".
public class VTodo extends VLocatable<VTodo> implements VDescribable2<VTodo>
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
| Type | Property and Description |
|---|---|
javafx.beans.property.ObjectProperty<DateTimeCompleted> |
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.
|
javafx.beans.property.ObjectProperty<DateTimeDue> |
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.
|
javafx.beans.property.ObjectProperty<DurationProp> |
duration
Ensures DateTimeDue and Duration are not both used.
|
javafx.beans.property.ObjectProperty<PercentComplete> |
percentComplete
PERCENT-COMPLETE
RFC 5545 iCalendar 3.8.1.8.
|
descriptionProperty, geographicPositionProperty, locationProperty, priorityProperty, resourcesPropertyattachmentsProperty, categoriesProperty, classificationProperty, contactsProperty, dateTimeCreatedProperty, dateTimeLastModifiedProperty, exceptionDatesProperty, recurrenceDatesProperty, recurrenceIdProperty, recurrenceRuleProperty, relatedToProperty, sequenceProperty, statusProperty, summaryPropertyattendeesProperty, dateTimeStampProperty, organizerProperty, requestStatusProperty, uniformResourceLocatorProperty, uniqueIdentifierPropertycommentsProperty, dateTimeStartPropertynonStandardPropertydescriptionPropertyattachmentsProperty, summaryPropertyVRepeatable.MergedIterator<T>DTSTART_COMPARATOR| Modifier and Type | Method and Description |
|---|---|
javafx.beans.property.ObjectProperty<DateTimeCompleted> |
dateTimeCompletedProperty()
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.
|
javafx.beans.property.ObjectProperty<DateTimeDue> |
dateTimeDueProperty()
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.
|
javafx.beans.property.ObjectProperty<DurationProp> |
durationProperty()
Ensures DateTimeDue and Duration are not both used.
|
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 |
java.time.temporal.TemporalAmount |
getActualDuration()
A convenience method that returns either Duration property value, or a calculated duration based on start and end values
|
DateTimeCompleted |
getDateTimeCompleted() |
DateTimeDue |
getDateTimeDue() |
PercentComplete |
getPercentComplete() |
static VTodo |
parse(java.lang.String contentLines)
Parse content lines into calendar component object
|
javafx.beans.property.ObjectProperty<PercentComplete> |
percentCompleteProperty()
PERCENT-COMPLETE
RFC 5545 iCalendar 3.8.1.8.
|
void |
setDateTimeCompleted(DateTimeCompleted completed) |
void |
setDateTimeCompleted(java.lang.String completed) |
void |
setDateTimeCompleted(java.time.ZonedDateTime completed) |
void |
setDateTimeDue(DateTimeDue due) |
void |
setDateTimeDue(java.lang.String due) |
void |
setDateTimeDue(java.time.temporal.Temporal due) |
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 |
setPercentComplete(java.lang.Integer percentComplete) |
void |
setPercentComplete(PercentComplete percentComplete) |
void |
setPercentComplete(java.lang.String percentComplete) |
VTodo |
withDateTimeCompleted(DateTimeCompleted completed) |
VTodo |
withDateTimeCompleted(java.lang.String completed) |
VTodo |
withDateTimeCompleted(java.time.ZonedDateTime completed) |
VTodo |
withDateTimeDue(DateTimeDue due) |
VTodo |
withDateTimeDue(java.lang.String due) |
VTodo |
withDateTimeDue(java.time.temporal.Temporal due) |
VTodo |
withPercentComplete(java.lang.Integer percentComplete) |
VTodo |
withPercentComplete(PercentComplete percentComplete) |
VTodo |
withPercentComplete(java.lang.String percentComplete) |
copyInto, descriptionProperty, equals, geographicPositionProperty, getDescription, getGeographicPosition, getLocation, getPriority, getResources, getVAlarms, hashCode, locationProperty, priorityProperty, resourcesProperty, setGeographicPosition, setGeographicPosition, setGeographicPosition, setLocation, setLocation, setPriority, setPriority, setPriority, setResources, setVAlarms, streamRecurrences, withGeographicPosition, withGeographicPosition, withGeographicPosition, withLocation, withLocation, withPriority, withPriority, withPriority, withResources, withResources, withResources, withVAlarms, withVAlarmsattachmentsProperty, 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, withStatusattendeesProperty, 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, withUniqueIdentifiercommentsProperty, dateTimeStartProperty, getComments, getDateTimeStart, isWholeDay, setComments, setDateTimeStart, setDateTimeStart, setDateTimeStart, withComments, withComments, withComments, withDateTimeStart, withDateTimeStart, withDateTimeStartgetNonStandard, nonStandardProperty, setNonStandard, withNonStandard, withNonStandard, withNonStandardgetParent, name, parseContent, parseContent, setParent, toStringchildrenUnmodifiable, copyIntoCallback, orderer, setContentLineGenerator, toContentclone, finalize, getClass, notify, notifyAll, wait, wait, waitdescriptionProperty, getDescription, setDescription, setDescription, withDescription, withDescriptionattachmentsProperty, getAttachments, getSummary, setAttachments, setSummary, setSummary, summaryProperty, withAttachments, withAttachments, withAttachments, withSummary, withSummaryparseContent, toContentchildrenUnmodifiable, copyIntoisValid, name, parseContentgetDuration, setDuration, setDuration, setDuration, withDuration, withDuration, withDurationcheckDateTimeStartConsistency, checkPotentialRecurrencesConsistency, checkRecurrencesConsistency, errorsRepeatable, getDateTimeStart, getRecurrencesConsistencyWithDateTimeStartListener, isRecurrence, isRecurrenceSetEmpty, lastRecurrence, merge, previousStreamValue, setRecurrenceRule, setRecurrenceRule, setRecurrenceRule, streamRecurrences, streamRecurrences, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceDates, withRecurrenceRule, withRecurrenceRule, withRecurrenceRulesetDateTimeLastModified, setDateTimeLastModified, setDateTimeLastModified, withDateTimeLastModified, withDateTimeLastModified, withDateTimeLastModifiedwithAttendees, withAttendees, withAttendeespublic javafx.beans.property.ObjectProperty<DateTimeCompleted> dateTimeCompletedProperty
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
public javafx.beans.property.ObjectProperty<DateTimeDue> dateTimeDueProperty
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
getDateTimeDue(),
setDateTimeDue(String)public javafx.beans.property.ObjectProperty<DurationProp> durationProperty
Ensures DateTimeDue and Duration are not both used.
durationProperty in interface VDuration<VTodo>durationProperty in class VLocatable<VTodo>VDuration.getDuration(),
VDuration.setDuration(DurationProp)public javafx.beans.property.ObjectProperty<PercentComplete> percentCompleteProperty
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
getPercentComplete(),
setPercentComplete(String)public VTodo()
public VTodo(VTodo source)
public javafx.beans.property.ObjectProperty<DateTimeCompleted> dateTimeCompletedProperty()
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
public DateTimeCompleted getDateTimeCompleted()
public void setDateTimeCompleted(java.lang.String completed)
public void setDateTimeCompleted(DateTimeCompleted completed)
public void setDateTimeCompleted(java.time.ZonedDateTime completed)
public VTodo withDateTimeCompleted(java.time.ZonedDateTime completed)
public VTodo withDateTimeCompleted(java.lang.String completed)
public VTodo withDateTimeCompleted(DateTimeCompleted completed)
public javafx.beans.property.ObjectProperty<DateTimeDue> dateTimeDueProperty()
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
getDateTimeDue(),
setDateTimeDue(String)public DateTimeDue getDateTimeDue()
public void setDateTimeDue(java.lang.String due)
public void setDateTimeDue(DateTimeDue due)
public void setDateTimeDue(java.time.temporal.Temporal due)
public VTodo withDateTimeDue(java.time.temporal.Temporal due)
public VTodo withDateTimeDue(java.lang.String due)
public VTodo withDateTimeDue(DateTimeDue due)
public javafx.beans.property.ObjectProperty<DurationProp> durationProperty()
Ensures DateTimeDue and Duration are not both used.
durationProperty in interface VDuration<VTodo>durationProperty in class VLocatable<VTodo>VDuration.getDuration(),
VDuration.setDuration(DurationProp)public javafx.beans.property.ObjectProperty<PercentComplete> percentCompleteProperty()
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
getPercentComplete(),
setPercentComplete(String)public PercentComplete getPercentComplete()
public void setPercentComplete(java.lang.String percentComplete)
public void setPercentComplete(java.lang.Integer percentComplete)
public void setPercentComplete(PercentComplete percentComplete)
public VTodo withPercentComplete(PercentComplete percentComplete)
public VTodo withPercentComplete(java.lang.Integer percentComplete)
public VTodo withPercentComplete(java.lang.String percentComplete)
public java.time.temporal.TemporalAmount getActualDuration()
VLocatableA convenience method that returns either Duration property value, or a calculated duration based on start and end values
getActualDuration in class VLocatable<VTodo>public void setEndOrDuration(java.time.temporal.Temporal startRecurrence,
java.time.temporal.Temporal endRecurrence)
VLocatableA 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.
setEndOrDuration in class VLocatable<VTodo>public java.util.List<java.lang.String> errors()
VElementProduces 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
errors in interface VElementerrors in class VLocatable<VTodo>public void eraseDateTimeProperties()
VDisplayableErase 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.
eraseDateTimeProperties in class VLocatable<VTodo>public static VTodo parse(java.lang.String contentLines)
Parse content lines into calendar component object