Class YAHOO.ext.grid.DefaultSelectionModel

Object
   |
   +--YAHOO.ext.grid.DefaultSelectionModel

Direct Known Subclasses:

YAHOO.ext.grid.DisableSelectionModel, YAHOO.ext.grid.SingleSelectionModel, YAHOO.ext.grid.EditorSelectionModel

class YAHOO.ext.grid.DefaultSelectionModel

The default SelectionModel used by YAHOO.ext.grid.Grid. It supports multiple selections and keyboard selection/navigation.


Defined in SelectionModel.js

Field Detail

addListener

Object addListener

events

Object events

fireEvent

Object fireEvent

locked

Object locked

onRowSelect

YAHOO.util.CustomEvent onRowSelect

Fires when a row is selected or deselected - fireDirect sig: (this, row, isSelected)

onSelectionChange

YAHOO.util.CustomEvent onSelectionChange

Fires when the selection changes on the Grid - fireDirect sig: (this, selectedRows[], selectedRowIds[])

removeListener

Object removeListener

YAHOO.ext.grid.DefaultSelectionModel

YAHOO.ext.grid.DefaultSelectionModel()

clearSelections

void clearSelections()

Clears all selections.

deselectRange

void deselectRange(<Number/HTMLElement> startRow, <Number/HTMLElement> endRow)

Deselects a range of rows. All rows in between startRow and endRow are also deselected.

Parameters:
startRow - The row or index of the first row in the range
endRow - The row or index of the last row in the range

deselectRow

void deselectRow(<Number/HTMLElement> row)

Deselects a row.

Parameters:
row - The row or index of the row to deselect

focusRow

void focusRow(<HTMLElement> row)

Deprecated. Tries to focus the row and scroll it into view - Use grid.scrollTo or grid.getView().focusRow() instead.

Parameters:
row - The row to focus

Deprecated

getCount

Number getCount()

Gets the number of selected rows.

getSelectedRowIds

Array getSelectedRowIds()

Returns the selected row ids.

Returns:
Array of String ids

getSelectedRows

Array getSelectedRows()

Returns the selected rows.

Returns:
Array of DOM row elements

hasSelection

Boolean hasSelection()

Returns True if there is a selection.

isLocked

Object isLocked()

isSelectable

Boolean isSelectable(<HTMLElement> row)

Returns True if the specified row is selectable.

Parameters:
row - The row to check

isSelected

Boolean isSelected(<HTMLElement> row)

Returns True if the specified row is selected.

Parameters:
row - The row to check

lock

void lock()

selectAll

void selectAll()

Selects all rows.

selectFirstRow

void selectFirstRow()

Selects the first row in the grid.

selectNext

void selectNext(<Boolean> keepExisting)

Selects the row immediately following the last selected row.

Parameters:
keepExisting - (optional) True to retain existing selections

selectPrevious

void selectPrevious(<Boolean> keepExisting)

Selects the row that precedes the last selected row.

Parameters:
keepExisting - (optional) True to retain existing selections

selectRange

void selectRange(<Number/HTMLElement> startRow, <Number/HTMLElement> endRow, <Boolean> keepExisting)

Selects a range of rows. All rows in between startRow and endRow are also selected.

Parameters:
startRow - The row or index of the first row in the range
endRow - The row or index of the last row in the range
keepExisting - (optional) True to retain existing selections

selectRow

void selectRow(<Number/HTMLElement> row, <Boolean> keepExisting)

Selects a row.

Parameters:
row - The row or index of the row to select
keepExisting - (optional) True to retain existing selections

selectRows

void selectRows(<Array> rows, <Boolean> keepExisting)

Selects multiple rows.

Parameters:
rows - Array of the rows or indexes of the row to select
keepExisting - (optional) True to retain existing selections

selectRowsById

void selectRowsById(<String/Array> id, <Boolean> keepExisting)

Set the selected rows by their ID(s). IDs must match what is returned by the DataModel getRowId(index).

Parameters:
id - The id(s) to select
keepExisting - (optional) True to retain existing selections

unlock

void unlock()