Real Date - SCN Design Studio Community

VISIBLE PROPERTIES

Name	Description	Group	Default	Visible

VISIBLE EVENTS

Name	Description	Group	Default	Visible

FUNCTIONS LIST

Name	Parameters	Return
format [details]	formatPattern	String
formatWithMask [details]	mask, (utc)	String
getCalendarWeek [details]		int
getCurrentTime [details]		String
getDay [details]		int
getDayName [details]		String
getDayOfWeek [details]		int
getDayOfYear [details]		int
getLastDayOfMonth [details]	(formatPattern), (month), (year)	String
getMonth [details]		int
getMonthName [details]		String
getQuarter [details]		int
getTimezoneOffset [details]		String
getYear [details]		int
initialize [details]	year, month, day	void
initializeWithInternalDate [details]	internalDate	void
internal_initializeNow [details]		void
internal_toString [details]		String
private_checkPrototypeFormat [details]		void
private_checkPrototypeRecalculate [details]		void
rollDays [details]	days	void
rollMonths [details]	months	void
rollWeeks [details]	weeks	void
rollYears [details]	years	void
toLocaleString [details]		String
toUTCString [details]		String

HIDDEN (TECHNICAL) PROPERTIES

Name	Description	Group	Default	Visible
days [String]	Days	Display		false
oneDay [String]	One Day	Display		false

FUNCTIONS IN DETAIL

String
format

Format by primitive string pattern which supports following content
YYYY: year
YY: 2-digit year
MM: 2-digit
M: month
DD: 2-digit day
D: day
WW: 2-digit calendar week
W: calendar week
Q: quarter

Name	Type	Help
formatPattern	String

Source Code

this.internal_initializeNow();

    this.date.recalculate();

    var resultString = formatPattern;
    resultString = resultString.replace("YYYY", this.getYear());
    resultString = resultString.replace("YY", this.getYear() % 100);

    if(this.getMonth() < 10) {
      resultString = resultString.replace("MM", "0" + this.getMonth());
      resultString = resultString.replace("M", this.getMonth());
    } else {
      resultString = resultString.replace("MM", this.getMonth());
    }

    if(this.getDay() < 10) {
      resultString = resultString.replace("DD", "0" + this.getDay());
      resultString = resultString.replace("D", this.getDay());
    } else {
      resultString = resultString.replace("DD", this.getDay());
    }

    if(this.getCalendarWeek() < 10) {
      resultString = resultString.replace("WW", "0" + this.getCalendarWeek());
      resultString = resultString.replace("W", this.getCalendarWeek());
    } else {
      resultString = resultString.replace("WW", this.getCalendarWeek());
    }

    resultString = resultString.replace("QQQ", "00" + this.getQuarter());
    resultString = resultString.replace("QQ", "0" + this.getQuarter());
    resultString = resultString.replace("Q", this.getQuarter());

    return resultString;

String
formatWithMask

Format by full mask.
Commom Masks:
default: "ddd mmm dd yyyy HH:MM:ss",
shortDate: "m/d/yy",
mediumDate: "mmm d, yyyy",
longDate: "mmmm d, yyyy",
fullDate: "dddd, mmmm d, yyyy",
shortTime: "h:MM TT",
mediumTime: "h:MM:ss TT",
longTime: "h:MM:ss TT Z",
isoDate: "yyyy-mm-dd",
isoTime: "HH:MM:ss",
isoDateTime: "yyyy-mm-dd'T'HH:MM:ss",
isoUtcDateTime: "UTC:yyyy-mm-dd'T'HH:MM:ss'Z'"

You want to format the date to get "Wed 04, 2015" back

var mask = "ddd mm, yyyy";
var formatted = DATE.formatWithMask(mask, false);

The "formatted" variable has now the requested format.

Name	Type	Help
mask	String
utc	boolean [ optional ]

Source Code

this.internal_initializeNow();

    this.date.recalculate();

    return this.date.format(mask, utc);

int
getCalendarWeek

Returns calendar week (iso form)

Source Code

this.internal_initializeNow();

    this.date.recalculate();

    return this.calendarWeek;

String
getCurrentTime

Get current time (HH:MM:SS:SSS)

Source Code

var d = new Date();
var timeString = d.getHours()+":"+d.getMinutes()+":"+d.getSeconds()+"."+d.getMilliseconds();
return timeString;

int
getDay

Returns the day of month

Source Code

this.internal_initializeNow();

return this.date.getUTCDate();

String
getDayName

Returns day name in English

Source Code

this.internal_initializeNow();

    this.date.recalculate();

    return this.dayOfWeekName;

int
getDayOfWeek

Returns day of week as integer (0-based, 0 is Sunday, 1 is Monday)

Source Code

this.internal_initializeNow();

return this.date.getUTCDay();

int
getDayOfYear

Returns day of year as integer

Source Code

this.internal_initializeNow();

    this.date.recalculate();

    return this.daysFromFirstJanuary;

String
getLastDayOfMonth

Determine last day of a given month. You can either specify the month and optionally the year yourself
or use the initialized date right away. To do that don't pass a month or a year.

Name	Type	Help
formatPattern	String [ optional ]	date format pattern (default YYYYMMDD)
month	String [ optional ]	target month(1-12)
year	String [ optional ]	target year

Source Code

int
getMonth

returns month, 1-index based (1-12)

Source Code

this.internal_initializeNow();

return this.date.getUTCMonth() + 1;

String
getMonthName

Returns month name in English

Source Code

this.internal_initializeNow();

    this.date.recalculate();

    return this.monthName;

int
getQuarter

Returns quarter as integer (1-4)

Source Code

this.internal_initializeNow();

    this.date.recalculate();

    return this.quarter;

String
getTimezoneOffset

Returns the offset

Source Code

this.internal_initializeNow();

return this.date.getTimezoneOffset();

int
getYear

Returns year as integer

Source Code

this.internal_initializeNow();

return this.date.getUTCFullYear();

void
initialize

initialization method with separate parameters

Name	Type	Help
year	int
month	int
day	int

Source Code

this.year = year;
    this.month = month - 1;
    this.day = day;

    this.date = new Date();

    var that = this;

    // create a special initialization function for UTC time zone to avoid calculation inconsistencies
    Date.prototype.createUtc = function(year, month0, day) {
        this.setUTCFullYear(year);
        this.setUTCMonth(month0);
        this.setUTCDate(day);
        this.setUTCHours(0);
        this.setUTCMinutes(0);
        this.setUTCSeconds(0);
        this.setUTCMilliseconds(0);
    }

    this.private_checkPrototypeRecalculate();
    this.private_checkPrototypeFormat();

    this.date.createUtc(this.year, this.month, this.day);
    this.date.recalculate();

void
initializeWithInternalDate

initialization method with internal date notation

Name	Type	Help
internalDate	String

Source Code

this.internalDate = internalDate;

    // the most primitive way to get integers from the internal date string
    var year = parseInt(internalDate.substring(0,4));

    var monthString = internalDate.substring(4,6);
    if(monthString.indexOf("0") == 0) {
      monthString = monthString.substring(1);
    }
    var month = parseInt(monthString);

    var dayString = internalDate.substring(6,8);
    if(dayString.indexOf("0") == 0) {
      dayString = dayString.substring(1);
    }
    var day = parseInt(dayString);
//    APPLICATION.createInfoMessage("Init: " + year + "," + month + ", " + day);
    this.initialize(year, month, day);

void
internal_initializeNow

Source Code

if(!this.date) {
      APPLICATION.createWarningMessage("Date Object Not Initialized. Initializing with some date. Use 'initialize' call next time.");

      this.date = new Date();

      this.initialize(this.date.getUTCFullYear(),  this.date.getUTCMonth() + 1, this.date.getUTCDay());

      this.date.recalculate();
    }

String
internal_toString

Source Code

this.internal_initializeNow();

    this.date.recalculate();

    return "Todays Date: " + this.date.toUTCString() + "\n"
     + "Last Monday Date: " + this.lastMondayDate.toUTCString() + "\n\n"
     + "First January Date: " + this.firstJanuaryDate.toUTCString() + "\n"
     + "Monday Before First January Date: " + this.mondayBeforeFirstJanuaryDate.toUTCString() + "\n"
     + "Monday After First January Date: " + this.mondayAfterFirstJanuaryDate.toUTCString() + "\n\n"
     + "Today Day: " + this.dayOfWeekToday + "\n"
     + "First January Day: " + this.dayOfWeekFirstJanuary + "\n"
     + "Last Monday Day: " + this.lastMondayDate.getDay() + "\n\n"
     + "Date Serialization: " + this.date + "\n"
     + "Monday Before First January Serialization: " + this.mondayBeforeFirstJanuaryDate + "\n"
     + "Monday After First January Serialization: " + this.mondayAfterFirstJanuaryDate + "\n"
     + "daysFromLastMondayToMondayBeforeFirstJanuary: " + this.daysFromLastMondayToMondayBeforeFirstJanuary + "\n"
     + "daysFromLastMondayToMondayAfterFirstJanuary: " + this.daysFromLastMondayToMondayAfterFirstJanuary + "\n\n"
     + "Day of Year: " + this.getDayOfYear() + "\n"
     + "Day of Month: " + this.getDay() + "\n\n"
     + "Day of Week: " + this.getDayOfWeek() + "\n"
     + "Calendar Week: " + this.getCalendarWeek() + "\n"
     + "Month: " + this.getMonth() + "\n"
     + "Quarter: " + this.getQuarter() + "\n"
     + "Year: " + this.getYear() + "\n"
     + "TimeZoneOffset: " + this.getTimezoneOffset() + "\n"
     + "Day Name: " + this.getDayName() + "\n"
     + "Month Name: " + this.getMonthName() + "\n"
     + "Formatted: " + this.getDay() + "." + this.getMonth() + "." + this.getYear() + "\n"
     + "Formatted [DD.MM.YYYY WW]: " + this.format("DD.MM.YYYY WW") + "\n"
     + "Formatted [MM/DD/YYYY WW]: " + this.format("MM/DD/YYYY WW") + "\n"
     + "Formatted by Mask [default, utc]: " + this.formatWithMask(this.dateFormat.masks.default, true) + "\n"
     + "Formatted by Mask [isoDateTime, no utc]: " + this.formatWithMask(this.dateFormat.masks.isoDateTime, false) + "\n\n"
     + "Internal Year: " + this.year + "\n"
     + "Internal Month: " + this.month + "\n"
     + "Internal Day: " + this.day + "\n"
     + "Internal Date: " + this.internalDate + "\n"
     + "";

void
private_checkPrototypeFormat

Private - do not call

Source Code

void
private_checkPrototypeRecalculate

Private - do not call

Source Code

void
rollDays

rolls days up or down, -20 means down by 20 days

Name	Type	Help
days	int

Source Code

this.internal_initializeNow();

    this.date.setUTCDate(this.date.getUTCDate() + days);

    this.date.recalculate();

void
rollMonths

rolls months up or down, -20 means down by 20 months

Name	Type	Help
months	int

Source Code

this.internal_initializeNow();

    this.date.setUTCMonth(this.date.getUTCMonth() + months);

    this.date.recalculate();

void
rollWeeks

rolls weeks up or down, -20 means down by 20 weeks

Name	Type	Help
weeks	int

Source Code

this.internal_initializeNow();

    this.date.setUTCDate(this.date.getUTCDate() + (weeks*7));

    this.date.recalculate();

void
rollYears

rolls years up or down, -20 means down by 20 years

Name	Type	Help
years	int

Source Code

this.internal_initializeNow();

    this.date.setUTCFullYear(this.date.getUTCFullYear() + years);

    this.date.recalculate();

String
toLocaleString

Returns locale string of the date

Source Code

this.internal_initializeNow();

return this.date.toLocaleString() ;

String
toUTCString

returns UTC string of the date

Source Code

this.internal_initializeNow();

return this.date.toUTCString() ;

THE END