4.3.1 CheckBoxGroup

CheckBoxGroupは、複数のCheckBoxからなるチェックボックスグループを形成する機能付加部品です。

チェックボックスグループを形成することにより、以下が可能になります。

グループ内で選択されている複数のチェックボックスの値の取得
グループ内のチェックボックスの選択状態が変更されたことによるイベント発生
FocusManager制御対象
- CheckBoxGroup自体をFocusManagerのフォーカス移動対象として指定可能
- 構成するCheckBoxを直接FocusManagerのフォーカス移動対象とする設定は無効

記述形式

<div rcf:type="CheckBoxGroup" rcf:targets="xxx1; xxx2; ... "></div>

または

<span rcf:type="CheckBoxGroup" rcf:targets="xxx1; xxx2; ... "></span>

注意

子要素は記述できません。詳細は、「5.1.4 子要素を持たない部品に子要素を記述した場合の動作」を参照してください。
本部品は画面に表示されないため、<div>タグおよび<span>タグのどちらで記述しても違いはありません。

プロパティ

表の項目の意味は、「Text」の「プロパティ」を参照してください。

名前	データ型	説明	省略	省略値	属性指定	更新	部分更新
targets	Array	グループを形成するCheckBoxのidのリストです。グループ内のカーソルキーによるフォーカスの制御は、本プロパティの指定順に従います。本プロパティが以下の値の場合は、エラーとなります。指定されたidを持つ部品が存在しない指定されたidを持つ部品がCheckBoxではない指定されたCheckBoxのvalueが空文字列であるグループ内に同じvalueを持つCheckBoxが存在する	不可	－	値	不可	不可
selectedValues	String型のArray	選択されているCheckBoxのvalueのリストです。すべてのCheckBoxが非選択の場合は、長さ0の配列となります。グループ内のどのvalueとも一致しない値が指定された場合は、エラーとなります。初期値として本プロパティを利用する場合の注意本プロパティが長さ0の配列の場合、関係するCheckBoxのcheckedプロパティ指定が有効となります。長さ0の配列以外の場合、CheckBoxのcheckedプロパティ指定は無効となり、本プロパティで指定された値を持つCheckBoxが選択状態となります。	可	[]	値、バインド	可	可

名前

データ型

説明

省略

省略値

属性指定

更新

部分更新

targets

Array

グループを形成するCheckBoxのidのリストです。
グループ内のカーソルキーによるフォーカスの制御は、本プロパティの指定順に従います。
本プロパティが以下の値の場合は、エラーとなります。

指定されたidを持つ部品が存在しない
指定されたidを持つ部品がCheckBoxではない
指定されたCheckBoxのvalueが空文字列である
グループ内に同じvalueを持つCheckBoxが存在する

不可

－

値

不可

selectedValues

String型のArray

選択されているCheckBoxのvalueのリストです。すべてのCheckBoxが非選択の場合は、長さ0の配列となります。
グループ内のどのvalueとも一致しない値が指定された場合は、エラーとなります。

初期値として本プロパティを利用する場合の注意
本プロパティが長さ0の配列の場合、関係するCheckBoxのcheckedプロパティ指定が有効となります。
長さ0の配列以外の場合、CheckBoxのcheckedプロパティ指定は無効となり、本プロパティで指定された値を持つCheckBoxが選択状態となります。

可

[]

値、バインド

可

そのほかにも、画面部品および機能付加部品で共通のプロパティを指定することができます。詳細は、「2.8.1 画面部品共通プロパティ」、および「4.4.1 機能付加部品共通プロパティ」を参照してください。

チェックボックスグループの形成

チェックボックスグループを形成するには、グループに含めるCheckBoxのidのリストをtargetsプロパティに指定します。
以下に例を示します。

...
<span rcf:id="checkBox1" rcf:type="CheckBox" rcf:value="val1" rcf:label="チェックボックス1"></span>
<span rcf:id="checkBox2" rcf:type="CheckBox" rcf:value="val2" rcf:label="チェックボックス2"></span>
 ...
<span rcf:id="group1" rcf:type="CheckBoxGroup" rcf:targets="checkBox1; checkBox2" ... ></span>
 ...

フォーカス制御: CheckBoxGroupをFocusManagerに登録することにより、グループ単位でフォーカスを制御します。
チェックボックスグループ内のフォーカスの移動はカーソルキーで行うことができ、フォーカスの移動は、targetsプロパティに指定された順番になります。

イベントリスナ

名前	説明	イベントオブジェクト
onSelected	グループ内のCheckBoxが選択されたときに呼ばれます。	CheckStatusChangeEvent
onDeselected	グループ内のCheckBoxの選択が解除されたときに呼ばれます。	CheckStatusChangeEvent

部品共通のイベントリスナは、「2.8.2 画面部品共通イベントリスナ」を参照してください。

JavaScript API

固有のJavaScript APIはありません。部品共通のJavaScript APIは、「2.8.3 画面部品共通JavaScript API」を参照してください。