You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by mw...@apache.org on 2013/02/23 00:43:56 UTC
svn commit: r1449255 [19/34] - in /cordova/site/public/docs: en/1.5.0/
en/1.5.0rc1/ en/1.6.0/ en/1.6.0rc1/ en/1.6.1/ en/1.7.0/ en/1.7.0rc1/
en/1.8.0/ en/1.8.0rc1/ en/1.8.1/ en/1.9.0/ en/1.9.0rc1/ en/2.0.0/
en/2.0.0rc1/ en/2.1.0/ en/2.1.0rc1/ en/2.1.0rc...
Added: cordova/site/public/docs/en/2.5.0rc1/cordova_globalization_globalization.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.5.0rc1/cordova_globalization_globalization.md.html?rev=1449255&view=auto
==============================================================================
--- cordova/site/public/docs/en/2.5.0rc1/cordova_globalization_globalization.md.html (added)
+++ cordova/site/public/docs/en/2.5.0rc1/cordova_globalization_globalization.md.html Fri Feb 22 23:42:47 2013
@@ -0,0 +1,1322 @@
+<!DOCTYPE html>
+<!--
+ 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.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="2.5.0rc1">2.5.0rc1</option>
+<option value="2.4.0rc1">2.4.0rc1</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0rc2">2.3.0rc2</option>
+<option value="2.3.0rc1">2.3.0rc1</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0rc2">2.2.0rc2</option>
+<option value="2.2.0rc1">2.2.0rc1</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0rc2">2.1.0rc2</option>
+<option value="2.1.0rc1">2.1.0rc1</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0rc1">2.0.0rc1</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0rc1">1.9.0rc1</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0rc1">1.8.0rc1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0rc1">1.7.0rc1</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0rc1">1.5.0rc1</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp">
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>Globalization</h1>
+ <small><select><option value="Globalization">Globalization</option>
+<option value="Globalization_objects">Â Â Â Â Â Â - Objects</option>
+<option value="Globalization_methods">Â Â Â Â Â Â - Methods</option>
+<option value="Globalization_variable_scope">Â Â Â Â Â Â - Variable Scope</option>
+<option value="Globalization_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="globalization.getPreferredLanguage">globalization.getPreferredLanguage</option>
+<option value="globalization.getPreferredLanguage_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.getPreferredLanguage_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.getPreferredLanguage_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.getPreferredLanguage_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.getPreferredLanguage_windows_phone_8_quirks">Â Â Â Â Â Â - Windows Phone 8 Quirks</option>
+<option value="globalization.getLocaleName">globalization.getLocaleName</option>
+<option value="globalization.getLocaleName_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.getLocaleName_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.getLocaleName_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.getLocaleName_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.getLocaleName_windows_phone_8_quirks">Â Â Â Â Â Â - Windows Phone 8 Quirks</option>
+<option value="globalization.dateToString">globalization.dateToString</option>
+<option value="globalization.dateToString_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.dateToString_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.dateToString_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.dateToString_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.dateToString_windows_phone_8_quirks">Â Â Â Â Â Â - Windows Phone 8 Quirks</option>
+<option value="globalization.stringToDate">globalization.stringToDate</option>
+<option value="globalization.stringToDate_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.stringToDate_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.stringToDate_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.stringToDate_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.stringToDate_windows_phone_8_quirks">Â Â Â Â Â Â - Windows Phone 8 Quirks</option>
+<option value="globalization.getDatePattern">globalization.getDatePattern</option>
+<option value="globalization.getDatePattern_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.getDatePattern_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.getDatePattern_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.getDatePattern_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.getDatePattern_windows_phone_8_quirks">Â Â Â Â Â Â - Windows Phone 8 Quirks</option>
+<option value="globalization.getDateNames">globalization.getDateNames</option>
+<option value="globalization.getDateNames_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.getDateNames_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.getDateNames_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.getDateNames_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.isDayLightSavingsTime">globalization.isDayLightSavingsTime</option>
+<option value="globalization.isDayLightSavingsTime_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.isDayLightSavingsTime_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.isDayLightSavingsTime_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.isDayLightSavingsTime_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.getFirstDayOfWeek">globalization.getFirstDayOfWeek</option>
+<option value="globalization.getFirstDayOfWeek_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.getFirstDayOfWeek_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.getFirstDayOfWeek_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.getFirstDayOfWeek_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.numberToString">globalization.numberToString</option>
+<option value="globalization.numberToString_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.numberToString_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.numberToString_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.numberToString_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.stringToNumber">globalization.stringToNumber</option>
+<option value="globalization.stringToNumber_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.stringToNumber_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.stringToNumber_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.stringToNumber_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.getNumberPattern">globalization.getNumberPattern</option>
+<option value="globalization.getNumberPattern_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.getNumberPattern_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.getNumberPattern_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.getNumberPattern_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="globalization.getNumberPattern_windows_phone_8_quirks">Â Â Â Â Â Â - Windows Phone 8 Quirks</option>
+<option value="globalization.getCurrencyPattern">globalization.getCurrencyPattern</option>
+<option value="globalization.getCurrencyPattern_description">Â Â Â Â Â Â - Description</option>
+<option value="globalization.getCurrencyPattern_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="globalization.getCurrencyPattern_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="globalization.getCurrencyPattern_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="GlobalizationError">GlobalizationError</option>
+<option value="GlobalizationError_properties">Â Â Â Â Â Â - Properties</option>
+<option value="GlobalizationError_description">Â Â Â Â Â Â - Description</option>
+<option value="GlobalizationError_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="GlobalizationError_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="GlobalizationError_full_example">Â Â Â Â Â Â - Full Example</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
+<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="Globalization">Globalization</a></h1>
+
+<p>The <code>globalization</code> object obtains information and performs operations specific to the user's locale and timezone.</p>
+
+<h2>
+<a name="Globalization_objects">Objects</a>
+</h2>
+
+<ul>
+<li><a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a></li>
+</ul>
+<h2>
+<a name="Globalization_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_globalization_globalization.md.html#globalization.getPreferredLanguage">globalization.getPreferredLanguage</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.getLocaleName">globalization.getLocaleName</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.dateToString">globalization.dateToString</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.stringToDate">globalization.stringToDate</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.getDatePattern">globalization.getDatePattern</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.getDateNames">globalization.getDateNames</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.isDayLightSavingsTime">globalization.isDayLightSavingsTime</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.getFirstDayOfWeek">globalization.getFirstDayOfWeek</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.numberToString">globalization.numberToString</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.stringToNumber">globalization.stringToNumber</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.getNumberPattern">globalization.getNumberPattern</a></li>
+<li><a href="cordova_globalization_globalization.md.html#globalization.getCurrencyPattern">globalization.getCurrencyPattern</a></li>
+</ul>
+<h2>
+<a name="Globalization_variable_scope">Variable Scope</a>
+</h2>
+
+<p>The <code>globalization</code> object is a child of the <code>navigator</code> object, and therefore has global scope.</p>
+
+<pre class="prettyprint"><code>// The global globalization object
+var globalization = navigator.globalization;
+</code></pre>
+
+<h2>
+<a name="Globalization_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>" value="org.apache.cordova.<a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a>" />
+</code></pre>
+
+<hr>
+<h1><a name="globalization.getPreferredLanguage">globalization.getPreferredLanguage</a></h1>
+
+<p>Get the string identifier for the client's current language.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getPreferredLanguage">globalization.getPreferredLanguage</a>(successCB, errorCB);
+</code></pre>
+
+<h2>
+<a name="globalization.getPreferredLanguage_description">Description</a>
+</h2>
+
+<p>It returns the language identifier string to the successCB callback with a
+properties object as a parameter. That object should have a <code>value</code> property with a String value.</p>
+
+<p>If there is an error getting the language, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN_ERROR.</p>
+
+<h2>
+<a name="globalization.getPreferredLanguage_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.getPreferredLanguage_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a popup dialog with the text "language: English".</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getPreferredLanguage">globalization.getPreferredLanguage</a>(
+ function (language) {alert('language: ' + language.value + '\n');},
+ function () {alert('Error getting language\n');}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.getPreferredLanguage_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkLanguage() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.getPreferredLanguage">globalization.getPreferredLanguage</a>(
+ 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>
+</code></pre>
+
+<h2>
+<a name="globalization.getPreferredLanguage_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
+
+<ul>
+<li>Returns the ISO 639-1 two-letter code for the current language.</li>
+</ul>
+<hr>
+<h1><a name="globalization.getLocaleName">globalization.getLocaleName</a></h1>
+
+<p>Get the string identifier for the client's current locale setting.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getLocaleName">globalization.getLocaleName</a>(successCB, errorCB);
+</code></pre>
+
+<h2>
+<a name="globalization.getLocaleName_description">Description</a>
+</h2>
+
+<p>It returns the locale identifier string to the successCB callback with a
+properties object as a parameter. That object should have a <code>value</code> property with a String value.</p>
+
+<p>If there is an error getting the locale, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN_ERROR.</p>
+
+<h2>
+<a name="globalization.getLocaleName_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.getLocaleName_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a popup dialog with the text "locale: en_US".</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getLocaleName">globalization.getLocaleName</a>(
+ function (locale) {alert('locale: ' + locale.value + '\n');},
+ function () {alert('Error getting locale\n');}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.getLocaleName_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkLocale() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.getLocaleName">globalization.getLocaleName</a>(
+ 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>
+</code></pre>
+
+<h2>
+<a name="globalization.getLocaleName_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
+
+<ul>
+<li>Returns the two-letter code defined in ISO 3166 for the current country/region.</li>
+</ul>
+<hr>
+<h1><a name="globalization.dateToString">globalization.dateToString</a></h1>
+
+<p>Returns a date formatted as a string according to the client's locale and timezone.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.dateToString">globalization.dateToString</a>(date, successCB, errorCB, options);
+</code></pre>
+
+<h2>
+<a name="globalization.dateToString_description">Description</a>
+</h2>
+
+<p>It returns the formatted date string to the successCB callback with a properties object as a parameter. That object should have a <code>value</code> property with a String value.</p>
+
+<p>The inbound <code>date</code> parameter should be of type <code>Date</code>.</p>
+
+<p>If there is an error formatting the date, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.FORMATTING_ERROR.</p>
+
+<p><code>options.formatLength</code> can be 'short', 'medium', 'long', or 'full'.
+<code>options.selector</code> can be 'date', 'time' or 'date and time'.</p>
+
+<p>The default options are <code>{formatLength:'short', selector:'date and time'}</code>.
+The <code>options</code> parameter is optional.</p>
+
+<h2>
+<a name="globalization.dateToString_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.dateToString_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "date: 9/25/2012 4:21PM" using the default options.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.dateToString">globalization.dateToString</a>(
+ new Date(),
+ function (date) {alert('date:' + date.value + '\n');},
+ function () {alert('Error getting dateString\n');},
+ {formatLength:'short', selector:'date and time'}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.dateToString_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDateString() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.dateToString">globalization.dateToString</a>(
+ 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>
+</code></pre>
+
+<h2>
+<a name="globalization.dateToString_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
+
+<ul>
+<li>
+<code>formatLength</code> option supports only short and full values</li>
+</ul>
+<hr>
+<h1><a name="globalization.stringToDate">globalization.stringToDate</a></h1>
+
+<p>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.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToDate">globalization.stringToDate</a>(dateString, successCB, errorCB, options);
+</code></pre>
+
+<h2>
+<a name="globalization.stringToDate_description">Description</a>
+</h2>
+
+<p>It returns the date to the success callback with a properties object as a parameter. That object should have the following properties:</p>
+
+<ul>
+<li>year {Number}: The four digit year</li>
+<li>month {Number}: The month from (0 - 11)</li>
+<li>day {Number}: The day from (1 - 31)</li>
+<li>hour {Number}: The hour from (0 - 23)</li>
+<li>minute {Number}: The minute from (0 - 59)</li>
+<li>second {Number}: The second from (0 - 59)</li>
+<li>millisecond {Number}: The milliseconds (from 0 - 999), not available on all platforms</li>
+</ul>
+<p>The inbound <code>dateString</code> parameter should be of type <code>String</code>.</p>
+
+<p><code>options.formatLength</code> can be 'short', 'medium', 'long', or 'full'.
+<code>options.selector</code> can be 'date', 'time' or 'date and time'.</p>
+
+<p>The default options are <code>{formatLength:'short', selector:'date and time'}</code>.
+The options parameter is optional.</p>
+
+<p>If there is an error parsing the date string, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PARSING_ERROR.</p>
+
+<h2>
+<a name="globalization.stringToDate_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.stringToDate_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display 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 index.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToDate">globalization.stringToDate</a>(
+ '9/25/2012',
+ function (date) {alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');},
+ function () {alert('Error getting date\n');},
+ {selector:'date'}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.stringToDate_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkStringDate() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToDate">globalization.stringToDate</a>(
+ '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>
+</code></pre>
+
+<h2>
+<a name="globalization.stringToDate_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
+
+<ul>
+<li>
+<code>formatLength</code> option supports only short and full values</li>
+</ul>
+<hr>
+<h1><a name="globalization.getDatePattern">globalization.getDatePattern</a></h1>
+
+<p>Returns a pattern string for formatting and parsing dates according to the client's user preferences.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getDatePattern">globalization.getDatePattern</a>(successCB, errorCB, options);
+</code></pre>
+
+<h2>
+<a name="globalization.getDatePattern_description">Description</a>
+</h2>
+
+<p>It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:</p>
+
+<ul>
+<li>pattern {String}: The date and time pattern for formatting and parsing dates. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>
+</li>
+<li>timezone {String}: The abbreviated name of the time zone on the client</li>
+<li>utc_offset {Number}: The current difference in seconds between the client's time zone and coordinated universal time.</li>
+<li>dst_offset {Number}: 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.</li>
+</ul>
+<p>If there is an error obtaining the pattern, then the errorCB callback is invokedwith a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PATTERN_ERROR.</p>
+
+<p><code>options.formatLength</code> can be 'short', 'medium', 'long', or 'full'.
+<code>options.selector</code> can be 'date', 'time' or 'date and time'.</p>
+
+<p>The default options are <code>{formatLength:'short', selector:'date and time'}</code>.
+The options parameter is optional.</p>
+
+<h2>
+<a name="globalization.getDatePattern_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.getDatePattern_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "pattern: M/d/yyyy h:mm a".</p>
+
+<pre class="prettyprint"><code>function checkDatePattern() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.getDatePattern">globalization.getDatePattern</a>(
+ function (date) {alert('pattern: ' + date.pattern + '\n');},
+ function () {alert('Error getting pattern\n');},
+ {formatLength:'short', selector:'date and time'}
+ );
+}
+</code></pre>
+
+<h2>
+<a name="globalization.getDatePattern_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDatePattern() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.getDatePattern">globalization.getDatePattern</a>(
+ 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>
+</code></pre>
+
+<h2>
+<a name="globalization.getDatePattern_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
+
+<ul>
+<li>
+<code>formatLength</code> option supports only short and full values.</li>
+<li>
+<code>pattern</code> property for <code>date and time</code> pattern returns only full datetime format.</li>
+<li>
+<code>timezone</code> property returns full time zone name</li>
+<li>
+<code>dst_offset</code> returned property is not supported and always returns zero.</li>
+</ul>
+<hr>
+<h1><a name="globalization.getDateNames">globalization.getDateNames</a></h1>
+
+<p>Returns an array of either the names of the months or days of the week according to the client's user preferences and calendar.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getDateNames">globalization.getDateNames</a>(successCB, errorCB, options);
+</code></pre>
+
+<h2>
+<a name="globalization.getDateNames_description">Description</a>
+</h2>
+
+<p>It returns the array of names to the successCB callback with a properties object as a parameter. That object should have a <code>value</code> property with an Array of Strings. That array will be the names starting from either the first month in the year or the first day of the week, depending on the option selected.</p>
+
+<p>If there is an error obtaining the names, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN_ERROR.</p>
+
+<p><code>options.type</code> can be 'narrow', or 'wide'.
+<code>options.item</code> can be 'months', or 'days'.</p>
+
+<p>The default options are <code>{type:'wide', item:'months'}</code>.
+The options parameter is optional.</p>
+
+<h2>
+<a name="globalization.getDateNames_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.getDateNames_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a series of 12 popup dialogs, one per month, with text similar to "month: January"</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getDateNames">globalization.getDateNames</a>(
+ 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'}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.getDateNames_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDateNames() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.getDateNames">globalization.getDateNames</a>(
+ 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>
+</code></pre>
+
+<hr>
+<h1><a name="globalization.isDayLightSavingsTime">globalization.isDayLightSavingsTime</a></h1>
+
+<p>Returns whether daylight savings time is in effect for a given date using the client's time zone and calendar.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.isDayLightSavingsTime">globalization.isDayLightSavingsTime</a>(date, successCB, errorCB);
+</code></pre>
+
+<h2>
+<a name="globalization.isDayLightSavingsTime_description">Description</a>
+</h2>
+
+<p>It returns whether or not daylight savings time is in effect to the successCB callback with a properties object as a parameter. That object should have a <code>dst</code> property with a Boolean value. The value 'true' indicates that daylight savings time is in effect for the given date, and 'false' indicates that it is not.</p>
+
+<p>The inbound parameter <code>date</code> should be of type <code>Date</code>.</p>
+
+<p>If there is an error reading the date, then the errorCB callback is invoked. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN_ERROR.</p>
+
+<h2>
+<a name="globalization.isDayLightSavingsTime_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.isDayLightSavingsTime_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case during the summer when the browser is set to a DST-enabled timezone, this should display a popup dialog with text similar to "dst: true".</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.isDayLightSavingsTime">globalization.isDayLightSavingsTime</a>(
+ new Date(),
+ function (date) {alert('dst: ' + date.dst + '\n');},
+ function () {alert('Error getting names\n');}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.isDayLightSavingsTime_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkDayLightSavings() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.isDayLightSavingsTime">globalization.isDayLightSavingsTime</a>(
+ 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>
+</code></pre>
+
+<hr>
+<h1><a name="globalization.getFirstDayOfWeek">globalization.getFirstDayOfWeek</a></h1>
+
+<p>Returns the first day of the week according to the client's user preferences and calendar.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getFirstDayOfWeek">globalization.getFirstDayOfWeek</a>(successCB, errorCB);
+</code></pre>
+
+<h2>
+<a name="globalization.getFirstDayOfWeek_description">Description</a>
+</h2>
+
+<p>The days of the week are numbered starting from 1 where 1 is considered to be Sunday. It returns the day to the successCB callback with a properties object as a parameter. That object should have a <code>value</code> property with a Number value.</p>
+
+<p>If there is an error obtaining the pattern, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN_ERROR.</p>
+
+<h2>
+<a name="globalization.getFirstDayOfWeek_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.getFirstDayOfWeek_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "day: 1".</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getFirstDayOfWeek">globalization.getFirstDayOfWeek</a>(
+ function (day) {alert('day: ' + day.value + '\n');},
+ function () {alert('Error getting day\n');}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.getFirstDayOfWeek_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkFirstDay() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.getFirstDayOfWeek">globalization.getFirstDayOfWeek</a>(
+ 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>
+</code></pre>
+
+<hr>
+<h1><a name="globalization.numberToString">globalization.numberToString</a></h1>
+
+<p>Returns a number formatted as a string according to the client's user preferences.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.numberToString">globalization.numberToString</a>(number, successCB, errorCB, options);
+</code></pre>
+
+<h2>
+<a name="globalization.numberToString_description">Description</a>
+</h2>
+
+<p>It returns the formatted number string to the successCB callback with a properties object as a parameter. That object should have a <code>value</code> property with a String value.</p>
+
+<p>If there is an error formatting the number, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.FORMATTING_ERROR.</p>
+
+<p><code>options.type</code> can be 'decimal', 'percent', or 'currency'. The default options are <code>{type:'decimal'}</code>. The <code>options</code> parameter is optional.</p>
+
+<h2>
+<a name="globalization.numberToString_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.numberToString_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "number: 3.142"</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.numberToString">globalization.numberToString</a>(
+ 3.1415926,
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.numberToString_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkNumber() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.numberToString">globalization.numberToString</a>(
+ 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>
+</code></pre>
+
+<hr>
+<h1><a name="globalization.stringToNumber">globalization.stringToNumber</a></h1>
+
+<p>Parses a number formatted as a string according to the client's user preferences and returns the corresponding number.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToNumber">globalization.stringToNumber</a>(string, successCB, errorCB, options);
+</code></pre>
+
+<h2>
+<a name="globalization.stringToNumber_description">Description</a>
+</h2>
+
+<p>It returns the number to the successCB callback with a properties object as a parameter. That object should have a <code>value</code> property with a Number value.</p>
+
+<p>If there is an error parsing the number string, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PARSING_ERROR.</p>
+
+<p><code>options.type</code> can be 'decimal', 'percent', or 'currency'.
+The default options are <code>{type:'decimal'}</code>. The <code>options</code> parameter is optional.</p>
+
+<h2>
+<a name="globalization.stringToNumber_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.stringToNumber_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to "number: 1234.56".</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToNumber">globalization.stringToNumber</a>(
+ '1234.56',
+ function (number) {alert('number: ' + number.value + '\n');},
+ function () {alert('Error getting number\n');},
+ {type:'decimal'}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.stringToNumber_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkNumber() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToNumber">globalization.stringToNumber</a>(
+ '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>
+</code></pre>
+
+<hr>
+<h1><a name="globalization.getNumberPattern">globalization.getNumberPattern</a></h1>
+
+<p>Returns a pattern string for formatting and parsing numbers according to the client's user preferences.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getNumberPattern">globalization.getNumberPattern</a>(successCB, errorCB, options);
+</code></pre>
+
+<h2>
+<a name="globalization.getNumberPattern_description">Description</a>
+</h2>
+
+<p>It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:</p>
+
+<ul>
+<li>pattern {String}: The number pattern for formatting and parsing numbers. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>
+</li>
+<li>symbol {String}: The symbol to be used when formatting and parsing e.g., percent or currency symbol.</li>
+<li>fraction {Number}: The number of fractional digits to use when parsing and formatting numbers.</li>
+<li>rounding {Number}: The rounding increment to use when parsing and formatting.</li>
+<li>positive {String}: The symbol to use for positive numbers when parsing and formatting.</li>
+<li>negative: {String}: The symbol to use for negative numbers when parsing and formatting.</li>
+<li>decimal: {String}: The decimal symbol to use for parsing and formatting.</li>
+<li>grouping: {String}: The grouping symbol to use for parsing and formatting.</li>
+</ul>
+<p>If there is an error obtaining the pattern, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PATTERN_ERROR.</p>
+
+<p><code>options.type</code> can be 'decimal', 'percent', or 'currency'.
+The default options are <code>{type:'decimal'}</code>. The <code>options</code> parameter is optional.</p>
+
+<h2>
+<a name="globalization.getNumberPattern_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+<li>Windows Phone 8</li>
+</ul>
+<h2>
+<a name="globalization.getNumberPattern_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale, this should display a popup dialog with text similar to:</p>
+
+<pre class="prettyprint"><code>pattern: #,##0.###
+symbol: .
+fraction: 0
+rounding: 0
+positive:
+negative: -
+decimal: .
+grouping: ,
+</code></pre>
+
+<p>.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getNumberPattern">globalization.getNumberPattern</a>(
+ 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'}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.getNumberPattern_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkPattern() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.getNumberPattern">globalization.getNumberPattern</a>(
+ 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>
+</code></pre>
+
+<h2>
+<a name="globalization.getNumberPattern_windows_phone_8_quirks">Windows Phone 8 Quirks</a>
+</h2>
+
+<ul>
+<li>
+<code>pattern</code> property is not supported; empty string is always returned.</li>
+<li>
+<code>fraction</code> property is not supported; zero is always returned.</li>
+</ul>
+<hr>
+<h1><a name="globalization.getCurrencyPattern">globalization.getCurrencyPattern</a></h1>
+
+<p>Returns a pattern string for formatting and parsing currency values according
+to the client's user preferences and ISO 4217 currency code.</p>
+
+<pre class="prettyprint"><code> navigator.<a href="cordova_globalization_globalization.md.html#globalization.getCurrencyPattern">globalization.getCurrencyPattern</a>(currencyCode, successCB, errorCB);
+</code></pre>
+
+<h2>
+<a name="globalization.getCurrencyPattern_description">Description</a>
+</h2>
+
+<p>It returns the pattern to the successCB callback with a properties object as a parameter. That object should have the following properties:</p>
+
+<ul>
+<li>pattern {String}: The currency pattern for formatting and parsing currency values. The patterns follow Unicode Technical Standard #35. <a class="external" href="http://unicode.org/reports/tr35/tr35-4.html">http://unicode.org/reports/tr35/tr35-4.html</a>
+</li>
+<li>code {String}: The ISO 4217 currency code for the pattern.</li>
+<li>fraction {Number}: The number of fractional digits to use when parsing and formatting currency.</li>
+<li>rounding {Number}: The rounding increment to use when parsing and formatting.</li>
+<li>decimal: {String}: The decimal symbol to use for parsing and formatting.</li>
+<li>grouping: {String}: The grouping symbol to use for parsing and formatting.</li>
+</ul>
+<p>The inbound <code>currencyCode</code> parameter should be a String of one of the ISO 4217 currency codes, for example 'USD'.</p>
+
+<p>If there is an error obtaining the pattern, then the errorCB callback is invoked with a <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a> object as a parameter. The expected code for this error is <a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.FORMATTING_ERROR.</p>
+
+<h2>
+<a name="globalization.getCurrencyPattern_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iPhone</li>
+</ul>
+<h2>
+<a name="globalization.getCurrencyPattern_quick_example">Quick Example</a>
+</h2>
+
+<p>In the case when the browser is set to the en_US locale and the selected currency is United States Dollars, this should display a popup dialog with text similar to:</p>
+
+<pre class="prettyprint"><code>pattern: $#,##0.##;($#,##0.##)
+code: USD
+fraction: 2
+rounding: 0
+decimal: .
+grouping: ,
+</code></pre>
+
+<p>.</p>
+
+<pre class="prettyprint"><code>navigator.<a href="cordova_globalization_globalization.md.html#globalization.getCurrencyPattern">globalization.getCurrencyPattern</a>(
+ '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');}
+);
+</code></pre>
+
+<h2>
+<a name="globalization.getCurrencyPattern_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function checkPattern() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.getCurrencyPattern">globalization.getCurrencyPattern</a>(
+ '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>
+</code></pre>
+
+<hr>
+<h1><a name="GlobalizationError">GlobalizationError</a></h1>
+
+<p>An object representing a error from the <a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a> API.</p>
+
+<h2>
+<a name="GlobalizationError_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>code:</strong> One of the following codes representing the error type (<code>Number</code>)
+<ul>
+<li>
+<a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.UNKNOWN_ERROR: 0</li>
+<li>
+<a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.FORMATTING_ERROR: 1</li>
+<li>
+<a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PARSING_ERROR: 2</li>
+<li>
+<a href="cordova_globalization_globalization.md.html#GlobalizationError">GlobalizationError</a>.PATTERN_ERROR: 3</li>
+</ul>
+</li>
+<li>
+<strong>message:</strong> A text message that includes the error explanation and/or details (<code>String</code>)</li>
+</ul>
+<h2>
+<a name="GlobalizationError_description">Description</a>
+</h2>
+
+<p>This object is created and populated by Cordova, and returned to a callback in the case of an error.</p>
+
+<h2>
+<a name="GlobalizationError_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>BlackBerry WebWorks (OS 5.0 and higher)</li>
+<li>iOS</li>
+</ul>
+<h2>
+<a name="GlobalizationError_quick_example">Quick Example</a>
+</h2>
+
+<p>When the following error callback is invoked, it should display a popup dialog with the text similar to "code: 3" and "message: ".</p>
+
+<pre class="prettyprint"><code>function errorCB(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+};
+</code></pre>
+
+<h2>
+<a name="GlobalizationError_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE HTML>
+<html>
+ <head>
+ <title>Cordova</title>
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ function successCB(date) {
+ alert('month:' + date.month +
+ ' day:' + date.day +
+ ' year:' + date.year + '\n');
+ }
+
+ function errorCB(error) {
+ alert('code: ' + error.code + '\n' +
+ 'message: ' + error.message + '\n');
+ };
+
+ function checkError() {
+ navigator.<a href="cordova_globalization_globalization.md.html#globalization.stringToDate">globalization.stringToDate</a>(
+ 'notADate',
+ successCB,
+ errorCB,
+ {selector:'foobar'}
+ );
+ }
+
+ </script>
+ </head>
+ <body>
+ <button onclick="checkError()">Click for error</button>
+ </body>
+</html>
+</code></pre>
+
+ </div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>
Added: cordova/site/public/docs/en/2.5.0rc1/cordova_inappbrowser_inappbrowser.md.html
URL: http://svn.apache.org/viewvc/cordova/site/public/docs/en/2.5.0rc1/cordova_inappbrowser_inappbrowser.md.html?rev=1449255&view=auto
==============================================================================
--- cordova/site/public/docs/en/2.5.0rc1/cordova_inappbrowser_inappbrowser.md.html (added)
+++ cordova/site/public/docs/en/2.5.0rc1/cordova_inappbrowser_inappbrowser.md.html Fri Feb 22 23:42:47 2013
@@ -0,0 +1,531 @@
+<!DOCTYPE html>
+<!--
+ 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.
+--><html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no, width=device-width">
+<meta name="generator" content="joDoc">
+<title>Apache Cordova API Documentation</title>
+<link rel="stylesheet" type="text/css" href="index.css">
+<link rel="stylesheet" type="text/css" href="mobile.css" media="only screen and (max-device-width: 1024px)">
+<link rel="stylesheet" type="text/css" href="prettify/prettify.css">
+</head>
+<body>
+ <div id="header">
+ <h1><a href="index.html">Apache <strong>Cordova</strong> Documentation</a></h1>
+ <small>
+ <select><optgroup label="English" value="en">
+<option value="edge">edge</option>
+<option selected value="2.5.0rc1">2.5.0rc1</option>
+<option value="2.4.0rc1">2.4.0rc1</option>
+<option value="2.4.0">2.4.0</option>
+<option value="2.3.0rc2">2.3.0rc2</option>
+<option value="2.3.0rc1">2.3.0rc1</option>
+<option value="2.3.0">2.3.0</option>
+<option value="2.2.0rc2">2.2.0rc2</option>
+<option value="2.2.0rc1">2.2.0rc1</option>
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0rc2">2.1.0rc2</option>
+<option value="2.1.0rc1">2.1.0rc1</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0rc1">2.0.0rc1</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0rc1">1.9.0rc1</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.8.0rc1">1.8.0rc1</option>
+<option value="1.8.0">1.8.0</option>
+<option value="1.7.0rc1">1.7.0rc1</option>
+<option value="1.7.0">1.7.0</option>
+<option value="1.6.1">1.6.1</option>
+<option value="1.6.0rc1">1.6.0rc1</option>
+<option value="1.6.0">1.6.0</option>
+<option value="1.5.0rc1">1.5.0rc1</option>
+<option value="1.5.0">1.5.0</option>
+</optgroup>
+<optgroup label="Japanese" value="jp">
+<option value="2.2.0">2.2.0</option>
+<option value="2.1.0">2.1.0</option>
+<option value="2.0.0">2.0.0</option>
+<option value="1.9.0">1.9.0</option>
+<option value="1.8.1">1.8.1</option>
+<option value="1.7.0">1.7.0</option>
+</optgroup>
+<optgroup label="Korean" value="kr"><option value="2.0.0">2.0.0</option></optgroup></select></small>
+ </div>
+ <div id="subheader">
+ <h1>InAppBrowser</h1>
+ <small><select><option value="InAppBrowser">InAppBrowser</option>
+<option value="InAppBrowser_description">Â Â Â Â Â Â - Description</option>
+<option value="InAppBrowser_methods">Â Â Â Â Â Â - Methods</option>
+<option value="InAppBrowser_permissions">Â Â Â Â Â Â - Permissions</option>
+<option value="addEventListener">addEventListener</option>
+<option value="addEventListener_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="addEventListener_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="addEventListener_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="removeEventListener">removeEventListener</option>
+<option value="removeEventListener_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="removeEventListener_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="removeEventListener_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="close">close</option>
+<option value="close_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="close_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="close_full_example">Â Â Â Â Â Â - Full Example</option>
+<option value="InAppBrowserEvent">InAppBrowserEvent</option>
+<option value="InAppBrowserEvent_properties">Â Â Â Â Â Â - Properties</option>
+<option value="window.open">window.open</option>
+<option value="window.open_supported_platforms">Â Â Â Â Â Â - Supported Platforms</option>
+<option value="window.open_quick_example">Â Â Â Â Â Â - Quick Example</option>
+<option value="window.open_full_example">Â Â Â Â Â Â - Full Example</option></select></small>
+ </div>
+
+ <div id="sidebar">
+ <div class="vertical_divider"></div>
+ <h1>API Reference</h1>
+<ul>
+<li><a href="cordova_accelerometer_accelerometer.md.html#Accelerometer">Accelerometer</a></li>
+<li><a href="cordova_camera_camera.md.html#Camera">Camera</a></li>
+<li><a href="cordova_media_capture_capture.md.html#Capture">Capture</a></li>
+<li><a href="cordova_compass_compass.md.html#Compass">Compass</a></li>
+<li><a href="cordova_connection_connection.md.html#Connection">Connection</a></li>
+<li><a href="cordova_contacts_contacts.md.html#Contacts">Contacts</a></li>
+<li><a href="cordova_device_device.md.html#Device">Device</a></li>
+<li><a href="cordova_events_events.md.html#Events">Events</a></li>
+<li><a href="cordova_file_file.md.html#File">File</a></li>
+<li><a href="cordova_geolocation_geolocation.md.html#Geolocation">Geolocation</a></li>
+<li><a href="cordova_globalization_globalization.md.html#Globalization">Globalization</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></li>
+<li><a href="cordova_media_media.md.html#Media">Media</a></li>
+<li><a href="cordova_notification_notification.md.html#Notification">Notification</a></li>
+<li><a href="cordova_splashscreen_splashscreen.md.html#Splashscreen">Splashscreen</a></li>
+<li><a href="cordova_storage_storage.md.html#Storage">Storage</a></li>
+</ul>
+<h1>Guides</h1>
+<ul>
+<li><a href="guide_getting-started_index.md.html#Getting%20Started%20Guides">Getting Started Guides</a></li>
+<li><a href="guide_command-line_index.md.html#Command-Line%20Usage">Command-Line Usage</a></li>
+<li><a href="guide_upgrading_index.md.html#Upgrading%20Guides">Upgrading Guides</a></li>
+<li><a href="guide_project-settings_index.md.html#Project%20Settings">Project Settings</a></li>
+<li><a href="guide_plugin-development_index.md.html#Plugin%20Development%20Guide">Plugin Development Guide</a></li>
+<li><a href="guide_whitelist_index.md.html#Domain%20Whitelist%20Guide">Domain Whitelist Guide</a></li>
+<li><a href="guide_cordova-webview_index.md.html#Embedding%20WebView">Embedding WebView</a></li>
+<li><a href="_index.html">Keyword Index</a></li>
+</ul>
+</div>
+
+ <div id="scrollable">
+ <div id="content">
+ <h1><a name="InAppBrowser">InAppBrowser</a></h1>
+
+<blockquote>
+ <p>The <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> is a web-browser that is shown in your app when you use the <code><a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a></code> call.</p>
+</blockquote>
+
+<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
+</code></pre>
+
+<h2>
+<a name="InAppBrowser_description">Description</a>
+</h2>
+
+<p>The object returned from a call to <code><a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a></code>.</p>
+
+<h2>
+<a name="InAppBrowser_methods">Methods</a>
+</h2>
+
+<ul>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a></li>
+<li><a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a></li>
+</ul>
+<h2>
+<a name="InAppBrowser_permissions">Permissions</a>
+</h2>
+
+<h3>Android</h3>
+
+<h4>app/res/xml/config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" value="org.apache.cordova.<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" />
+</code></pre>
+
+<h3>iOS</h3>
+
+<h4>config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" value="CDVInAppBrowser" />
+</code></pre>
+
+<h3>Windows Phone 7 + 8</h3>
+
+<h4>config.xml</h4>
+
+<pre class="prettyprint"><code><plugin name="<a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>" />
+</code></pre>
+
+<h1><a name="addEventListener">addEventListener</a></h1>
+
+<blockquote>
+ <p>Adds a listener for an event from the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.</p>
+</blockquote>
+
+<pre class="prettyprint"><code>ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>(eventname, callback);
+</code></pre>
+
+<ul>
+<li>
+<strong>ref:</strong> reference to the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window (<code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code>)</li>
+<li>
+<p><strong>eventname:</strong> the event to listen for (<code>String</code>)</p>
+
+<pre class="prettyprint"><code>loadstart - event fired when the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> starts to load a URL
+loadstop - event fired when the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> finished loading a URL
+exit - event fired when the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window is closed
+</code></pre>
+</li>
+<li><p><strong>callback:</strong> the function that is called when the event is fired.
+The function is passed an <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowserEvent">InAppBrowserEvent</a></code> object.</p></li>
+</ul>
+<h2>
+<a name="addEventListener_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iOS</li>
+<li>Windows Phone 7 + 8</li>
+</ul>
+<h2>
+<a name="addEventListener_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
+ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstart', function() { alert(event.url); });
+</code></pre>
+
+<h2>
+<a name="addEventListener_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
+ ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstart', function() { alert('start: ' + event.url); });
+ ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstop', function() { alert('stop: ' + event.url); });
+ ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('exit', function() { alert(event.type); });
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+</html>
+</code></pre>
+
+<h1><a name="removeEventListener">removeEventListener</a></h1>
+
+<blockquote>
+ <p>Removes a listener for an event from the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.</p>
+</blockquote>
+
+<pre class="prettyprint"><code>ref.<a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a>(eventname, callback);
+</code></pre>
+
+<ul>
+<li>
+<strong>ref:</strong> reference to the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window (<code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code>)</li>
+<li>
+<p><strong>eventname:</strong> the event to stop listening for (<code>String</code>)</p>
+
+<pre class="prettyprint"><code>loadstart - event fired when the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> starts to load a URL
+loadstop - event fired when the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> finished loading a URL
+exit - event fired when the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window is closed
+</code></pre>
+</li>
+<li><p><strong>callback:</strong> the function that was to be called when the event is fired.
+The function is passed an <code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowserEvent">InAppBrowserEvent</a></code> object.</p></li>
+</ul>
+<h2>
+<a name="removeEventListener_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iOS</li>
+<li>Windows Phone 7 + 8</li>
+</ul>
+<h2>
+<a name="removeEventListener_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
+var myCallback = function() { alert(event.url); }
+ref.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstart', myCallback);
+ref.<a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a>('loadstart', myCallback);
+</code></pre>
+
+<h2>
+<a name="removeEventListener_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Global <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> reference
+ var iabRef = null;
+
+ function iabLoadStart(event) {
+ alert(event.type + ' - ' + event.url);
+ }
+
+ function iabLoadStop(event) {
+ alert(event.type + ' - ' + event.url);
+ }
+
+ function iabClose(event) {
+ alert(event.type);
+ iabRef.<a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a>('loadstart', iabLoadStart);
+ iabRef.<a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a>('loadstop', iabLoadStop);
+ iabRef.<a href="cordova_inappbrowser_inappbrowser.md.html#removeEventListener">removeEventListener</a>('exit', iabClose);
+ }
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ iabRef = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
+ iabRef.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstart', iabLoadStart);
+ iabRef.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('loadstop', iabLoadStop);
+ iabRef.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>('exit', iabClose);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+</html>
+</code></pre>
+
+<h1><a name="close">close</a></h1>
+
+<blockquote>
+ <p>Closes the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window.</p>
+</blockquote>
+
+<pre class="prettyprint"><code>ref.<a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a>();
+</code></pre>
+
+<ul>
+<li>
+<strong>ref:</strong> reference to the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window (<code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code>)</li>
+</ul>
+<h2>
+<a name="close_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iOS</li>
+<li>Windows Phone 7 + 8</li>
+</ul>
+<h2>
+<a name="close_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
+ref.<a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a>();
+</code></pre>
+
+<h2>
+<a name="close_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>.<a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
+ // <a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a> <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> after 5 seconds
+ setTimeout(function() {
+ ref.<a href="cordova_inappbrowser_inappbrowser.md.html#close">close</a>();
+ }, 5000);
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+</html>
+</code></pre>
+
+<h1><a name="InAppBrowserEvent">InAppBrowserEvent</a></h1>
+
+<p>The object that is passed to the callback function from an <a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a> call on an <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> object.</p>
+
+<h2>
+<a name="InAppBrowserEvent_properties">Properties</a>
+</h2>
+
+<ul>
+<li>
+<strong>type:</strong> the eventname (<code>String</code>) - one of loadstart, loadstop, or exit</li>
+<li>
+<strong>url:</strong> the URL that was loaded (<code>String</code>)</li>
+</ul>
+<hr>
+<h1><a name="window.open">window.open</a></h1>
+
+<p>Opens a URL in a new <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> instance, the current browser instance, or the system browser.</p>
+
+<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>(url, target, options);
+</code></pre>
+
+<ul>
+<li>
+<strong>ref:</strong> reference to the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> window (<code><a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a></code>)</li>
+<li>
+<strong>url:</strong> the URL to load (<code>String</code>). Call encodeURI() on this if you have Unicode characters in your URL.</li>
+<li>
+<p><strong>target:</strong> the target to load the URL in (<code>String</code>) (Optional, Default: "_self")</p>
+
+<pre class="prettyprint"><code>_self - opens in the Cordova WebView if url is in the white-list, else it opens in the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>
+_blank - always open in the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>
+_system - always open in the system web browser
+</code></pre>
+</li>
+<li>
+<p><strong>options:</strong> options for the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a> (<code>String</code>) (Optional, Default: "location=yes")</p>
+
+<p>The options string must not contain any blank space, each feature name and value must be separated by a comma. Feature names are case insensitive. Only the value below is supported on all platforms:</p>
+
+<ul>
+<li>
+<strong>location</strong> - set to 'yes' or 'no' to turn the location bar on or off for the <a href="cordova_inappbrowser_inappbrowser.md.html#InAppBrowser">InAppBrowser</a>
+</li>
+</ul>
+<h2>iOS only</h2>
+
+<ul>
+<li>
+<strong>enableViewportScale</strong> - set to 'yes' or 'no' to prevent viewport scaling through a meta tag (defaults to 'no')</li>
+<li>
+<strong>mediaPlaybackRequiresUserAction</strong> - set to 'yes' or 'no' to not allow autoplayed HTML5 video (defaults to 'no')</li>
+<li>
+<strong>allowInlineMediaPlayback</strong> - set to 'yes' or 'no' to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute (defaults to 'no')</li>
+<li>
+<strong>keyboardDisplayRequiresUserAction</strong> - set to 'yes' or 'no' to open the keyboard when form elements get focus via the JavaScript focus() call (defaults to 'yes')</li>
+<li>
+<strong>suppressesIncrementalRendering</strong> - set to 'yes' or 'no' to wait until all new view content has been received before it is rendered (defaults to 'no')</li>
+<li>
+<strong>presentationstyle</strong> - set to 'pagesheet', 'formsheet' or 'fullscreen' to set the <a class="external" href="http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle">presentation style</a> (defaults to 'fullscreen')</li>
+<li>
+<strong>transitionstyle</strong> - set to 'fliphorizontal', 'crossdissolve' or 'coververtical' to set the <a class="external" href="http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle">transition style</a> (defaults to 'coververtical')</li>
+</ul>
+</li>
+</ul>
+<h2>
+<a name="window.open_supported_platforms">Supported Platforms</a>
+</h2>
+
+<ul>
+<li>Android</li>
+<li>iOS</li>
+<li>BlackBerry 10</li>
+<li>Windows Phone 7 + 8</li>
+</ul>
+<h2>
+<a name="window.open_quick_example">Quick Example</a>
+</h2>
+
+<pre class="prettyprint"><code>var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('http://apache.org', '_blank', 'location=yes');
+var ref2 = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>(encodeURI('http://ja.m.wikipedia.org/wiki/ãã³ã°ã«'), '_blank', 'location=yes');
+</code></pre>
+
+<h2>
+<a name="window.open_full_example">Full Example</a>
+</h2>
+
+<pre class="prettyprint"><code><!DOCTYPE html>
+<html>
+ <head>
+ <title><a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a> Example</title>
+
+ <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
+ <script type="text/javascript" charset="utf-8">
+
+ // Wait for Cordova to load
+ //
+ document.<a href="cordova_inappbrowser_inappbrowser.md.html#addEventListener">addEventListener</a>("<a href="cordova_events_events.md.html#deviceready">deviceready</a>", onDeviceReady, false);
+
+ // Cordova is ready
+ //
+ function onDeviceReady() {
+ // external url
+ var ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>(encodeURI('http://apache.org'), '_blank', 'location=yes');
+ // relative document
+ ref = <a href="cordova_inappbrowser_inappbrowser.md.html#window.open">window.open</a>('next.html', '_self');
+ }
+
+ </script>
+ </head>
+ <body>
+ </body>
+</html>
+</code></pre>
+
+ </div>
+ </div>
+
+ <!-- Functionality and Syntax Highlighting -->
+ <script type="text/javascript" src="index.js"></script><script type="text/javascript" src="prettify/prettify.js"></script>
+</body>
+</html>