PageManagerオブジェクト

コンポーネント情報
version	8.0.0
since	8.0.0

コンポーネント概要

ページマネージャクラスです。

ページ情報やページ遷移に関連する機能を提供するクラスです。

使い方

以下のような使い方を想定しています。

 var url = PageManager.getPageUrl(<pageCode>);
 
 PageManager.redirect(url);

getPageUrl() について

標準の実装では、取得するページの一覧はPluginで設定します。
以下の拡張ポイントを指定してプラグインを作成してください。

拡張ポイント: jp.co.intra_mart.page

プラグイン記述例：

   <extension point="jp.co.intra_mart.page">
     <page-config id="sample.page">
       <-- 標準のページプロバイダ -->
       <page-provider-class>jp.co.intra_mart.system.page.provider.StandardPageProvider</page-provider-class>
       <init-param>
         <param-name>sample.foo.bar</param-name>
         <param-value>/sample/foo/bar</param-value>
       </init-param>
 
       ：
 
     </page-config>
   </extension>

ページコード「sample.foo.bar」を指定することで、「プラグイン記述例」のプラグインからURL「/sample/foo/bar」が取得できます。

getPageUrl() が返却するURLをコンテキストパスからのURLとするためには、「/」で始まるように記述してください。

ページプロバイダについて
標準で用意された以下のページプロバイダを <page-provider-class> タグに指定します。

プロバイダクラス	説明
jp.co.intra_mart.system.page.provider.StandardPageProvider	設定されたURLをそのまま返却します。
jp.co.intra_mart.system.page.provider.script.StandardJsspPageProvider	設定されたページパスをスクリプト開発ページ用のURLに変換して返却します。
jp.co.intra_mart.system.page.provider.client_type.ClientTypePageProvider	クライアントタイプが設定と一致する場合、設定されたURLをそのまま返却します。クライアントタイプの設定は、 `<init-param>` タグの `<param-name>` タグに `client-type` を指定して設定します。（例） <init-param> <param-name>client-type</param-name> <param-value>pc</param-value> </init-param>
jp.co.intra_mart.system.page.provider.client_type.ClientTypeJsspPageProvider	クライアントタイプが設定と一致する場合、スクリプト開発ページのURLを返却します。

redirect() について

グローバル関数 redirect() とは以下の点が異なります。

HTMLフォームを作成し、onloadイベントによるsubmit() を行います。
これにより、POSTメソッドをサポートします。
指定したURLの先頭が「/」で始まる相対パスの場合、コンテキストパスからの相対パスとして扱います。

onloadイベントによりリダイレクトを行なっているため、Ajaxリクエストの場合はリダイレクトされません。

Ajaxでリダイレクトを行う場合、コールバック関数によるハンドリングが必要となるため、個別の処理が必要となります。

Ajaxでのリクエストで利用される処理では、redirect() メソッドは利用しないようにしてください。

メソッドの概要

返却値の型	メソッド名
ResultObject	getPageUrl (String `pageCode`) static 設定情報からページURLを取得します。
ResultObject	redirect (String `url`, String `[method]`, Object `[parameters]`) static 指定ページにリダイレクトを行います。

メソッドの詳細

ResultObject getPageUrl (String pageCode) static

設定情報からページURLを取得します。

引数で指定したページコードからページURLを返却します。

パラメータ

pageCode : String: ページコード

返却値

ResultObject: ResultObject 処理結果オブジェクト
正常に取得できた場合、 data プロパティにはページURLが設定されます。

ResultObject redirect (String url, String [method], Object [parameters]) static

指定ページにリダイレクトを行います。

パラメータ

url : String: リダイレクトURL
このURLが「/」で始まる相対表記である場合、コンテキストパスからの相対パスとします。
このURLが「/」で始まらない相対表記である場合、リクエストURIからの相対パスとします。
プロトコル指定のある、絶対表記である場合、そのままURLとして解釈します。
未指定の場合、空文字列となります。
URLのパスの後ろの「?」以降のクエリ文字列は解析されて、リダイレクトURLからは削除され、 POSTリクエストのMessageBodyとしてとして送信されます。

[method] : String: リダイレクトメソッド
未指定の場合、GET
ただし、未指定の場合でリクエストパラメータが指定されている場合は、POSTとします。

[parameters] : Object: 拡張するリクエストパラメータのマップ
リクエストとして送信したいパラメータをオブジェクトのキーと値のペアで指定します。

返却値

ResultObject: ResultObject 処理結果オブジェクト
data プロパティには null が設定されます。