Class ilib.Date.GregDate

Extends ilib.Date.
Construct a new Gregorian date object. The constructor parameters can contain any of the following properties:

unixtime - sets the time of this instance according to the given unix time. Unix time is the number of milliseconds since midnight on Jan 1, 1970.
julianday - sets the time of this instance according to the given Julian Day instance or the Julian Day given as a float
year - any integer, including 0
month - 1 to 12, where 1 means January, 2 means February, etc.
day - 1 to 31
hour - 0 to 23. A formatter is used to display 12 hour clocks, but this representation is always done with an unambiguous 24 hour representation
minute - 0 to 59
second - 0 to 59
millisecond - 0 to 999
dst - boolean used to specify whether the given time components are intended to be in daylight time or not. This is only used in the overlap time when transitioning from DST to standard time, and the time components are ambiguous. Otherwise at all other times of the year, this flag is ignored. If you specify the date using unix time (UTC) or a julian day, then the time is already unambiguous and this flag does not need to be specified.
For example, in the US, the transition out of daylight savings time in 2014 happens at Nov 2, 2014 2:00am Daylight Time, when the time falls back to Nov 2, 2014 1:00am Standard Time. If you give a date/time components as "Nov 2, 2014 1:30am", then there are two 1:30am times in that day, and you would have to give the standard flag to indicate which of those two you mean. (dst=true means daylight time, dst=false means standard time).
timezone - the ilib.TimeZone instance or time zone name as a string of this gregorian date. The date/time is kept in the local time. The time zone is used later if this date is formatted according to a different time zone and the difference has to be calculated, or when the date format has a time zone component in it.
locale - locale for this gregorian date. If the time zone is not given, it can be inferred from this locale. For locales that span multiple time zones, the one with the largest population is chosen as the one that represents the locale.
date - use the given intrinsic Javascript date to initialize this one.

If the constructor is called with another Gregorian date instance instead of a parameter block, the other instance acts as a parameter block and its settings are copied into the current instance.
If the constructor is called with no arguments at all or if none of the properties listed above from unixtime through millisecond are present, then the date components are filled in with the current date at the time of instantiation. Note that if you do not give the time zone when defaulting to the current time and the time zone for all of ilib was not set with ilib.setTimeZone(), then the time zone will default to UTC ("Universal Time, Coordinated" or "Greenwich Mean Time").
If any of the properties from year through millisecond are not specified in the params, it is assumed that they have the smallest possible value in the range for the property (zero or one).
Depends directive: !depends gregoriandate.js
Defined in: ilib-dyn-full.js.

Class Summary

Constructor Attributes Constructor Name and Description

ilib.Date.GregDate(params)

Field Summary

Field Attributes Field Name and Description

day

The day of the month.

hour

The hour of the day.

millisecond

The millisecond of the second.

minute

The minute of the hours.

month

The month number, ranging from 1 (January) to 12 (December).

second

The second of the minute.

year

Year in the Gregorian calendar.

Method Summary

Method Attributes Method Name and Description

getCalendar()

Return the name of the calendar that governs this date.

getDayOfWeek()

Return the day of the week of this date.

getDayOfYear()

Return the ordinal day of the year.

getEra()

Return the era for this date as a number.

Methods borrowed from class ilib.Date:
after, before, firstSunday, getJSDate, getJulianDay, getRataDie, getTime, getTimeExtended, getTimeZone, getWeekOfMonth, getWeekOfYear, onOrAfter, onOrBefore, setJulianDay, setRd, setTime, setTimeZone

Class Detail

ilib.Date.GregDate(params)

Parameters:

{Object=} params

parameters that govern the settings and behaviour of this Gregorian date

Field Detail

{number} day

The day of the month. This ranges from 1 to 31.

{number} hour

The hour of the day. This can be a number from 0 to 23, as times are stored unambiguously in the 24-hour clock.

{number} millisecond

The millisecond of the second. Ranges from 0 to 999.

{number} minute

The minute of the hours. Ranges from 0 to 59.

{number} month

The month number, ranging from 1 (January) to 12 (December).

{number} second

The second of the minute. Ranges from 0 to 59.

{number} year

Year in the Gregorian calendar.

Method Detail

{string} getCalendar()

Return the name of the calendar that governs this date.

Returns:

{string} a string giving the name of the calendar

{number} getDayOfWeek()

Return the day of the week of this date. The day of the week is encoded as number from 0 to 6, with 0=Sunday, 1=Monday, etc., until 6=Saturday.

Returns:

{number} the day of the week

{number} getDayOfYear()

Return the ordinal day of the year. Days are counted from 1 and proceed linearly up to 365, regardless of months or weeks, etc. That is, January 1st is day 1, and December 31st is 365 in regular years, or 366 in leap years.

Returns:

{number} the ordinal day of the year

{number} getEra()

Return the era for this date as a number. The value for the era for Gregorian calendars is -1 for "before the common era" (BCE) and 1 for "the common era" (CE). BCE dates are any date before Jan 1, 1 CE. In the proleptic Gregorian calendar, there is a year 0, so any years that are negative or zero are BCE. In the Julian calendar, there is no year 0. Instead, the calendar goes straight from year -1 to 1.

Returns:

{number} 1 if this date is in the common era, -1 if it is before the common era

Field Attributes	Field Name and Description
	day The day of the month.
	hour The hour of the day.
	millisecond The millisecond of the second.
	minute The minute of the hours.
	month The month number, ranging from 1 (January) to 12 (December).
	second The second of the minute.
	year Year in the Gregorian calendar.

Method Attributes	Method Name and Description
	getCalendar() Return the name of the calendar that governs this date.
	getDayOfWeek() Return the day of the week of this date.
	getDayOfYear() Return the ordinal day of the year.
	getEra() Return the era for this date as a number.

Classes

Class ilib.Date.GregDate