32.4.12 viewオブジェクト

クライアントスクリプト機能で表示するテーブルデータの取得やユーザHTML画面を使用するためのオブジェクトです。
テーブルデータとは、2次元で表される配列を扱うデータ形式です。配列の各要素はstring型の文字列です。

メソッド名	機能
addWidget	エミュレータ画面上に部品を表示
getWidget	エミュレータ画面上の部品オブジェクトを取得
hideLoading	Loading画面を非表示
hideWidget	エミュレータ画面上の部品を非表示
load	ユーザHTMLの表示
removeWidget	エミュレータ画面上の部品を消去
showLoading	Loading画面を表示
showWidget	エミュレータ画面上の部品を再表示
unload	ユーザHTMLの消去

オブジェクト名	機能	初期値
table	エミュレータ画面に表示するテーブルデータ	Arrayオブジェクトの初期値
keypad	エミュレータのキーパッドをカスタマイズ

■addWidget

エミュレータ画面上へ部品を表示

エミュレータの画面上に部品を表示します。

●呼び出し形式

addWidget(WsmgrWidgetObj)

●パラメータ

パラメータ	説明	省略時の初期値
WsmgrWidgetObj	WsmgrWidgetオブジェクトを指定	省略できません

参考

パラメータの詳細はWsmgrWidgetオブジェクトの説明を参照してください。

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合は、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var button1 = new WsmgrWidget("button1", "button");
button1.setPosition(10, 15, 5, 1);
dspemu.view.addWidget(button1);

注意

部品の表示位置が同じ位置を指していた場合、または、部品のサイズによって他の部品と重なる場合は、あとから追加した部品が前面に表示されます。

■getWidget

エミュレータ画面上の部品オブジェクトを取得

エミュレータ画面上の部品オブジェクトを取得します。

●呼び出し形式

getWidget(id)

●パラメータ

パラメータ	説明	省略時の初期値
id	WsmgrWidgetオブジェクトのidを指定	省略できません

参考

パラメータの詳細はWsmgrWidgetオブジェクトの説明を参照してください。

●リターン値

関数の呼び出しに成功すると部品オブジェクト(WsmgrWidgetオブジェクト)を返します。エラーが発生した場合は、nullを返します。エラーの詳細は、getErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var check1 = new WsmgrWidget("check1", "check");
check1.setPosition(10,10, 5, 1); 
dspemu.view.addWidget(check1); 

var button1 = new WsmgrWidget("button1", "button");
button1.setPosition(10, 15, 5, 1); 
button1.bind("click", function (e) {
    // チェック部品オブジェクトを取得
    var check = e.dspemu.view.getWidget("check1");
});
dspemu.view.addWidget(button1);

■hideLoading

Loading画面の非表示

表示されているLoading画面を非表示に設定します。

●呼び出し形式

hideLoading()

●パラメータ

ありません

●リターン値

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

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

dspemu.view.showLoading({'url': 'customize/Loading.htm', 'opacity': 0.8});
dspemu.screen.bind('change', function (e) {
    if (!e.byHost) {
        return false;
    }
    if (dspemu.screen.contains('SYSTEM READY')) {
        var win = new WsmgrWindow('customize/menu.htm'); 
        win.bind('load', function (e) {
            // ユーザHTMLロード完了後にLoading画面を非表示
            e.dspemu.view.hideLoading();
        });
        dspemu.view.load(win); 
    }
});

■hideWidget

エミュレータ画面上の部品を非表示に設定

エミュレータの画面上に表示されている部品を非表示に設定します。

●呼び出し形式

hideWidget(id)

●パラメータ

パラメータ	説明	省略時の初期値
id	WsmgrWidgetオブジェクトで設定したidを指定	エミュレータ画面上のすべての部品を非表示に設定します

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合は、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var button1 = new WsmgrWidget("button1", "button");
button1.setPosition(10, 15, 5, 1);
dspemu.view.addWidget(button1);
dspemu.view.hideWidget(button1);

■load

ユーザHTMLの表示

指定されたオブジェクトの設定に従い、ユーザHTMLをエミュレータ画面に表示します。

●呼び出し形式

load(obj)

●パラメータ

パラメータ	説明	省略時の初期値
obj	ユーザHTMLの表示方法を設定したオブジェクトを指定 WsmgrDialog：ダイアログを表示 WsmgrWindows：エミュレータ上に表示	省略できません

参考

WsmgrDialogオブジェクト、WsmgrWindowオブジェクトの詳細は各リファレンスを参照してください。

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合は、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var screen = new WsmgrWindow("user.htm");
screen.setStyle("screen");
dspemu.view.load(screen);  // ユーザHTMLを表示

■removeWidget

エミュレータ画面上の部品を消去

エミュレータの画面上の部品を消去します。

●呼び出し形式

removeWidget(id)

●パラメータ

パラメータ	説明	省略時の初期値
id	WsmgrWidgetオブジェクトで設定したidを指定	エミュレータ画面上のすべての部品を消去します

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合は、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var button1 = new WsmgrWidget("button1", "button");
button1.setPosition(10, 15, 5, 1);
dspemu.view.addWidget(button1);
dspemu.view.removeWidget("button1");

■showLoading

Loading画面の表示

エミュレータ画面上にLoading画面を表示します。

●呼び出し形式

showLoading(option)

●パラメータ

パラメータ	説明	省略時の初期値
option	Loading画面の表示オプションをオブジェクトで指定指定可能なオプションは表示オプションを参照	初期値で表示

●表示オプション一覧

オプション	説明
'url'	Loading画面のURLを指定 Loading画面をユーザが作成したHTMLページに変更する場合に指定します。絶対パス指定以外の場合、接続アイコンのプロパティで指定されたユーザスクリプトファイルを配置しているフォルダ配下を参照します。ファイルが存在しない場合は、サーバのuserconfigフォルダ配下を参照します。初期値：製品標準のLoading画面を表示
'opacity'	Loading画面の透過率を0～1.0の範囲で指定初期値：1.0(透過しません)

オプション

説明

'url'

Loading画面のURLを指定
Loading画面をユーザが作成したHTMLページに変更する場合に指定します。
絶対パス指定以外の場合、接続アイコンのプロパティで指定されたユーザスクリプトファイルを配置しているフォルダ配下を参照します。ファイルが存在しない場合は、サーバのuserconfigフォルダ配下を参照します。
初期値：製品標準のLoading画面を表示

'opacity'

Loading画面の透過率を0～1.0の範囲で指定

初期値：1.0(透過しません)

●リターン値

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

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成
// Loading画面を透過して表示します
dspemu.view.showLoading({'url': 'customize/Loading.htm', 'opacity': 0.8});

■showWidget

エミュレータ画面上の部品を再表示

エミュレータの画面上で非表示にした部品を再表示に設定します。

●呼び出し形式

showWidget(id)

●パラメータ

パラメータ	説明	省略時の初期値
id	WsmgrWidgetオブジェクトで設定したidを指定	エミュレータ画面上のすべての部品を再表示に設定します

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合は、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var button1 = new WsmgrWidget("button1", "button");
button1.setPosition(10, 15, 5, 1);
dspemu.view.addWidget(button1);
dspemu.view.hideWidget(button1);
dspemu.view.showWidget(button1);

■unload

ユーザHTMLの消去

ユーザHTMLを消去します。

●呼び出し形式

unload([obj])

●パラメータ

パラメータ	説明	省略時の初期値
obj	消去するユーザHTMLが設定されているオブジェクトを指定指定なし：表示されているユーザHTMLをすべて消去します。 WsmgrWindowオブジェクト：指定されたWsmgrWindowオブジェクトで設定したページを消去します。 WsmgrDialogオブジェクト：指定されたWsmgrDialogオブジェクトで表示したダイアログを消去します。	すべて消去

●リターン値

関数の呼び出しに成功するとtrueを返します。エラーが発生した場合は、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成

var win = new WsmgrWindow('user.htm');
dspemu.view.load(win); // ユーザを表示
dspemu.bind('load', function (e) {
    dspemu.view.unload(win);  // 表示中のユーザHTMLを消去
});