Class Index | File Index

Classes


Class zwt.ui.table.ColumnSelectionModel


Extends zwt.ui.table.TableSelectionModel.

A column selection model represents the current state of the selection for a table. The selection is modeled as an array of columns.

This implementation is used to enable column selection in a table.


Defined in: ColumnSelectionModel.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Construct a column selection model.
Method Summary
Method Attributes Method Name and Description
 
addSelection(array_cells, boolean_exclusive)
Add the set of columns in the specified array of cells to the selection.
 
Change the selection to the empty set.
 
Return the selected columns.
 
isColumnSelected(int_rowIndex)
Return true if the specified column is selected.
 
removeSelection(array_cells)
Remove the set of columns in the specified array of cells from the selection.
 
setSelection(array_cells, boolean_exclusive)
Change the selection to be the set of columns in the specified array of cells.
Methods borrowed from class zwt.ui.table.TableSelectionModel:
getTableSelectionModelEventManager, isCellSelected, isRowSelected, isSelectable, onEvent, shiftRows
Class Detail
zwt.ui.table.ColumnSelectionModel()
Construct a column selection model.
Author: Jeremy KUHN.
See:
zwt.ui.table.TableSelectionModel
Method Detail
addSelection(array_cells, boolean_exclusive)
Add the set of columns in the specified array of cells to the selection.

If this selection is exclusive, then the intersection of the current selection and the new columns in the array of cells is removed from the selection.

If this represents a change to the current selection then an event is emitted to notify the change.

Parameters:
{Integer[][]} array_cells
An array of cells
{Boolean} boolean_exclusive
If true, the selection is exclusive

clearSelection()
Change the selection to the empty set.

If this represents a change to the current selection then an event is emitted to notify the change.


{Integer[]} getSelectedColumns()
Return the selected columns.
Returns:
The selected columns

isColumnSelected(int_rowIndex)
Return true if the specified column is selected.
Parameters:
{Integer} int_rowIndex
The index of the column in the data model

removeSelection(array_cells)
Remove the set of columns in the specified array of cells from the selection.

If this represents a change to the current selection then an event is emitted to notify the change.

Parameters:
{Integer[][]} array_cells
An array of cells

setSelection(array_cells, boolean_exclusive)
Change the selection to be the set of columns in the specified array of cells.

If this selection is exclusive, then the intersection of the current selection and the new columns is removed from the selection.

If this represents a change to the current selection then an event is emitted to notify the change.

Parameters:
{Integer[][]} array_cells
An array of cells
{Boolean} boolean_exclusive
If true, the selection is exclusive

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Nov 09 2011 19:29:09 GMT+0100 (CET)