Class PTDate

Object
   |
   +--PTDate

class PTDate

A useful wrapper class around Date objects. Also contains static methods for manipulating Dates.

Usage:	
 	var ptd = new PTDate('', new Date(), 'en');
 	ptd.incrementMonth();
 	PTDate.get2DigitMinutes(new Date());
 

- PTDateValidator
- PTStringUtil

Field Detail

date

Date date

The underlying Date object

DEFAULT_LOCALE

<static> <final> String DEFAULT_LOCALE

The Default locale constant.

See Also:

Constant Field Values

defaultDateFormat

<static> String defaultDateFormat

Date format used as default for all new PTDate objects. Initially set to 'EEE MMM d HH:mm:ss yyyy'.

defaultLanguage

<static> String defaultLanguage

Language used as default for all new PTDate objects. Initially set to 'en'.

FORMAT_DEFAULT

<static> <final> Number FORMAT_DEFAULT

Default date format constant

See Also:

Constant Field Values

FORMAT_FULL

<static> <final> Number FORMAT_FULL

Full date format constant

See Also:

Constant Field Values

FORMAT_LONG

<static> <final> Number FORMAT_LONG

Long date format constant

See Also:

Constant Field Values

FORMAT_MEDIUM

<static> <final> Number FORMAT_MEDIUM

Medium date format constant

See Also:

Constant Field Values

FORMAT_SHORT

<static> <final> Number FORMAT_SHORT

Short date format constant

See Also:

Constant Field Values

TIME_POLICY_ALLOW_TIMES

<static> <final> Number TIME_POLICY_ALLOW_TIMES

Allow times time-policy constant

See Also:

Constant Field Values

TIME_POLICY_FORBID_TIMES

<static> <final> Number TIME_POLICY_FORBID_TIMES

Forbid times time-policy constant

See Also:

Constant Field Values

TIME_POLICY_REQUIRE_TIMES

<static> <final> Number TIME_POLICY_REQUIRE_TIMES

Require times time-policy constant

See Also:

Constant Field Values

VERSION

<static> <final> Object VERSION

See Also:

Constant Field Values

PTDate

PTDate(datestring,date,language,dateFormat)

PTDate Object constructor

Parameters:
datestring - String containing date (String)
date - Date object representation of datestring (Date)
language - Optional language code for date (String)
dateFormat - Optional format string for date (String) Author Patrick Corcoran

Requires:
- PTDateValidator
- PTStringUtil

clone

Object clone()

Returns a (by value) copy of this object. This implementation assumes no properties and methods were dynamically added.

Returns:
a cloned PTDate Object

format

String format(dateFormat,language)

Generate a custom-formatted string from a PTDate
This function uses the same formatting codes as Java date formats.
Eg: EEE MMM d HH:mm:ss yyyy
yields: Mon Feb 7 08:30:00 2003

Parameters:
dateFormat - Optional format string for date (String)
language - Optional language code for date (String)

Returns:
Formatted Datestring (String)

getNumberOfDaysInThisMonth

Number getNumberOfDaysInThisMonth()

Returns the number of days in the month of the internal date object

Returns:
the number of days in the month

getTime

Number getTime()

wrapper method for Date.getTime() method

Returns:
the millis since Jan 1, 1970.

hasTime

Boolean hasTime()

Determines whether or not a PTDate object has a specific time associated with the date, or if its specificity is limited to the day level or greater.

Returns:
true if a specific time is associated with the date

incrementDay

void incrementDay()

Increments the internal date object by one day

incrementMonth

void incrementMonth()

Increments the month of the internal date object

incrementWeek

void incrementWeek()

Increments the internal date object by one week

convert2DigitTo4DigitYear

<static> String convert2DigitTo4DigitYear(year)

Convert a 2-digit to a 4-digit year, subject to pivot date

Parameters:
date - Date object (Date)
language - Language code for date (String)

Returns:
Formatted Datestring (String)

formatDate

<static> String formatDate(date,dateFormat,language)

Format a Date object

Parameters:
date - Date object (Date)
dateFormat - Format string for date (String)
language - Language code for date (String)

Returns:
Formatted Datestring (String)

get1Digit0To11Hour

<static> String get1Digit0To11Hour(date)

Get hour in 1-digit form, range 0 to 11

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get1Digit1To12Hour

<static> String get1Digit1To12Hour(date)

Get hour in 1-digit form, range 1 to 12

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get1Digit1To24Hour

<static> String get1Digit1To24Hour(date)

Get hour in 1-digit form, range 1 to 24

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get1DigitDayOfMonth

<static> String get1DigitDayOfMonth(date)

Get date of month in 1-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get1DigitMinutes

<static> String get1DigitMinutes(date)

Get minutes in 1-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get1DigitMonth

<static> String get1DigitMonth(date)

Get month in 1-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get1DigitSeconds

<static> String get1DigitSeconds(date)

Get seconds in 1-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2Digit0To11Hour

<static> String get2Digit0To11Hour(date)

Get hour in 2-digit form, range 0 to 11

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2Digit0To23Hour

<static> String get2Digit0To23Hour(date)

Get hour in 2-digit form, range 0 to 23

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2Digit1To12Hour

<static> String get2Digit1To12Hour(date)

Get hour in 2-digit form, range 1 to 12

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2Digit1To24Hour

<static> String get2Digit1To24Hour(date)

Get hour in 2-digit form, range 1 to 24

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2DigitDayOfMonth

<static> String get2DigitDayOfMonth(date)

Get date of month in 2-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2DigitMinutes

<static> String get2DigitMinutes(date)

Get minutes in 2-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2DigitMonth

<static> String get2DigitMonth(date)

Get month in 2-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2DigitSeconds

<static> String get2DigitSeconds(date)

Get seconds in 2-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get2DigitYear

<static> String get2DigitYear(date)

get2DigitYear Get year in 2-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

get3DigitMilliseconds

<static> String get3DigitMilliseconds(date)

Get milliseconds in 3-digit form

Parameters:
date - Date object (Date)

Returns:
Formatted Datestring (String)

getAMPM

<static> String getAMPM(date,language)

Get AM/PM string for date, internationalized

Parameters:
date - Date object (Date)
language - Language code for date (String)

Returns:
Formatted Datestring (String)

getNumberOfDaysInMonth

<static> Number getNumberOfDaysInMonth(date)

Returns the number of days in the month of a given date

Parameters:
date - Date object (Date)

Returns:
number of days in the date's month

isLeapYear

<static> Boolean isLeapYear(year)

Is a given year a leap year?

Parameters:
year - The year to check (integer or Date)

Returns:
true if the year is a leap year

validateAndFormatDate

<static> String validateAndFormatDate(dateString, outputFormat, locale, alertOnFailure, timePolicy, formatList)

Validate a string to determine if it is a valid date, and if so format it to a desired format

Parameters:
dateString - String to validate (string)
outputFormat - Format for returned dates (string)
locale - Locale to use for validation purposes, optional (string)
alertOnFailure - Whether or not to alert on failure, optional (boolean)
timePolicy - Policy to use regarding times, optional (integer)
formatList - Array of format strings for comparison, optional (Array)

Returns:
new string with formatted date or false

validateDate

<static> Boolean validateDate(dateString, locale, alertOnFailure, timePolicy, formatList)

Validate a string to determine if it is a valid date

Parameters:
dateString - String to validate (String)
locale - Locale to use for validation purposes (String)
alertOnFailure - Whether or not to alert on failure, optional (boolean)
timePolicy - Policy to use regarding times, optional (integer)
formatList - Array of format strings for comparison, optional (Array)

Returns:
new Date object or false