Calendar

$(ANCHOR _Calendar) Represents time in week, month and year divisions. Remarks: Calendar is the abstract base class for the following Calendar implementations: Gregorian, Hebrew, Hijri, Japanese, Korean, Taiwan and ThaiBuddhist.

Members

Enums

CURRENT_ERA
anonymousenum CURRENT_ERA

Indicates the current era of the calendar.

DatePart
enum DatePart
Undocumented in source.
DayOfWeek
enum DayOfWeek
Undocumented in source.
GREGORIAN
anonymousenum GREGORIAN
Undocumented in source.
WeekRule
enum WeekRule
Undocumented in source.

Functions

addMonths
Time addMonths(Time t, int nMonths, bool truncateDay)

Returns a new Time with the specified number of months added. If the months are negative, the months are subtracted.

addYears
Time addYears(Time t, int nYears)

Add the specified number of years to the given Time.

eras
uint[] eras()

Property. When overridden, retrieves the list of eras in the current calendar.

getDayOfMonth
uint getDayOfMonth(Time time)

When overridden, returns the day of the month in the specified Time.

getDayOfWeek
DayOfWeek getDayOfWeek(Time time)

When overridden, returns the day of the week in the specified Time.

getDayOfYear
uint getDayOfYear(Time time)

When overridden, returns the day of the year in the specified Time.

getDaysInMonth
uint getDaysInMonth(uint year, uint month)

Returns the number of days in the specified _year and _month of the current era.

getDaysInMonth
uint getDaysInMonth(uint year, uint month, uint era)

When overridden, returns the number of days in the specified _year and _month of the specified _era.

getDaysInYear
uint getDaysInYear(uint year)

Returns the number of days in the specified _year of the current era.

getDaysInYear
uint getDaysInYear(uint year, uint era)

When overridden, returns the number of days in the specified _year of the specified _era.

getEra
uint getEra(Time time)

When overridden, returns the era in the specified Time.

getMonth
uint getMonth(Time time)

When overridden, returns the month in the specified Time.

getMonthsInYear
uint getMonthsInYear(uint year)

Returns the number of months in the specified _year of the current era.

getMonthsInYear
uint getMonthsInYear(uint year, uint era)

When overridden, returns the number of months in the specified _year of the specified _era.

getWeekOfYear
uint getWeekOfYear(Time time, WeekRule rule, DayOfWeek firstDayOfWeek)

Returns the week of the year that includes the specified Time.

getYear
uint getYear(Time time)

When overridden, returns the year in the specified Time.

id
uint id()

Property. Retrieves the identifier associated with the current calendar.

isLeapYear
bool isLeapYear(uint year)

Indicates whether the specified _year in the current era is a leap _year.

isLeapYear
bool isLeapYear(uint year, uint era)

When overridden, indicates whether the specified _year in the specified _era is a leap _year.

split
void split(Time time, uint year, uint month, uint day, uint doy, uint dow, uint era)

Get the components of a Time structure using the rules of the calendar. This is useful if you want more than one of the given components. Note that this doesn't handle the time of day, as that is calculated directly from the Time struct.

toDate
Date toDate(Time time)

Get the components of a Time structure using the rules of the calendar. This is useful if you want more than one of the given components. Note that this doesn't handle the time of day, as that is calculated directly from the Time struct.

toTime
Time toTime(uint year, uint month, uint day, uint hour, uint minute, uint second, uint millisecond)

Returns a Time value set to the specified date and time in the current era.

toTime
Time toTime(Date d)

Returns a Time value for the given Date, in the current era

toTime
Time toTime(DateTime dt)

Returns a Time value for the given DateTime, in the current era

toTime
Time toTime(Date d, TimeOfDay t)

Returns a Time value for the given Date and TimeOfDay, in the current era

toTime
Time toTime(uint year, uint month, uint day, uint hour, uint minute, uint second, uint millisecond, uint era)

When overridden, returns a Time value set to the specified date and time in the specified _era.

Static functions

getTimeTicks
long getTimeTicks(uint hour, uint minute, uint second)
Undocumented in source. Be warned that the author may not have intended to support it.

Meta