Class Ext.grid.RowSelectionModel

Package:	Ext.grid
Class:	RowSelectionModel
Extends:	AbstractSelectionModel
Defined In:	RowSelectionModel.js

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

Properties - Methods - Events - Config Options

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	RowSelectionModel(`Object config`)	RowSelectionModel
		RowSelectionModel
	addEvents(`Object object`) : void	Observable
	Copies any events from the passed object onto this object if they do not already exist. The passed object must also ...	Observable
	addListener(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this component	Observable
	clearSelections() : void	RowSelectionModel
	Clears all selections.	RowSelectionModel
	deselectRange(`Number startRow`, `Number endRow`) : void	RowSelectionModel
	Deselects a range of rows. All rows in between startRow and endRow are also deselected.	RowSelectionModel
	deselectRow(`Number row`) : void	RowSelectionModel
	Deselects a row.	RowSelectionModel
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	getCount() : Number	RowSelectionModel
	Gets the number of selected rows.	RowSelectionModel
	getSelected() : Record	RowSelectionModel
	Returns the first selected record.	RowSelectionModel
	getSelections() : Array	RowSelectionModel
	Returns the selected records	RowSelectionModel
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object is currently listening for a specified event	Observable
	hasSelection() : Boolean	RowSelectionModel
	Returns True if there is a selection.	RowSelectionModel
	isIdSelected(`String id`) : Boolean	RowSelectionModel
	Returns True if the specified record id is selected.	RowSelectionModel
	isLocked() : Boolean	AbstractSelectionModel
	Returns true if the selections are locked	AbstractSelectionModel
	isSelected(`Number/Record record`) : Boolean	RowSelectionModel
	Returns True if the specified row is selected.	RowSelectionModel
	lock() : void	AbstractSelectionModel
	Lock the selections	AbstractSelectionModel
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	purgeListeners() : void	Observable
	Removes all listeners for this object	Observable
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	selectAll() : void	RowSelectionModel
	Selects all rows.	RowSelectionModel
	selectFirstRow() : void	RowSelectionModel
	Selects the first row in the grid.	RowSelectionModel
	selectLastRow([`Boolean keepExisting`]) : void	RowSelectionModel
	Select the last row.	RowSelectionModel
	selectNext([`Boolean keepExisting`]) : void	RowSelectionModel
	Selects the row immediately following the last selected row.	RowSelectionModel
	selectPrevious([`Boolean keepExisting`]) : void	RowSelectionModel
	Selects the row that precedes the last selected row.	RowSelectionModel
	selectRange(`Number startRow`, `Number endRow`, [`Boolean keepExisting`]) : void	RowSelectionModel
	Selects a range of rows. All rows in between startRow and endRow are also selected.	RowSelectionModel
	selectRecords(`Array records`, [`Boolean keepExisting`]) : void	RowSelectionModel
	Select records.	RowSelectionModel
	selectRow(`Number row`, [`Boolean keepExisting`]) : void	RowSelectionModel
	Selects a row.	RowSelectionModel
	selectRows(`Array rows`, [`Boolean keepExisting`]) : void	RowSelectionModel
	Selects multiple rows.	RowSelectionModel
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable
	unlock() : void	AbstractSelectionModel
	Unlock the selections	AbstractSelectionModel

Public Events

Event		Defined By
	beforerowselect : (`SelectionModel this`, `Number rowIndex`)	RowSelectionModel
	Fires when a row is selected being selected, return false to cancel.	RowSelectionModel
	rowselect : (`SelectionModel this`, `Number rowIndex`)	RowSelectionModel
	Fires when a row is selected.	RowSelectionModel
	selectionchange : (`SelectionModel this`)	RowSelectionModel
	Fires when the selection changes	RowSelectionModel

Config Options

Config Options		Defined By
	singleSelect : Boolean	RowSelectionModel
	True to allow selection of only one row at a time (defaults to false)	RowSelectionModel

Constructor Details

RowSelectionModel

public function RowSelectionModel(Object config)

Parameters:

config : Object

Method Details

addEvents

public function addEvents(Object object)

Copies any events from the passed object onto this object if they do not already exist. The passed object must also inherit from Observable for this method to have any effect.

Parameters:

object : Object
The object from which to copy events

Returns:

void

This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object options])

Appends an event handler to this component

Parameters:

eventName : String
The type of event to listen for
handler : Function
The method the event invokes
options : Object
(optional)

Returns:

void

This method is defined by Observable.

clearSelections

public function clearSelections()

Clears all selections.

Parameters:

None.

Returns:

void

This method is defined by RowSelectionModel.

deselectRange

public function deselectRange(Number startRow, Number endRow)

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

Parameters:

startRow : Number
The index of the first row in the range
endRow : Number
The index of the last row in the range

Returns:

void

This method is defined by RowSelectionModel.

deselectRow

public function deselectRow(Number row)

Deselects a row.

Parameters:

row : Number
The index of the row to deselect

Returns:

void

This method is defined by RowSelectionModel.

fireEvent

public function fireEvent(String eventName, Object... args)

Fires the specified event with the passed parameters (minus the event name).

Parameters:

eventName : String
args : Object...
Variable number of parameters are passed to handlers

Returns:

Boolean
returns false if any of the handlers return false otherwise it returns true

This method is defined by Observable.

getCount

public function getCount()

Gets the number of selected rows.

Parameters:

None.

Returns:

Number

This method is defined by RowSelectionModel.

getSelected

public function getSelected()

Returns the first selected record.

Parameters:

None.

Returns:

Record

This method is defined by RowSelectionModel.

getSelections

public function getSelections()

Returns the selected records

Parameters:

None.

Returns:

Array
Array of selected records

This method is defined by RowSelectionModel.

hasListener

public function hasListener(String eventName)

Checks to see if this object is currently listening for a specified event

Parameters:

eventName : String
The name of the event to check for

Returns:

Boolean
True if the event is being listened for, else false

This method is defined by Observable.

hasSelection

public function hasSelection()

Returns True if there is a selection.

Parameters:

None.

Returns:

Boolean

This method is defined by RowSelectionModel.

isIdSelected

public function isIdSelected(String id)

Returns True if the specified record id is selected.

Parameters:

id : String
The id of record to check

Returns:

Boolean

This method is defined by RowSelectionModel.

isLocked

public function isLocked()

Returns true if the selections are locked

Parameters:

None.

Returns:

Boolean

This method is defined by AbstractSelectionModel.

isSelected

public function isSelected(Number/Record record)

Returns True if the specified row is selected.

Parameters:

record : Number/Record
The record or index of the record to check

Returns:

Boolean

This method is defined by RowSelectionModel.

lock

public function lock()

Lock the selections

Parameters:

None.

Returns:

void

This method is defined by AbstractSelectionModel.

on

public function on(String eventName, Function handler, [Object options])

Appends an event handler to this element (shorthand for addListener)

Parameters:

eventName : String
The type of event to listen for
handler : Function
The method the event invokes
options : Object
(optional)

Returns:

void

This method is defined by Observable.

purgeListeners

public function purgeListeners()

Removes all listeners for this object

Parameters:

None.

Returns:

void

This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])

Removes a listener

Parameters:

eventName : String
The type of event to listen for
handler : Function
The handler to remove
scope : Object
(optional) The scope (this object) for the handler

Returns:

void

This method is defined by Observable.

selectAll

public function selectAll()

Selects all rows.

Parameters:

None.

Returns:

void

This method is defined by RowSelectionModel.

selectFirstRow

public function selectFirstRow()

Selects the first row in the grid.

Parameters:

None.

Returns:

void

This method is defined by RowSelectionModel.

selectLastRow

public function selectLastRow([Boolean keepExisting])

Select the last row.

Parameters:

keepExisting : Boolean
(optional) True to keep existing selections

Returns:

void

This method is defined by RowSelectionModel.

selectNext

public function selectNext([Boolean keepExisting])

Selects the row immediately following the last selected row.

Parameters:

keepExisting : Boolean
(optional) True to keep existing selections

Returns:

void

This method is defined by RowSelectionModel.

selectPrevious

public function selectPrevious([Boolean keepExisting])

Selects the row that precedes the last selected row.

Parameters:

keepExisting : Boolean
(optional) True to keep existing selections

Returns:

void

This method is defined by RowSelectionModel.

selectRange

public function selectRange(Number startRow, Number endRow, [Boolean keepExisting])

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

Parameters:

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

Returns:

void

This method is defined by RowSelectionModel.

selectRecords

public function selectRecords(Array records, [Boolean keepExisting])

Select records.

Parameters:

records : Array
The records to select
keepExisting : Boolean
(optional) True to keep existing selections

Returns:

void

This method is defined by RowSelectionModel.

selectRow

public function selectRow(Number row, [Boolean keepExisting])

Selects a row.

Parameters:

row : Number
The index of the row to select
keepExisting : Boolean
(optional) True to keep existing selections

Returns:

void

This method is defined by RowSelectionModel.

selectRows

public function selectRows(Array rows, [Boolean keepExisting])

Selects multiple rows.

Parameters:

rows : Array
Array of the indexes of the row to select
keepExisting : Boolean
(optional) True to keep existing selections

Returns:

void

This method is defined by RowSelectionModel.

un

public function un(String eventName, Function handler, [Object scope])

Removes a listener (shorthand for removeListener)

Parameters:

eventName : String
The type of event to listen for
handler : Function
The handler to remove
scope : Object
(optional) The scope (this object) for the handler

Returns:

void

This method is defined by Observable.

unlock

public function unlock()

Unlock the selections

Parameters:

None.

Returns:

void

This method is defined by AbstractSelectionModel.

Event Details

beforerowselect

public event beforerowselect

Fires when a row is selected being selected, return false to cancel.

Subscribers will be called with the following parameters:

this : SelectionModel
rowIndex : Number
The selected index

This event is defined by RowSelectionModel.

rowselect

public event rowselect

Fires when a row is selected.

Subscribers will be called with the following parameters:

this : SelectionModel
rowIndex : Number
The selected index

This event is defined by RowSelectionModel.

selectionchange

public event selectionchange

Fires when the selection changes

Subscribers will be called with the following parameters:

this : SelectionModel

This event is defined by RowSelectionModel.

Config Details

singleSelect

singleSelect : Boolean

True to allow selection of only one row at a time (defaults to false)

This config option is defined by RowSelectionModel.