Observable AbstractSelectionModel RowSelectionModel CheckboxSelectionModel
Package: | Ext.grid |
Defined In: | CheckboxSelectionModel.js |
Class: | CheckboxSelectionModel |
Extends: | RowSelectionModel |
Config Options | Defined By | |
---|---|---|
header : String Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-...
Any valid text or HTML fragment to display in the header cell for the checkbox column (defaults to '<div class="x-grid3-hd-checker"> </div>'). The default CSS class of 'x-grid3-hd-checker' displays a checkbox in the header and provides support for automatic check all/none behavior on header click. This string can be replaced by any valid HTML fragment, including a simple text string (e.g., 'Select Rows'), but the automatic check all/none behavior will only work if the 'x-grid3-hd-checker' class is supplied.
|
CheckboxSelectionModel | |
listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should b...
A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.
|
Observable | |
moveEditorOnEnter : Boolean
False to turn off moving the editor to the next cell when the enter key is pressed
|
RowSelectionModel | |
singleSelect : Boolean
True to allow selection of only one row at a time (defaults to false)
|
RowSelectionModel | |
sortable : Boolean
True if the checkbox column is sortable (defaults to false).
|
CheckboxSelectionModel | |
width : Number
The default width in pixels of the checkbox column (defaults to 20).
|
CheckboxSelectionModel |
Method | Defined By | |
---|---|---|
CheckboxSelectionModel( Object config )
Parameters:
|
CheckboxSelectionModel | |
addEvents( Object object ) : void Used to define events on this Observable
Used to define events on this Observable
Parameters:
|
Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this component
Appends an event handler to this component
Parameters:
|
Observable | |
clearSelections() : void Clears all selections.
Clears all selections.
Parameters:
|
RowSelectionModel | |
deselectRange( Number startRow , Number endRow ) : void Deselects a range of rows. All rows in between startRow and endRow are also deselected.
Deselects a range of rows. All rows in between startRow and endRow are also deselected.
Parameters:
|
RowSelectionModel | |
deselectRow( Number row ) : void Deselects a row.
Deselects a row.
Parameters:
|
RowSelectionModel | |
each( Function fn , [Object scope ] ) : Boolean Calls the passed function with each selection. If the function returns false, iteration is
stopped and this function ...
Calls the passed function with each selection. If the function returns false, iteration is
stopped and this function returns false. Otherwise it returns true.
Parameters:
|
RowSelectionModel | |
fireEvent( String eventName , Object... args ) : Boolean Fires the specified event with the passed parameters (minus the event name).
Fires the specified event with the passed parameters (minus the event name).
Parameters:
|
Observable | |
getCount() : Number Gets the number of selected rows.
Gets the number of selected rows.
Parameters:
|
RowSelectionModel | |
getSelected() : Record Returns the first selected record.
Returns the first selected record.
Parameters:
|
RowSelectionModel | |
getSelections() : Array Returns the selected records
Returns the selected records
Parameters:
|
RowSelectionModel | |
hasListener( String eventName ) : Boolean Checks to see if this object has any listeners for a specified event
Checks to see if this object has any listeners for a specified event
Parameters:
|
Observable | |
hasNext() : Boolean Returns true if there is a next record to select
Returns true if there is a next record to select
Parameters:
|
RowSelectionModel | |
hasPrevious() : Boolean Returns true if there is a previous record to select
Returns true if there is a previous record to select
Parameters:
|
RowSelectionModel | |
hasSelection() : Boolean Returns True if there is a selection.
Returns True if there is a selection.
Parameters:
|
RowSelectionModel | |
isIdSelected( String id ) : Boolean Returns True if the specified record id is selected.
Returns True if the specified record id is selected.
Parameters:
|
RowSelectionModel | |
isLocked() : Boolean Returns true if the selections are locked.
Returns true if the selections are locked.
Parameters:
|
AbstractSelectionModel | |
isSelected( Number/Record record ) : Boolean Returns True if the specified row is selected.
Returns True if the specified row is selected.
Parameters:
|
RowSelectionModel | |
lock() : void Locks the selections.
Locks the selections.
Parameters:
|
AbstractSelectionModel | |
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void Appends an event handler to this element (shorthand for addListener)
Appends an event handler to this element (shorthand for addListener)
Parameters:
|
Observable | |
purgeListeners() : void Removes all listeners for this object
Removes all listeners for this object
Parameters:
|
Observable | |
relayEvents( Object o , Array events ) : void Relays selected events from the specified Observable as if the events were fired by this.
Relays selected events from the specified Observable as if the events were fired by this.
Parameters:
|
Observable | |
removeListener( String eventName , Function handler , [Object scope ] ) : void Removes a listener
Removes a listener
Parameters:
|
Observable | |
resumeEvents() : void Resume firing events. (see suspendEvents)
Resume firing events. (see suspendEvents)
Parameters:
|
Observable | |
selectAll() : void Selects all rows.
Selects all rows.
Parameters:
|
RowSelectionModel | |
selectFirstRow() : void Selects the first row in the grid.
Selects the first row in the grid.
Parameters:
|
RowSelectionModel | |
selectLastRow( [Boolean keepExisting ] ) : void Select the last row.
Select the last row.
Parameters:
|
RowSelectionModel | |
selectNext( [Boolean keepExisting ] ) : Boolean Selects the row immediately following the last selected row.
Selects the row immediately following the last selected row.
Parameters:
|
RowSelectionModel | |
selectPrevious( [Boolean keepExisting ] ) : Boolean Selects the row that precedes the last selected row.
Selects the row that precedes the last selected row.
Parameters:
|
RowSelectionModel | |
selectRange( Number startRow , Number endRow , [Boolean keepExisting ] ) : void Selects a range of rows. All rows in between startRow and endRow are also selected.
Selects a range of rows. All rows in between startRow and endRow are also selected.
Parameters:
|
RowSelectionModel | |
selectRecords( Array records , [Boolean keepExisting ] ) : void Select records.
Select records.
Parameters:
|
RowSelectionModel | |
selectRow( Number row , [Boolean keepExisting ] ) : void Selects a row.
Selects a row.
Parameters:
|
RowSelectionModel | |
selectRows( Array rows , [Boolean keepExisting ] ) : void Selects multiple rows.
Selects multiple rows.
Parameters:
|
RowSelectionModel | |
suspendEvents() : void Suspend the firing of all events. (see resumeEvents)
Suspend the firing of all events. (see resumeEvents)
Parameters:
|
Observable | |
un( String eventName , Function handler , [Object scope ] ) : void Removes a listener (shorthand for removeListener)
Removes a listener (shorthand for removeListener)
Parameters:
|
Observable | |
unlock() : void Unlocks the selections.
Unlocks the selections.
Parameters:
|
AbstractSelectionModel |
Event | Defined By | |
---|---|---|
beforerowselect : ( SelectionModel this , Number rowIndex , Boolean keepExisting , Record record ) Fires when a row is being selected, return false to cancel.
Fires when a row is being selected, return false to cancel.
Listeners will be called with the following arguments:
|
RowSelectionModel | |
rowdeselect : ( SelectionModel this , Number rowIndex , Record record ) Fires when a row is deselected.
Fires when a row is deselected.
Listeners will be called with the following arguments:
|
RowSelectionModel | |
rowselect : ( SelectionModel this , Number rowIndex , Ext.data.Record r ) Fires when a row is selected.
Fires when a row is selected.
Listeners will be called with the following arguments:
|
RowSelectionModel | |
selectionchange : ( SelectionModel this ) Fires when the selection changes
Fires when the selection changes
Listeners will be called with the following arguments:
|
RowSelectionModel |