jfxtras.labs.icalendar

Class VCalendar

java.lang.Object

jfxtras.labs.icalendar.VCalendar

public class VCalendar
extends java.lang.Object

API Based on Internet Calendaring and Scheduling Core Object Specification (iCalendar) RFC5545

Parent calendaring and scheduling core object. It contains two required properties, one optional property, and collections of calendar components.

calprops   = *(
          ;
          ; The following are REQUIRED,
          ; but MUST NOT occur more than once.
          ;
          prodid / version /
          ;
          ; The following are OPTIONAL,
          ; but MUST NOT occur more than once.
          ;
          calscale / method /
          ;
          ; The following are OPTIONAL,
          ; and MAY occur more than once.
          ;
          x-prop / iana-prop
          ;
          )

component  = 1*(eventc / todoc / journalc / freebusyc /
             timezonec / iana-comp / x-comp)

iana-comp  = "BEGIN" ":" iana-token CRLF
             1*contentline
             "END" ":" iana-token CRLF

x-comp     = "BEGIN" ":" x-name CRLF
             1*contentline
             "END" ":" x-name CRLF

See Also:

VCalendarUtilities

Property Summary

Type	Property and Description
javafx.beans.property.StringProperty	calendarScale CALSCALE: RFC 5545 iCalendar 3.7.1.
javafx.beans.property.StringProperty	iCalendarSpecificationVersion VERSION: RFC 5545 iCalendar 3.7.4.
javafx.beans.property.StringProperty	objectMethod METHOD: RFC 5545 iCalendar 3.7.2.
javafx.beans.property.StringProperty	productIdentifier PRODID: RFC 5545 iCalendar 3.7.3.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CALENDAR_SCALE
static java.lang.String	DEFAULT_ICALENDAR_SPECIFICATION_VERSION
static java.lang.String	DEFAULT_PRODUCT_IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
VCalendar()

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.StringProperty	calendarScaleProperty() CALSCALE: RFC 5545 iCalendar 3.7.1.
java.lang.String	getCalendarScale()
java.lang.String	getICalendarSpecificationVersion()
javafx.util.Callback<java.lang.String,VEvent<?,?>>	getMakeVEventCallback() VEVENT Callback Callback to make a VEvent from a string.
javafx.util.Callback<java.lang.String,VJournal<?,?>>	getMakeVJournalCallback() VJOURNAL callback Callback to make a VJournal from a string.
javafx.util.Callback<java.lang.String,VTodo<?,?>>	getMakeVTodoCallback() VTODO Callback Callback to make a VTodo from a string.
java.lang.String	getObjectMethod()
java.lang.String	getProductIdentifier()
javafx.beans.property.StringProperty	iCalendarSpecificationVersionProperty() VERSION: RFC 5545 iCalendar 3.7.4.
javafx.beans.property.StringProperty	objectMethodProperty() METHOD: RFC 5545 iCalendar 3.7.2.
javafx.beans.property.StringProperty	productIdentifierProperty() PRODID: RFC 5545 iCalendar 3.7.3.
void	setCalendarScale(java.lang.String value)
void	setICalendarSpecificationVersion(java.lang.String value)
void	setMakeVEventCallback(javafx.util.Callback<java.lang.String,VEvent<?,?>> callback)
void	setMakeVJournalCallback(javafx.util.Callback<java.lang.String,VJournal<?,?>> callback)
void	setMakeVTodoCallback(javafx.util.Callback<java.lang.String,VTodo<?,?>> callback)
void	setObjectMethod(java.lang.String value)
void	setProductIdentifier(java.lang.String value)
javafx.collections.ObservableList<VAlarm>	vAlarms() VALARM: RFC 5545 iCalendar 3.6.6.
javafx.collections.ObservableList<VEvent<?,?>>	vEvents() VEVENT: RFC 5545 iCalendar 3.6.1.
javafx.collections.ObservableList<VFreeBusy>	vFreeBusyList() VFREEBUSY: RFC 5545 iCalendar 3.6.4.
javafx.collections.ObservableList<VJournal<?,?>>	vJournals() VJOURNAL: RFC 5545 iCalendar 3.6.3.
javafx.collections.ObservableList<VTimeZone>	vTimeZones() VTIMEZONE: RFC 5545 iCalendar 3.6.5.
javafx.collections.ObservableList<VTodo<?,?>>	vTodos() VTODO: RFC 5545 iCalendar 3.6.2.
VCalendar	withCalendarScale(java.lang.String s)
VCalendar	withICalendarSpecificationVersion(java.lang.String s)
VCalendar	withObjectMethod(java.lang.String s)
VCalendar	withProductIdentifier(java.lang.String s)
VCalendar	withVEventCallback(javafx.util.Callback<java.lang.String,VEvent<?,?>> callback)
VCalendar	withVJournalCallback(javafx.util.Callback<java.lang.String,VJournal<?,?>> callback)
VCalendar	withVTodoCallback(javafx.util.Callback<java.lang.String,VTodo<?,?>> callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

calendarScale

public javafx.beans.property.StringProperty calendarScaleProperty

CALSCALE: RFC 5545 iCalendar 3.7.1. page 76 This property defines the calendar scale used for the calendar information specified in the iCalendar object.

This project is based on the Gregorian calendar scale. The Gregorian calendar scale is assumed if this property is not specified in the iCalendar object. It is expected that other calendar scales will be defined in other specifications or by future versions of iCalendar.

The default value is "GREGORIAN"

Example: CALSCALE:GREGORIAN

See Also:

getCalendarScale(), setCalendarScale(String)

objectMethod

public javafx.beans.property.StringProperty objectMethodProperty

METHOD: RFC 5545 iCalendar 3.7.2. page 77 This property defines the iCalendar object method associated with the calendar object

Example: METHOD:REQUEST

See Also:

getObjectMethod(), setObjectMethod(String)

productIdentifier

public javafx.beans.property.StringProperty productIdentifierProperty

PRODID: RFC 5545 iCalendar 3.7.3. page 78 This property specifies the identifier for the product that created the iCalendar object

This project is named JFxtras iCalendar

Example: PRODID:-//JFxtras//JFXtras iCalendar 1.0//EN

See Also:

getProductIdentifier(), setProductIdentifier(String)

iCalendarSpecificationVersion

public javafx.beans.property.StringProperty iCalendarSpecificationVersionProperty

VERSION: RFC 5545 iCalendar 3.7.4. page 79 This property specifies the identifier corresponding to the highest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object.

This project complies with version 2.0

Example: VERSION:2.0

See Also:

getICalendarSpecificationVersion(), setICalendarSpecificationVersion(String)

Field Detail

DEFAULT_PRODUCT_IDENTIFIER

public static final java.lang.String DEFAULT_PRODUCT_IDENTIFIER

DEFAULT_CALENDAR_SCALE

public static final java.lang.String DEFAULT_CALENDAR_SCALE

See Also:

Constant Field Values

DEFAULT_ICALENDAR_SPECIFICATION_VERSION

public static final java.lang.String DEFAULT_ICALENDAR_SPECIFICATION_VERSION

See Also:

Constant Field Values

Constructor Detail

VCalendar

public VCalendar()

Method Detail

calendarScaleProperty

public javafx.beans.property.StringProperty calendarScaleProperty()

CALSCALE: RFC 5545 iCalendar 3.7.1. page 76 This property defines the calendar scale used for the calendar information specified in the iCalendar object.

This project is based on the Gregorian calendar scale. The Gregorian calendar scale is assumed if this property is not specified in the iCalendar object. It is expected that other calendar scales will be defined in other specifications or by future versions of iCalendar.

The default value is "GREGORIAN"

Example: CALSCALE:GREGORIAN

See Also:

getCalendarScale(), setCalendarScale(String)

getCalendarScale

public java.lang.String getCalendarScale()

setCalendarScale

public void setCalendarScale(java.lang.String value)

withCalendarScale

public VCalendar withCalendarScale(java.lang.String s)

objectMethodProperty

public javafx.beans.property.StringProperty objectMethodProperty()

METHOD: RFC 5545 iCalendar 3.7.2. page 77 This property defines the iCalendar object method associated with the calendar object

Example: METHOD:REQUEST

See Also:

getObjectMethod(), setObjectMethod(String)

getObjectMethod

public java.lang.String getObjectMethod()

setObjectMethod

public void setObjectMethod(java.lang.String value)

withObjectMethod

public VCalendar withObjectMethod(java.lang.String s)

productIdentifierProperty

public javafx.beans.property.StringProperty productIdentifierProperty()

PRODID: RFC 5545 iCalendar 3.7.3. page 78 This property specifies the identifier for the product that created the iCalendar object

This project is named JFxtras iCalendar

Example: PRODID:-//JFxtras//JFXtras iCalendar 1.0//EN

See Also:

getProductIdentifier(), setProductIdentifier(String)

getProductIdentifier

public java.lang.String getProductIdentifier()

setProductIdentifier

public void setProductIdentifier(java.lang.String value)

withProductIdentifier

public VCalendar withProductIdentifier(java.lang.String s)

iCalendarSpecificationVersionProperty

public javafx.beans.property.StringProperty iCalendarSpecificationVersionProperty()

VERSION: RFC 5545 iCalendar 3.7.4. page 79 This property specifies the identifier corresponding to the highest version number or the minimum and maximum range of the iCalendar specification that is required in order to interpret the iCalendar object.

This project complies with version 2.0

Example: VERSION:2.0

See Also:

getICalendarSpecificationVersion(), setICalendarSpecificationVersion(String)

getICalendarSpecificationVersion

public java.lang.String getICalendarSpecificationVersion()

setICalendarSpecificationVersion

public void setICalendarSpecificationVersion(java.lang.String value)

withICalendarSpecificationVersion

public VCalendar withICalendarSpecificationVersion(java.lang.String s)

vEvents

public javafx.collections.ObservableList<VEvent<?,?>> vEvents()

VEVENT: RFC 5545 iCalendar 3.6.1. page 52

A grouping of component properties that describe an event.

See Also:

VComponent, VEvent

getMakeVEventCallback

public javafx.util.Callback<java.lang.String,VEvent<?,?>> getMakeVEventCallback()

VEVENT Callback Callback to make a VEvent from a string. This defines how the specific VEvent implementation creates VEvent objects

For example, the following callback is used in the test cases with the VEvent implementation VEventMock: (s) → VEventMock.parse(s)

setMakeVEventCallback

public void setMakeVEventCallback(javafx.util.Callback<java.lang.String,VEvent<?,?>> callback)

withVEventCallback

public VCalendar withVEventCallback(javafx.util.Callback<java.lang.String,VEvent<?,?>> callback)

vTodos

public javafx.collections.ObservableList<VTodo<?,?>> vTodos()

VTODO: RFC 5545 iCalendar 3.6.2. page 55

A grouping of component properties that describe a task that needs to be completed.

See Also:

VComponent, VTodo

getMakeVTodoCallback

public javafx.util.Callback<java.lang.String,VTodo<?,?>> getMakeVTodoCallback()

VTODO Callback Callback to make a VTodo from a string. This defines how the specific VTodo implementation creates VTodo objects

setMakeVTodoCallback

public void setMakeVTodoCallback(javafx.util.Callback<java.lang.String,VTodo<?,?>> callback)

withVTodoCallback

public VCalendar withVTodoCallback(javafx.util.Callback<java.lang.String,VTodo<?,?>> callback)

vJournals

public javafx.collections.ObservableList<VJournal<?,?>> vJournals()

VJOURNAL: RFC 5545 iCalendar 3.6.3. page 57

A grouping of component properties that describe a task that needs to be completed.

See Also:

VComponent, VJournal

getMakeVJournalCallback

public javafx.util.Callback<java.lang.String,VJournal<?,?>> getMakeVJournalCallback()

VJOURNAL callback Callback to make a VJournal from a string. This defines how the specific VJournal implementation creates VJournal objects

setMakeVJournalCallback

public void setMakeVJournalCallback(javafx.util.Callback<java.lang.String,VJournal<?,?>> callback)

withVJournalCallback

public VCalendar withVJournalCallback(javafx.util.Callback<java.lang.String,VJournal<?,?>> callback)

vFreeBusyList

public javafx.collections.ObservableList<VFreeBusy> vFreeBusyList()

VFREEBUSY: RFC 5545 iCalendar 3.6.4. page 59

See Also:

VFreeBusy

vTimeZones

public javafx.collections.ObservableList<VTimeZone> vTimeZones()

VTIMEZONE: RFC 5545 iCalendar 3.6.5. page 62

See Also:

VTimeZone

vAlarms

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

VALARM: RFC 5545 iCalendar 3.6.6. page 71

See Also:

VAlarm