いくつかの個別の要素をひとつのエンティティにまとめ、それを通常の要素と同様に扱えるようにします。 グループのメソッドのほとんどは、グループを構成している要素自体のメソッドをそのまま使用します。 例えば、グループ自体には値を保持していません。グループの setValue() および getValue() メソッドは、グループ内の個々の要素のメソッドを使用して 値の設定および取得を行います。
複数の要素の視覚的なグループ化 (例えば、同一行に "送信" および "リセット" の 2 つのボタンを配置するなど)、同名の要素のグループ化 (例えば、チェックボックスや ラジオボタンのグループなど)、そして要素の論理的なグループ化 (例えば、姓・名の 2 つのテキストフィールドをひとつの「名前」グループとして扱うなど) といった用途に使用することができます。
HTML_Common
HTML_QuickForm_group
表 47-1HTML_QuickForm_group を継承するクラス
| クラス | 概要 |
|---|---|
| HTML_QuickForm_date | 日付 (および時刻) を入力するための要素グループ用のクラス |
| HTML_QuickForm_hierselect | 2 つの HTML Select 要素を動的に作成するためのクラス。最初の select の選択内容によって、2 つめの select の選択肢が変化する |
HTML_QuickForm_group が継承しているメソッド
表 47-2HTML_QuickForm_element から継承したもの
| メソッド名 | 概要 |
|---|---|
| コンストラクタ HTML_QuickForm_element::HTML_QuickForm_element() | クラスのコンストラクタ |
| HTML_QuickForm_element::accept() | レンダラを受け入れる |
| HTML_QuickForm_element::apiVersion() | 現在の API のバージョンを返す |
| HTML_QuickForm_element::exportValue() | '安全な' 要素の値を返す |
| HTML_QuickForm_element::freeze() | 要素を凍結し、その値のみを返す |
| HTML_QuickForm_element::getFrozenHtml() | HTML タグを含めずにフィールドの値を返す |
| HTML_QuickForm_element::getLabel() | 要素の表示テキストを返す |
| HTML_QuickForm_element::getName() | 要素名を返す |
| HTML_QuickForm_element::getType() | 要素の型を返す |
| HTML_QuickForm_element::getValue() | フォーム要素の値を返す |
| HTML_QuickForm_element::isFrozen() | 要素が凍結されているかどうかを返す |
| HTML_QuickForm_element::onQuickFormEvent() | この要素上でイベントが発生した場合に HTML_QuickForm からコールされる |
| HTML_QuickForm_element::setLabel() | 要素の表示テキストを設定する |
| HTML_QuickForm_element::setName() | 入力フィールドの名前を設定する |
| HTML_QuickForm_element::setPersistantFreeze() | 要素の値を、それが凍結されているかどうかにかかわらず hidden フィールドに保持し続けるかどうかを設定する |
| HTML_QuickForm_element::setValue() | フォーム要素の値を設定する |
| HTML_QuickForm_element::unfreeze() | フォーム要素の凍結を解除する |