23.7 WsmgrWidgetリファレンス

エミュレータ画面上に指定されたスタイルの部品を配置するためのオブジェクトです。エミュレータ画面上に部品を配置するには、viewオブジェクトのaddWidgetメソッドに指定する必要があります。

注意

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

■WsmgrWidget

フィールドに配置する部品の設定をするオブジェクトを生成します。

●オブジェクト生成方法

new WsmgrWidget(id, style[, value])

●パラメータ

パラメータ	説明		省略時の初期値
id	部品のidを指定		省略できません
style	部品のスタイルを指定		省略できません
value	スタイルに従った初期値を指定
	check	true：チェックする false：チェックしない	false
	radio	true：選択する false：選択しないグループの最後に選択したボタンが有効	false
	他のスタイルで指定した場合は無効

●部品のスタイル

スタイル	説明
"button"	ボタンを配置します
"link"	リンクを配置します
"calendar"	カレンダーボタンを配置します
"check"	フィールドにチェックボックスを配置します
"radio"	フィールドにラジオボタンを配置します
"select"	リストボックスを配置します

●リターン値

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

●JavaScriptを用いて記述した例

var button1 = null;
try {
    button1 = new WsmgrWidget("button1", "button");
} catch(e) {
    // エラー発生時の処理
}

●メソッド一覧

メソッド名	機能
bind	部品のイベントを登録
getGroup	ラジオボタンのグループ名を取得
getId	部品のidを取得
getOption	カレンダーのオプションの取得
getPosition	部品の表示位置、幅を取得
getState	チェックボックス、ラジオボタンの状態取得
getValue	部品の表示文字列を取得
insertItem	リストボックスの表示データを設定
setGroup	ラジオボタンのグループを設定
setOption	カレンダーのオプションを設定
setPosition	フィールド先頭からの表示位置、幅を指定
setState	チェックボックス、ラジオボタンの状態変更
setValue	部品に設定する文字列を指定

■bind

Web部品にイベントを登録

●呼び出し形式

bind(type, func)

●パラメータ

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

参考

Web部品で発生するイベントの一覧を記載します。

スタイル	イベントの発生タイミング
"select"	load：リストボックスのロード時 change：リストボックスのデータ変更時
"button"	load：ボタンのロード時 click：ボタンのクリック時
"link"	load：リンクのロード時 click：リンクのクリック時
"calendar"	load：カレンダーのロード時 click：カレンダーのクリック時
"check"	load：チェックボックスのロード時 click：チェックボックスのクリック時
"radio"	load：ラジオボタンのロード時 click：ラジオボタンのクリック時
"input"	load：テキストボックスのロード時

●リターン値

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

●JavaScriptを用いて記述した例

var calendar = new WsmgrWidget("calendar1", "calendar");
calendar.bind("click", onCalendarClick);

■getGroup

ラジオボタンのグループ名を取得

注意

このメソッドはWsmgrWidgetオブジェクト生成時にスタイルにradioを指定した場合のみ、存在します。その他のスタイルで指定した場合は、スクリプトの実行時に例外が発生します。

●呼び出し形式

getGroup()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功するとグループ名を返します。エラーが発生した場合は空文字("")を返します。

エラーの詳細はgetErrorメソッドにより取得できます。

●JavaScriptを用いて記述した例

var radio1 = new WsmgrWidget("radio1", "radio");
radio1.getGroup();

■getId

部品のidを取得

●呼び出し形式

getId()

●パラメータ

ありません

●リターン値

関数呼び出しが成功すると設定されているidを返します。設定されていない場合は空文字を返します。

●JavaScriptを用いて記述した例

var button1 = new WsmgrWidget("button1", "button");
var id = button1.getId();

■getOption

カレンダーオプションを取得します。

注意

このメソッドはWsmgrWidgetオブジェクト生成時にスタイルにcalendarを指定した場合のみ、存在します。その他のスタイルで指定した場合は、スクリプトの実行時に例外が発生します。

●呼び出し形式

getOption()

●パラメータ

ありません

●リターン値

関数の呼び出しに成功すると設定されているカレンダーオプション(オブジェクト)を返します。エラーの場合はnullを返します。

●カレンダーオプション

オプション	設定値
disabled	true：カレンダー無効 false：カレンダー有効(初期値)
changeMonth	true：月をプルダウンで選択可能とする false：設定無効(初期値)
changeYear	true：年をプルダウンで選択可能とする false：設定無効(初期値)
showOtherMonths	true：各月の空いているスペースに前月、次月の日を表示 false：設定無効(初期値)
selectOtherMonths	true：空いているスペースに表示した日を選択可能とする false：設定無効(初期値)
firstDay	週の始まりの曜日を数値(0～6)で指定 0：日曜日(初期値)、1：月曜日、2：火曜日、3：水曜日、 4：木曜日、5：金曜日、6：土曜日
numberOfMonths	カレンダーを表示する数を数値で指定 (初期値：1)
minDate	表示するカレンダーを文字列で指定(初期値：null) -ny：n年前(nは任意数値) -nm：nヶ月前(nは任意数値) -nd：n日前(nは任意数値)
maxDate	表示するカレンダーを文字列で指定(初期値はnull) +ny：n年後(nは任意数値) +nm：nヶ月後(nは任意数値) +nd：n日後(nは任意数値)
dateFormat	カレンダー選択時に取得されるフォーマットを文字列で指定 "yy/mm/dd"(初期値) setOptionでスタイルの指定時は、年月日の順番を入れ替え可能（例：mm/dd/yy）、また区切り文字("/")も任意文字に変更可能
showMonthAfterYear	true：年表示の後に月を表示(初期値) false：月表示の後に年を表示
dayNamesMin	曜日の表示名を文字列の配列で指定 ["日","月","火","水","木","金","土"](初期値)
monthNames	月の表示名を文字列の配列で指定 ["1月","2月","3月","3月","5月","6月","7月","8月","9月","10月","11月","12月"](初期値)
nextText	翌月への移動ボタン名を文字列で指定 (初期値："次")
prevText	前月への移動ボタン名を文字列で指定 (初期値："前")
buttonImage	カレンダーボタンの画像イメージパスを文字列で指定パス指定が無い場合はサーバのuserconfig配下を参照
autoOpen	true：カレンダーを指定された位置に固定表示 false：ボタンアクションによって表示(初期値)

●JavaScriptを用いて記述した例

var calendar = new WsmgrWidget("calendar1", "calendar");
var option = calendar.getOption();
option.autoOpen = true; // 固定表示

注意

表示中のカレンダー部品には適用されません。

■getPosition

部品の表示位置、幅を取得

●呼び出し形式

getPosition()

●パラメータ

ありません

●リターン値

関数呼び出しが成功すると表示位置、幅のオブジェクトを返します。setPositonで表示位置、幅の指定がない場合、または、エラーの場合はnullを返します。

●JavaScriptを用いて記述した例

var button1 = new WsmgrWidget("button1", "button");
button1.setPosition(10, 15, 5, 1);
var position = button1.getPosition();
var row = position.row; // 行位置の取得
var col = position.col; // 桁位置の取得
var width = position.width; // 幅の取得
var height = position.height; // 高さの取得

■getState

チェックボックス、ラジオボタンの状態を取得

注意

このメソッドはWsmgrWidgetオブジェクト生成時にスタイルにcheck、radioを指定した場合のみ、存在します。その他のスタイルで指定した場合は、スクリプトの実行時に例外が発生します。

●呼び出し形式

getState()

●パラメータ

ありません

●リターン値

チェックされている状態の場合はtrueを返します。チェックしていない場合はfalseが返ります。

●JavaScriptを用いて記述した例

var check1= new WsmgrWidget("check1", "check");
check1.setPosition(10, 15);
check1.getState();

■getValue

部品の表示文字列を取得

注意

このメソッドはWsmgrWidgetオブジェクト生成時にスタイルにbutton、link、check、radioを指定した場合のみ、存在します。その他のスタイルで指定した場合は、スクリプトの実行時に例外が発生します。

●呼び出し形式

getValue()

●パラメータ

ありません

●リターン値

関数呼び出しが成功すると設定されている文字列を返します。設定されていない場合は空文字を返します。

●JavaScriptを用いて記述した例

var button1 = new WsmgrWidget("button1", "button");
var text = button1.getValue();

■insertItem

リストボックスの表示データを設定します。

注意

このメソッドはWsmgrWidgetオブジェクト生成時にスタイルにselectを指定した場合のみ、存在します。その他のスタイルで指定した場合は、スクリプトの実行時に例外が発生します。

●呼び出し形式

insertItem(select, value, checked)

●パラメータ

パラメータ	説明	省略時の初期値
select	リストボックスに表示される値を指定	省略できません
value	リストボックス選択時に取得される値を指定 selectパラメータと同じ値を設定する場合はnullを指定	selectと同じ値
checked	true：選択状態 false：非選択状態	false

パラメータ

説明

省略時の初期値

select

リストボックスに表示される値を指定

省略できません

value

リストボックス選択時に取得される値を指定

selectパラメータと同じ値を設定する場合はnullを指定

selectと同じ値

checked

true：選択状態
false：非選択状態

false

参考

複数データにcheckedパラメータ trueを指定した場合は、最後に指定したデータが選択状態になります。

●リターン値

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

●JavaScriptを用いて記述した例

var select1= new WsmgrWidget("selsect1", "select");
select1.insertItem("項目1", "1");
select1.insertItem("項目2", "2", true);
select1.insertItem("項目3", "3");

■setGroup

ラジオボタンのグループ名を設定します。

注意

●呼び出し形式

setGroup(name)

●パラメータ

パラメータ	説明	省略時の初期値
name	任意のグループ名	設定した値をクリア

●リターン値

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

●JavaScriptを用いて記述した例

var radio1 = new WsmgrWidget("radio1", "radio");
radio1.setGroup("グループ1");

■setOption

カレンダーオプションを設定

注意

●呼び出し形式

setOption(calendar)

●パラメータ

パラメータ	説明	省略時の初期値
calendar	カレンダーの表示オプションをオブジェクトで指定初期値および設定可能なオプションについてはgetOptionを参照	初期設定で表示

●リターン値

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

●JavaScriptを用いて記述した例

var calendar1 = new WsmgrWidget("calendar1", "calendar");
calendar1.setOption({ showOtherMonths: true,   // 各月の空いているスペースに前月、次月の日を表示
                      selectOtherMonths: true, // 空いているスペースに表示した日を選択可能とする
                      minDate: "-7d",  // 7日前まで選択可能とする
                      maxDate: "+7d"   // 7日後まで選択可能とする
});

■setPosition

エミュレータ画面上の表示位置、幅を指定

●呼び出し形式

setPosition(row, col, width, height)

●パラメータ

パラメータ	説明	省略時の初期値
row	部品の左上位置のエミュレータの「行」を指定(1～24)	省略できません
col	部品の左上位置のエミュレータの「桁」を指定(1～80)	省略できません
width	部品の表示幅を「文字」単位で指定(1～80)	省略できません
height	部品の表示する高さを「文字」単位で指定(1～24)	省略できません

参考

スタイルがCalendarでオプションのautoOpenフラグがtrueの場合は、カレンダーの表示領域サイズになります。falseの場合は、ボタンの大きさを指定します。

●リターン値

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

●JavaScriptを用いて記述した例

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

■setState

チェックボックス、ラジオボタンの状態を設定

注意

●呼び出し形式

setState(checked)

●パラメータ

パラメータ	説明	省略時の初期値
checked	true：選択状態 false：非選択状態	false

●リターン値

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

●JavaScriptを用いて記述した例

var check1= new WsmgrWidget("check1", "check");
check1.setPosition(10, 15);
check1.setState(true);

■setValue

部品に設定する文字列を指定

注意

●呼び出し形式

setValue(value)

●パラメータ

パラメータ	説明	省略時の初期値
value	部品に文字列を設定 button部品：ボタン表示文字列 link部品：リンク設定文字列 check/radio部品：ボタンの右側に表示する文字列 ※エミュレータの右端までの表示になります	空文字("")

●リターン値

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

●JavaScriptを用いて記述した例

var button1 = new WsmgrWidget("button1", "button");
button1.setValue("[ENTER]");