5.12.1 JavaScriptPluginManager（JavaScriptプラグインマネージャクラス）
JavaScriptからナビゲーション プラットフォーム独自の処理を行うためのオブジェクトを提供するクラスです。JavaScript内からは予約変数ucnpJavaScriptPluginManagerで取得できます。
JavaScriptPluginManagerのメソッドを次に示します。JavaScriptPluginManagerの一部のメソッドは，Webブラウザ（クライアント側）で実行するJavaScriptでも使用できます。
|
メソッド名 |
説明 |
Webブラウザ（クライアント側）で実行するJavaScriptでの使用可否 |
|---|---|---|
|
入力パラメタに結線されているガイドパーツの入力パラメタ名と型名を格納したMapオブジェクトを取得します。 |
○ |
|
|
JavaScriptプラグインの第2引数に渡されるMapオブジェクトを取得します。 |
○ |
|
|
指定したパラメタのキャッシュ値を取得します。 結線しているガイドパーツが，ラジオボタン，チェックボックス，またはハイパーリンクの場合は，キャッシュ値を取得する際，ラベル部分を含めた値全体を取得するか，ラベル部分を除外した値を取得するかを指定できます。 |
○ |
|
|
JavaScriptプラグインの戻り値に使用するMapオブジェクトを取得します。 |
○ |
|
|
RestClientオブジェクトを取得します。 |
× |
|
|
JavaScriptプラグインの第1引数に渡されるHttpSessionオブジェクトを取得します。 |
× |
|
|
入力パラメタの入力メソッド（inputFromNodeメソッドと同様のメソッド）からの呼び出しかどうかを判定します。 |
○ |
- （凡例）
-
○：使用できます。
×：使用できません。
- 〈この項の構成〉
(1) getCurrentParamsTypeMapメソッド
入力パラメタに結線されているガイドパーツの入力パラメタ名と型名を格納したMapオブジェクトを取得します。
(a) 形式
public Map<String, String> getCurrentParamsTypeMap();
(b) 引数
なし
(c) 戻り値
入力パラメタ名がキー，型名が値に格納されたMapオブジェクトが返されます。
なお，入力パラメタのうち，ガイドパーツから結線されていないパラメタのキーの情報はMapオブジェクトに格納されません。
|
項番 |
ガイドパーツの種類 |
ガイドパーツの型名 |
|---|---|---|
|
1 |
固定テキスト |
Label |
|
2 |
画像 |
Image |
|
3 |
テキストボックス |
TextBox |
|
4 |
テキストエリア |
TextArea |
|
5 |
ラジオボタン |
RadioButton |
|
6 |
チェックボックス |
CheckBox |
|
7 |
ドロップダウン |
DropDown |
|
8 |
ハイパーリンク |
HyperLink |
|
9 |
インラインフレーム |
Iframe |
(2) getParamメソッド
JavaScriptプラグインの第2引数に渡されるMapオブジェクトを取得します。
(a) 形式
public Map<String, Object> getParam();
(b) 引数
なし
(c) 戻り値
JavaScriptプラグインの第1引数に渡されるMapオブジェクトが返されます。
このオブジェクトには，入力パラメタに値が入力されたときは，inputFromNodeメソッドの第2引数（param）と同様の情報が格納されます。また，出力パラメタに値が出力されたときは，outputToNodeメソッドと同様の情報が格納されます。inputFromNodeメソッドおよびoutputToNodeメソッドの詳細については，マニュアル「ナビゲーション プラットフォーム 開発ガイド」を参照してください。
ただし，このオブジェクトからucnp.current.params.mapキーの値は取得できません。
(d) 例外
なし
(3) getParamValueメソッド
指定したパラメタのキャッシュ値を取得します。
結線しているガイドパーツが，ラジオボタン，チェックボックス，またはハイパーリンクの場合は，キャッシュ値を取得する際，ラベル部分を含めた値全体を取得するか，ラベル部分を除外した値を取得するかを指定できます。
(a) 形式
形式1
public String getParamValue(String paramName);
形式2
public String getParamValue(String paramName, boolean withLabel);
(b) 引数
-
paramName
キャッシュ値を取得するパラメタ名を指定します。
-
withLabel
パラメタのキャッシュ値を取得する際，ラベルを含めた値全体を取得するかどうかを指定します。なお，このメソッドを形式1で使用する場合は「false」が仮定されます。
-
true
ラベルを含めた値全体がそのまま返されます。
-
false
結線しているガイドパーツの種類に応じて，次の表に示す値が返されます。
表5‒7 ガイドパーツの種類と取得する値 項番
ガイドパーツの種類
取得する値
1
固定テキスト
キャッシュ値
2
画像
キャッシュ値
3
テキストボックス
キャッシュ値
4
テキストエリア
キャッシュ値
5
ラジオボタン
キャッシュ値のラベル部分（先頭から改行コード（\r\n）まで）を除外した値
6
チェックボックス
キャッシュ値のラベル部分（先頭から改行コード（\r\n）まで）を除外した値
7
ドロップダウン
キャッシュ値
8
ハイパーリンク
キャッシュ値のラベル部分（先頭から改行コード（\r\n）まで）を除外した値
9
インラインフレーム
キャッシュ値
-
(c) 戻り値
指定したパラメタのキャッシュ値が返されます。
(d) 例外
なし
(4) getReturnMapメソッド
JavaScriptプラグインの戻り値に使用するMapオブジェクトを取得します。
(a) 形式
Map<String, Object> getReturnMap();
(b) 引数
なし
(c) 戻り値
JavaScriptプラグインの戻り値に使用するMapオブジェクトが返されます。
このオブジェクトには，入力パラメタに値が入力されたときは，inputFromNodeメソッドの第2引数（param）と同様の情報が格納されます。また，出力パラメタに値が出力されたときは，outputToNodeメソッドと同様の情報が格納されます。inputFromNodeメソッドおよびoutputToNodeメソッドの詳細については，マニュアル「ナビゲーション プラットフォーム 開発ガイド」を参照してください。
(d) 例外
なし
(5) getRestClientメソッド
RestClientオブジェクトを取得します。
(a) 形式
public RestClient getRestClient();
(b) 引数
なし
(c) 戻り値
RestClientオブジェクトが返されます。
(d) 例外
なし
(6) getSessionメソッド
JavaScriptプラグインの第1引数に渡されるHttpSessionオブジェクトを取得します。
(a) 形式
public HttpSession getSession();
(b) 引数
なし
(c) 戻り値
JavaScriptプラグインの第1引数に渡されるHttpSessionオブジェクトが返されます。
このオブジェクトには，inputFromNodeメソッドおよびoutputToNodeメソッドの第1引数（session）と同様の情報が格納されます。inputFromNodeメソッドおよびoutputToNodeメソッドの詳細については，マニュアル「ナビゲーション プラットフォーム 開発ガイド」を参照してください。
(d) 例外
なし
(7) isInputメソッド
入力パラメタの入力メソッド（inputFromNodeメソッドと同様のメソッド）からの呼び出しかどうかを判定します。
(a) 形式
boolean isInput();
(b) 引数
なし
(c) 戻り値
-
true
入力パラメタからの入力メソッド（inputFromNodeメソッドと同様のメソッド）での呼び出しの場合（JavaScriptプラグインが，JavaScriptプラグインを配置したノードから次のノードに遷移したときに実行された場合）
-
false
入力パラメタからの入力メソッド（inputFromNodeメソッドと同様のメソッド）での呼び出しでない場合（JavaScriptプラグインが，JavaScriptプラグインを配置したノードに遷移したときに実行された場合）
(d) 例外
なし