Package: | YAHOO.ext.grid |
Class: | SingleSelectionModel |
Extends: | DefaultSelectionModel |
Defined In: | SelectionModel.js |
Method | Defined By | |
---|---|---|
SingleSelectionModel() | SingleSelectionModel | |
Create new SingleSelectionModel | ||
addListener(String eventName , Function handler , [Object scope ], [boolean override ]) : void |
Observable | |
Appends an event handler to this component | ||
bufferedListener(String eventName , Function handler , [Object scope ], [Number millis ]) : Function |
Observable | |
Appends an event handler to this component that is buffered. If the event is triggered more than once in the specifie... | ||
clearSelections() : void | DefaultSelectionModel | |
Clears all selections. | ||
delayedListener(String eventName , Function handler , [Object scope ], [Number delay ]) : Function |
Observable | |
Appends an event handler to this component that is delayed the specified number of milliseconds. This is useful for e... | ||
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 ) : Boolean |
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 | ||
on(String eventName , Function handler , [Object scope ], [boolean override ]) : void |
Observable | |
Appends an event handler to this element (shorthand for addListener) | ||
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 | |
---|---|---|
rowselect : (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 function SingleSelectionModel()
public function addListener(String eventName
, Function handler
, [Object scope
], [boolean override
])
eventName
: Stringhandler
: Functionscope
: Objectoverride
: booleanvoid
public function bufferedListener(String eventName
, Function handler
, [Object scope
], [Number millis
])
eventName
: Stringhandler
: Functionscope
: Objectmillis
: NumberFunction
public function clearSelections()
void
public function delayedListener(String eventName
, Function handler
, [Object scope
], [Number delay
])
eventName
: Stringhandler
: Functionscope
: Objectdelay
: NumberFunction
public function deselectRange(Number/HTMLElement startRow
, Number/HTMLElement endRow
)
startRow
: Number/HTMLElementendRow
: Number/HTMLElementvoid
public function deselectRow(Number/HTMLElement row
)
row
: Number/HTMLElementvoid
public function fireEvent(String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function focusRow(HTMLElement row
)
row
: HTMLElementvoid
public function getCount()
Number
public function getSelectedRowIds()
Array
public function getSelectedRows()
Array
public function hasSelection()
Boolean
public function isLocked()
Boolean
public function isSelectable(HTMLElement row
)
row
: HTMLElementBoolean
public function isSelected(HTMLElement row
)
row
: HTMLElementBoolean
public function lock()
void
public function on(String eventName
, Function handler
, [Object scope
], [boolean override
])
eventName
: Stringhandler
: Functionscope
: Objectoverride
: booleanvoid
public function purgeListeners()
void
public function removeListener(String eventName
, Function handler
, [Object scope
])
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function selectAll()
void
public function selectFirstRow()
void
public function selectNext([Boolean keepExisting
])
keepExisting
: Booleanvoid
public function selectPrevious([Boolean keepExisting
])
keepExisting
: Booleanvoid
public function selectRange(Number/HTMLElement startRow
, Number/HTMLElement endRow
, [Boolean keepExisting
])
startRow
: Number/HTMLElementendRow
: Number/HTMLElementkeepExisting
: Booleanvoid
public function selectRow(Number/HTMLElement row
, [Boolean keepExisting
])
row
: Number/HTMLElementkeepExisting
: Booleanvoid
public function selectRows(Array rows
, [Boolean keepExisting
])
rows
: ArraykeepExisting
: Booleanvoid
public function selectRowsById(String/Array id
, [Boolean keepExisting
])
id
: String/ArraykeepExisting
: Booleanvoid
public function unlock()
void
public event rowselect
this
: SelectionModelrow
: HTMLElementselected
: Booleanpublic event selectionchange
this
: SelectionModelrows
: Arrayids
: String