Xin Calendar 2 Step-by-step: The helper functions

yxScripts.com

Say we have a date format of [ Mon. dd (day), yyyy ] which will give us some nice reading dates such as [ Jul. 28 (Wed), 2004 ], but we would have some hard time if we want to validate such a date or compare two dates. Luckily with the helper functions, this is an easy job.

Xin Calendar 2 not only lets us choose our own date format but also provides us some helper functions to deal with the dates in our own date format.

The helper functions we currently have are:

• toCalendarDate(date)
  ... takes a JS date parameter and returns the date string in date format

• toJSDate(date)
  ... takes a date string parameter in date format and returns the JS date

• getCurrentDate()
  ... returns today's date in date format

• checkDate(date)
  ... takes a date string parameter, returns 0 if it's compliant to the date format, or returns 1 if it is not, or returns 2 if it's empty or undefined

• compareDates(date1, date2)
  ... takes two date string parameters, returns 0 if they are the same date, or returns 1 if date1 comes later than date2, or returns -1 if date1 comes earlier than date2

• getDateNumbers(date)
  ... takes a date string parameter, returns an array of strings for its year, month and day

• hideCalendar(name)
  ... hides the calendar referred by the name, provided that the calendar is present at the time the call is made

• hideCalendars()
  ... hides all the calendars

• getCalendarDate(name)
  ... returns the selected date string of the calendar referred by the name, provided that the calendar is present

• setCalendarDate(name, date)
  ... sets the selected date of the calendar referred by the name, provided that the calendar is present

• refreshCalendar(name)
  ... scrolls the calendar referred by the name to show the current selected date, provided that the calendar is present

• scrollMonth(name, dm)
  ... scrolls the calendar referred by the name by the given month offset (positive or negative), will update the year if the month offset crosses the year

• scrollYear(name, dy)
  ... scrolls the calendar referred by the name by the given year offset (positive or negative)

[The user functions] [Back to index page]

# # #