X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/c930e9176a5a85509c5b0230e2bff5c22a591432..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Date.html diff --git a/docs/output/Date.html b/docs/output/Date.html deleted file mode 100644 index 33f1a459..00000000 --- a/docs/output/Date.html +++ /dev/null @@ -1,310 +0,0 @@ -
Package: | Global |
Defined In: | Date.js |
Class: | Date |
Extends: | Object |
-Format Description Example returned values ------- ----------------------------------------------------------------------- ----------------------- - d Day of the month, 2 digits with leading zeros 01 to 31 - D A short textual representation of the day of the week Mon to Sun - j Day of the month without leading zeros 1 to 31 - l A full textual representation of the day of the week Sunday to Saturday - N ISO-8601 numeric representation of the day of the week 1 (for Monday) through 7 (for Sunday) - S English ordinal suffix for the day of the month, 2 characters st, nd, rd or th. Works well with j - w Numeric representation of the day of the week 0 (for Sunday) to 6 (for Saturday) - z The day of the year (starting from 0) 0 to 364 (365 in leap years) - W ISO-8601 week number of year, weeks starting on Monday 01 to 53 - F A full textual representation of a month, such as January or March January to December - m Numeric representation of a month, with leading zeros 01 to 12 - M A short textual representation of a month Jan to Dec - n Numeric representation of a month, without leading zeros 1 to 12 - t Number of days in the given month 28 to 31 - L Whether it's a leap year 1 if it is a leap year, 0 otherwise. - o ISO-8601 year number (identical to (Y), but if the ISO week number (W) Examples: 1998 or 2004 - belongs to the previous or next year, that year is used instead) - Y A full numeric representation of a year, 4 digits Examples: 1999 or 2003 - y A two digit representation of a year Examples: 99 or 03 - a Lowercase Ante meridiem and Post meridiem am or pm - A Uppercase Ante meridiem and Post meridiem AM or PM - g 12-hour format of an hour without leading zeros 1 to 12 - G 24-hour format of an hour without leading zeros 0 to 23 - h 12-hour format of an hour with leading zeros 01 to 12 - H 24-hour format of an hour with leading zeros 00 to 23 - i Minutes, with leading zeros 00 to 59 - s Seconds, with leading zeros 00 to 59 - u Decimal fraction of a second Examples: - (minimum 1 digit, arbitrary number of digits allowed) 001 (i.e. 0.001s) or - 100 (i.e. 0.100s) or - 999 (i.e. 0.999s) or - 999876543210 (i.e. 0.999876543210s) - O Difference to Greenwich time (GMT) in hours and minutes Example: +1030 - P Difference to Greenwich time (GMT) with colon between hours and minutes Example: -08:00 - T Timezone abbreviation of the machine running the code Examples: EST, MDT, PDT ... - Z Timezone offset in seconds (negative if west of UTC, positive if east) -43200 to 50400 - c ISO 8601 date - Notes: Examples: - 1) If unspecified, the month / day defaults to the current month / day, 1991 or - the time defaults to midnight, while the timezone defaults to the 1992-10 or - browser's timezone. If a time is specified, it must include both hours 1993-09-20 or - and minutes. The "T" delimiter, seconds, milliseconds and timezone 1994-08-19T16:20+01:00 or - are optional. 1995-07-18T17:21:28-02:00 or - 2) The decimal fraction of a second, if specified, must contain at 1996-06-17T18:22:29.98765+03:00 or - least 1 digit (there is no limit to the maximum number 1997-05-16T19:23:30,12345-0400 or - of digits allowed), and may be delimited by either a '.' or a ',' 1998-04-15T20:24:31.2468Z or - Refer to the examples on the right for the various levels of 1999-03-14T20:24:32Z or - date-time granularity which are supported, or see 2000-02-13T21:25:33 - http://www.w3.org/TR/NOTE-datetime for more info. 2001-01-12 22:26:34 - U Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT) 1193432466 or -2138434463 - M$ Microsoft AJAX serialized dates \/Date(1238606590509)\/ (i.e. UTC milliseconds since epoch) or - \/Date(1238606590509+0800)\/ --Example usage (note that you must escape format specifiers with '\\' to render them as character literals): -
// Sample date:
-// 'Wed Jan 10 2007 15:05:01 GMT-0600 (Central Standard Time)'
-
-var dt = new Date('1/10/2007 03:05:01 PM GMT-0600');
-document.write(dt.format('Y-m-d')); // 2007-01-10
-document.write(dt.format('F j, Y, g:i a')); // January 10, 2007, 3:05 pm
-document.write(dt.format('l, \\t\\he jS \\of F Y h:i:s A')); // Wednesday, the 10th of January 2007 03:05:01 PM
-Here are some standard date/time patterns that you might find helpful. They
-are not part of the source of Date.js, but to use them you can simply copy this
-block of code into any script that is included after Date.js and they will also become
-globally available on the Date object. Feel free to add or remove patterns as needed in your code.
-Date.patterns = {
- ISO8601Long:"Y-m-d H:i:s",
- ISO8601Short:"Y-m-d",
- ShortDate: "n/j/Y",
- LongDate: "l, F d, Y",
- FullDateTime: "l, F d, Y g:i:s A",
- MonthDay: "F d",
- ShortTime: "g:i A",
- LongTime: "g:i:s A",
- SortableDateTime: "Y-m-d\\TH:i:s",
- UniversalSortableDateTime: "Y-m-d H:i:sO",
- YearMonth: "F, Y"
-};
-Example usage:
-var dt = new Date();
-document.write(dt.format(Date.patterns.ShortDate));
-Developer-written, custom formats may be used by supplying both a formatting and a parsing function -which perform to specialized requirements. The functions are stored in parseFunctions and formatFunctions.
Property | Defined By | |
---|---|---|
DAY : String Date interval constant | Date | |
HOUR : String Date interval constant | Date | |
MILLI : String Date interval constant | Date | |
MINUTE : String Date interval constant | Date | |
MONTH : String Date interval constant | Date | |
SECOND : String Date interval constant | Date | |
YEAR : String Date interval constant | Date | |
dayNames : Array An array of textual day names.
-Override these values for international dates.
-Example:
-Date.dayNames = [
- 'SundayI... An array of textual day names.
-Override these values for international dates.
-Example:
-
| Date | |
defaults : Object An object hash containing default date values used during date parsing.
-The following properties are available:<div c... An object hash containing default date values used during date parsing. -The following properties are available:
Override these properties to customize the default date values used by the parseDate method. -Note: In countries which experience Daylight Saving Time (i.e. DST), the h, i, s -and ms properties may coincide with the exact time in which DST takes effect. -It is the responsiblity of the developer to account for this. -Example Usage: -
| Date | |
formatCodes : Object The base format-code to formatting-function hashmap used by the format method.
-Formatting functions are strings (or f... The base format-code to formatting-function hashmap used by the format method.
-Formatting functions are strings (or functions which return strings) which
-will return the appropriate value when evaluated in the context of the Date object
-from which the format method is called.
-Add to / override these mappings for custom date formatting.
-Note: Date.format() treats characters as literals if an appropriate mapping cannot be found.
-Example:
-
| Date | |
formatFunctions : Object An object hash in which each property is a date formatting function. The property name is the
-format string which cor... An object hash in which each property is a date formatting function. The property name is the -format string which corresponds to the produced formatted date string. -This object is automatically populated with date formatting functions as -date formats are requested for Ext standard formatting strings. -Custom formatting functions may be inserted into this object, keyed by a name which from then on -may be used as a format string to format. Example:
-A formatting function should return a string repesentation of the passed Date object:
To enable date strings to also be parsed according to that format, a corresponding -parsing function must be placed into the parseFunctions property. | Date | |
monthNames : Array An array of textual month names.
-Override these values for international dates.
-Example:
-Date.monthNames = [
- 'Jan... An array of textual month names.
-Override these values for international dates.
-Example:
-
| Date | |
monthNumbers : Object An object hash of zero-based javascript month numbers (with short month names as keys. note: keys are case-sensitive)... An object hash of zero-based javascript month numbers (with short month names as keys. note: keys are case-sensitive).
-Override these values for international dates.
-Example:
-
| Date | |
parseFunctions : Object An object hash in which each property is a date parsing function. The property name is the
-format string which that f... An object hash in which each property is a date parsing function. The property name is the -format string which that function parses. -This object is automatically populated with date parsing functions as -date formats are requested for Ext standard formatting strings. -Custom parsing functions may be inserted into this object, keyed by a name which from then on -may be used as a format string to parseDate. - Example:
-A parsing function should return a Date object, and is passed the following parameters:
To enable Dates to also be formatted according to that format, a corresponding -formatting function must be placed into the formatFunctions property. | Date | |
useStrict : Boolean Global flag which determines if strict date parsing should be used.
-Strict date parsing will not roll-over invalid da... Global flag which determines if strict date parsing should be used.
-Strict date parsing will not roll-over invalid dates, which is the
-default behaviour of javascript Date objects.
-(see parseDate for more information)
-Defaults to false. | Date |
Method | Defined By | |
---|---|---|
add( String interval , Number value )
- :
- DateProvides a convenient method for performing basic date arithmetic. This method
-does not modify the Date instance bein... Provides a convenient method for performing basic date arithmetic. This method
-does not modify the Date instance being called - it creates and returns
-a new Date instance containing the resulting date value.
-Examples:
-
Parameters:
| Date | |
between( Date start , Date end )
- :
- BooleanChecks if this date falls on or between the given start and end dates. Checks if this date falls on or between the given start and end dates. Parameters:
| Date | |
clearTime( Boolean clone )
- :
- DateAttempts to clear all time information from this Date by setting the time to midnight of the same day,
-automatically ... Attempts to clear all time information from this Date by setting the time to midnight of the same day,
-automatically adjusting for Daylight Saving Time (DST) where applicable.
-(note: DST timezone information for the browser's host operating system is assumed to be up-to-date) Parameters:
| Date | |
clone()
- :
- Date Creates and returns a new Date instance with the exact same date value as the called instance.
-Dates are copied and p... Creates and returns a new Date instance with the exact same date value as the called instance.
-Dates are copied and passed by reference, so if a copied date variable is modified later, the original
-variable will also be changed. When the intention is to create a new variable that will not
-modify the original instance, you should create a clone.
-Example of correctly cloning a date:
-
Parameters:
| Date | |
format( String format )
- :
- StringFormats a date given the supplied format string. Formats a date given the supplied format string. Parameters:
| Date | |
getDayOfYear()
- :
- Number Get the numeric day number of the year, adjusted for leap year. Get the numeric day number of the year, adjusted for leap year. Parameters:
| Date | |
getDaysInMonth()
- :
- Number Get the number of days in the current month, adjusted for leap year. Get the number of days in the current month, adjusted for leap year. Parameters:
| Date | |
getElapsed( [Date date ] )
- :
- NumberReturns the number of milliseconds between this date and date Returns the number of milliseconds between this date and date Parameters:
| Date | |
getFirstDateOfMonth()
- :
- Date Get the date of the first day of the month in which this date resides. Get the date of the first day of the month in which this date resides. Parameters:
| Date | |
getFirstDayOfMonth()
- :
- Number Get the first day of the current month, adjusted for leap year. The returned value
-is the numeric day index within t... Get the first day of the current month, adjusted for leap year. The returned value
-is the numeric day index within the week (0-6) which can be used in conjunction with
-the monthNames array to retrieve the textual day name.
-Example:
-
Parameters:
| Date | |
getGMTOffset( [Boolean colon ] )
- :
- StringGet the offset from GMT of the current date (equivalent to the format specifier 'O'). Get the offset from GMT of the current date (equivalent to the format specifier 'O'). Parameters:
| Date | |
getLastDateOfMonth()
- :
- Date Get the date of the last day of the month in which this date resides. Get the date of the last day of the month in which this date resides. Parameters:
| Date | |
getLastDayOfMonth()
- :
- Number Get the last day of the current month, adjusted for leap year. The returned value
-is the numeric day index within th... Get the last day of the current month, adjusted for leap year. The returned value
-is the numeric day index within the week (0-6) which can be used in conjunction with
-the monthNames array to retrieve the textual day name.
-Example:
-
Parameters:
| Date | |
getMonthNumber( String name )
- :
- Number<static> Get the zero-based javascript month number for the given short/full month name.
-Override this function for internatio... <static> Get the zero-based javascript month number for the given short/full month name.
-Override this function for international dates. Parameters:
| Date | |
getShortDayName( Number day )
- :
- String<static> Get the short day name for the given day number.
-Override this function for international dates. <static> Get the short day name for the given day number.
-Override this function for international dates. Parameters:
| Date | |
getShortMonthName( Number month )
- :
- String<static> Get the short month name for the given month number.
-Override this function for international dates. <static> Get the short month name for the given month number.
-Override this function for international dates. Parameters:
| Date | |
getSuffix()
- :
- String Get the English ordinal suffix of the current day (equivalent to the format specifier 'S'). Get the English ordinal suffix of the current day (equivalent to the format specifier 'S'). Parameters:
| Date | |
getTimezone()
- :
- String Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').
-Note: The date string ret... Get the timezone abbreviation of the current date (equivalent to the format specifier 'T').
-Note: The date string returned by the javascript Date object's toString() method varies
-between browsers (e.g. FF vs IE) and system region settings (e.g. IE in Asia vs IE in America).
-For a given date string e.g. "Thu Oct 25 2007 22:55:35 GMT+0800 (Malay Peninsula Standard Time)",
-getTimezone() first tries to get the timezone abbreviation from between a pair of parentheses
-(which may or may not be present), failing which it proceeds to get the timezone abbreviation
-from the GMT offset portion of the date string. Parameters:
| Date | |
getWeekOfYear()
- :
- Number Get the numeric ISO-8601 week number of the year.
-(equivalent to the format specifier 'W', but without a leading zero... Get the numeric ISO-8601 week number of the year.
-(equivalent to the format specifier 'W', but without a leading zero). Parameters:
| Date | |
isDST()
- :
- Boolean Checks if the current date is affected by Daylight Saving Time (DST). Checks if the current date is affected by Daylight Saving Time (DST). Parameters:
| Date | |
isLeapYear()
- :
- Boolean Checks if the current date falls within a leap year. Checks if the current date falls within a leap year. Parameters:
| Date | |
isValid( Number year , Number month , Number day , [Number hour ], [Number minute ], [Number second ], [Number millisecond ] )
- :
- Boolean<static> Checks if the passed Date parameters will cause a javascript Date "rollover". <static> Checks if the passed Date parameters will cause a javascript Date "rollover". Parameters:
| Date | |
parseDate( String input , String format , [Boolean strict ] )
- :
- Date<static> Parses the passed string using the specified date format.
-Note that this function expects normal calendar dates, mean... <static> Parses the passed string using the specified date format.
-Note that this function expects normal calendar dates, meaning that months are 1-based (i.e. 1 = January).
-The defaults hash will be used for any date value (i.e. year, month, day, hour, minute, second or millisecond)
-which cannot be found in the passed string. If a corresponding default date value has not been specified in the defaults hash,
-the current date's year, month, day or DST-adjusted zero-hour time value will be used instead.
-Keep in mind that the input date string must precisely match the specified format string
-in order for the parse operation to be successful (failed parse operations return a null value).
- Example:
Parameters:
| Date |