Class Index | File Index

Classes


Class GregorianCal


Extends Calendar.
Construct a new Gregorian calendar object. This class encodes information about a Gregorian calendar.


Defined in: ilib-full-dyn.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
GregorianCal(options)
Method Summary
Method Attributes Method Name and Description
 
getMonLength(month, year)
Return the number of days in a particular month in a particular year.
 
Return the number of months in the given year.
 
Return the type of this calendar.
 
isLeapYear(year)
Return true if the given year is a leap year in the Gregorian calendar.
<deprecated>  
newDateInstance(options)
Return a date instance for this calendar type using the given options.
Class Detail
GregorianCal(options)
Parameters:
{{noinstance:boolean}=} options
Method Detail
{number} getMonLength(month, year)
Return the number of days in a particular month in a particular year. This function can return a different number for a month depending on the year because of things like leap years.
Parameters:
{number} month
the month for which the length is sought
{number} year
the year within which that month can be found
Returns:
{number} the number of days within the given month in the given year

{number} getNumMonths(year)
Return the number of months in the given year. The number of months in a year varies for some luni-solar calendars because in some years, an extra month is needed to extend the days in a year to an entire solar year. The month is represented as a 1-based number where 1=first month, 2=second month, etc.
Parameters:
{number} year
a year for which the number of months is sought
Returns:
{number} The number of months in the given year

{string} getType()
Return the type of this calendar.
Returns:
{string} the name of the type of this calendar

{boolean} isLeapYear(year)
Return true if the given year is a leap year in the Gregorian calendar. The year parameter may be given as a number, or as a GregDate object.
Parameters:
{number|GregorianDate} year
the year for which the leap year information is being sought
Returns:
{boolean} true if the given year is a leap year

<deprecated> {IDate} newDateInstance(options)
Return a date instance for this calendar type using the given options.
Parameters:
{Object} options
options controlling the construction of the date instance
Deprecated:
Since 11.0.5. Use DateFactory({calendar: cal.getType(), ...}) instead
Returns:
{IDate} a date appropriate for this calendar type

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Feb 02 2016 15:53:55 GMT-0800 (PST)