Inheritance diagram

Collaboration diagram

Description

Specification of the SFZTableView class

Figure 383. Specification of the SFZTableView class

The SFZTableView class is a responder which provides a view of a tabular form with a table model (SFOTableModel).

A table view holds some table view columns (SFOTableViewColumn) which correspond to columns to display.

Each table view column displays a title header of the column and holds a table cell reactor (SFOTableCellReactor) which displays and edits table cells.

A table view column can be connected to the cell data by specifying the column index of a table model (SFOTableModel) to it.

Table model

A table model (SFOTableModel) is a tabular form data to display in a table view.

A table model consists of a variable-length array (SFXArray) of items [rows] (SFXTableItemBase).

An item [row] consists of a fixed-length (the size is a template parameter NUM) array of cell objects (SFXAny).

* As a result, the number of columns is fixed and the number of rows is variable in a table model.

How to connect

	Model and view
	To connect a model to a table view, call the SFZTableView::SetModel function.

	View and columns
	To connect a table view column to the table view, call the SFZTableView::AddColumn function.

	Model column and view column
	To connect a model column to a table view column, call the SFOTableViewColumn::NewInstance function or the SFOTableViewColumn::SetModelColumnIndex function. Connecting the same column of the table model to a number of table view columns makes the table view diplay a number of columns of the same data.

View column and cell reactor

To connect a table cell reactor to a table view column, call the SFOTableViewColumn::NewInstance function or the SFOTableViewColumn::SetCellReactor function. The SFOTableCellTextReactor, SFOTableCellToggleReactor and SFOTableCellImageReactor classes are provided as the default concrete table cell reactors. These reactors can display texts, checkboxes, and images in cells per column. Text and checkbox cells can be editable.

Hierarchical properties of the SFZTableView, SFOTableViewColumn, and SFOTableCellReactor classes

These classes hold a hierarchical property (SFXHierarchyProperty).

And these have a parent-child (inheritance) relationship as follows.

SFZTableView property => SFOTableViewColumn property => SFOTableCellReactor property

A property which does not exist in child is inherited from parent. A property which exists in parent can be overridden in child.

	Note
	A property which is inherited by other properties is called as a parent property. A property which inherites another property is called as a child property. And, a property which has no parent property is called as a root property.

Kinds of property

A hierarchical property (SFXHierarchyProperty) consists of a map of a key and a value, and the keys represent the various kinds, for example, a foreground color or a text font (see: Properties of the SFZTableView, SFOTableViewColumn, and SFOTableCellReactor classes).

The SFZTableView, SFOTableViewColumn, SFOTableCellReactor, SFOTableCellTextReactor, SFOTableCellToggleReactor and SFOTableCellImageReactor classes holds the following properties.

	Note
	Properties which are described in default value are defined in the table view (SFZTableView) except the SFLPROP_LEFTTOP_MARGIN_SIZE and SFLPROP_RIGHTBOTTOM_MARGIN_SIZE property.

	Note
	Interpretation of the property and the default value are free to be changed or set in user defined classes. User defined property key can be set from SFLPROP_USER_CLASS_BEGIN (0x8000) to SFLPROP_USER_CLASS_END (0xFFFE).

* Sample code

For actual code, see here (mvcfactory-en.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];

    // *** Create a table view ***

    view = SFZTableView::NewInstance();

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

    // Set the row height to 24 pixel
    view->SetItemHeight(24);

    // Set the horizontal cursor loop
    view->SetXLoop(true);

    // Set the vertical cursor loop
    view->SetYLoop(true);

    // Create a scroll bar
    bar = SFZScrollBarControl::NewInstance();

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

    // Set the scroll bar to the view
    view->SetScrollBarControl(bar);

    // *** Create a table model ***

    // Create an instance of a table model
    model = SFOTableModel::NewInstance();

    // Get icon images from a resource file
    for (SInt16 i = 0; i < 12; i++) {
        icon[i] = SFBShell::GetInstance()->LoadResImage("userapp.bar", IDI_OBJECT_5001 + i);
    }

    // Set each items, and append it to the model
    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);
    }

    // *** Connect the model to the view ***

    view->SetModel(model);

    // *** Create the first table view column ***

    // Create a table cell toggle reactor
    rtor = SFOTableCellToggleReactor::NewInstance();

    // Set editable
    rtor->SetProperty(SFLPROP_EDITABLE, true);

    // Connect it to the third table model column (Bool type): the header title is "" (empty string)
    vcol = SFOTableViewColumn::NewInstance("", 2, rtor);

    // Fix the column width to 24 pixel
    vcol->SetProperty(SFLPROP_FIXED_WIDTH, 24);

    // Append the column to the view
    view->AddColumn(vcol);

    // *** Create the second table view column ***

    // Create a table cell image reactor
    rtor = SFOTableCellImageReactor::NewInstance();

    // Connect it to the second table model column (SFBImageSmp type): the header title is "" (empty string)
    vcol = SFOTableViewColumn::NewInstance("", 1, rtor);

    // Fix the column width to 24 pixel
    vcol->SetProperty(SFLPROP_FIXED_WIDTH, 24);

    // Append the column to the view
    view->AddColumn(vcol);

    // *** Create the third table view column ***

    // Create a table cell text reactor
    rtor = SFOTableCellTextReactor::NewInstance();

    // Set editable
    rtor->SetProperty(SFLPROP_EDITABLE, true);

    // Connect it to the first table model column (SFXAnsiString type): the header title is "marks"
    vcol = SFOTableViewColumn::NewInstance("marks", 0, rtor);

    // Set the column to left align
    vcol->SetProperty(SFLPROP_ALIGNMENT, IDF_ALIGN_LEFT | IDF_ALIGN_MIDDLE);

    // Append the column to the view
    view->AddColumn(vcol);

    return;
}

Figure 384. Execution example of the SFZTableView class

Reference

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

Member

Description

This constructor makes the following initialization.

Reference

SFXHierarchyProperty

Description

This destructor clears the all table view columns.

	Note
	This function calls the SFZTableView::ClearColumn funtion.

Reference

SFZTableView::ClearColumn

Return value

Description

This function adds a column in the tail (right end) of the table view.

	Note
	This operation increments the reference count of the column (SFOTableViewColumn) which is specified as the "viewcolumn" argument.

Example

The following is a code to add a column to a table view.

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

view->AddColumn(vcol);

Reference

SFOTableViewColumn | SFOTableCellTextReactor

Description

This function clears the all table view columns.

	Note
	This operation decrements the reference count of the each columns (SFOTableViewColumn).

Reference

SFOTableViewColumn

Return value

The DOWN key of the table view.

Description

This function gets the DOWN key of the table view.

	Note
	The DOWN key of the table view is set by the SFZTableView::SetDownKey function.

Reference

SFZTableView::SetDownKey | SFZTableView::HandleDownKey | AVKType

Return value

The column index of the focused cell.

Description

This function gets the column index of the focused cell.

	Note
	The column index of the cell which has cursor is returned. When the mode is full row select, the preferred column index which is set by the SFZTableView::SetPreferredColumn function is returned.

Reference

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

Return value

The row index of the focused cell.

Description

This function gets the row index of the focused cell.

	Note
	The row index of the cell which has cursor is returned.

Reference

SFZTableView::GetFocusedCellColumnIndex | SFZTableView::SetFocusedCellIndex

Return value

Description

This function gets the frame margin of the table view.

	Note
	The frame visibility can be set by the SFZTableView::SetFrameVisible function.

Reference

SFZTableView::SetFrameVisible | SFXMargin

Return value

Description

This function gets the visible state of the frame of the table view.

	Note
	The frame visibility can be set by the SFZTableView::SetFrameVisible function.

Reference

SFZTableView::SetFrameVisible

Return value

Description

This function gets the cell/row select mode.

Reference

SFZTableView::SetFullRowSelect

Return value

Height of the header (in which the column title is drawn). [unit: pixel]

Description

This function gets the height of the header (in which the column title is drawn). [unit: pixel]

	Note
	Regardless of the header visibility which is set by the SFZTableView::SetHeaderVisible function, the value which is set by the SFZTableView::SetHeaderHeight function is gotten by this function.

Reference

SFZTableView::SetHeaderHeight | SFZTableView::SetHeaderVisible

Return value

Description

This function gets the visibility of the header (in which the title is drawn).

	Note
	To set the visibility, call the SFZTableView::SetHeaderVisible function.

Reference

SFZTableView::SetHeaderVisible

Return value

Height of the item [row]. [unit: pixel]

Description

This function gets the header of the item [row] of the table view. [unit: pixel]

	Note
	The height is set by the SFZTableView::SetItemHeight function.

Reference

SFZTableView::SetItemHeight

Return value

The LEFT key of the table view.

Description

This function gets the LEFT key of the table view.

	Note
	The LEFT key is set by the SFZTableView::SetLeftKey function.

Reference

SFZTableView::SetLeftKey | SFZTableView::HandleLeftKey | AVKType

Return value

The operate key of the table view.

Description

This function gets the operate key of the table view.

	Note
	The operate key is set by the SFZTableView::SetOperateKey function.

Reference

SFZTableView::SetOperateKey | SFZTableView::HandleOperateKey | AVKType

Return value

The preferred column index.

Description

This function gets the preferred column index (which is effective only when the row select mode is on).

	About preferred column index
	The preferred column index is effective only when the row select mode is on by calling the SFZTableView::SetFullRowSelect function. When the cursor row is selected by pressing the operate key or by calling the SFZTableView::Select function on row select mode, only the cell of this column index of the row is internally selected and processed.

Reference

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

Return value

Property value (SFXHierarchyProperty::ValueRec) corresponding to the specified key.

Description

This function gets the property value corresponding to the specified key.

If the key is not found, the return value is null.

	null value of the SFXHierarchyProperty::ValueRec
	SFXHierarchyProperty::ValueRec is a union at most 4 bytes. The null value means that it is filled with 0 bits. If the union type is SFXRGBColor, the null value is SFXRGBColor(0x00, 0x00, 0x00, 0x00) that is black. If Bool, it is false.

When the "found" arugment except null is specified, whether the key is found is returned as Bool value. If you want to only check the key existence, use the SFOTableCellReactor::HasProperty function.

	Note
	For more details about the hierarchical property, see the SFXHierarchyProperty class of the reference.

Reference

SFXHierarchyProperty::ValueRec | SFZTableView::HasProperty | SFXHierarchyProperty

Return value

The RIGHT key of the table view.

Description

This function gets the RIGHT key of the table view.

	Note
	The RIGHT key of the table view is set by the SFZTableView::SetRightKey function.

Reference

SFZTableView::SetRightKey | SFZTableView::HandleRightKey | AVKType

Return value

Scroll bar control.

Description

This function gets the scroll bar control which is connected to the table view.

Reference

SFZTableView::SetScrollBarControl

Return value

The UP key of the table view.

Description

This function gets the UP key.

	Note
	The UP key of the table view is set by the SFZTableView::SetUpKey function.

Reference

SFZTableView::SetUpKey | SFZTableView::HandleUpKey | AVKType

Return value

Description

This function gets the X cursor loop flag.

Reference

SFZTableView::SetXLoop

Return value

Description

This function gets the Y cursor loop flag.

Reference

SFZTableView::SetYLoop

Description

This function will be called when the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event is received.

In case you want to perform your own processing when the virtual region is changed, override this virtual function.

The default implementation is to recalculate the row position to draw and the column width.

	Sending the (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event
	The (SFEVT_RESPONDER_BOUND, SFP16_BOUND_VIRTUAL) event will occur when the virtual region is changed by calling the SFYResponder::SetRealBound or SFYResponder::SetVirtualBound function.

Another method when the virtual region is changed

Other than overriding this virtual function, it is possible to define and implement the handler for region event[XANDLER_DECLARE_VOIDBOUND], and register it into the responder. In the processing when the virtual region is updated, this virtual function is executed first, and next the handlers for region event are executed in the registered order. In almost all cases, the method to override this virtual function is adopted since defining, implementing and registering the handler for region event can be omitted.

Internal implementation

Internal implementation of this function is as follows:

/*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 //

Reference

SFYResponder::SetRealBound | SFYResponder::SetVirtualBound | Region Event[SFEVT_RESPONDER_BOUND]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the DOWN key set with the SFZTableView::SetDownKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is as follows:

Move the focus down by one item.

If the focused cell is the last one, the behavior is different depending on the value of the Y cursor loop flag.

	Note
	To set the Y cursor loop flag, call the SFZTableView::SetYLoop function.

	Cursor
	Depending on the select mode (cell or row), the focus which is called as cursor is moved by cell or row. The select mode is set by the SFZTableView::SetFullRowSelect function. * The preferred column index which is set by the SFZTableView::SetPreferredColumn function is not changed.

Internal implementation

Internal implementation of this function is as follows.

/*protected virtual */Bool SFZTableView::HandleDownKey(Void)
{
    SInt32                                      colLen;
    SInt32                                      rowLen;
    SInt32                                      row;

    if (_model != null) {
        colLen = _vcolSeq.GetSize();
        rowLen = _model->GetRowLength();
        if (colLen > 0 && rowLen > 0) {
            row = (_ysel + 1 < rowLen) ? _ysel + 1 : _yloop ? 0 : rowLen - 1;
            OffFocusCell();
            _ysel = row;
            RefreshYOffset();
            OnFocusCell();
            Invalidate();
        }
    }
    return true;
}// SFZTableView::HandleDownKey //

Reference

SFZTableView::SetDownKey | SFZTableView::SetYLoop | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFXEvent | key event [SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the LEFT key set with the SFZTableView::SetLeftKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is as follows:

The behavior is different depending on the select mode (cell or row).

	Select mode: cell or row
	Depending on the select mode (cell or row), the focus which is called as cursor is moved by cell or row. The select mode is set by the SFZTableView::SetFullRowSelect function.

On cell select mode

Move the focus (which is called as cursor) to the left by one cell.

If the focus is in the left edge, the behavior is different depending on the value of the X cursor loop flag.

	Note
	To set the X cursor loop flag, call the SFZTableView::SetXLoop function.

On row select mode

Not move.

* The preferred column index which is set by the SFZTableView::SetPreferredColumn function is not changed.

Internal implementation

Internal implementation of this function is as follows.

/*protected virtual */Bool SFZTableView::HandleLeftKey(Void)
{
    SInt32                                      colLen;
    SInt32                                      rowLen;
    SInt32                                      col;

    if (_model != null) {
        colLen = _vcolSeq.GetSize();
        rowLen = _model->GetRowLength();
        if (colLen > 0 && rowLen > 0) {
            col = _fullRowSelect ? _preferXsel : (_xsel > 0) ? _xsel - 1 : _xloop ? colLen - 1 : 0;
            OffFocusCell();
            _xsel = col;
            OnFocusCell();
            Invalidate(GetItemBound(_ysel));
        }
    }
    return true;
}// SFZTableView::HandleLeftKey //

Reference

SFZTableView::SetLeftKey | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::SetXLoop | SFXEvent | key event [SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the operate key set with the SFZTableView::SetOperateKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is as follows:

Unfocus the selected cell temporally, and operate (select) the cell by calling the SFOTableCellReactor::Handle function. Then, focus back the cell.

The time the cell is focused back is when the SFOTableCellReactor::InvokeResultCell function is invoked.

	Row select mode
	If the operate key is pressed on row select mode, the cell to be selected is the preferred column cell on the row. The select mode or the preferred column index is set by the SFZTableView::SetFullRowSelect function or the SFZTableView::SetPreferredColumn function.

About the select operation

The behavior of the SFOTableCellReactor::Handle function is different as follows depending on the kind of cells and its status. If the cell is an editable text, the native text input control is invoked (See: the SFOTableCellTextReactor::Handle function). If the cell is an editable checkbox, the checkmark is toggled. (See: the SFOTableCellToggleReactor::Handle function). Otherwise, nothing is done.

Internal implementation

Internal implementation of this fucntion is as follows.

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

Reference

SFZTableView::SetOperateKey | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFOTableCellReactor::Handle | SFOTableCellTextReactor::Handle | SFOTableCellToggleReactor::Handle | SFOTableCellReactor::InvokeResultCell | SFXEvent | key event [SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the RIGHT key set with the SFZTableView::SetRightKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is as follows:

The behavior is different depending on the select mode (cell or row).

	Select mode: cell or row
	Depending on the select mode (cell or row), the focus which is called as cursor is moved by cell or row. The select mode is set by the SFZTableView::SetFullRowSelect function.

On cell select mode

Move the focus (which is called as cursor) to the right by one cell.

If the focus is in the right edge, the behavior is different depending on the value of the X cursor loop flag.

	Note
	To set the X cursor loop flag, call the SFZTableView::SetXLoop function.

On row select mode

Not move.

* The preferred column index which is set by the SFZTableView::SetPreferredColumn function is not changed.

Internal implementation

Internal implementation of this function is as follows.

/*protected virtual */Bool SFZTableView::HandleRightKey(Void)
{
    SInt32                                      length;

    if (_model != null) {
        if (_fullRowSelect) {
            OffFocusCell();
            _xsel = _preferXsel;
            OnFocusCell();
            Invalidate(GetItemBound(_ysel));
        }
        else {
            length = _vcolSeq.GetSize();
            if (_xsel + 1 < length) {
                OffFocusCell();
                ++_xsel;
                OnFocusCell();
                Invalidate(GetItemBound(_ysel));
            }
            else if (_yloop) {
                if (length > 0) {
                    OffFocusCell();
                    _xsel = 0;
                    OnFocusCell();
                    Invalidate(GetItemBound(_ysel));
                }
            }
        }
    }
    return true;
}// SFZTableView::HandleRightKey //

Reference

SFZTableView::SetRightKey | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFZTableView::SetXLoop | SFXEvent | key event [SFEVT_KEY]

Description

This function will be called when the SFEVT_KEY event(key event[SFEVT_KEY]) of the UP key set with the SFZTableView::SetUpKey function is received.

In case you want to perform your own processing, override this function.

The default implementation is as follows:

Move the focus up by one item.

If the focused cell is the first one, the behavior is different depending on the value of the Y cursor loop flag.

	Note
	To set the Y cursor loop flag, call the SFZTableView::SetYLoop function.

	Cursor
	Depending on the select mode (cell or row), the focus which is called as cursor is moved by cell or row. The select mode is set by the SFZTableView::SetFullRowSelect function. * The preferred column index which is set by the SFZTableView::SetPreferredColumn function is not changed.

Internal implementation

Internal implementation of this function is as follows.

/*protected virtual */Bool SFZTableView::HandleUpKey(Void)
{
    SInt32                                      colLen;
    SInt32                                      rowLen;
    SInt32                                      row;

    if (_model != null) {
        colLen = _vcolSeq.GetSize();
        rowLen = _model->GetRowLength();
        if (colLen > 0 && rowLen > 0) {
            row = (_ysel > 0) ? _ysel - 1 : _yloop ? rowLen - 1 : 0;
            OffFocusCell();
            _ysel = row;
            RefreshYOffset();
            OnFocusCell();
            Invalidate();
        }
    }
    return true;
}// SFZTableView::HandleUpKey //

Reference

SFZTableView::SetUpKey | SFZTableView::SetYLoop | SFZTableView::SetFullRowSelect | SFZTableView::SetPreferredColumn | SFXEvent | key event [SFEVT_KEY]

Return value

Description

This function checks if the specified property key is contained.

	Note
	To search the property key and get its value simultaneously, the SFZTableView::GetProperty function is better to use. Because the searching is only once.

Reference

SFZTableView::GetProperty | SFXHierarchyProperty

Argument

Return value

Description

This function creates a new instance of the SFZTableView class.

If succeeds, a not null pointer will be returned, and the "exception" argument is SFERR_NO_ERROR. If fails, a null pointer will be returned, and "exception" argument holds the error value.

Example

The following is a code to generate a new instance of the SFZTableView class.

SFZTableViewSmp view;
SFCError error;

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

Reference

SFZTableView

Return value

Description

This function selects the focused cell.

Unfocus the selected cell temporally, and operate (select) the cell by calling the SFOTableCellReactor::Handle function. Then, focus back the cell.

The time the cell is focused back is when the SFOTableCellReactor::InvokeResultCell function is invoked.

	Row select mode
	If the operate key is pressed on row select mode, the cell to be selected is the preferred column cell on the row. The select mode or the preferred column index is set by the SFZTableView::SetFullRowSelect function or the SFZTableView::SetPreferredColumn function.

About the select operation

The behavior of the SFOTableCellReactor::Handle function is different as follows depending on the kind of cells and its status. If the cell is an editable text, the native text input control is invoked (See: the SFOTableCellTextReactor::Handle function). If the cell is an editable checkbox, the checkmark is toggled. (See: the SFOTableCellToggleReactor::Handle function). Otherwise, nothing is done.

Internal implementation

Internal implementation of this fucntion is as follows.

/*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 //

Reference

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

Description

This function sets the DOWN key of the table view.

Default value: AVK_DOWN

If the DOWN key is pressed, the focus of the cell/row is moved down by one item by the internal handler (SFZTableView::HandleDownKey function).

If the focused cell is the last one, the behavior is different depending on the value of the Y cursor loop flag.

	Note
	To set the Y cursor loop flag, call the SFZTableView::SetYLoop function.

	Cursor
	Depending on the select mode (cell or row), the focus which is called as cursor is moved by cell or row. The select mode is set by the SFZTableView::SetFullRowSelect function. * The preferred column index which is set by the SFZTableView::SetPreferredColumn function is not changed.

Reference

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

Return value

Description

This function focuses the cell which is specified by the row index and the column index.

	Note
	When the select mode is row select, the real focus is moved to the cell of the preferred column index which is set by the SFZTableView::SetPreferredColumn function.

Reference

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

Description

This function sets the visibility of the frame of the table view.

Default value: true.

If the "param" argument is set to false, the frame is invisible and its margin area is not allocated.

	Note
	The frame visibility influences the margin which is gotten by the SFZTableView::GetFrameMargin function.

Reference

SFZTableView::GetFrameVisible | SFZTableView::GetFrameMargin

Description

This function sets the cell/row select mode.

Default value: false (cell select mode).

When the "param" arugment is set to true, the mode is row select. Then the cursor is drawn by row and the element of the table view is selected by row.

When false, the mode is cell select. Then drawn and selected by cell.

	Selection of the cell when the mode is row select
	When the operate key is pressed in row select mode, the cell of the preferred column index is selected. (Default: the cell of the zero-th column). * To set the preferred column index, call the SFZTableView::SetPreferredColumn function.

Reference

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

Description

This function sets the height of the header in which the column title is drawn. [unit: pixel]

Default value: 22 pixel.

Reference

SFZTableView::GetHeaderHeight

Description

This function sets the visibility of the header in which the column title is drawn.

Default value: true

If the "param" argument is set to false, the header is invisible and not drawn.

	Note
	The header visibility does not influence the value which is gotten by the SFZTableView::GetHeaderHeight function. That is the value which is set by the SFZTableView::SetHeaderHeight function.

Reference

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

Description

This function sets the height of the item [row] of the table view. [unit: pixel]

Default value: 22 pixels.

Reference

SFZTableView::GetItemHeight

Description

This function sets the LEFT key of the table view.

Default value: AVK_LEFT

The behavior is different depending on the select mode as follows.

	Cell/Row select mode
	Depending on the select mode (cell or row), the focus which is also called as cursor is moved by cell or row. The select mode is set by the SFZTableView::SetFullRowSelect function.

On cell select mode

If the LEFT key is pressed, the focus of the cell is moved left by one cell by the internal handler (SFZTableView::HandleLeftKey function).

If the focused cell is in the left edge, the behavior is different depending on the value of the X cursor loop flag.

	Note
	To set the X cursor loop flag, call the SFZTableView::SetXLoop function.

On row select mode

Not move.

* The preferred column index which is set by the SFZTableView::SetPreferredColumn function is not changed.

Reference

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

Description

This function sets the specified table model.

	Table model
	Table model (SFOTableModel class) represents the data which is displayed and edited in the table view (SFZTableView class).

Example

The following is a code to set the table model.

SFZTableViewSmp view;
SFOTableModelSmp model;

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

view->SetModel(model);

Reference

SFOTableModelBase | SFOTableModel

Description

This function sets the operate key of the table view.

Default value: AVK_SELECT

	Note
	If the operate key is pressed, the SFZTableView::HandleOperateKey function is called.

Reference

SFZTableView::GetOperateKey | SFZTableView::HandleOperateKey | AVKType

Description

This function sets the preferred column index (that is effective only on row select mode).

Default value: 0.

	About the preferred column index
	The preferred column index is effective only on row select mode. If the focused cells are selected on row select mode, the selection is assigned to the cell which has the preferred column index. * The select mode is set by the SFZTableView::SetFullRowSelect function.

Reference

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

Return value

Description

This function sets the property value corresponding to the specified key.

	Note
	For more details about the property, see the reference of the SFXHierarchyProperty class.

Reference

SFXHierarchyProperty::ValueRec | SFXHierarchyProperty

Description

This function sets the RIGHT key of the table view.

Default value: AVK_RIGHT

The behavior is different depending on the select mode as follows.

	Cell/Row select mode
	Depending on the select mode (cell or row), the focus which is also called as cursor is moved by cell or row. The select mode is set by the SFZTableView::SetFullRowSelect function.

On cell select mode

If the RIGHT key is pressed, the focus of the cell is moved right by one cell by the internal handler (SFZTableView::HandleRightKey function).

If the focused cell is in the right edge, the behavior is different depending on the value of the X cursor loop flag.

	Note
	To set the X cursor loop flag, call the SFZTableView::SetXLoop function.

On row select mode

Not move.

* The preferred column index which is set by the SFZTableView::SetPreferredColumn function is not changed.

Reference

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

Description

This function connects the scroll bar control to the table view.

Default value: SFYScrollBarControlSmp::EmptyInstance() [In default, no scroll bar is set].

	Note
	Scroll bar control whose direction is vertical (SFYScrollBarControl::VERTICAL) is only supported.

Example

The following is a code to set the scroll bar control.

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);

Reference

SFZTableView::GetScrollBarControl | SFYScrollBarControl::OrientationEnum | SFYScrollBarControl

Description

This function sets the UP key of the table view.

Default value: AVK_UP

If the UP key is pressed, the focus of the cell/row is moved up by one item by the internal handler (SFZTableView::HandleUpKey function).

If the focused cell is the first one, the behavior is different depending on the value of the Y cursor loop flag.

	Note
	To set the Y cursor loop flag, call the SFZTableView::SetYLoop function.

	Cursor
	Depending on the select mode (cell or row), the focus which is called as cursor is moved by cell or row. The select mode is set by the SFZTableView::SetFullRowSelect function. * The preferred column index which is set by the SFZTableView::SetPreferredColumn function is not changed.

Reference

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

Description

This function sets the X cursor loop flag.

Default value: false.

	X cursor loop
	The X cursor loop is the hehavior of the focus move of the cell in the right/left edge to the cell in the left/right edge by pressing the RIGHT/LEFT key.

Reference

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

Description

This function sets the Y cursor loop flag.

Default value: false.

	Y cursor loop
	The Y cursor loop is the behavior of the focus move of the first/last cell to the last/first cell by pressing the UP/DOWN key.

Reference

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

Reference

SFYResponder::GetType | SFYResponder::SetType |