Accessors for class IliTableSelection

Properties

column
columnsCount
row
rowsCount
type

Methods

addColumn
addRow
containsCell
containsColumn
containsRow
getColumnAt
getRowAt
isCell
isColumn
isColumnOrCell
isEmpty
isFull
isMulti
isRow
isRowOrCell
removeColumn
removeRow
setCell
setColumn
setEmpty
setRow

Description

This class describes a selection in a table. It is mainly used in conjunction with the IliTableGadget class.
Here is an example that selects rows 2 and 4 in a table gadget:

     tg = Application.MyPanel.MyTableGadget;
     sel = tg.selection;

     sel.setRow(2);
     sel.addRow(4);

     tg.selection = sel;

Type Name Description Notes

Int column Contains the column position of the selected column or cell.

Int columnsCount Contains the number of selected columns. read-only

Int row Contains the row position of the selected row or cell.

Int rowsCount Contains the number of selected rows. read-only

IliTableSelectionType type Contains the type of selection. It can be one of the following:

IliSelectNone
IliSelectAll
IliSelectColumn
IliSelectRow
IliSelectCell

Void addColumn(Int colno) Adds to the selection the column whose position in the table gadget is colno. The type of selection must be IliSelectColumn.

Void addRow(Int rowno) Adds to the selection the row whose position in the table gadget is rowno. The type of selection must be IliSelectRow.

Boolean containsCell(Int rowno, Int colno) Return true if the cell whose row is given by rowno and whose column is given by colno is included in the selection.

Boolean containsColumn(Int colno) Return true if the column whose position in the table gadget is given by colno is included in the selection.

Boolean containsRow(Int rowno) Return true if the row whose position in the table gadget is given by rowno is included in the selection.

Int getColumnAt(Int idx) Returns the position of the column whose index in the selection is idx. The idx parameter ranges from 0 to columnsCount -1. The returnedvalue indicates the position of the column in the table gadget while the idx parameter indicates the position of the column within the selection.

Int getRowAt(Int idx) Returns the position of the row whose index in the selection is idx. The idx parameter ranges from 0 to rowsCount -1. The returnedvalue indicates the position of the row in the table gadget while the idx parameter indicates the position of the row within the selection.

Boolean isCell() This property is true if one cell is selected. In this case, the selected cell is identified by the column and row properties.

Boolean isColumn() This property is true if one column is selected. In this case, the selected column is identified by the column property.

Boolean isColumnOrCell() This property is true if one column or one cell is selected.

Boolean isEmpty() This property is true if the selection is empty.

Boolean isFull() This property is true if the entire table gadget is selected.

Boolean isMulti() This property is true if the selection contains more than one row or column.

Boolean isRow() This property is true if one row is selected. In this case, the selected row is identified by the row property.

Boolean isRowOrCell() This property is true if one row or one cell is selected.

Void removeColumn(Int colno) Removes from the selection the column whose position in the table gadget is colno.

Void removeRow(Int rowno) Removes from the selection the row whose position in the table gadget is rowno.

Void setCell(Int rowno, Int colno) Sets the type to IliSelectCell and sets the cell position of the selected cell.

Void setColumn(Int colno) Sets the type to IliSelectColumn and sets the column position of the selected column.

Void setEmpty() Sets the selection as empty. The type is set to IliSelectNone.

Void setRow(Int rowno) Sets the type to IliSelectRow and sets the row position of the selected row.

Type	Name	Description	Notes
`Int`	`column`	Contains the column position of the selected column or cell.
`Int`	`columnsCount`	Contains the number of selected columns.	read-only
`Int`	`row`	Contains the row position of the selected row or cell.
`Int`	`rowsCount`	Contains the number of selected rows.	read-only
`IliTableSelectionType`	`type`	Contains the type of selection. It can be one of the following: `IliSelectNone` `IliSelectAll` `IliSelectColumn` `IliSelectRow` `IliSelectCell`
`Void`	`addColumn(Int colno)`	Adds to the selection the column whose position in the table gadget is `colno`. The type of selection must be `IliSelectColumn`.
`Void`	`addRow(Int rowno)`	Adds to the selection the row whose position in the table gadget is `rowno`. The type of selection must be `IliSelectRow`.
`Boolean`	`containsCell(Int rowno, Int colno)`	Return `true` if the cell whose row is given by `rowno` and whose column is given by `colno` is included in the selection.
`Boolean`	`containsColumn(Int colno)`	Return `true` if the column whose position in the table gadget is given by `colno` is included in the selection.
`Boolean`	`containsRow(Int rowno)`	Return `true` if the row whose position in the table gadget is given by `rowno` is included in the selection.
`Int`	`getColumnAt(Int idx)`	Returns the position of the column whose index in the selection is `idx`. The `idx` parameter ranges from `0` to `columnsCount` `-1`. The `returnedvalue` indicates the position of the column in the table gadget while the `idx` parameter indicates the position of the column within the selection.
`Int`	`getRowAt(Int idx)`	Returns the position of the row whose index in the selection is `idx`. The `idx` parameter ranges from `0` to `rowsCount -1`. The `returnedvalue` indicates the position of the row in the table gadget while the `idx` parameter indicates the position of the row within the selection.
`Boolean`	`isCell()`	This property is `true` if one cell is selected. In this case, the selected cell is identified by the `column` and `row` properties.
`Boolean`	`isColumn()`	This property is `true` if one column is selected. In this case, the selected column is identified by the `column` property.
`Boolean`	`isColumnOrCell()`	This property is `true` if one column or one cell is selected.
`Boolean`	`isEmpty()`	This property is `true` if the selection is empty.
`Boolean`	`isFull()`	This property is `true` if the entire table gadget is selected.
`Boolean`	`isMulti()`	This property is `true` if the selection contains more than one row or column.
`Boolean`	`isRow()`	This property is `true` if one row is selected. In this case, the selected row is identified by the `row` property.
`Boolean`	`isRowOrCell()`	This property is `true` if one row or one cell is selected.
`Void`	`removeColumn(Int colno)`	Removes from the selection the column whose position in the table gadget is `colno`.
`Void`	`removeRow(Int rowno)`	Removes from the selection the row whose position in the table gadget is `rowno`.
`Void`	`setCell(Int rowno, Int colno)`	Sets the type to `IliSelectCell` and sets the cell position of the selected cell.
`Void`	`setColumn(Int colno)`	Sets the type to `IliSelectColumn` and sets the column position of the selected column.
`Void`	`setEmpty()`	Sets the selection as empty. The type is set to `IliSelectNone`.
`Void`	`setRow(Int rowno)`	Sets the type to `IliSelectRow` and sets the row position of the selected row.