CB-5658 Delete stale snapshot of plugin docs
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/repo Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/commit/ccc42e78 Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/tree/ccc42e78 Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/diff/ccc42e78 Branch: refs/heads/master Commit: ccc42e78fd9f12be4742a3c639322d95541c5ee8 Parents: 43e6d5b Author: Andrew Grieve <[email protected]> Authored: Tue Dec 17 20:49:39 2013 -0500 Committer: Andrew Grieve <[email protected]> Committed: Tue Dec 17 20:49:39 2013 -0500 ---------------------------------------------------------------------- docs/GlobalizationError/globalizationerror.md | 94 ---------------- docs/globalization.dateToString.md | 97 ---------------- docs/globalization.getCurrencyPattern.md | 112 ------------------ docs/globalization.getDateNames.md | 102 ----------------- docs/globalization.getDatePattern.md | 105 ----------------- docs/globalization.getFirstDayOfWeek.md | 82 -------------- docs/globalization.getLocaleName.md | 83 -------------- docs/globalization.getNumberPattern.md | 125 --------------------- docs/globalization.getPreferredLanguage.md | 83 -------------- docs/globalization.isDayLightSavingsTime.md | 87 -------------- docs/globalization.md | 63 ----------- docs/globalization.numberToString.md | 90 --------------- docs/globalization.stringToDate.md | 114 ------------------- docs/globalization.stringToNumber.md | 93 --------------- 14 files changed, 1330 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/GlobalizationError/globalizationerror.md ---------------------------------------------------------------------- diff --git a/docs/GlobalizationError/globalizationerror.md b/docs/GlobalizationError/globalizationerror.md deleted file mode 100644 index 015510b..0000000 --- a/docs/GlobalizationError/globalizationerror.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -GlobalizationError -============ - -An object representing a error from the Globalization API. - -Properties ----------- - -- __code__: One of the following codes representing the error type _(Number)_ - - GlobalizationError.UNKNOWN\_ERROR: 0 - - GlobalizationError.FORMATTING\_ERROR: 1 - - GlobalizationError.PARSING\_ERROR: 2 - - GlobalizationError.PATTERN\_ERROR: 3 -- __message__: A text message that includes the error's explanation and/or details _(String)_ - -Description ------------ - -This object is created and populated by Cordova, and returned to a callback in the case of an error. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - -When the following error callback executes, it displays a -popup dialog with the text similar to `code: 3` and `message:` - - function errorCallback(error) { - alert('code: ' + error.code + '\n' + - 'message: ' + error.message + '\n'); - }; - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>GlobalizationError Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function successCallback(date) { - alert('month:' + date.month + - ' day:' + date.day + - ' year:' + date.year + '\n'); - } - - function errorCallback(error) { - alert('code: ' + error.code + '\n' + - 'message: ' + error.message + '\n'); - }; - - function checkError() { - navigator.globalization.stringToDate( - 'notADate', - successCallback, - errorCallback, - {selector:'foobar'} - ); - } - - </script> - </head> - <body> - <button onclick="checkError()">Click for error</button> - </body> - </html> - http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.dateToString.md ---------------------------------------------------------------------- diff --git a/docs/globalization.dateToString.md b/docs/globalization.dateToString.md deleted file mode 100644 index da117bc..0000000 --- a/docs/globalization.dateToString.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.dateToString -=========== - -Returns a date formatted as a string according to the client's locale and timezone. - - navigator.globalization.dateToString(date, successCallback, errorCallback, options); - -Description ------------ - -Returns the formatted date `String` via a `value` property accessible -from the object passed as a parameter to the `successCallback`. - -The inbound `date` parameter should be of type `Date`. - -If there is an error formatting the date, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.FORMATTING\_ERROR`. - -The `options` parameter is optional, and its default values are: - - {formatLength:'short', selector:'date and time'} - -The `options.formatLength` can be `short`, `medium`, `long`, or `full`. - -The `options.selector` can be `date`, `time` or `date and time`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -If the browser is set to the `en\_US` locale, this displays a popup -dialog with text similar to `date: 9/25/2012 4:21PM` using the default -options: - - navigator.globalization.dateToString( - new Date(), - function (date) { alert('date: ' + date.value + '\n'); }, - function () { alert('Error getting dateString\n'); }, - { formatLength: 'short', selector: 'date and time' } - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>dateToString Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkDateString() { - navigator.globalization.dateToString( - new Date(), - function (date) {alert('date: ' + date.value + '\n');}, - function () {alert('Error getting dateString\n');, - {formatLength:'short', selector:'date and time'}} - ); - } - </script> - </head> - <body> - <button onclick="checkDateString()">Click for date string</button> - </body> - </html> - -Windows Phone 8 Quirks --------------- - -- The `formatLength` option supports only `short` and `full` values. http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.getCurrencyPattern.md ---------------------------------------------------------------------- diff --git a/docs/globalization.getCurrencyPattern.md b/docs/globalization.getCurrencyPattern.md deleted file mode 100644 index 3d49d16..0000000 --- a/docs/globalization.getCurrencyPattern.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.getCurrencyPattern -=========== - -Returns a pattern string to format and parse currency values according -to the client's user preferences and ISO 4217 currency code. - - navigator.globalization.getCurrencyPattern(currencyCode, successCallback, errorCallback); - -Description ------------ - -Returns the pattern to the `successCallback` with a `properties` object -as a parameter. That object should contain the following properties: - -- __pattern__: The currency pattern to format and parse currency values. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_ -- __code__: The ISO 4217 currency code for the pattern. _(String)_ -- __fraction__: The number of fractional digits to use when parsing and formatting currency. _(Number)_ -- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_ -- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_ -- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_ - -The inbound `currencyCode` parameter should be a `String` of one of -the ISO 4217 currency codes, for example 'USD'. - -If there is an error obtaining the pattern, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.FORMATTING\_ERROR`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS - -Quick Example -------------- - -When the browser is set to the `en\_US` locale and the selected -currency is United States Dollars, this example displays a popup -dialog with text similar to the results that follow: - - navigator.globalization.getCurrencyPattern( - 'USD', - function (pattern) { - alert('pattern: ' + pattern.pattern + '\n' + - 'code: ' + pattern.code + '\n' + - 'fraction: ' + pattern.fraction + '\n' + - 'rounding: ' + pattern.rounding + '\n' + - 'decimal: ' + pattern.decimal + '\n' + - 'grouping: ' + pattern.grouping); - }, - function () { alert('Error getting pattern\n'); } - ); - -Expected result: - - pattern: $#,##0.##;($#,##0.##) - code: USD - fraction: 2 - rounding: 0 - decimal: . - grouping: , - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>getCurrencyPattern Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkPattern() { - navigator.globalization.getCurrencyPattern( - 'USD', - function (pattern) {alert('pattern: ' + pattern.pattern + '\n' + - 'code: ' + pattern.code + '\n' + - 'fraction: ' + pattern.fraction + '\n' + - 'rounding: ' + pattern.rounding + '\n' + - 'decimal: ' + pattern.decimal + '\n' + - 'grouping: ' + pattern.grouping);}, - function () {alert('Error getting pattern\n');} - ); - } - - </script> - </head> - <body> - <button onclick="checkPattern()">Click for pattern</button> - </body> - </html> http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.getDateNames.md ---------------------------------------------------------------------- diff --git a/docs/globalization.getDateNames.md b/docs/globalization.getDateNames.md deleted file mode 100644 index 389cfa6..0000000 --- a/docs/globalization.getDateNames.md +++ /dev/null @@ -1,102 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.getDateNames -=========== - -Returns an array of the names of the months or days of the week, -depending on the client's user preferences and calendar. - - navigator.globalization.getDateNames(successCallback, errorCallback, options); - -Description ------------ - -Returns the array of names to the `successCallback` with a -`properties` object as a parameter. That object contains a `value` -property with an `Array` of `String` values. The array features names -starting from either the first month in the year or the first day of -the week, depending on the option selected. - -If there is an error obtaining the names, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.UNKNOWN\_ERROR`. - -The `options` parameter is optional, and its default values are: - - {type:'wide', item:'months'} - -The value of `options.type` can be `narrow` or `wide`. - -The value of `options.item` can be `months` or `days`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this example displays -a series of twelve popup dialogs, one per month, with text similar to -`month: January`: - - navigator.globalization.getDateNames( - function (names) { - for (var i = 0; i < names.value.length; i++) { - alert('month: ' + names.value[i] + '\n'); - } - }, - function () { alert('Error getting names\n'); }, - { type: 'wide', item: 'months' } - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>getDateNames Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkDateNames() { - navigator.globalization.getDateNames( - function (names) { - for (var i=0; i<names.value.length; i++) { - alert('month: ' + names.value[i] + '\n'); - } - }, - function () {alert('Error getting names\n');}, - {type:'wide', item:'months'} - ); - } - - </script> - </head> - <body> - <button onclick="checkDateNames()">Click for date names</button> - </body> - </html> - http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.getDatePattern.md ---------------------------------------------------------------------- diff --git a/docs/globalization.getDatePattern.md b/docs/globalization.getDatePattern.md deleted file mode 100644 index 14ee0a6..0000000 --- a/docs/globalization.getDatePattern.md +++ /dev/null @@ -1,105 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.getDatePattern -=========== - -Returns a pattern string to format and parse dates according to the -client's user preferences. - - navigator.globalization.getDatePattern(successCallback, errorCallback, options); - -Description ------------ - -Returns the pattern to the `successCallback`. The object passed in as -a parameter contains the following properties: - -- __pattern__: The date and time pattern to format and parse dates. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_ -- __timezone__: The abbreviated name of the time zone on the client. _(String)_ -- __utc\_offset__: The current difference in seconds between the client's time zone and coordinated universal time. _(Number)_ -- __dst\_offset__: The current daylight saving time offset in seconds between the client's non-daylight saving's time zone and the client's daylight saving's time zone. _(Number)_ - -If there is an error obtaining the pattern, the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.PATTERN\_ERROR`. - -The `options` parameter is optional, and defaults to the following values: - - {formatLength:'short', selector:'date and time'} - -The `options.formatLength` can be `short`, `medium`, `long`, or -`full`. The `options.selector` can be `date`, `time` or `date and -time`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this example displays -a popup dialog with text such as `pattern: M/d/yyyy h:mm a`: - - function checkDatePattern() { - navigator.globalization.getDatePattern( - function (date) { alert('pattern: ' + date.pattern + '\n'); }, - function () { alert('Error getting pattern\n'); }, - { formatLength: 'short', selector: 'date and time' } - ); - } - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>getDatePattern Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkDatePattern() { - navigator.globalization.getDatePattern( - function (date) {alert('pattern: ' + date.pattern + '\n');}, - function () {alert('Error getting pattern\n');}, - {formatLength:'short', selector:'date and time'} - ); - } - - </script> - </head> - <body> - <button onclick="checkDatePattern()">Click for pattern</button> - </body> - </html> - -Windows Phone 8 Quirks --------------- - -- The `formatLength` supports only `short` and `full` values. -- The `pattern` for `date and time` pattern returns only full datetime format. -- The `timezone` returns the full time zone name. -- The `dst_offset` property is not supported, and always returns zero. - http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.getFirstDayOfWeek.md ---------------------------------------------------------------------- diff --git a/docs/globalization.getFirstDayOfWeek.md b/docs/globalization.getFirstDayOfWeek.md deleted file mode 100644 index cb095e9..0000000 --- a/docs/globalization.getFirstDayOfWeek.md +++ /dev/null @@ -1,82 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.getFirstDayOfWeek -=========== - -Returns the first day of the week according to the client's user -preferences and calendar. - - navigator.globalization.getFirstDayOfWeek(successCallback, errorCallback); - -Description ------------ - -The days of the week are numbered starting from 1, where 1 is assumed -to be Sunday. Returns the day to the `successCallback` with a -`properties` object as a parameter. That object should have a `value` -property with a `Number` value. - -If there is an error obtaining the pattern, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.UNKNOWN\_ERROR`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this displays a -popup dialog with text similar to `day: 1`. - - navigator.globalization.getFirstDayOfWeek( - function (day) {alert('day: ' + day.value + '\n');}, - function () {alert('Error getting day\n');} - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>getFirstDayOfWeek Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkFirstDay() { - navigator.globalization.getFirstDayOfWeek( - function (day) {alert('day: ' + day.value + '\n');}, - function () {alert('Error getting day\n');} - ); - } - - </script> - </head> - <body> - <button onclick="checkFirstDay()">Click for first day of week</button> - </body> - </html> - http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.getLocaleName.md ---------------------------------------------------------------------- diff --git a/docs/globalization.getLocaleName.md b/docs/globalization.getLocaleName.md deleted file mode 100644 index 52a0226..0000000 --- a/docs/globalization.getLocaleName.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.getLocaleName -=========== - -Get the string identifier for the client's current locale setting. - - navigator.globalization.getLocaleName(successCallback, errorCallback); - - -Description ------------ - -Returns the locale identifier string to the `successCallback` with a -`properties` object as a parameter. That object should have a `value` -property with a `String` value. - -If there is an error getting the locale, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.UNKNOWN\_ERROR`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this displays a popup -dialog with the text `locale: en\_US`. - - navigator.globalization.getLocaleName( - function (locale) {alert('locale: ' + locale.value + '\n');}, - function () {alert('Error getting locale\n');} - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>getLocaleName Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkLocale() { - navigator.globalization.getLocaleName( - function (locale) {alert('locale: ' + locale.value + '\n');}, - function () {alert('Error getting locale\n');} - ); - } - </script> - </head> - <body> - <button onclick="checkLocale()">Click for locale</button> - </body> - </html> - -Windows Phone 8 Quirks ---------------------- -- Returns the two-letter code defined in ISO 3166 for the current country/region. http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.getNumberPattern.md ---------------------------------------------------------------------- diff --git a/docs/globalization.getNumberPattern.md b/docs/globalization.getNumberPattern.md deleted file mode 100644 index 70f0027..0000000 --- a/docs/globalization.getNumberPattern.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.getNumberPattern -=========== - -Returns a pattern string to format and parse numbers according to the client's user preferences. - - navigator.globalization.getNumberPattern(successCallback, errorCallback, options); - -Description ------------ - -Returns the pattern to the `successCallback` with a `properties` object -as a parameter. That object contains the following properties: - -- __pattern__: The number pattern to format and parse numbers. The patterns follow Unicode Technical Standard #35. <http://unicode.org/reports/tr35/tr35-4.html>. _(String)_ -- __symbol__: The symbol to use when formatting and parsing, such as a percent or currency symbol. _(String)_ -- __fraction__: The number of fractional digits to use when parsing and formatting numbers. _(Number)_ -- __rounding__: The rounding increment to use when parsing and formatting. _(Number)_ -- __positive__: The symbol to use for positive numbers when parsing and formatting. _(String)_ -- __negative__: The symbol to use for negative numbers when parsing and formatting. _(String)_ -- __decimal__: The decimal symbol to use for parsing and formatting. _(String)_ -- __grouping__: The grouping symbol to use for parsing and formatting. _(String)_ - -If there is an error obtaining the pattern, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.PATTERN\_ERROR`. - -The `options` parameter is optional, and default values are: - - {type:'decimal'} - -The `options.type` can be `decimal`, `percent`, or `currency`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this should display a -popup dialog with text similar to the results that follow: - - navigator.globalization.getNumberPattern( - function (pattern) {alert('pattern: ' + pattern.pattern + '\n' + - 'symbol: ' + pattern.symbol + '\n' + - 'fraction: ' + pattern.fraction + '\n' + - 'rounding: ' + pattern.rounding + '\n' + - 'positive: ' + pattern.positive + '\n' + - 'negative: ' + pattern.negative + '\n' + - 'decimal: ' + pattern.decimal + '\n' + - 'grouping: ' + pattern.grouping);}, - function () {alert('Error getting pattern\n');}, - {type:'decimal'} - ); - -Results: - - pattern: #,##0.### - symbol: . - fraction: 0 - rounding: 0 - positive: - negative: - - decimal: . - grouping: , - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>getNumberPattern Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkPattern() { - navigator.globalization.getNumberPattern( - function (pattern) {alert('pattern: ' + pattern.pattern + '\n' + - 'symbol: ' + pattern.symbol + '\n' + - 'fraction: ' + pattern.fraction + '\n' + - 'rounding: ' + pattern.rounding + '\n' + - 'positive: ' + pattern.positive + '\n' + - 'negative: ' + pattern.negative + '\n' + - 'decimal: ' + pattern.decimal + '\n' + - 'grouping: ' + pattern.grouping);}, - function () {alert('Error getting pattern\n');}, - {type:'decimal'} - ); - } - - </script> - </head> - <body> - <button onclick="checkPattern()">Click for pattern</button> - </body> - </html> - -Windows Phone 8 Quirks ----------------- -- The `pattern` property is not supported, and retuens an empty string. -- The `fraction` property is not supported, and returns zero. http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.getPreferredLanguage.md ---------------------------------------------------------------------- diff --git a/docs/globalization.getPreferredLanguage.md b/docs/globalization.getPreferredLanguage.md deleted file mode 100644 index 4e3b54b..0000000 --- a/docs/globalization.getPreferredLanguage.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.getPreferredLanguage -=========== - -Get the string identifier for the client's current language. - - navigator.globalization.getPreferredLanguage(successCallback, errorCallback); - - -Description ------------ - -Returns the language identifier string to the `successCallback` with a -`properties` object as a parameter. That object should have a `value` -property with a `String` value. - -If there is an error getting the language, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.UNKNOWN\_ERROR`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this should display a -popup dialog with the text `language: English`: - - navigator.globalization.getPreferredLanguage( - function (language) {alert('language: ' + language.value + '\n');}, - function () {alert('Error getting language\n');} - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>getPreferredLanguage Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkLanguage() { - navigator.globalization.getPreferredLanguage( - function (language) {alert('language: ' + language.value + '\n');}, - function () {alert('Error getting language\n');} - ); - } - </script> - </head> - <body> - <button onclick="checkLanguage()">Click for language</button> - </body> - </html> - -Windows Phone 8 Quirks -------- -- Returns the ISO 639-1 two-letter code for the current language. http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.isDayLightSavingsTime.md ---------------------------------------------------------------------- diff --git a/docs/globalization.isDayLightSavingsTime.md b/docs/globalization.isDayLightSavingsTime.md deleted file mode 100644 index e6d3f2f..0000000 --- a/docs/globalization.isDayLightSavingsTime.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.isDayLightSavingsTime -=========== - -Indicates whether daylight savings time is in effect for a given date -using the client's time zone and calendar. - - navigator.globalization.isDayLightSavingsTime(date, successCallback, errorCallback); - -Description ------------ - -Indicates whether or not daylight savings time is in effect to the -`successCallback` with a `properties` object as a parameter. That object -should have a `dst` property with a `Boolean` value. A `true` value -indicates that daylight savings time is in effect for the given date, -and `false` indicates that it is not. - -The inbound parameter `date` should be of type `Date`. - -If there is an error reading the date, then the `errorCallback` -executes. The error's expected code is `GlobalizationError.UNKNOWN\_ERROR`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -During the summer, and if the browser is set to a DST-enabled -timezone, this should display a popup dialog with text similar to -`dst: true`: - - navigator.globalization.isDayLightSavingsTime( - new Date(), - function (date) {alert('dst: ' + date.dst + '\n');}, - function () {alert('Error getting names\n');} - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>isDayLightSavingsTime Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkDayLightSavings() { - navigator.globalization.isDayLightSavingsTime( - new Date(), - function (date) {alert('dst: ' + date.dst + '\n');}, - function () {alert('Error getting names\n');} - ); - } - - </script> - </head> - <body> - <button onclick="checkDayLightSavings()">Click for daylight savings</button> - </body> - </html> - http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.md ---------------------------------------------------------------------- diff --git a/docs/globalization.md b/docs/globalization.md deleted file mode 100644 index b473ec9..0000000 --- a/docs/globalization.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -Globalization -====== - -Obtains information and performs operations specific to the user's -locale and timezone. - -Objects -------- - -- GlobalizationError - -Methods -------- - -- globalization.getPreferredLanguage -- globalization.getLocaleName -- globalization.dateToString -- globalization.stringToDate -- globalization.getDatePattern -- globalization.getDateNames -- globalization.isDayLightSavingsTime -- globalization.getFirstDayOfWeek -- globalization.numberToString -- globalization.stringToNumber -- globalization.getNumberPattern -- globalization.getCurrencyPattern - -Variable Scope --------------- - -The `globalization` object is a child of the `navigator` object, and -therefore has global scope. - - // The global globalization object - var globalization = navigator.globalization; - -Permissions ------------ - -### Android - -#### app/res/xml/config.xml - - <plugin name="Globalization" value="org.apache.cordova.Globalization" /> http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.numberToString.md ---------------------------------------------------------------------- diff --git a/docs/globalization.numberToString.md b/docs/globalization.numberToString.md deleted file mode 100644 index 800955e..0000000 --- a/docs/globalization.numberToString.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.numberToString -=========== - -Returns a number formatted as a string according to the client's user preferences. - - navigator.globalization.numberToString(number, successCallback, errorCallback, options); - -Description ------------ - -Returns the formatted number string to the `successCallback` with a -`properties` object as a parameter. That object should have a `value` -property with a `String` value. - -If there is an error formatting the number, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.FORMATTING\_ERROR`. - -The `options` parameter is optional, and its default values are: - - {type:'decimal'} - -The `options.type` can be 'decimal', 'percent', or 'currency'. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this displays a popup -dialog with text similar to `number: 3.142`: - - navigator.globalization.numberToString( - 3.1415926, - function (number) {alert('number: ' + number.value + '\n');}, - function () {alert('Error getting number\n');}, - {type:'decimal'} - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>numberToString Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkNumber() { - navigator.globalization.numberToString( - 3.1415926, - function (number) {alert('number: ' + number.value + '\n');}, - function () {alert('Error getting number\n');}, - {type:'decimal'} - ); - } - - </script> - </head> - <body> - <button onclick="checkNumber()">Click for number</button> - </body> - </html> - http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.stringToDate.md ---------------------------------------------------------------------- diff --git a/docs/globalization.stringToDate.md b/docs/globalization.stringToDate.md deleted file mode 100644 index a1b9350..0000000 --- a/docs/globalization.stringToDate.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.stringToDate -=========== - -Parses a date formatted as a string, according to the client's user -preferences and calendar using the time zone of the client, and -returns the corresponding date object. - - navigator.globalization.stringToDate(dateString, successCallback, errorCallback, options); - -Description ------------ - -Returns the date to the success callback with a `properties` object as -a parameter. That object should have the following properties: - -- __year__: The four digit year. _(Number)_ -- __month__: The month from (0 - 11). _(Number)_ -- __day__: The day from (1 - 31). _(Number)_ -- __hour__: The hour from (0 - 23). _(Number)_ -- __minute__: The minute from (0 - 59). _(Number)_ -- __second__: The second from (0 - 59). _(Number)_ -- __millisecond__: The milliseconds (from 0 - 999), not available on all platforms. _(Number)_ - -The inbound `dateString` parameter should be of type `String`. - -The `options` parameter is optional, and defaults to the following -values: - - {formatLength:'short', selector:'date and time'} - -The `options.formatLength` can be `short`, `medium`, `long`, or -`full`. The `options.selector` can be `date`, `time` or `date and -time`. - -If there is an error parsing the date string, then the `errorCallback` -executes with a `GlobalizationError` object as a parameter. The -error's expected code is `GlobalizationError.PARSING\_ERROR`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this displays a -popup dialog with text similar to `month:8 day:25 year:2012`. Note -that the month integer is one less than the string, as the month -integer represents an array index. - - navigator.globalization.stringToDate( - '9/25/2012', - function (date) {alert('month:' + date.month + - ' day:' + date.day + - ' year:' + date.year + '\n');}, - function () {alert('Error getting date\n');}, - {selector: 'date'} - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>stringToDate Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkStringDate() { - navigator.globalization.stringToDate( - '9/25/2012', - function (date) {alert('month:' + date.month + - ' day:' + date.day + - ' year:' + date.year + '\n');}, - function () {alert('Error getting date\n');}, - {selector:'date'} - ); - } - - </script> - </head> - <body> - <button onclick="checkStringDate()">Click for parsed date</button> - </body> - </html> - -Windows Phone 8 Quirks ------------------- - -- The `formatLength` option supports only `short` and `full` values. http://git-wip-us.apache.org/repos/asf/cordova-plugin-globalization/blob/ccc42e78/docs/globalization.stringToNumber.md ---------------------------------------------------------------------- diff --git a/docs/globalization.stringToNumber.md b/docs/globalization.stringToNumber.md deleted file mode 100644 index 738491e..0000000 --- a/docs/globalization.stringToNumber.md +++ /dev/null @@ -1,93 +0,0 @@ ---- -license: Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---- - -globalization.stringToNumber -=========== - -Parses a number formatted as a string according to the client's user -preferences and returns the corresponding number. - - navigator.globalization.stringToNumber(string, successCallback, errorCallback, options); - -Description ------------ - -Returns the number to the `successCallback` with a `properties` object -as a parameter. That object should have a `value` property with a -`Number` value. - -If there is an error parsing the number string, then the -`errorCallback` executes with a `GlobalizationError` object as a -parameter. The error's expected code is -`GlobalizationError.PARSING\_ERROR`. - -The `options` parameter is optional, and defaults to the following -values: - - {type:'decimal'} - -The `options.type` can be `decimal`, `percent`, or `currency`. - -Supported Platforms -------------------- - -- Android -- BlackBerry WebWorks (OS 5.0 and higher) -- iOS -- Windows Phone 8 - -Quick Example -------------- - -When the browser is set to the `en\_US` locale, this should display a -popup dialog with text similar to `number: 1234.56`: - - navigator.globalization.stringToNumber( - '1234.56', - function (number) {alert('number: ' + number.value + '\n');}, - function () {alert('Error getting number\n');}, - {type:'decimal'} - ); - -Full Example ------------- - - <!DOCTYPE HTML> - <html> - <head> - <title>stringToNumber Example</title> - <script type="text/javascript" charset="utf-8" src="cordova-x.x.x.js"></script> - <script type="text/javascript" charset="utf-8"> - - function checkNumber() { - navigator.globalization.stringToNumber( - '1234.56', - function (number) {alert('number: ' + number.value + '\n');}, - function () {alert('Error getting number\n');}, - {type:'decimal'} - ); - } - - </script> - </head> - <body> - <button onclick="checkNumber()">Click for parsed number</button> - </body> - </html> -
