globalization.getDatePattern

クライアントのユーザー設定を元に、日時のフォーマットと変換のためのパターン文字列を返します。

navigator.globalization.getDatePattern(successCB, errorCB, options);

概要

successCB コールバック関数に、プロパティーオブジェクトをパラメーターとしてパターンを返します。このオブジェクトは以下のプロパティーを持っています:

  • pattern {String}: 日時のフォーマットと変換のための日付および時間のパターンを表します。このパターンは Unicode Technical Standard #35 に従っています。 http://unicode.org/reports/tr35/tr35-4.html
  • timezone {String}: クライアントのタイムゾーンの省略名を表します。
  • utc_offset {Number}: クライアントのタイムゾーンと協定世界時との現在の差を秒で表します。
  • dst_offset {Number}: 現在のサマータイム (デイライトセービングタイム) のオフセットを秒で表します。

もしパターン取得中にエラーが発生した場合、 errorCB コールバックが GlobalizationError オブジェクトをパラメーターとして呼び出されます。このエラーに対するエラーコードは GlobalizationError.PATTERN_ERROR です。

options.formatLength には 'short', 'medium', 'long', または 'full' が指定出来ます。 options.selector には 'date', 'time' または 'date and time' が指定出来ます。

デフォルトのオプションは {formatLength:'short', selector:'date and time'} です。 この options パラメーターはオプション (任意) です。

サポートされているプラットフォーム

  • Android
  • BlackBerry WebWorks (OS 5.0 以上)
  • iPhone

使用例

ブラウザーのロケールが en_US に設定されている場合、次のコードは "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'}
  );
}

詳細な使用例

<!DOCTYPE HTML>
<html>
  <head>
    <title>Cordova</title>
    <script type="text/javascript" charset="utf-8" src="cordova-2.2.0.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()">クリックしてパターンを表示</button>
  </body>
</html>