31.6 WsmgrDialogリファレンス

ユーザHTMLをエミュレータ画面上にダイアログボックスを表示するためのオブジェクトです。ユーザHTMLを表示するには、viewオブジェクトのloadメソッドに指定する必要があります。

注意

本オブジェクトは、エミュレータと同一ウィンドウで利用してください。

■WsmgrDialog

エミュレータ画面上にユーザHTMLをダイアログ表示します。

●オブジェクト生成方法

new WsmgrDialog(url, style)

●パラメータ

パラメータ	説明	省略時の初期値
url	ユーザHTMLのURLを指定絶対パス指定以外の場合、サーバのuserconfigフォルダ配下を参照します。	省略できません
style	ダイアログボックスのスタイルを文字列で指定 "ok"：「OK」ボタンを表示 "ok cancel"：「OK」「キャンセルボタン」を表示 "yes"：「はい」ボタンを表示 "yes no"：「はい」「いいえ」を表示 "yes no cancel"：「はい」「いいえ」「キャンセルボタン」を表示	"ok cancel"

●リターン値

オブジェクトの生成に成功するとWsmgrDialogオブジェクトを返します。エラーの場合は、例外をスローします。

●JavaScriptを用いて記述した例

var dialog = null;
try {
    dialog = new WsmgrDialog("user.htm", "ok");
} catch(e) {
    // エラー発生時の処理
}

●メソッド一覧

メソッド名	機能
bind	イベント発生時に呼び出すコールバック関数を登録
click	クリックイベントを発生させます。
setParameter	イベント発生時にコールバック関数に渡すパラメータを指定
setPosition	ダイアログの表示設定
setSize	ダイアログの表示サイズを指定
setTitle	ダイアログのタイトルを指定

■bind

イベント発生時のコールバック関数の登録

ダイアログでイベントが発生した際に呼び出すコールバック関数を登録します。

●呼び出し形式

bind(type, func)

●パラメータ

パラメータ	説明	省略時の初期値
type	イベントタイプを文字列で指定 "load"：ユーザHTMLロード完了時 "init"：ダイアログの初期化時 "close"：ダイアログのクローズ時 "click"：ボタンクリック時	省略できません
func	コールバック関数を指定 typeで指定したイベントに登録された関数を解除する場合は null を指定	null

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var dialog = new WsmgrDialog("user.htm", "ok");
dialog.bind("load", onLoad);

参考

各イベントでは共通のパラメータとして、ダイアログオブジェクトが指定されます。dataパラメータで指定された値はダイアログオブジェクトに設定されて渡されます。

●ダイアログオブジェクト

メンバ変数	説明
window	ユーザHTMLのwindowオブジェクト
document	ユーザHTMLのdocumentオブジェクト
params	setParameterで指定したパラメータオブジェクト

●ダイアログオブジェクトの参照例）

var dialog = new WsmgrDialog("user.htm", "ok");
dialog.setParamter("data1", "データ1");
dialog.setParamter("data2", "データ2");
dialog.bind("load", onLoad);
dspemu.view.load(dialog); // ダイアログ表示
    :
｝

function onLoad(event) {
    event.window …       //ユーザHTMLのwindowオブジェクト
    event.document …     //ユーザHTMLのdocumentオブジェクト
    event.params.data1 ….  //setParameterで指定したパラメータオブジェクト
    event.params.data2 ….
    :
}

■click

WsmgrDialogオブジェクトのclickイベントを発生させます。

bindメソッドでclickイベントに登録したコールバック関数が実行されます。

●呼び出し形式

click(id)

●パラメータ

パラメータ	説明	省略時の初期値
id	コールバック関数呼び出し時に渡す、オブジェクトのメンバ変数 id値を指定 'ok':[OK]ボタン 'cancel':[キャンセル]ボタン 'yes': [はい]ボタン 'no': [いいえ]ボタン	'ok'

●リターン値

関数の呼び出しが成功するとtrueを返します。clickイベントが登録されていない場合や、エラーが発生した場合はfalseを返します。

●JavaScriptを用いて記述した例

ユーザスクリプトファイルの記述例

var dspemu = new WsmgrDspemu();
var dialog = new WsmgrDialog("user.htm", "ok");
dialog.bind('click', function(e) {
  if(e.id == 'ok') {
    // [OK]ボタンクリック時の処理を記述
  }
});

user.htmの記述例

function onButtonClick() {
  var dialog = parent.dialog;
  dialog.click('ok'); // ダイアログのclickイベントを発生
}

■setParameter

イベント発生時のコールバック関数に渡すパラメータ設定

イベントの発生時にコールバック関数に渡すパラメータを設定します。

●呼び出し形式

setParameter(name, data)

●パラメータ

パラメータ	説明	省略時の初期値
name	コールバック関数に渡されるダイアログオブジェクトのparamsのメンバ名を指定	初期化します
data	nameで指定したメンバ変数の値を指定

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var dialog = new WsmgrDialog("user.htm", "ok");
dialog.setParameter("data1", "データ1");
dialog.setParameter("data2", "データ2");

参照

ダイアログオブジェクトについてはbindメソッドを参照してください。

■setPosition

ダイアログの表示設定

ダイアログの表示位置、高さ、幅の設定をします。

●呼び出し形式

setPosition(left, top, width, height)

●パラメータ

パラメータ	説明	省略時の初期値
top	ダイアログの左上位置のエミュレータの「行」を指定(1～24)	ブラウザの中央位置
left	ダイアログの左上位置のエミュレータの「桁」を指定(1～80)	ブラウザの中央位置
width	ダイアログの幅を「文字」単位で指定(1～80)	幅を変更しません
height	ダイアログの高さを「文字」単位で指定(1～24)	高さを変更しません

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var dialog = new WsmgrDialog("user.htm", "ok");
dialog.setPosition(1, 1, 10, 20);

■setSize

ダイアログ表示サイズの設定

ダイアログの表示サイズを指定します。

●呼び出し形式

setSize(width, height)

●パラメータ

パラメータ	説明	省略時の初期値
width	ダイアログの幅を「文字」単位で指定(1～80)	省略できません
height	ダイアログの高さを「文字」単位で指定(1～24)	省略できません

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var dialog = new WsmgrDialog("user.htm", "ok");
dialog.setSize(20, 20);

■setTitle

ダイアログのタイトルを設定

ダイアログのタイトルを設定します。

●呼び出し形式

setTitle(titleName)

●パラメータ

パラメータ	説明	省略時の初期値
titleName	ダイアログタイトルを文字列で指定	空文字("")

●リターン値

関数呼び出しが成功するとtrueを返します。エラーの場合はfalseを返します。

●JavaScriptを用いて記述した例

var dialog = new WsmgrDialog("user.htm", "ok");
dialog.setTitle("ダイアログ1");