戻る

システム関数

ページ遷移関数

  • 書式

  • $.mobile.changePage(to,[, options])

  • 引数

  • to

    型：文字列またはオブジェクト

    次のいずれかの方法で、遷移先のページを指定します。

    • 戻る
    • URLを文字列として渡す（"target.html"など）
    • jQueryのコレクションオブジェクトを渡す（$("#target")）など）

  • options

    型：オブジェクト

    ページ遷移に関わるさまざまなオプションを指定します。

    • 戻る
    • プロパティ
      型
      省略時の値
      説明
      allowSamPageTransition
      boolean
      false
      初期状態のchangePage()関数は、アクティブページと同じページへの遷移を無視する。この値をtrueにすることで、ページ遷移が可能になる。ただし、ページ遷移アニメーションの中には、同一ページ間ではうまく動かないものもある。そうしたことも含めて、すべて独自にハンドリングできるのでなければ、この値はfalseのままにしておくのがよい
      changeHash
      boolean
      true
      履歴ハッシュの書き換えを行うかどうか、ハッシュを書き換えない場合、ロケーションバーの表示も変わらず、履歴もたまらないので、前の画面に「戻る」こともできなくなる
      data
      文字列またはオブジェクト
      undefined
      引数toの指定がURLであった場合、ここで指定した値をパラメータとして付与できる。文字列であれば、「a=1&b=2&c=3」のように直接していする。オブジェクトとして渡した場合、キーと値が自動的に展開される
      dataUrl
      文字列
      undefined
      遷移後に更新するURL。引数toにURLを指定した場合、とくに指定がなければそれがそのまま使われる。また、ページコンテナにdata-url属性が指定されている場合は、それを用いる
      pageContainer
      オブジェクト
      $.mobile.pageContainer
      遷移するページが読みこまれるべきコンテナ要素を含むjQueryオブジェクト
      reloadPage
      boolean
      false
      この値をtrueにすると、遷移先のURLがすでにDOM上にあっても、強制的に再取得を促す。引数toにURLを指定した場合のみ有効
      reverse
      boolean
      false
      この値をtrueにすると、ページ遷移後の効果が逆回しになる
      showLoadMsg
      boolean
      true
      この値をfalseにすると、ページ読み込み時のローディングメッセージが表示されなくなる
      role
      文字列
      undefined
      読み込まれたページコンテナのdata-roleに設定される値を指定する。省略した場合は何も関与せず、読み込まれたマークアップをそのまま使う
      transition
      文字列
      $.mobile.defaultPageTransition
      ページ切り替え効果を指定する。省略した場合は、グローバル設定にある初期値を使う
      type
      文字列
      get
      リクエストのメソッドを指定する。設定可能なのは、「get」もしくは「post」のみ。引数toにURLを指定した場合のみ有効 
$.mobile.changePage("target.html");

$.mobile.changePage("target.html",{
	transition:"pop",
	changeHash:false
});

var $pg = "
ページの内容...
";
$.mobile.pageContainer.append($pg);
$.mobile.changePage($("#target"),{
	dataUrl:"/target.html"
});

ページ読み込み関数

  • 書式

  • $.mobile.loadPage(url [, options])

  • 引数

  • url

    型：文字列

    読み込むURLを指定します。絶対パス、相対パスのいずれでも指定可能です。

  • options

    型：オブジェクト

    ページ読み込みに関わるさまざまなオプションを指定します。

    • 戻る
    • プロパティ
      型
      省略時の値
      説明
      data
      文字列またはオブジェクト
      undefined
      ここで指定した値をurlパラメータとして付与できる。文字列であれば「a=1&b=2&c=3」のように直接指定する。オブジェクトとして指定した場合、キーと値が自動的に展開される
      loadMsgDelay
      数値
      50
      ローディングメッセージを表示するまでの時間をミリ秒で指定する。これを指定しておくことにより、たとえばすでにキャッシュされて読み込む必要がないページの指定時など、不要なメッセージの表示を抑制できる
      pageContainer
      オブジェクト
      $.mobile.pageContainer
      遷移するページが読みこまれるべきコンテナ要素を含むjQueryオブジェクト
      reloadPage
      boolean
      false
      この値をtrueにすると、遷移先のURLがすでにDOM上にあっても、強制的に再取得を促す
      role
      文字列
      undefined
      読み込まれたページコンテナのdata-roleに設定される値を指定する。省略した場合は何も関与せず、読み込まれたマークアップをそのまま使う
      type
      文字列
      get
      リクエストメソッドを指定する。設定可能なのは、「get」もしくは「post」のみ
  • 戻り値

  • jQuery Defferedオブジェクト

$.mobile.loadPage("target.html");

$.mobile.loadPage("target.html",function(){
	type:"post",
	data:$("for#search").serialize(),
	reloadPage:true
});

ローディングメッセージ表示関数

  • 書式

  • $.mobile.showPageLoadingMsg()

$.mobile.showPageLoadingMsg();

ローディングメッセージ削除関数

  • 書式

  • $.mobile.hidePageLoadingMsg()

$.mobile.hidePageLoadingMsg();

固定ツールバー表示関数

  • 書式

  • $.mobile.fixedToolbars.show([immediately])

  • 引数

  • immediately

    型：boolean

    省略時の値：false

    通常、固定ツールバーは100ミリ秒かけてフェードインで表示されます。この引数にfalseを指定すると、そうした効果なしに即座に表示されます。

$.mobile.fixedToolbars.show();

$.mobile.fixedToolbars.show(true);

固定ツールバー非表示関数

  • 書式

  • $.mobile.fixedToolbars.hide([immediately])

  • 引数

  • immediately

    型：boolean

    省略時の値：false

    通常、固定ツールバーは100ミリ秒かけてフェードアウトで表示されます。この引数にfalseを指定すると、そうした効果なしに即座に非表示になります。

$.mobile.fixedToolbars.hide();

$.mobile.fixedToolbars.hide(true);

URLパース関数

  • 書式

  • $.mobile.path.parseUrl(url)

  • 引数

  • url

    型：文字列

    パースしたいURL文字列を指定します。

  • 戻り値

  • パース結果オブジェクト

    • 戻る
    • プロパティ
      説明
      href
      引数に渡されたもともとのURLが返される
      hrefNoHash
      引数に渡されたもともとのURLからハッシュ部分を除いたものが返される
      protocol
      プロトコル部分。「:」も含む文字列が返される
      authority
      オーソリティ情報が返される。ユーザ名、パスワード、ホスト名、ポート番号までを含む
      domain
      ドメイン部分が返される。オーソリティにプロトコルを加えたもの
      host
      ホスト名と、ポート番号（指定があれば）が返される
      hostname
      ホスト名が返される
      port
      ポート番号が返される。とくに指定がない場合、値は空になる
      password
      認証パスワード部分が返される
      username
      認証ユーザ部分が返される
      pathname
      パスやファイル名部分が返される
      directory
      パスのディレクトリ部分だけが返される
      filename
      パスのファイル名部分だけが返される
      search
      「?」以下の検索パラメータが返される
      hash
      URLのハッシュ部分。「#」も含む文字列が返される 
$.mobile.path.parseUrl("http://example.com/search?q=keywords");

絶対パス作成関数

  • 書式

  • $.mobile.path.makePathAbsokute(relPath, absPath)

  • 引数

  • relPath

    型：文字列

    絶対パス化したい、相対パスです。

  • absPath

    型：文字列

    相対パスの起点となる絶対パスです。

  • 戻り値

  • 相対パスを絶対パス化した文字列

var path = $.mobile.path.makePathAbsolute("d/target.html", "/a/b/c/example.html");

絶対URL作成関数

  • 書式

  • $.mobile.path.makeUrlAbsokute(relUrl, absUrl)

  • 引数

  • relUrl

    型：文字列

    絶対URL化したい、相対URLです。

  • absUrl

    型：文字列

    相対URLの起点となる絶対URLです。

  • 戻り値

  • 相対URLを絶対URL化した文字列

var path = $.mobile.path.makeUrlAbsolute("target.html", "http://example.com/");

同一ドメイン判別関数

  • 書式

  • $.mobile.path.isSampleDomain(url1, url2)

  • 引数

  • url1

    型：文字列

    比較するURLその1です。

  • url2

    型：文字列

    比較するURLその2です。

  • 戻り値

  • 同一ドメインであればtrue、そうでなければfalse

var path = $.mobile.path.makeUrlAbsolute("target.html", "http://example.com/");

相対URL判別関数

  • 書式

  • $.mobile.path.isRelativeUrl(url)

  • 引数

  • url

    型：文字列

    判別対象のURLです。

  • 戻り値

  • 相対URLであればtrue、そうでなければfalse

var isRel = $.mobile.path.isRelativeUrl("http://example.com/target.html");

絶対URL判別関数

  • 書式

  • $.mobile.path.isAbsoluteUrl(url)

  • 引数

  • url

    型：文字列

    判別対象のURLです。

  • 戻り値

  • 絶対URLであればtrue、そうでなければfalse

var isRel = $.mobile.path.isAbsoluteUrl("http://example.com/target.html");

サイレントスクロール関数

  • 書式

  • $.mobile.silentScroll([yPos])

  • 引数

  • yPos

    型：数値

    省略時の値：0

    スクロール先のY座標です。

$.mobile.silentScroll(450);
inserted by FC2 system