WSMGR for Web V9 使用手引書

32.4.14 view.keypadオブジェクト

エミュレータのキーパッドをカスタマイズします。

メソッド名	機能
createKeyInfo	キー情報の生成
getKey	指定されたキーパッドのキー情報を取得
getKeys	キーパッドすべてのキー情報を取得
getStyle	キーパッドの表示スタイルを取得
setButtonRowCol	キーパット表示(行数、表示ボタン数)を設定
setKey	キーパッド指定された面の指定されたキーを設定
setKeys	キーパッドの複数キーを一括設定
setPosition	キーパッドの表示設定
setPreset	キーパッドのプリセットを指定
setSize	キーパッドの表示設定
setStyle	キーパッドの表示スタイルを設定

■createKeyInfo

キー情報の生成

指定されたキーパッド設定に従って、キー情報オブジェクトを生成します。
actionパラメータには、macroオブジェクトのType関数に指定可能な文字列を指定してください。

参考

生成したキー情報は、setKeyメソッドの引数に指定できます。また、複数のキーをまとめて指定する場合は、キー情報オブジェクトを配列にしてsetKeysメソッドの引数に指定します。

●呼び出し形式

createKeyInfo(surface, row, col, name, action)

●パラメータ

パラメータ	説明	省略時の初期値
surface	ボタンを設定するキーパッドの面を数値で指定	省略できません
row	キーパッドの行を数値で指定	省略できません
col	キーパッドの桁を数値で指定	省略できません
name	キーパッドの表示ボタン名を文字列で指定	省略できません
action	ボタンのアクションを文字列で指定	省略できません

●リターン値

関数の呼び出しに成功するとキー情報オブジェクトを返します。エラーが発生した場合はnullを返します。

●キー情報オブジェクト プロパティ

パラメータ	説明
surface	指定されたボタンを設定するキーパッドの面
row	指定されたキーパッドの行数
col	指定されたキーパッドの桁数
name	指定されたキーパッドの表示ボタン名
action	指定されたキーパッドボタンのアクション文字列

●JavaScriptを用いて記述した例

setKeyメソッドを参照してください。

■getKey

指定されたキーパッドのキー情報を取得

指定された位置のキー情報オブジェクトを取得します。

●呼び出し形式

getKey(surface, row, col)

●パラメータ

パラメータ	説明	省略時の初期値
surface	キーパッドの面を数値で指定	省略できません
row	キーパッドの行を数値で指定	省略できません
col	キーパッドの桁を数値で指定	省略できません

●リターン値

関数の呼び出しに成功すると指定されたキーパッド位置のキー情報オブジェクトを返します。エラーが発生した場合はnullを返します。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成
dspemu.bind('load', function (e) {
    // 1面の1行1桁目のキー情報オブジェクトを取得
    var keyInfo = dspemu.view.keypad.getKey(1, 1, 1);
});

■getKeys

キーパッドすべてのキー情報を取得

表示されているキーパッドのすべてのキー情報オブジェクト配列を取得します。

●呼び出し形式

getKeys()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとキーパッドのキー情報オブジェクト配列を返します。エラーが発生した場合はnullを返します。

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成
dspemu.bind('load', function (e) {
    // キーパッドのキー情報を取得
    var keyInfoArray = dspemu.view.keypad.getKeys();
    if (keyInfoArray != null) {
        // キー情報の参照
        for (var i = 0; i < keyInfoArray.length; i++) {
            var keyInfo = keyInfoArray[i]; 
            if (keyInfo.name == 'PF1') {
                // ボタン表示名がPF1の場合の処理
                // :
            }
        }
    }
});

■getStyle

キーパッドの表示スタイルを取得

エミュレータ上のキーパッドの表示スタイルを取得します。

●呼び出し形式

getStyle()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると現在のエミュレータのキーパッドの表示スタイルを示すスタイル名（文字列）を返します。

スタイル名	表示スタイル
"none"	非表示
"fixed"	エミュレータ画面の下端に固定表示
"fixed-left"	エミュレータ画面の左端に固定表示
"fixed-right"	エミュレータ画面の右端に固定表示
"fixed-top"	エミュレータ画面の上端に固定表示
"fixed-bottom"	エミュレータ画面の下端に固定表示(fixedと同じ)
"float"	エミュレータ画面上を移動可能(キー配置は横並び表示)
"float-landscape"	同上
"float-portrait"	エミュレータ画面上を移動可能(キー配置は縦並び表示)

●JavaScriptを用いて記述した例

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

var keyStyle = dspemu.view.keypad.getStyle();  // キーパッドの表示スタイルを取得

■setButtonRowCol

キーパッドの表示形式の設定

エミュレータ上に表示するキーパットの最大表示面数、表示行数、表示ボタン数を指定します。

●呼び出し形式

setButtonRowCol(surface, row, col)

●パラメータ

パラメータ	説明	省略時の初期値
surface	表示するキーパッドの最大面数を指定	省略できません
row	キーパッド表示行数の指定	省略できません
col	キーパッド表示ボタン数の指定	省略できません

●リターン値

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

●JavaScriptを用いて記述した例

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

dspemu.view.keypad.setButtonRowCol(1, 2, 10);  // キーパッドをボタン数10個の2行で1面のみ表示

■setKey

キーパッドの指定面のキーボタンを設定

キーパッドの指定面に定義されているキーボタンを指定したボタンに変更します。
actionパラメータには、macroオブジェクトのType関数に指定可能な文字列を指定してください。

●呼び出し形式

setKey(surface, row, col, name, action) または
setKey(keyInfo)

●パラメータ

パラメータ	説明	省略時の初期値
surface	ボタンを設定するキーパッドの面を数値で指定	省略できません
row	キーパッドの行を数値で指定	省略できません
col	キーパッドの桁を数値で指定	省略できません
name	キーパッドの表示ボタン名を文字列で指定	省略できません
action	ボタンのアクションを文字列で指定	省略できません

パラメータ	説明	省略時の初期値
keyInfo	createKeyInfoメソッドで生成したキー情報オブジェクトを指定	省略できません

参考

マクロ実行をボタンに設定する場合は、actionパラメータに以下のように指定します。
（test1.srcを実行する例）

[MACRO:test1.scr]

●リターン値

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

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成
dspemu.bind('load', function (e) {
    // 1面1行1桁のボタンを、実行キーを入力するボタン"LOGON"に設定
    dspemu.view.keypad.setKey(1, 1, 1, "LOGON", "LOGON[ENTER]");
    // キー情報オブジェクトを使用した例：
    var keyInfo = dspemu.view.keypad.createKeyInfo(1, 1, 2, "LOGOFF", "LOGOFF[ENTER]");
    dspemu.view.keypad.setKey(keyInfo); 
});

■setKeys

キーパッドの複数キーを一括設定

指定されたキー情報オブジェクト配列に従って、キーパッドの複数のボタンを設定します。

●呼び出し形式

setKeys(keyInfoArray)

●パラメータ

パラメータ	説明	省略時の初期値
keyInfoArray	createKeyInfoメソッドで生成したキー情報オブジェクトの配列を指定	省略できません

●リターン値

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

●JavaScriptを用いて記述した例

var dspemu = new WsmgrDspemu();  // インスタンスの作成
var defaultKeypadKeys = [];
dspemu.bind('load', function (e) {
    // キーパッドの設定情報を保存
    defaultKeypadKeys = dspemu.view.keypad.getKeys();
});
// 画面更新後イベントを登録
dspemu.screen.bind('change', function (e) {
    if (!e.byHost) {
        return;
    }
    if (dspemu.screen.contains('SYSTEM READY')) {
        // キーパッドのカスタマイズを戻す
        dspemu.view.keypad.setKeys(defaultKeypadKeys);
    } else if (dspemu.screen.contains('ID:00001')) {
        // 画面に応じたキーパッドのカスタマイズ
        var keyInfoArray = [];
        var keyInfo = dspemu.view. keypad.createKeyInfo(1, 1, 1, '戻る','[PF1]');
        keyInfoArray.push(keyInfo);
        keyInfo = dspemu.view. keypad.createKeyInfo(1, 1, 3, '実行','[PF3]');
        keyInfoArray.push(keyInfo);
        // : 
        dspemu.view.keypad.setKeys(keyInfoArray);
    }
});

■setPosition

キーパッドの表示位置・サイズを設定

エミュレータ上のキーパッドの表示位置やサイズを設定します。

注意

• 表示設定の変更はキーパッドのスタイルがfloatの場合のみ有効です。

• 本メソッドはエミュレータと同一ウィンドウから呼び出してください。

●呼び出し形式

setPosition(top, left, width, height)

●パラメータ

パラメータ	説明	省略時の初期値
top	キーパッドを表示する左上位置をエミュレータ画面の行で指定(1～24) 位置を変更しない場合はnullを指定	省略できません
left	キーパッドを表示する左上位置をエミュレータ画面の桁で指定(1～80) 位置を変更しない場合はnullを指定	省略できません
width	キーパッドの幅を文字単位で指定 (1～80)	幅を変更しません
height	キーパッドの高さを文字単位で指定 (1～24)	高さを変更しません

●リターン値

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

●JavaScriptを用いて記述した例

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

dspemu.view.keypad.setStyle("float");  // キーパッドのスタイルをfloatに指定
dspemu.view.keypad.setPosition (1, 1, 80, 2); // 1行1桁に幅80文字で高さ2文字分のキーバッドを設定

■setPreset

キーパッドのプリセットを指定

エミュレータのキーパッドを、PC用、タブレット端末用に最適化した標準セットに切り替えます。

●呼び出し形式

setPreset(preset)

●パラメータ

パラメータ	説明		省略時の初期値
preset	"pc"	従来のキーパッドを表示	省略できません
	"tablet"	タブレット端末用に最適化したキーパッドを表示

●リターン値

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

●JavaScriptを用いて記述した例

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

dspemu.view.keypad.setPreset("tablet"); // タブレット用のキーパッドを指定

■setSize

キーパッドの表示サイズを設定

エミュレータ上に表示するキーパットの表示サイズ（幅、高さ）を指定します。

注意

表示サイズの変更はキーパッドのスタイルがfloatの場合のみ有効です。

●呼び出し形式

setSize(width, height)

●パラメータ

パラメータ	説明	省略時の初期値
width	キーパッドの幅を文字単位で指定 (1～80)	省略できません
height	キーパッドの高さを文字単位で指定 (1～24)	省略できません

●リターン値

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

●JavaScriptを用いて記述した例

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

dspemu.view.keypad.setStyle("float");  // キーパッドのスタイルをfloatに指定
dspemu.view.keypad.setSize(80, 2); // キーパッドのサイズを幅80文字で高さ2文字分に設定

■setStyle

キーパッドの表示スタイルを設定

エミュレータのキーパッドを指定の表示スタイルに設定します。

●呼び出し形式

setStyle(style)

●パラメータ

パラメータ	説明		省略時の初期値
style	"none"	非表示に設定	省略できません
	"fixed"	エミュレータ画面の下端に固定表示(初期値)
	"fixed-left"	エミュレータ画面の左端に固定表示
	"fixed-right"	エミュレータ画面の右端に固定表示
	"fixed-top"	エミュレータ画面の上端に固定表示
	"fixed-bottom"	エミュレータ画面の下端に固定表示(fixedと同じ)
	"float" または "float-landscape"	エミュレータ画面上を移動可能なキーパッドを表示(初期表示位置は下端) ※キーが横に並びます
	"float-portrait"	エミュレータ画面上を移動可能なキーパッドを表示(初期表示位置は右端) ※キーが縦に並びます

●リターン値

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

●JavaScriptを用いて記述した例

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

dspemu.view.keypad.setStyle("fixed-right");   // 右端にキーパッドを表示