継承図

協調図

解説

SFZTableView クラスの仕様

図 434. SFZTableView クラスの仕様

SFZTableView クラスは、 テーブルモデル（SFOTableModel）を利用して表形式のビュー(テーブルビュー)を提供するレスポンダです。

テーブルビュー（SFZTableView）は、 表示する列に相当する数だけのテーブルビューカラム（SFOTableViewColumn）を保持します。

各テーブルビューカラムは列タイトルを表すヘッダーを描画し、各データを表すテーブルセル (セル) を表示・編集するための 1つ のテーブルセルリアクター (SFOTableCellReactor) を保持します。

テーブルビューカラムにテーブルモデル（SFOTableModel）の列番号を指定することで、ビューの列に表示したいデータとを 関連付けることができます。

テーブルモデル

テーブルモデル（SFOTableModel）は、 テーブルビュー（SFZTableView）に表示するための表形式のデータです。

テーブルモデルは、 項目[行]（SFXTableItemBase）の可変長配列（SFXArray）で構成されます。

項目[行]は、 セルオブジェクト（SFXAny）の固定長配列 (サイズはテンプレートパラメータ NUM) で構成されます。

※ 結果として、テーブルモデルでは、列数は固定、行数は可変となります。

関連付け

	モデルとビュー
	テーブルビューへのテーブルモデルの関連付けは、 SFZTableView::SetModel 関数を利用して行います。

	ビューと列
	テーブルビューへのテーブルビューカラムの追加は、 SFZTableView::AddColumn 関数を利用して行います。

	モデル列とビュー列
	テーブルビューカラムとテーブルモデルカラムの関連付けは、 SFOTableViewColumn::NewInstance 関数、または SFOTableViewColumn::SetModelColumnIndex 関数を利用して行います。 同じテーブルモデルカラムを異なる複数のテーブルビューカラムに関連付けることにより、 テーブルモデルの同じ列のデータをテーブルビュー内に複数の列として表示することが可能です。

	ビュー列とセルリアクター
	テーブルビューカラムとテーブルセルリアクターの関連付けは、 SFOTableViewColumn::NewInstance 関数、または SFOTableViewColumn::SetCellReactor 関数を利用して行います。 デフォルトの具象テーブルセルリアクタークラスとして SFOTableCellTextReactor / SFOTableCellToggleReactor / SFOTableCellImageReactor クラスが提供されます。 これらの具象テーブルセルリアクタークラスを利用して、 テーブルビューのセルには列単位でテキスト、チェックボックス、画像を表示できます。 テキストとチェックボックスのセルは編集することも可能です。

SFZTableView / SFOTableViewColumn / SFOTableCellReactor の階層プロパティ

SFZTableView、 SFOTableViewColumn、 SFOTableCellReactor の各クラスは、内部に階層プロパティ （SFXHierarchyProperty）を保持しています。

これらの階層プロパティの間には、

SFZTableView のプロパティ → SFOTableViewColumn のプロパティ → SFOTableCellReactor のプロパティ

というプロパティの親子関係（継承関係）が存在します。 子プロパティに存在しない属性は親プロパティから継承し、 親プロパティの属性を子プロパティでオーバーライドすることが可能です。

	注意
	他のプロパティから継承されるプロパティを親プロパティ、 他のプロパティを継承するプロパティを子プロパティと呼びます。 また、親プロパティが存在しないプロパティをルートプロパティと呼びます。

階層プロパティの継承機能は、 テーブルビュー全体で定義したある属性について特定の列においてだけ変更したい場合に利用できます。

プロパティの属性

階層プロパティ（SFXHierarchyProperty）は、 属性キーと属性値のマップから構成され、 属性キーは前景色やテキストのフォントといった様々な属性の種類を表します（参照: 以下の表「SFZTableView / SFOTableViewColumn / SFOTableCellReactor のプロパティ」）。

SFZTableView / SFOTableViewColumn / SFOTableCellReactor / SFOTableCellTextReactor / SFOTableCellToggleReactor / SFOTableCellImageReactor クラスが内部に保持する、 階層プロパティ（SFXHierarchyProperty）の内容は以下の表にある通りです。

	注意
	デフォルト値が記入されている属性は、 テーブルビュー（SFZTableView）のプロパティ（ルートプロパティ）にすべて設定されています。 ただし、SFLPROP_LEFTTOP_MARGIN_SIZE / SFLPROP_RIGHTBOTTOM_MARGIN_SIZE 属性を除きます。

	注意
	ユーザー定義クラスで 階層プロパティ（SFXHierarchyProperty）を使用する場合、 属性の解釈やデフォルト値は以下の内容に関係なく自由に変更・設定可能です。 また、SFLPROP_USER_CLASS_BEGIN（0x8000）から SFLPROP_USER_CLASS_END（0xFFFE） の間にユーザー独自の属性を定義することも可能です。

	未使用の属性について
	未使用の属性に値を設定しても何も行われません。

□サンプルコード

詳細なコードは、 こちら（mvcfactory.zip）を参照してください。

Void UserAppClass::Main(Void)
{
    static ACharConst                           marks[][16] = {
        "sun",
        "cloud",
        "snowman",
        "star",
        "white star",
        "telephone",
        "spade",
        "heart",
        "diamond",
        "club",
        "quaver",
        "semiquaver"
    };
    SFZScrollBarControlSmp                      bar;
    SFZTableViewSmp                             view;
    SFOTableModelSmp                            model;
    SFOTableViewColumnSmp                       vcol;
    SFOTableCellReactorSmp                      rtor;
    SFXTableItem<3>                             item;
    SFBImageSmp                                 icon[12];

    // ■■■ テーブルビューの作成 ■■■ 

    view = SFZTableView::NewInstance();

    view->SetParent(GetThis());
    view->SetRealBound(GetLocalBound().Deflate(5, 5, 10, 5));
    view->SetState(true, true, true, true);

    // 行の高さを 24 に設定する
    view->SetItemHeight(24);

    // 横向きにカーソルをループする
    view->SetXLoop(true);

    // 縦向きにカーソルをループする
    view->SetYLoop(true);

    // スクロールバーを生成する
    bar = SFZScrollBarControl::NewInstance();

    bar->SetParent(GetThis());
    SFXRectangle bound(view->GetRealBound());
    bar->SetRealBound(bound.AddX(bound.GetWidth()).SetWidth(5));
    bar->SetState(true, true, false, false);

    // テーブルビューにスクロールバーを設定する
    view->SetScrollBarControl(bar);

    // ■■■ テーブルモデルの作成 ■■■ 

    // テーブルモデルを生成する
    model = SFOTableModel::NewInstance();

    // アイコン画像をリソースファイルから取得する
    for (SInt16 i = 0; i < 12; i++) {
        icon[i] = SFBShell::GetInstance()->LoadResImage("userapp.bar", IDI_OBJECT_5001 + i);
    }

    // アイテムに各テーブルモデルカラムのデータをセットして追加する
    for (SInt32 row = 0; row < 60; ++row) {
        item.data[0] = SFXAnsiString(marks[row % 12]);
        item.data[1] = icon[row % 12];
        item.data[2] = static_cast<Bool>(row % 2);
        model->InsertLast(item);
    }

    // ■■■ テーブルビューとテーブルモデルの関連付け ■■■ 

    view->SetModel(model);

    // ■■■ 第 1 列目のテーブルビューカラムの作成 ■■■ 

    // テーブルセルトグルリアクターを作成する
    rtor = SFOTableCellToggleReactor::NewInstance();

    // 編集可に設定する
    rtor->SetProperty(SFLPROP_EDITABLE, true);

    // 第 3 列目のテーブルモデルカラム（Bool 型）と関連付ける: ヘッダーのタイトルは ""（空文字列）
    vcol = SFOTableViewColumn::NewInstance("", 2, rtor);

    // 固定幅 24 に設定する
    vcol->SetProperty(SFLPROP_FIXED_WIDTH, 24);

    // テーブルビューにテーブルビューカラムを追加する
    view->AddColumn(vcol);

    // ■■■ 第 2 列目のテーブルビューカラムの作成 ■■■ 

    // イメージセルテキストリアクターを作成する
    rtor = SFOTableCellImageReactor::NewInstance();

    // 第 2 列目のテーブルモデルカラム（SFBImageSmp 型）と関連付ける: ヘッダーのタイトルは ""（空文字列）
    vcol = SFOTableViewColumn::NewInstance("", 1, rtor);

    // 固定幅を 24 に設定する
    vcol->SetProperty(SFLPROP_FIXED_WIDTH, 24);

    // テーブルビューにテーブルビューカラムを追加する
    view->AddColumn(vcol);

    // ■■■ 第 3 列目のテーブルビューカラムの作成 ■■■ 

    // テーブルセルテキストリアクターを作成する
    rtor = SFOTableCellTextReactor::NewInstance();
    // 編集可に設定する
    rtor->SetProperty(SFLPROP_EDITABLE, true);

    // 第 1 列目のテーブルモデルカラム（SFXAnsiString 型）と関連付ける: ヘッダーのタイトルは "marks" 
    vcol = SFOTableViewColumn::NewInstance("marks", 0, rtor);

    // アライメントを左詰めに設定する
    vcol->SetProperty(SFLPROP_ALIGNMENT, IDF_ALIGN_LEFT | IDF_ALIGN_MIDDLE);

    // テーブルビューにテーブルビューカラムを追加する
    view->AddColumn(vcol);

    return;
}

図 435. SFZTableView クラスの動作例

参照

SFOTableModel | SFXTableItem | SFOTableViewColumn | SFOTableCellReactor | SFOTableCellToggleReactor | SFOTableCellImageReactor | SFOTableCellTextReactor | SFXHierarchyProperty

メンバ

解説

このコンストラクタは、以下の初期化処理を行います。

参照

SFXHierarchyProperty

解説

このデストラクタは、 テーブルビューカラムをすべてクリアします。

	注意
	この関数は、内部的に SFZTableView::ClearColumn 関数を呼び出します。

参照

SFZTableView::ClearColumn

戻り値

解説

この関数は、 テーブルビューの末尾（右端）にテーブルビューカラムを追加します。

	注意
	この操作により、 viewcolumn 引数に指定した テーブルビューカラム（SFOTableViewColumn）の参照カウントはインクリメントされます。

使用例

以下は、テーブルビューにテーブルビューカラムを追加するコードです。

SFZTableViewSmp view = SFZTableView::NewInstance();
SFOTableViewColumnSmp vcol = SFOTableViewColumn::NewInstance("title", 0, SFOTableCellTextReactor::NewInstance());

view->AddColumn(vcol);

参照

SFOTableViewColumn | SFOTableCellTextReactor

解説

この関数は、 テーブルビューのテーブルビューカラムをすべてクリアします。

	注意
	この操作により、 テーブルビューの各テーブルビューカラム（SFOTableViewColumn）の参照カウントはデクリメントされます。

参照

SFOTableViewColumn

戻り値

テーブルビューの DOWN キー。

解説

この関数は、テーブルビューの DOWN キーを取得します。

	注意
	テーブルビューの DOWN キーは、 SFZTableView::SetDownKey 関数を利用して設定します。

参照

SFZTableView::SetDownKey | SFZTableView::HandleDownKey | AVKType

戻り値

現在フォーカスが当たっているセルの列番号。

解説

この関数は、 現在フォーカスが当たっているセルの列番号を取得します。

	注意
	カーソルのあるセルの列番号が返ります。 行選択モードである場合は、 SFZTableView::SetPreferredColumn 関数で設定した優先セル選択列番号が返ります。

参照

SFZTableView::GetFocusedCellRowIndex | SFZTableView::SetPreferredColumn | SFZTableView::SetFocusedCellIndex

戻り値

現在フォーカスが当たっているセルの行番号。

解説

この関数は、 現在フォーカスが当たっているセルの行番号を取得します。

	注意
	カーソルのあるセルの行番号が返ります。

参照

SFZTableView::GetFocusedCellColumnIndex | SFZTableView::SetFocusedCellIndex

戻り値

解説

この関数は、 フレームマージン（テーブルビューの枠用余白領域）を取得します。

	注意
	フレームの可視・不可視の設定は、SFZTableView::SetFrameVisible 関数を利用して行います。

参照

SFZTableView::SetFrameVisible | SFXMargin

戻り値

解説

この関数は、 フレーム（テーブルビューの枠）の可視状態を取得します。

	注意
	フレームの可視・不可視の設定は、SFZTableView::SetFrameVisible 関数を利用して行います。

参照

SFZTableView::SetFrameVisible

戻り値

解説

この関数は、 セル/行選択モードを取得します。

参照

SFZTableView::SetFullRowSelect

戻り値

ヘッダー（列のタイトル名などが描画される領域）の高さ。[単位: ピクセル]

解説

この関数は、 ヘッダー（列のタイトル名などが描画される領域）の高さを取得します。[単位: ピクセル]

	注意
	この関数で得られる値は、 SFZTableView::SetHeaderVisible 関数によるヘッダーの可視状態の設定に関係なく、 常に SFZTableView::SetHeaderHeight 関数で設定した値となります。

参照

SFZTableView::SetHeaderHeight | SFZTableView::SetHeaderVisible

戻り値

解説

この関数は、 ヘッダー（列のタイトル名などが描画される領域）の可視状態を取得します。

	注意
	ヘッダーの可視・不可視の設定は、SFZTableView::SetHeaderVisible 関数を利用して行います。

参照

SFZTableView::SetHeaderVisible

戻り値

項目[行]の高さ。[単位: ピクセル]

解説

この関数は、テーブルビューの項目[行]の高さを取得します。[単位: ピクセル]

	注意
	テーブルビューの項目[行]の高さは、 SFZTableView::SetItemHeight 関数を利用して設定します。

参照

SFZTableView::SetItemHeight

戻り値

テーブルビューの LEFT キー。

解説

この関数は、テーブルビューの LEFT キーを取得します。

	注意
	テーブルビューの LEFT キーは、 SFZTableView::SetLeftKey 関数を利用して設定します。

参照

SFZTableView::SetLeftKey | SFZTableView::HandleLeftKey | AVKType

戻り値

テーブルビューの操作キー。

解説

この関数は、テーブルビューの操作キーを取得します。

	注意
	テーブルビューの操作キーは、 SFZTableView::SetOperateKey 関数を利用して設定します。

参照

SFZTableView::SetOperateKey | SFZTableView::HandleOperateKey | AVKType

戻り値

優先列選択の列番号。

解説

この関数は、 優先セル選択列番号を取得します（行選択モード ON の時のみ有効）。

	優先セル選択列番号について
	優先セル選択列番号は、 SFZTableView::SetFullRowSelect 関数を使用して行選択モードを ON にしている場合に限り有効です。 行選択モード時に操作キーを押下してカーソル行を選択すると、 カーソル行内のこの列番号のセルが選択されて処理されます。

参照

SFZTableView::SetPreferredColumn | SFZTableView::SetFullRowSelect | SFZTableView::HandleOperateKey

戻り値

指定された属性キーに対応する属性値（SFXHierarchyProperty::ValueRec）。

解説

この関数は、指定された属性キーに対応する属性値を取得します。

属性キーが見つからなかった場合、null 値が返ります。

	SFXHierarchyProperty::ValueRec の null 値
	SFXHierarchyProperty::ValueRec は最大 4 バイトの共用体で、null 値はその全てのビットが 0 になります。 従って、型が SFXRGBColor の場合は SFXRGBColor(0x00, 0x00, 0x00, 0x00) で黒色、Bool の場合は false となります。

found 引数を null 以外の BoolPtr 値を指定すると、 属性キーの有無が返ります。 属性キーの有無を判定するだけなら SFZTableView::HasProperty 関数も利用可能です。

	注意
	属性についての詳細は、 SFXHierarchyProperty クラスの解説を参照してください。

参照

SFXHierarchyProperty::ValueRec | SFZTableView::HasProperty | SFXHierarchyProperty

戻り値

テーブルビューの RIGHT キー。

解説

この関数は、テーブルビューの RIGHT キーを取得します。

	注意
	テーブルビューの RIGHT キーは、 SFZTableView::SetRightKey 関数を利用して設定します。

参照

SFZTableView::SetRightKey | SFZTableView::HandleRightKey | AVKType

戻り値

スクロールバーコントロール。

解説

この関数は、 テーブルビューに関連付けられているスクロールバーコントロールを取得します。

参照

SFZTableView::SetScrollBarControl

戻り値

テーブルビューの UP キー。

解説

この関数は、UP キーを取得します。

	注意
	テーブルビューの UP キーは、 SFZTableView::SetUpKey 関数を利用して設定します。

参照

SFZTableView::SetUpKey | SFZTableView::HandleUpKey | AVKType

戻り値

解説

この関数は、X カーソルループフラグを取得します。

参照

SFZTableView::SetXLoop

戻り値

解説

この関数は、Y カーソルループフラグを取得します。

参照

SFZTableView::SetYLoop

解説

この関数は、領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] を受信したときに呼び出されます。

仮想領域の変更時に追加の処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装では、描画を開始する行の位置と、列の幅を再計算します。

	領域イベント[(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) イベント]
	SFYResponder::SetRealBound / SFYResponder::SetVirtualBound 関数は、 この関数内の処理により仮想領域が変化すると、 領域イベント [SFXEvent(SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL, rectangle)] をレスポンダに送信します。 SFYWidget クラスを継承するレスポンダが領域イベントを受信すると、 SFYWidget::SFYWidget コンストラクタで最初に登録した領域イベント専用ハンドラの処理により、 SFYWidget::HandleBoundVirtual 仮想関数が呼び出されます。 ※ 領域イベントの P32 パラメータ rectangle には変更後の仮想領域が設定されています。

	仮想領域の変更処理
	SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドする以外に、 領域イベント専用ハンドラ[XANDLER_DECLARE_VOIDBOUND]を定義・実装し レスポンダに登録して行うことも可能です。 仮想領域の変更処理は、最初に SFYWidget::HandleBoundVirtual 仮想関数を実行し、 次に領域イベント専用ハンドラを登録した順に実行して行われます。 領域イベント専用ハンドラを宣言し登録する手間が省けるので、 通常は SFYWidget::HandleBoundVirtual 仮想関数をオーバーライドして処理を記述します。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Void SFZTableView::HandleBoundVirtual(Void)
{
    RefreshYOffset();
    RefreshColumnWidth();
    return;
}// SFZTableView::HandleBoundVirtual //

/*private */Void SFZTableView::RefreshYOffset(Void)
{
    SInt16                                      boundHeight;

    _yoffset += ExpectYOffsetMovement(_ysel, &boundHeight);
    if (_bar != null) {
        if (_model != null) {
            _bar->SetMinimumValue(0);
            _bar->SetMaximumValue((_itemHeight + _ypadding) *  _model->GetRowLength() - _ypadding);
            _bar->SetPageValue(boundHeight);
            _bar->SetCurrentValue(-_yoffset);
        }
        else {
            _bar->SetMinimumValue(0);
            _bar->SetMaximumValue(0);
        }
    }
    return;
}// SFZTableView::RefreshYOffset //

/*private */SFCError SFZTableView::RefreshColumnWidth(Void)
{
    SInt32                                      colLen;
    SFCError                                    error(SFERR_NO_ERROR);

    if ((colLen = _vcolSeq.GetSize()) > 0) {
        if (_colWidth.GetSize() < colLen) {
            error = _colWidth.SetSize(colLen);
        }
        if (error == SFERR_NO_ERROR) {
            SFXRectangle                        bound;
            SInt32                              share;
            bound.Set(GetLocalBound());
            bound.Deflate(GetFrameMargin());
            share = bound.GetWidth();
            share -= _xpadding * (colLen - 1);
            if (share > 0) {
                SInt32                          i;
                SInt32                          nAuto(0);
                for (i = 0; i < colLen; ++i) {
                    Bool                        found;
                    SInt16                      temp;
                    temp = _vcolSeq[i]->GetProperty(SFLPROP_FIXED_WIDTH, &found).s16;
                    if (found) {
                        _colWidth[i] = temp;
                        share -= temp;
                    }
                    else {
                        nAuto++;
                        _colWidth[i] = -1;
                    }
                }
                if (share > 0 && nAuto > 0) {
                    SInt32                      width;
                    SInt32                      residue;
                    width = share / nAuto;
                    residue = share - width * nAuto;
                    for (i = 0; i < colLen; ++i) {
                        if (_colWidth[i] == -1) {
                            if (--nAuto > 0) {
                                _colWidth[i] = static_cast<SInt16>(width);
                            }
                            else {
                                _colWidth[i] = static_cast<SInt16>(width + residue);
                            }
                        }
                    }
                }
            }
        }
    }
    return error;
}// SFZTableView::RefreshColumnWidth //

参照

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | 領域イベント[SFEVT_RESPONDER_BOUND]

解説

この関数は、SFZTableView::SetDownKey 関数で設定した DOWN キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

独自のキーイベント処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は以下の通りです。

カーソル（フォーカスされている行またはセル）を 1 つ下に移動します。

カーソルが最下端にある場合は、 Y カーソルループフラグの値に応じて以下のように異なります。

	注意
	Y カーソルループフラグの設定は、 SFZTableView::SetYLoop 関数を利用して行います。

	カーソル
	カーソルは、 セル/行選択モードに応じてセル/行単位になります。 セル/行選択モードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。 ※ SFZTableView::SetPreferredColumn 関数で設定する優先セル選択列番号は変化しません。

参照

SFZTableView::SetDownKey | SFZTableView::SetYLoop | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFXEvent | キーイベント[SFEVT_KEY]

解説

この関数は、SFZTableView::SetLeftKey 関数で設定した LEFT キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

独自のキーイベント処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は以下の通りです。

セル/行選択モードにより以下のように異なります。

	セル/行選択モード
	カーソルは、 セル/行選択モードに応じてセル/行単位になります。 このモードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。

■セル選択モード時

カーソル（フォーカスされているセル）を 1 つ左に移動します。

カーソルが最左端のセルにある場合は、 X カーソルループフラグの値に応じて以下のように異なります。

	注意
	X カーソルループフラグの設定は、 SFZTableView::SetXLoop 関数を利用して行います。

■行選択モード時

カーソル（フォーカスされている行）を移動しません。

優先セル選択列番号（操作キーを押下してカーソル行を選択した場合に選択されるセルの列番号）も変化しません。

	注意
	優先セル選択列番号の設定は、 SFZTableView::SetPreferredColumn 関数を利用して行います。

参照

SFZTableView::SetLeftKey | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::SetXLoop | SFXEvent | キーイベント[SFEVT_KEY]

解説

この関数は、SFZTableView::SetOperateKey 関数で設定した操作キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

独自のキーイベント処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は以下の通りです。

選択されたセルのフォーカスを一時的に外し、 SFOTableCellReactor::Handle 関数を呼び出して操作（セレクト処理）を行います。 その後フォーカスを復帰します。

フォーカスがセルに復帰するタイミングは、 SFOTableCellReactor::Handle 関数内で SFOTableCellReactor::InvokeResultCell 関数を呼び出したときです。

	行選択モードの場合
	行選択モードで操作キーを押下した場合、 選択されるセルはカーソル行の優先セル選択列番号のセルです。 行選択モード/優先セル選択列番号の設定は、 SFZTableView::SetFullRowSelect / SFZTableView::SetPreferredColumn 関数を利用して行います。

	セレクト処理について
	SFOTableCellReactor::Handle 関数の振る舞いは、 セルのデータの種類や状態に応じて以下のように異なります。 セルがテキストで編集可能な場合は、 ネイティブテキスト入力コントロールを起動します （参照: SFOTableCellTextReactor::Handle 関数）。 セルがチェックボックスで編集可能な場合は、 チェックマークの状態を反転させます （参照: SFOTableCellToggleReactor::Handle 関数）。 上記以外の場合は、何も行いません。

内部実装

この関数の内部実装は以下の通りです。

/*protected virtual */Bool SFZTableView::HandleOperateKey(Void)
{
    Select();
    return true;
}// SFZTableView::HandleOperateKey //

参照

SFZTableView::SetOperateKey | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFOTableCellReactor::Handle | SFOTableCellTextReactor::Handle | SFOTableCellToggleReactor::Handle | SFOTableCellReactor::InvokeResultCell | SFXEvent | キーイベント[SFEVT_KEY]

解説

この関数は、SFZTableView::SetRightKey 関数で設定した RIGHT キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

独自のキーイベント処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は以下の通りです。

セル/行選択モードにより以下のように異なります。

	セル/行選択モード
	カーソルは、 セル/行選択モードに応じてセル/行単位になります。 このモードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。

■セル選択モード時

カーソル（フォーカスされているセル）を 1 つ右に移動します。

カーソルが最右端のセルにある場合は、 X カーソルループフラグの値に応じて以下のように異なります。

	注意
	X カーソルループフラグの設定は、 SFZTableView::SetXLoop 関数を利用して行います。

■行選択モード時

カーソル（フォーカスされている行）を移動しません。

優先セル選択列番号（操作キーを押下してカーソル行を選択した場合に選択されるセルの列番号）も変化しません。

	注意
	優先セル選択列番号の設定は、 SFZTableView::SetPreferredColumn 関数を利用して行います。

参照

SFZTableView::SetRightKey | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::SetXLoop | SFXEvent | キーイベント[SFEVT_KEY]

解説

この関数は、SFZTableView::SetUpKey 関数で設定した UP キーの SFEVT_KEY イベント （キーイベント[SFEVT_KEY]）を受信したときに呼び出されます。

独自のキーイベント処理を行いたい場合は、この関数をオーバーライドします。

デフォルトの実装は以下の通りです。

カーソル（フォーカスされている行またはセル）を 1 つ上に移動します。

カーソルが最上端にある場合は、 Y カーソルループフラグの値に応じて以下のように異なります。

	注意
	Y カーソルループフラグの設定は、 SFZTableView::SetYLoop 関数を利用して行います。

	カーソル
	カーソルは、 セル/行選択モードに応じてセル/行単位になります。 セル/行選択モードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。 ※ SFZTableView::SetPreferredColumn 関数で設定する優先セル選択列番号は変化しません。

参照

SFZTableView::SetUpKey | SFZTableView::SetYLoop | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFXEvent | キーイベント[SFEVT_KEY]

戻り値

解説

この関数は、 指定された属性キーに対応する属性値が設定されているかどうかを判定します。

	注意
	属性キーの有無の判定と属性値の取得を同時に行う場合は、 SFZTableView::GetProperty 関数を使用することを推奨します。 この場合、検索の回数が半分になり、パフォーマンスは向上します。

参照

SFZTableView::GetProperty | SFXHierarchyProperty

引数

戻り値

解説

この関数は、SFZTableView インスタンスを作成します。

インスタンスの作成に成功した場合は null 以外のポインタを返します。 失敗した場合は、null ポインタを返します。

exception 引数を指定した場合、 この引数にはエラー値が返ります。

使用例

以下は、SFZTableView インスタンスを生成するためのコードです。

SFZTableViewSmp view;
SFCError error;

if ((view = SFZTableView::NewInstance(&error)) != null) {
    // .. (省略) ..
}

参照

SFZTableView

戻り値

解説

この関数は、 フォーカスが当たっているセルを選択します。

選択されたセルのフォーカスを一時的に外し、 SFOTableCellReactor::Handle 関数を呼び出して操作（セレクト処理）を行います。 その後フォーカスを復帰します。

フォーカスがセルに復帰するタイミングは、 SFOTableCellReactor::Handle 関数内で SFOTableCellReactor::InvokeResultCell 関数を呼び出したときです。

	行選択モードの場合
	行選択モードで操作キーを押下した場合、 選択されるセルはカーソル行の優先セル選択列番号のセルです。 行選択モード/優先セル選択列番号の設定は、 SFZTableView::SetFullRowSelect / SFZTableView::SetPreferredColumn 関数を利用して行います。

	セレクト処理について
	SFOTableCellReactor::Handle 関数の振る舞いは、 セルのデータの種類や状態に応じて以下のように異なります。 セルがテキストで編集可能な場合は、 ネイティブテキスト入力コントロールを起動します （参照: SFOTableCellTextReactor::Handle 関数）。 セルがチェックボックスで編集可能な場合は、 チェックマークの状態を反転させます （参照: SFOTableCellToggleReactor::Handle 関数）。 上記以外の場合は、何も行いません。

内部実装

この関数の内部実装は以下の通りです。

*public */SFCError SFZTableView::Select(Void)
{
    SInt32                                      colLen;
    SInt32                                      rowLen;
    SInt32                                      col;
    SInt32                                      row;
    SFXAnyPtr                                   cellobj;
    SFCError                                    error(SFERR_NO_ERROR);

    if (_model != null) {
        colLen = _vcolSeq.GetSize();
        rowLen = _model->GetRowLength();
        if (colLen > 0 && rowLen > 0) {
            col = _fullRowSelect ? _preferXsel : _xsel;
            row = _ysel;
            if (col >= 0 && col < colLen && row >= 0 && row < rowLen) {
                cellobj = _model->GetColumnRow(_vcolSeq[col]->GetModelColumnIndex(), row);
                if (cellobj != null) {
                    OffFocusCell();
                    if (_vcolSeq[col]->HandleCell(*cellobj, row, OnFocusCellSPP, this, &_property)) {
                        Invalidate();
                    }
                }
                else {
                    error = SFERR_INVALID_STATE;
                }
            }
            else {
                error = SFERR_INVALID_STATE;
            }
        }
        else {
            error = SFERR_INVALID_STATE;
        }
    }
    else {
        error = SFERR_INVALID_STATE;
    }
    return error;
}// SFZTableView::Select //

参照

SFZTableView::SetFocusedCellIndex | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFOTableCellReactor::Handle | SFOTableCellTextReactor::Handle | SFOTableCellToggleReactor::Handle | SFOTableCellReactor::InvokeResultCell

解説

この関数は、 指定されたキーをテーブルビューの DOWN キーに設定します。

デフォルト値: AVK_DOWN

DOWN キーが押下されると、 テーブルビューの内部ハンドラ（SFZTableView::HandleDownKey 関数） によりカーソル（フォーカスされている行またはセル）が 1 つ下に移動します。

カーソルが最下端にある場合は、 Y カーソルループフラグの値に応じて以下のように振る舞いが異なります。

	注意
	Y カーソルループフラグの設定は、 SFZTableView::SetYLoop 関数を利用して行います。

	カーソル
	カーソルは、 セル/行選択モードに応じてセル/行単位になります。 セル/行選択モードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。 ※ SFZTableView::SetPreferredColumn 関数で設定する優先セル選択列番号は変化しません。

参照

SFZTableView::GetDownKey | SFZTableView::HandleDownKey | SFZTableView::SetYLoop | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::SetUpKey | SFZTableView::SetLeftKey | SFZTableView::SetRightKey | SFZTableView::SetYLoop | AVKType

戻り値

解説

この関数は、 指定された行番号と列番号のセルにフォーカスを当てます。

	注意
	行選択モードである場合は、 SFZTableView::SetPreferredColumn 関数で設定した優先セル選択列番号のセルにフォーカスが移動します。

参照

SFZTableView::GetFocusedCellColumnIndex | SFZTableView::GetFocusedCellRowIndex | SFZTableView::SetPreferredColumn

解説

この関数は、 フレーム（テーブルビューの枠）の可視状態を設定します。

デフォルト値: true。

param 引数に false に指定すると、 フレームは不可視となり、 フレームマージン（テーブルビューの枠用余白領域）は確保されず、 フレームは描画されません。

	注意
	フレームの可視・不可視により、 SFZTableView::GetFrameMargin 関数で得られるフレームマージンは異なります。

参照

SFZTableView::GetFrameVisible | SFZTableView::GetFrameMargin

解説

この関数は、 セル/行選択モードを設定します。

デフォルト値: false（セル選択モード）。

param 引数に true を指定した場合、 行選択モードになり、 カーソルは行単位で描画され、 行単位でテーブルビューの要素が選択されます。

false を指定した場合は、 セル選択モードになり、 カーソルはセル単位で描画され、 セル単位でテーブルビューの要素が選択されます。

	行選択モード時のセル選択
	行選択モードで操作キーを押下した場合、カーソル行の優先セル選択列番号のセルが選択されます。 （デフォルト: 0 番目の列のセル）。 ※ 優先セル選択列番号の設定は、 SFZTableView::SetPreferredColumn 関数を利用して行います。

参照

SFZTableView::GetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::HandleLeftKey | SFZTableView::HandleRightKey

解説

この関数は、 ヘッダー（列のタイトル名などが描画される領域）の高さを設定します。[単位: ピクセル]

デフォルト値: 22 ピクセル。

参照

SFZTableView::GetHeaderHeight

解説

この関数は、 ヘッダー（列のタイトル名などが描画される領域）の可視状態を設定します。

デフォルト値: true

param 引数に false に指定すると、 ヘッダーは不可視となり、描画されません。

	注意
	SFZTableView::GetHeaderHeight 関数で得られる値は、 ヘッダーの可視・不可視の影響を受けません。 SFZTableView::SetHeaderHeight 関数で設定した値となります。

参照

SFZTableView::GetHeaderVisible | SFZTableView::GetHeaderHeight | SFZTableView::SetHeaderHeight

解説

この関数は、 テーブルビューの項目[行]の高さを設定します。[単位: ピクセル]

デフォルト値: 22 ピクセル。

参照

SFZTableView::GetItemHeight

解説

この関数は、 指定されたキーをテーブルビューの LEFT キーに設定します。

デフォルト値: AVK_LEFT

セル/行選択モードにより以下のように振る舞いが異なります。

	セル/行選択モード
	カーソルは、 セル/行選択モードに応じてセル/行単位になります。 このモードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。

■セル選択モード時

LEFT キーが押下されると、 テーブルビューの内部ハンドラ（SFZTableView::HandleLeftKey 関数） によりカーソル（フォーカスされているセル）が 1 つ左に移動します。

カーソルが最左端のセルにある場合は、 X カーソルループフラグの値に応じて以下のように振る舞いが異なります。

	注意
	X カーソルループフラグの設定は、 SFZTableView::SetXLoop 関数を利用して行います。

■行選択モード時

LEFT キーが押下されても、 カーソル（フォーカスされている行）は移動しません。

優先セル選択列番号（操作キーを押下してカーソル行を選択した場合に選択されるセルの列番号）も変化しません。

	注意
	優先セル選択列番号の設定は、 SFZTableView::SetPreferredColumn 関数を利用して行います。

参照

SFZTableView::GetLeftKey | SFZTableView::HandleLeftKey | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::SetXLoop | SFZTableView::SetRightKey | SFZTableView::SetDownKey | SFZTableView::SetUpKey | SFZTableView::SetXLoop | AVKType

解説

この関数は、 指定されたテーブルモデルを設定します。

	テーブルモデル
	テーブルモデル（SFOTableModel クラス）とは、 テーブルビュー（SFZTableView クラス）で表示・編集するデータを表します。

使用例

以下は、テーブルモデルを設定するコードです。

SFZTableViewSmp view;
SFOTableModelSmp model;

view = SFZTableView::NewInstance();
model = SFOTableModel::NewInstance();

view->SetModel(model);

参照

SFOTableModelBase | SFOTableModel

解説

この関数は、 テーブルビューの操作キーを設定します。

デフォルト値: AVK_SELECT

	注意
	操作キーが押下されると、 SFZTableView::HandleOperateKey 関数が呼び出されます。

参照

SFZTableView::GetOperateKey | SFZTableView::HandleOperateKey | AVKType

解説

この関数は、 指定された値を優先セル選択列番号に設定します（行選択モード ON の時のみ有効）。

デフォルト値: 0。

	優先セル選択列番号について
	優先セル選択列番号は、行選択モード時に限り有効です。 行選択モード時に操作キーを押下してカーソル行を選択すると、 カーソル行のこの列番号のセルが選択されて処理されます。 ※ 行選択モードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。

参照

SFZTableView::GetPreferredColumn | SFZTableView::SetFullRowSelect | SFZTableView::HandleOperateKey | SFZTableView::HandleLeftKey | SFZTableView::HandleRightKey

戻り値

解説

この関数は、 指定された属性キーに対応する属性値を設定します。

	注意
	属性についての詳細は、 SFXHierarchyProperty クラスの解説を参照してください。

参照

SFXHierarchyProperty::ValueRec | SFXHierarchyProperty

解説

この関数は、 指定されたキーをテーブルビューの RIGHT キーに設定します。

デフォルト値: AVK_RIGHT

セル/行選択モードにより以下のように振る舞いが異なります。

	セル/行選択モード
	カーソルは、 セル/行選択モードに応じてセル/行単位になります。 このモードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。

■セル選択モード時

RIGHT キーが押下されると、 テーブルビューの内部ハンドラ（SFZTableView::HandleRightKey 関数） によりカーソル（フォーカスされているセル）が 1 つ右に移動します。

カーソルが最右端のセルにある場合は、 X カーソルループフラグの値に応じて以下のように振る舞いが異なります。

	注意
	X カーソルループフラグの設定は、 SFZTableView::SetXLoop 関数を利用して行います。

■行選択モード時

RIGHT キーが押下されても、 カーソル（フォーカスされている行）は移動しません。

優先セル選択列番号（操作キーを押下してカーソル行を選択した場合に選択されるセルの列番号）も変化しません。

	注意
	優先セル選択列番号の設定は、 SFZTableView::SetPreferredColumn 関数を利用して行います。

参照

SFZTableView::GetRightKey | SFZTableView::HandleRightKey | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::SetXLoop | SFZTableView::SetLeftKey | SFZTableView::SetDownKey | SFZTableView::SetUpKey | SFZTableView::SetXLoop | AVKType

解説

この関数は、 テーブルビューで使用されるスクロールバーコントロールを設定します。

デフォルト値: SFYScrollBarControlSmp::EmptyInstance()[デフォルトではスクロールバーコントロールは設定されていません]。

	注意
	垂直方向のスクロールバーコントロール（SFYScrollBarControl::VERTICAL）だけがサポートされます。

使用例

以下は、スクロールバーコントロールを設定するコードです。

SFZTableViewSmp view;
SFZScollBarControlSmp bar;

view = SFZTableView::NewInstance();
view->SetParent(GetThis());
view->SetRealBound(GetLocalBound().Deflate(5, 5, 10, 5));
view->SetState(true, true, true, true);

bar = SFZScrollBarConrol::NewInstance();
bar->SetParent(GetThis());
SFXRectangle bound(view->GetRealBound());
bar->SetRealBound(bound.AddX(bound.GetWidth()).SetWidth(5));

view->SetScrollBarControl(bar);

参照

SFZTableView::GetScrollBarControl | SFYScrollBarControl::OrientationEnum | SFYScrollBarControl

解説

この関数は、 指定されたキーをテーブルビューの UP キーに設定します。

デフォルト値: AVK_UP

UP キーが押下されると、 テーブルビューの内部ハンドラ（SFZTableView::HandleUpKey 関数） によりカーソル（フォーカスされている行またはセル）が 1 つ上に移動します。

カーソルが最上端にある場合は、 Y カーソルループフラグの値に応じて以下のように振る舞いが異なります。

	注意
	Y カーソルループフラグの設定は、 SFZTableView::SetYLoop 関数を利用して行います。

	カーソル
	カーソルは、 セル/行選択モードに応じてセル/行単位になります。 セル/行選択モードの設定は、 SFZTableView::SetFullRowSelect 関数を利用して行います。 ※ SFZTableView::SetPreferredColumn 関数で設定する優先セル選択列番号は変化しません。

参照

SFZTableView::GetUpKey | SFZTableView::HandleUpKey | SFZTableView::SetYLoop | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::SetDownKey | SFZTableView::SetLeftKey | SFZTableView::SetRightKey | SFZTableView::SetYLoop | AVKType

解説

この関数は、 X カーソルループフラグを設定します。

デフォルト値: false。

	X カーソルループについて
	X カーソルループとは、 カーソルが最右端/最左端の位置にあるときに RIGHT/LEFT キーを押下したときに、 カーソルを最左端/最右端に移動する振る舞いのことです。

参照

SFZTableView::GetXLoop | SFZTableView::HandleRightKey | SFZTableView::HandleLeftKey

解説

この関数は、 X カーソルループフラグを設定します。

デフォルト値: false。

	Y カーソルループについて
	Y カーソルループとは、 カーソルが最上端/最下端の位置にあるときに UP/DOWN キーを押下したときに、 カーソルを最下端/最上端に移動する振る舞いのことです。

参照

SFZTableView::GetYLoop | SFZTableView::HandleDownKey | SFZTableView::HandleUpKey

参照

SFYResponder::GetType | SFYResponder::SetType |