エミュレータ画面を操作するためのオブジェクトです。
メソッド名 | 機能 |
|---|---|
getKeyUnlockTime | キーアンロック時間の取得 |
getText | 指定範囲の文字列取得 |
getTextArrays | 矩形範囲からの文字配列の取得 |
getWaitTime | 最大待ち時間の取得 |
setKeyUnlockTime | キーアンロック時間の設定 |
setText | キー入力 |
setWaitTime | 最大待ち時間の設定 |
wait | 指定文字列の受信待ち |
■getKeyUnlockTime
キーアンロック時間の取得
設定されているキーアンロック時間を取得します。
キーアンロック時間とは、キーボードロック中に一瞬ロックが解除された場合に、この解除を本来の解除としないようにタイミングをとるための時間のことをいいます。初期値は1秒です。
キー入力が可能かどうかの判断はキーボードロックの解除後キーアンロック時間だけ待ち、なおキーボードロック解除状態が続いていればキー入力可能と判断します。逆にキーアンロックタイム待ち中にキーボードロックになれば、はじめからキーボードロックの解除を待ちます。
setTextメソッド呼び出し時にすでにキーボードロックが解除されていてもキーアンロック時間だけ待ちます。
●呼び出し形式
getKeyUnlockTime()
●パラメータ
ありません
●リターン値
関数の呼び出しに成功すると、設定されているキーアンロック時間を秒単位(秒.ミリ秒)で取得します。取得に失敗した場合は-1を返します。エラーの詳細は、getErrorメソッドにより取得できます。
●JavaScriptを用いて記述した例
setTextメソッドを参照してください。
■getText
指定範囲の文字列を取得
エミュレータ画面より指定した範囲の文字列を取得します。指定範囲内に含まれるフィールドアトリビュートは空白に置き換えます。
●呼び出し形式
getText(row1, col1, row2, col2)
●パラメータ
パラメータ | 説明 | 省略時の初期値 |
|---|---|---|
row1 | 指定範囲の開始行位置 | 1 |
col1 | 指定範囲の開始桁位置 | 1 |
row2 | 指定範囲の終了行位置 | 24 |
col2 | 指定範囲の終了桁位置 | 80 |
●リターン値
関数の呼び出しに成功すると取得した文字列を返します。エラーが発生した場合はnullを返します。エラーの詳細は、getErrorメソッドを使ってエラー番号を調べることができます。
●JavaScriptを用いて記述した例
setTextメソッドを参照してください。
■getTextArrays
矩形範囲からの文字列配列の取得
エミュレータ画面から指定位置が含まれるフィールドの矩形範囲より2次元配列の文字列データを取得します。
●呼び出し形式
getTextArrays(row1, col1, row2, col2)
●パラメータ
パラメータ | 説明 | 省略時の初期値 |
|---|---|---|
row1 | 指定範囲の開始行位置 | 1 |
col1 | 指定範囲の開始桁位置 | 1 |
row2 | 指定範囲の終了行位置 | 24 |
col2 | 指定範囲の終了桁位置 | 80 |
●リターン値
関数の呼び出しに成功すると指定範囲のフィールド文字列をテーブル文字列として返します。エラーが発生した場合はnullを返します。リターン値がnullの場合はgetErrorメソッドを使ってエラー番号を調べることができます。
参考
getTextArrayメソッドで取得するテーブル文字列には、アトリビュート属性のみのフィールドは含まれません。
●JavaScriptを用いて記述した例
setTextメソッドを参照してください。
■getWaitTime
最大待ち時間の取得
設定されている最大待ち時間を取得します。最大待ち時間の初期値は20秒です。
●呼び出し形式
getWaitTime()
●パラメータ
ありません
●リターン値
関数の呼び出しに成功すると、設定されている最大待ち時間を取得します。取得に失敗した場合は-1を返します。エラーの詳細は、getErrorメソッドにより取得できます。
●JavaScriptを用いて記述した例
// 最大待ち時間の取得
var waitTime = WsmgrConnector.emulator.screen.getWaitTime();
■setKeyUnlockTime
キーアンロック時間の設定
キーアンロック時間を設定します。
●呼び出し形式
setKeyUnlockTime(second, millisecond)
●パラメータ
パラメータ | 説明 | 省略時の初期値 |
|---|---|---|
second | キーアンロックタイム（秒.ミリ秒）（0～65535） | 省略できません |
millisecond | キーアンロックタイム(ミリ秒) | 0 |
●リターン値
関数の呼び出しに成功するとtrueを返します。設定に失敗した場合、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。
●JavaScriptを用いて記述した例
setTextメソッドを参照してください。
■setText
キー入力
キー入力をエミュレートします。キーボードロック状態の場合は、キー入力可能になるのを待ってから入力を行います。最大待ち時間は、setWaitTimeメソッドで指定された時間だけ待ちます。キーアンロック時間は、setKeyUnlockTimeメソッドで任意の時間に指定できます。
入力キーに特殊キーやJEFコードを含める時は[ENTER]のようにカッコ[]で囲みます。カッコ内は1つの項目だけ指定可能です。左カッコ[を入力するときは左カッコを重ねて記述します。
注意
1つのsetText文のパラメータで指定できる特殊キーは、1つのみです。2つ以上の特殊キーを指定しないでください。
キー入力の結果、表示中のページとエミュレータ画面が一致しなくなった場合は、表示中のページに一致すエミュレータ画面へ移動するか、表示中のページからスクリプトエディタで遷移情報が記録されているエミュレータ画面へ移動後に、forwardメソッドを呼び出してください。
●呼び出し形式
setText(text, row, col)
●パラメータ
パラメータ | 説明 | 省略時の初期値 |
|---|---|---|
text | 入力する文字列 | 省略できません |
row | 入力開始行位置(1～24) | カーソル位置 |
col | 入力開始桁位置(1～80) | カーソル位置 |
参考
textパラメータに指定可能な特殊キー文字列は、toEmulatorKeyメソッドの●取得可能なキー一覧を参照してください。
●リターン値
関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。エラーの詳細は、getErrorメソッドにより取得できます。
参考
メソッド呼び出し時に入力禁止状態だった場合は、RESETキーによる解除後に指定された文字列を入力します。また、指定されたすべての文字入力が正常に行われた結果、入力禁止状態となった場合もRESETキーにより解除されます。
入力禁止状態を解除した場合は、リターン値はfalseを返します。エラーの詳細コードは28(キー入力禁止を解除しました)を返します。
●JavaScriptを用いて記述した例
// キーアンロック時間の取得
var unlockTime = WsmgrConnector.emulator.screen.getKeyUnlockTime();
// キーアンロック時間の設定
WsmgrConnector.emulator.screen.setKeyUnlockTime(0, 100);
// キー入力
WsmgrConnector.emulator.screen.setText('40[ENTER]', 2, 15);
var table = [];
while(true) {
// エミュレータ画面より文字列は2次元配列で取得
var arrays = WsmgrConnector.emulator.screen.getTextArrays(5, 1, 22, 80);
table = table.concat(arrays);
// エミュレータ画面より文字を取得
var text = WsmgrConnector.emulator.screen.getText(23, 1, 23, 80);
if (text.indexOf('続きがあります') == -1) {
break;
}
// キー入力可の待ち合わせ
WsmgrConnector.emulator.screen.wait();
WsmgrConnector.emulator.screen.setText('[ENTER]');
}
// 設定を戻します
WsmgrConnector.emulator.screen.setKeyUnlockTime(unlockTime);■setWaitTime
最大待ち時間の設定
setTextメソッド、waitメソッドの最大待ち時間を設定します。
●呼び出し形式
setWaitTime(second)
●パラメータ
パラメータ | 説明 | 省略時の初期値 |
|---|---|---|
second | 待ち時間(秒)(1～65535) | 省略できません |
●リターン値
関数の呼び出しに成功するとtrueを返します。エラーが発生した場合はfalseを返します。エラーの詳細は、getErrorメソッドにより取得できます。
●JavaScriptを用いて記述した例
if (!WsmgrConnector.emulator.isConnected()) {
// 最大待ち時間の設定
WsmgrConnector.emulator.screen.setWaitTime(10);
}■wait
指定文字列の受信待ち
指定文字列を受信するのを待ちます。このメソッドはキー入力が可能になってから指定された文字列を受信したかを判定します。最大待ち時間は、setWaitTimeメソッドで設定された待ち時間になります。キーアンロック時間は、setKeyUnlockTimeメソッドで任意の時間に設定できます。
引数をすべて省略すると、キー入力が可能状態になるのを待つことが可能です。
●呼び出し形式
wait(text, row1, col1, row2, col2)
●パラメータ
パラメータ | 説明 | 省略時の初期値 |
|---|---|---|
text | 受信待ち文字列 | キー入力可を待つ |
row1 | 受信待ち開始行位置(1～24) | 1 |
col1 | 受信待ち開始桁位置(1～80) | 1 |
row2 | 受信待ち終了行位置(1～24) | 24 |
col2 | 受信待ち終了桁位置(1～80) | 80 |
●リターン値
文字列を受信した場合はtrueを返します。受信待ちに失敗した場合、falseを返します。エラーの詳細は、getErrorメソッドにより取得できます。
●JavaScriptを用いて記述した例
setTextメソッドを参照してください。