| Package: | YAHOO.ext.grid |
| Class: | EditorSelectionModel |
| Extends: | DefaultSelectionModel |
| Defined In: | EditorSelectionModel.js |
| Property | Defined By | |
|---|---|---|
| clicksToActivateCell : Number | EditorSelectionModel | |
| Number of clicks to activate a cell (for editing) - valid values are 1 or 2 | ||
| Method | Defined By | |
|---|---|---|
| EditorSelectionModel() | EditorSelectionModel | |
addListener(String eventName, Function handler, [Object scope], [boolean override]) : void |
Observable | |
| Appends an event handler to this element | ||
| clearSelections() : void | DefaultSelectionModel | |
| Clears all selections. | ||
delayedListener(String eventName, Function handler, [Object scope], [Number delay]) : Function |
Observable | |
| Appends an event handler to this element that is delayed the specified number of milliseconds. | ||
deselectRange(Number/HTMLElement startRow, Number/HTMLElement endRow) : void |
DefaultSelectionModel | |
| Deselects a range of rows. All rows in between startRow and endRow are also deselected. | ||
deselectRow(Number/HTMLElement row) : void |
DefaultSelectionModel | |
| Deselects a row. | ||
fireEvent(String eventName, Object... args) : void |
Observable | |
| Fires the specified event with the passed parameters (minus the event name). | ||
focusRow(HTMLElement row) : void |
DefaultSelectionModel | |
| Deprecated. Deprecated. Tries to focus the row and scroll it into view - Use grid.scrollTo or grid.getView().focusRow... | ||
| getCount() : Number | DefaultSelectionModel | |
| Gets the number of selected rows. | ||
| getSelectedRowIds() : Array | DefaultSelectionModel | |
| Returns the selected row ids. | ||
| getSelectedRows() : Array | DefaultSelectionModel | |
| Returns the selected rows. | ||
| hasSelection() : Boolean | DefaultSelectionModel | |
| Returns True if there is a selection. | ||
| isLocked() : Boolean | DefaultSelectionModel | |
| Returns true if the selections are locked | ||
isSelectable(HTMLElement row) : Boolean |
DefaultSelectionModel | |
| Returns True if the specified row is selectable. | ||
isSelected(HTMLElement row) : Boolean |
DefaultSelectionModel | |
| Returns True if the specified row is selected. | ||
| lock() : void | DefaultSelectionModel | |
| Lock the selections | ||
| purgeListeners() : void | Observable | |
| Removes all listeners for this object | ||
removeListener(String eventName, Function handler, [Object scope]) : void |
Observable | |
| Removes a listener | ||
| selectAll() : void | DefaultSelectionModel | |
| Selects all rows. | ||
| selectFirstRow() : void | DefaultSelectionModel | |
| Selects the first row in the grid. | ||
selectNext([Boolean keepExisting]) : void |
DefaultSelectionModel | |
| Selects the row immediately following the last selected row. | ||
selectPrevious([Boolean keepExisting]) : void |
DefaultSelectionModel | |
| Selects the row that precedes the last selected row. | ||
selectRange(Number/HTMLElement startRow, Number/HTMLElement endRow, [Boolean keepExisting]) : void |
DefaultSelectionModel | |
| Selects a range of rows. All rows in between startRow and endRow are also selected. | ||
selectRow(Number/HTMLElement row, [Boolean keepExisting]) : void |
DefaultSelectionModel | |
| Selects a row. | ||
selectRows(Array rows, [Boolean keepExisting]) : void |
DefaultSelectionModel | |
| Selects multiple rows. | ||
selectRowsById(String/Array id, [Boolean keepExisting]) : void |
DefaultSelectionModel | |
| Set the selected rows by their ID(s). IDs must match what is returned by the DataModel getRowId(index). | ||
| unlock() : void | DefaultSelectionModel | |
| Unlock the selections | ||
| Event | Defined By | |
|---|---|---|
dragenter : (SelectionModel this, HTMLElement row, Boolean selected) |
DefaultSelectionModel | |
| Fires when a row is selected or deselected | ||
selectionchange : (SelectionModel this, Array rows, String ids) |
DefaultSelectionModel | |
| Fires when the selection changes | ||
public Number clicksToActivateCell
public function EditorSelectionModel()
public function addListener(String eventName, Function handler, [Object scope], [boolean override])
eventName : Stringhandler : Functionscope : Objectoverride : booleanvoidpublic function clearSelections()
voidpublic function delayedListener(String eventName, Function handler, [Object scope], [Number delay])
eventName : Stringhandler : Functionscope : Objectdelay : NumberFunctionpublic function deselectRange(Number/HTMLElement startRow, Number/HTMLElement endRow)
startRow : Number/HTMLElementendRow : Number/HTMLElementvoidpublic function deselectRow(Number/HTMLElement row)
row : Number/HTMLElementvoidpublic function fireEvent(String eventName, Object... args)
eventName : Stringargs : Object...voidpublic function focusRow(HTMLElement row)
row : HTMLElementvoidpublic function getCount()
Numberpublic function getSelectedRowIds()
Arraypublic function getSelectedRows()
Arraypublic function hasSelection()
Booleanpublic function isLocked()
Booleanpublic function isSelectable(HTMLElement row)
row : HTMLElementBooleanpublic function isSelected(HTMLElement row)
row : HTMLElementBooleanpublic function lock()
voidpublic function purgeListeners()
voidpublic function removeListener(String eventName, Function handler, [Object scope])
eventName : Stringhandler : Functionscope : Objectvoidpublic function selectAll()
voidpublic function selectFirstRow()
voidpublic function selectNext([Boolean keepExisting])
keepExisting : Booleanvoidpublic function selectPrevious([Boolean keepExisting])
keepExisting : Booleanvoidpublic function selectRange(Number/HTMLElement startRow, Number/HTMLElement endRow, [Boolean keepExisting])
startRow : Number/HTMLElementendRow : Number/HTMLElementkeepExisting : Booleanvoidpublic function selectRow(Number/HTMLElement row, [Boolean keepExisting])
row : Number/HTMLElementkeepExisting : Booleanvoidpublic function selectRows(Array rows, [Boolean keepExisting])
rows : ArraykeepExisting : Booleanvoidpublic function selectRowsById(String/Array id, [Boolean keepExisting])
id : String/ArraykeepExisting : Booleanvoidpublic function unlock()
voidpublic event dragenter
this : SelectionModelrow : HTMLElementselected : Booleanpublic event selectionchange
this : SelectionModelrows : Arrayids : String