23.4.10 fieldsオブジェクト

エミュレータ画面のフィールドオブジェクトをリストで保持するオブジェクトです。fieldsオブジェクトを使用するには、screenオブジェクトのfieldsメソッドでオブジェクトの取得が必要です。

メソッド名		機能
JavaScript	VB/C#	機能
bind	-	fieldsオブジェクトが保持するすべてのフィールドにイベントを登録
filter	Filter	指定したセレクターで絞り込んだ結果のfieldsオブジェクトを取得
get	Get	指定したインデックスのフィールドを取得
getNextField	GetNextField	fieldsオブジェクトが保持する各フィールドより指定した先にあるフィールドを取得
getNextInputField	GetNextInputField	fieldsオブジェクトが保持する各フィールドの次の非保護フィールドを取得
next	Next	fieldsオブジェクトが保持する各フィールドの次のフィールドを取得
prev	Prev	fieldsオブジェクトが保持する各フィールドの前のフィールドを取得
setGroup	-	fieldsオブジェクトが保持するすべてのフィールドにグループ名を設定
setStyle	-	fieldsオブジェクトが保持するすべてのフィールドにスタイルを設定
setWidth	-	fieldsオブジェクトが保持するすべてのフィールドの表示幅を設定

プロパティ名	設定	参照	機能
length	-	○	fieldsオブジェクトが保持するフィールド数

■bind

fieldsオブジェクトのフィールドへイベントを登録

fieldsオブジェクトが保持するすべてのフィールドに指定したイベントが発生した際に呼び出されるコールバック関数を登録します。
スタイルを指定したフィールドで、指定されたイベントの発生時にコールバック関数を呼び出します。

●呼び出し形式

bind(type, func, data)

●パラメータ

パラメータ	説明	省略時の初期値
type	コールバック関数を登録するイベント名を示す文字列 "load"：ロードイベント "click"：クリックイベント "change"：チェンジイベント	省略できません
func	コールバック関数を指定 typeで指定したイベントに登録された関数を解除する場合は null を指定	null
data	コールバック関数に渡す任意のデータ	null

●スタイルごとのイベント一覧

スタイル	イベントの発生タイミング
"assist"	load：フィールドのロード時 click：入力候補リストの選択時 change：キー入力時、およびフィールド選択時
"select"	load：初期データのロード時 change：リストボックスのデータ変更時
"button"	load：フィールドのロード時 click：ボタンのクリック時
"link"	load：フィールドのロード時 click：リンクのクリック時
"calendar"	load：フィールドのロード時 click：リンクのクリック時
"check"	load：フィールドのロード時 click：チェックボックスのクリック時
"radio"	load：フィールドのロード時 click：ラジオボタンのクリック時

●リターン値

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

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("{style: 'button'}");  // fieldsオブジェクトを取得
fields.bind("click", onClick, {fields: fields}); // fieldsオブジェクトへコールバック関数を登録

■filter／Filter

セレクターで絞り込んだfieldsオブジェクトの取得

指定したセレクターで絞り込んだ結果から、fieldsオブジェクトを取得します。

●呼び出し形式

filter(selector)

●パラメータ

パラメータ	説明	省略時の初期値
selector	fieldsオブジェクトが保持するfieldオブジェクトのリストから抽出する条件を指定抽出条件はscreenオブジェクトのgetFieldsメソッドを参照	すべて("*")

●リターン値

関数の呼び出しに成功すると取得したfieldsオブジェクトを返します。一致する文字列が見つからなかった場合、およびエラーが発生した場合は、fieldsオブジェクトのlengthプロパティが0のfieldsオブジェクトを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("担当");  // 文字列「担当」を含むfieldsオブジェクトを取得
fields = fields.filter("{attr: 'protect'}"); // 保護フィールドで絞り込み

■get／Get

指定したインデックスのフィールドを取得

指定したインデックス位置に存在するフィールドを取得します。

●呼び出し形式

get(index)

●パラメータ

パラメータ	説明	省略時の初期値
index	fieldオブジェクトのインデックス位置(0以上)	省略できません

●リターン値

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

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("担当");  // 文字列「担当」を含むfieldsオブジェクトを取得
for (var i = 0; i < fields.length; i++) {
    var field = fields.get(i); 
}

■getNextField／GetNextField

fieldsオブジェクトより指定した先に存在するfieldsオブジェクトを取得

fieldsオブジェクトが保持するすべてのフィールドより取得したfieldsオブジェクトから、指定数分先に存在するfieldsオブジェクトを取得します。

●呼び出し形式

getNextField(index)

●パラメータ

パラメータ	説明	省略時の初期値
index	取得対象のfieldオブジェクトまでの数を指定	1

●リターン値

関数の呼び出しに成功すると取得したfieldsオブジェクトを返します。フィールドが見つからなかった場合、およびエラーが発生した場合はfieldsオブジェクトのlengthプロパティが0のfieldsオブジェクトを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("ユーザID");  // 文字列"ユーザID"を含むfieldsオブジェクトを取得
fields = fields.getNextField(2); // 2つ先のフィールドを含むfieldsオブジェクトの取得

■getNextInputField／GetNextInputField

fieldsオブジェクトの次の非保護フィールドのfieldsオブジェクトを取得

fieldsオブジェクトが保持するすべての非保護フィールドより、次の非保護フィールドを保持するfieldsオブジェクトを取得します。

●呼び出し形式

getNextInputField()

●パラメータ

ありません

●リターン値

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("ユーザID");  // 文字列"ユーザID"を含むfieldsオブジェクトを取得
fields = fields.getNextInputField(); // フィールドの次の非保護フィールドを含むfieldsオブジェクトの取得

■next／Next

fieldsオブジェクト内の次のfieldsオブジェクトを取得

fieldsオブジェクトが保持するすべてのフィールドより現在のフィールドの次のフィールドから、fieldsオブジェクトを取得します。

●呼び出し形式

next()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると次のfieldsオブジェクトを返します。現在のフィールドが最終フィールドで、次のフィールドが存在しない場合、およびエラーの場合はfieldsオブジェクトのlengthプロパティが0のfieldsオブジェクトを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("{attr: 'protect'}");  // 保護フィールドのfieldsオブジェクトを取得
fields = fields.next(); //次のフィールドを含む、fieldsオブジェクトを取得

■prev／Prev

fieldsオブジェクト内の前のfieldsオブジェクトを取得

fieldsオブジェクトが保持するすべてのオブジェクトより、現在のフィールドの前のフィールドから、fieldsオブジェクトを取得します。

●呼び出し形式

prev()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると前のfieldsオブジェクトを返します。現在のフィールドが先頭フィールドで、前のフィールドが存在しない場合、およびエラーの場合はfieldsオブジェクトのlengthプロパティが0のfieldsオブジェクトを返します。エラーの詳細は、getError／GetErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("{attr : 'unprotect'}");  // 非保護フィールドのfieldsオブジェクトを取得
fields = fields.prev(); //前のフィールドを含むfieldsオブジェクトを取得

■setGroup

fieldsオブジェクトへグループ名を設定

fieldsオブジェクトが保持するすべてのフィールドにグループ名を指定します。フィールドのスタイルがradioの場合のみ有効です。

●呼び出し形式

setGroup(name)

●パラメータ

パラメータ	説明	省略時の初期値
name	フィールドに設定するグループ名	設定した値をクリア

●リターン値

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

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("{style: 'radio'}");  // スタイルが「radio」のfieldsオブジェクトを取得
fields.setGroup("グループ1"); //グループ名を設定

■setStyle

fieldsオブジェクトのスタイルを変更

fieldsオブジェクトが保持するすべてのフィールドを、指定した初期値のスタイルに変更します。

●呼び出し形式

setStyle(style[, value])

●パラメータ

パラメータ	説明	省略時の初期値
style	設定するスタイルを示す文字列指定可能な値は下記「スタイル」を参照	設定されたスタイルを解除
value	スタイルの初期値を示す文字列指定可能な値は下記「スタイルと初期値」を参照

●スタイル

スタイル	説明
"assist"	フィールドを入力候補に設定します。フィールドが非保護フィールドの場合のみ設定できます。
"button"	フィールドをボタンに設定します。フィールドが保護フィールドの場合のみ設定できます。
"calendar"	フィールドをカレンダー属性に設定します。
"check"	フィールドをチェックボックスに設定します。チェックボックスはフィールドアトリビュート位置に設定されます。
"hide"	フィールドを非表示に設定します。
"link"	フィールドをリンクに設定します。フィールドが保護フィールドの場合のみ設定できます。
"radio"	フィールドをラジオボタンに設定します。ラジオボタンはフィールドアトリビュート位置に設定されます。
"select"	フィールドをリストボックスに設定します。フィールドが非保護フィールドの場合のみ設定できます。
空文字("")	スタイルを初期値に設定します。属性の指定を解除する場合に指定してください。

●スタイルと初期値

スタイル	値	初期値の説明
"button" "calendar"	"full-field"	フィールド全体(初期値)
	"round-text"	前後空白を取り除いた領域
	"attribute"	フィールドアトリビュート位置
"link"	"full-field"	フィールド全体 (初期値)
"link"	"round-text"	前後空白を取り除いた領域
"radio" "check"	true	選択状態
"radio" "check"	false	非選択状態(初期値)

●リターン値

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

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("{attr: 'unprotect'}");

fields.setStyle("select");

■setWidth

fieldsオブジェクトのフィールドへ表示幅を設定

fieldsオブジェクトが保持するすべてのフィールドの表示幅を指定します。フィールドのスタイルがbutton、selectの場合、かつスタイルの初期値がattribute以外の場合のみ有効です。

●呼び出し形式

setWidth(value)

●パラメータ

パラメータ	説明	省略時の初期値
value	"auto"：自動で幅を設定(初期値) 1～80：半角文字換算で幅を指定右端を超えるサイズを指定した場合は、右端までのサイズで表示します	省略できません

注意

スタイルを設定したフィールドが隣のフィールドと重なった場合は、フィールドの上に重なって表示されます。
重なり合うフィールドの両方にスタイルが設定されていた場合は、後から生成されたフィールドが上に重なって表示されます。

●リターン値

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

●JavaScriptを用いて記述した例

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

var fields = dspemu.screen.getFields("{assist: 'button'}");  // スタイルが「button」のfieldsオブジェクトを取得
fields.setWidth("auto"); // フィールド幅を自動で表示