gregorianCalendar

gregorianCalendar

gregorianCalendar

gregorian calendar functions: version 2.2 mar-2005 Paul Hastings ([email protected])

Metadata

Instantiating 

	        

	    
	


dayFormat()
formats a day string depending on passed locale

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
	            

	              longFormat
	              String
	              No
	              false
	              
	              
	            

			
          
        

	
getCalendarName()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
getDaysInMonth()
returns array containing maximum number of days per month in this calendar

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
None

          
        

	
getEras()
returns era names for this calendar

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
getLocaleName()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
getLocales()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
None

          
        

	
getMaxDay()
returns maximum number of days in any month per calendar

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
None

          
        

	
getMonths()
returns month names for this calendar

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
getServerOffset()
returns server TZ offset in ms

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
None

          
        

	
getShortMonths()
returns abbrev month names for this calendar

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
getShortWeekDays()
returns short day names for this calendar

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
	            

	              calendarOrder
	              boolean
	              No
	              true
	              
	              
	            

			
          
        

	
getTimeSpan()
returns array of localized timespan (0-23, 1-12am/pm)

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
getWeekDays()
returns day names for this calendar

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
	            

	              calendarOrder
	              boolean
	              No
	              true
	              
	              
	            

			
          
        

	
getYear()
returns this calendar year

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisYear
	              numeric
	              Yes
	              
	              
	              
	            

			
          
        

	
i18nDateFormat()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              No
	              en_US
	              
	              
	            

			
	            

	              thisDateFormat
	              numeric
	              No
	              1
	              
	              
	            

			
          
        

	
i18nDateParse()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              string
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
i18nDateTimeFormat()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              No
	              en_US
	              
	              
	            

			
	            

	              thisDateFormat
	              numeric
	              No
	              1
	              
	              
	            

			
	            

	              thisTimeFormat
	              numeric
	              No
	              1
	              
	              
	            

			
          
        

	
i18nDayofWeek()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
i18nDaysInMonth()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
i18nIsLeapYear()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisYear
	              numeric
	              Yes
	              
	              
	              
	            

			
          
        

	
i18nIsWeekend()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
          
        

	
i18nTimeFormat()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              No
	              en_US
	              
	              
	            

			
	            

	              thisTimeFormat
	              numeric
	              No
	              1
	              
	              
	            

			
          
        

	
is24HourFormat()
determines if given locale use military sytle 24 hour timeformat & which format it uses returns 0 if not 24 hour timeformat, 1 if timeformat is 0-23 and 2 if 0-24

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
isAfter()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              when
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
isBefore()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              when
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
isDayFirstFormat()
determines if given locale uses day-month or month-day format

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
isValidLocale()

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
monthDayFormat()
formats a month/day or day/month string depending on passed locale

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
          
        

	
monthFormat()
formats a month string depending on passed locale

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisDate
	              date
	              Yes
	              
	              
	              
	            

			
	            

	              thisLocale
	              string
	              Yes
	              
	              
	              
	            

			
	            

	              longFormat
	              String
	              No
	              true
	              
	              
	            

			
          
        

	
weekStarts()
returns DOY (1-7) that this locale's week starts

		
Arguments

        

          
            

              Name
              Type
              Required
              Default
              Options
              Description
            

          
          
	
	            

	              thisLocale
	              string
	              Yes