Packagecom.flexcalendar.components.calendar.core.dataModel.formatICalendar
Classpublic class Recur
InheritanceRecur Inheritance Object

Class representing Recur data type from iCalendar RFC - defines a recurrence. All fields named accordingly to RFC 5545, section 3.3.10. Recurrence Rule. See http://tools.ietf.org/html/rfc5545#section-3.3.10.



Public Properties
 PropertyDefined By
  byDay : Array
specifies a COMMA-separated list of days of the week valid values: SU, MO, TU, WE, TH, FR, SA each value can also be preceded by a positive (+n) or negative (-n) integer
Recur
  byHour : Array
specifies a COMMA- separated list of hours of the day valid values: 0-59
Recur
  byMinute : Array
specifies a COMMA-separated list of minutes valid values: 0-59
Recur
  byMonth : Array
specifies a COMMA-separated list of months of the year valid values: 1 to 12
Recur
  byMonthDay : Array
specifies a COMMA-separated list of days of the month valid values: 1 to 31 or -31 to -1
Recur
  bySecond : Array
specifies a COMMA-separated list of seconds within a minute valid values: 0-60 note: value 60 means "leap second"
Recur
  bySetPos : Array
specifies a COMMA-separated list of values that corresponds to the nth occurrence within the set of recurrence instances specified by the rule.
Recur
  byWeekNo : Array
specifies a COMMA-separated list of ordinals specifying weeks of the year valid values: 1 to 53 or -53 to -
Recur
  byYearDay : Array
specifies a COMMA-separated list of days of the year valid values: 1 to 366 or -366 to -1
Recur
  count : int
defines the number of occurrences at which to range-bound the recurrence
Recur
  experimentalValues : Array
Table of experimental values, unspecified by RFC.
Recur
  freq : String = DAILY
the type of recurrence rule valid values: SECONDLY, MINUTELY, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY
Recur
  interval : int
contains a positive integer representing at which intervals the recurrence rule repeats default (no value) means 1
Recur
  until : Date
defines a DATE or DATE-TIME value that bounds the recurrence rule in an inclusive manner
Recur
  wkSt : String
specifies the day on which the workweek starts valid values: MO, TU, WE, TH, FR, SA, and SU default (no value) means MO
Recur
Public Methods
 MethodDefined By
  
Recur(recurString:String, dateOptions:DateOptions)
Create Recur instance.
Recur
  
buildRecurrenceArray(dtStart:Date, periodStart:Date, periodEnd:Date, duration:int = 0):Array
Build array of start dates for this recur instance.
Recur
  
Recur
Public Constants
 ConstantDefined By
  DAILY : String = DAILY
[static] repeating events based on an interval of a day or more
Recur
  HOURLY : String = HOURLY
[static] repeating events based on an interval of an hour or more
Recur
  MINUTELY : String = MINUTELY
[static] repeating events based on an interval of a minute or more
Recur
  MONTHLY : String = MONTHLY
[static] repeating events based on an interval of a month or more
Recur
  SECONDLY : String = SECONDLY
[static] repeating events based on an interval of a second or more
Recur
  WEEKLY : String = WEEKLY
[static] repeating events based on an interval of a week or more
Recur
  YEARLY : String = YEARLY
[static] repeating events based on an interval of a year or more
Recur
Property Detail
byDayproperty
public var byDay:Array

specifies a COMMA-separated list of days of the week valid values: SU, MO, TU, WE, TH, FR, SA each value can also be preceded by a positive (+n) or negative (-n) integer

byHourproperty 
public var byHour:Array

specifies a COMMA- separated list of hours of the day valid values: 0-59

byMinuteproperty 
public var byMinute:Array

specifies a COMMA-separated list of minutes valid values: 0-59

byMonthproperty 
public var byMonth:Array

specifies a COMMA-separated list of months of the year valid values: 1 to 12

byMonthDayproperty 
public var byMonthDay:Array

specifies a COMMA-separated list of days of the month valid values: 1 to 31 or -31 to -1

bySecondproperty 
public var bySecond:Array

specifies a COMMA-separated list of seconds within a minute valid values: 0-60 note: value 60 means "leap second"

bySetPosproperty 
public var bySetPos:Array

specifies a COMMA-separated list of values that corresponds to the nth occurrence within the set of recurrence instances specified by the rule. valid values: 1 to 366 or -366 to -1

byWeekNoproperty 
public var byWeekNo:Array

specifies a COMMA-separated list of ordinals specifying weeks of the year valid values: 1 to 53 or -53 to -

byYearDayproperty 
public var byYearDay:Array

specifies a COMMA-separated list of days of the year valid values: 1 to 366 or -366 to -1

countproperty 
public var count:int

defines the number of occurrences at which to range-bound the recurrence

experimentalValuesproperty 
public var experimentalValues:Array

Table of experimental values, unspecified by RFC. Contains objects with "name" and "value" fields.

freqproperty 
public var freq:String = DAILY

the type of recurrence rule valid values: SECONDLY, MINUTELY, HOURLY, DAILY, WEEKLY, MONTHLY, YEARLY

intervalproperty 
public var interval:int

contains a positive integer representing at which intervals the recurrence rule repeats default (no value) means 1

untilproperty 
public var until:Date

defines a DATE or DATE-TIME value that bounds the recurrence rule in an inclusive manner

wkStproperty 
public var wkSt:String

specifies the day on which the workweek starts valid values: MO, TU, WE, TH, FR, SA, and SU default (no value) means MO

Constructor Detail
Recur()Constructor
public function Recur(recurString:String, dateOptions:DateOptions)

Create Recur instance. If provided recurString is invalid, an error is thrown.

Parameters
recurString:String — recurrence rule string, or null
 
dateOptions:DateOptions — date handling options
Method Detail
buildRecurrenceArray()method
public function buildRecurrenceArray(dtStart:Date, periodStart:Date, periodEnd:Date, duration:int = 0):Array

Build array of start dates for this recur instance.

Parameters

dtStart:Date — first occurrence
 
periodStart:Date — start of the requested period
 
periodEnd:Date — end of the requested period
 
duration:int (default = 0) — duration of the recurring instance, allows adding events starting before periodStart but ending after it

Returns
Array — array of start dates of recurring instance
buildRecurString()method 
public function buildRecurString():String

Returns
String
Constant Detail
DAILYConstant
public static const DAILY:String = DAILY

repeating events based on an interval of a day or more

HOURLYConstant 
public static const HOURLY:String = HOURLY

repeating events based on an interval of an hour or more

MINUTELYConstant 
public static const MINUTELY:String = MINUTELY

repeating events based on an interval of a minute or more

MONTHLYConstant 
public static const MONTHLY:String = MONTHLY

repeating events based on an interval of a month or more

SECONDLYConstant 
public static const SECONDLY:String = SECONDLY

repeating events based on an interval of a second or more

WEEKLYConstant 
public static const WEEKLY:String = WEEKLY

repeating events based on an interval of a week or more

YEARLYConstant 
public static const YEARLY:String = YEARLY

repeating events based on an interval of a year or more