This class has no public properties.
|
RowSelectionModel( Object config ) |
RowSelectionModel |
|
|
addEvents( Object object ) : void |
Observable |
Used to define events on this Observable |
|
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable |
Appends an event handler to this component |
|
clearSelections() : void |
RowSelectionModel |
Clears all selections. |
|
deselectRange( Number startRow , Number endRow ) : void |
RowSelectionModel |
Deselects a range of rows. All rows in between startRow and endRow are also deselected. |
|
deselectRow( Number row ) : void |
RowSelectionModel |
Deselects a row. |
|
fireEvent( String eventName , Object... args ) : Boolean |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
getCount() : Number |
RowSelectionModel |
Gets the number of selected rows. |
|
getSelected() : Record |
RowSelectionModel |
Returns the first selected record. |
|
getSelections() : Array |
RowSelectionModel |
Returns the selected records |
|
hasListener( String eventName ) : Boolean |
Observable |
Checks to see if this object has any listeners for a specified event |
|
hasSelection() : Boolean |
RowSelectionModel |
Returns True if there is a selection. |
|
isIdSelected( String id ) : Boolean |
RowSelectionModel |
Returns True if the specified record id is selected. |
|
isLocked() : Boolean |
AbstractSelectionModel |
Returns true if the selections are locked. |
|
isSelected( Number/Record record ) : Boolean |
RowSelectionModel |
Returns True if the specified row is selected. |
|
lock() : void |
AbstractSelectionModel |
Locks the selections. |
|
on( String eventName , Function handler , [Object scope ], [Object options ] ) : 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 |
RowSelectionModel |
Selects all rows. |
|
selectFirstRow() : void |
RowSelectionModel |
Selects the first row in the grid. |
|
selectLastRow( [Boolean keepExisting ] ) : void |
RowSelectionModel |
Select the last row. |
|
selectNext( [Boolean keepExisting ] ) : void |
RowSelectionModel |
Selects the row immediately following the last selected row. |
|
selectPrevious( [Boolean keepExisting ] ) : void |
RowSelectionModel |
Selects the row that precedes the last selected row. |
|
selectRange( Number startRow , Number endRow , [Boolean keepExisting ] ) : void |
RowSelectionModel |
Selects a range of rows. All rows in between startRow and endRow are also selected. |
|
selectRecords( Array records , [Boolean keepExisting ] ) : void |
RowSelectionModel |
Select records. |
|
selectRow( Number row , [Boolean keepExisting ] ) : void |
RowSelectionModel |
Selects a row. |
|
selectRows( Array rows , [Boolean keepExisting ] ) : void |
RowSelectionModel |
Selects multiple rows. |
|
un( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener (shorthand for removeListener) |
|
unlock() : void |
AbstractSelectionModel |
Unlocks the selections. |
|
beforerowselect : ( SelectionModel this , Number rowIndex , Boolean keepExisting ) |
RowSelectionModel |
Fires when a row is selected being selected, return false to cancel. |
|
rowdeselect : ( SelectionModel this , Number rowIndex ) |
RowSelectionModel |
Fires when a row is deselected. |
|
rowselect : ( SelectionModel this , Number rowIndex , Ext.data.Record r ) |
RowSelectionModel |
Fires when a row is selected. |
|
selectionchange : ( SelectionModel this ) |
RowSelectionModel |
Fires when the selection changes |
addEvents
public function addEvents( Object object
)
Used to define events on this Observable
addListener
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this component
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler
function. The handler function's "this" context.
options
: Object(optional) An object containing handler configuration
properties. This may contain any of the following properties:
- scope {Object} The scope in which to execute the handler function. The handler function's "this" context.
- delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
- single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer {Number} Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed
by the specified number of milliseconds. If the event fires again within that time, the original
handler is not invoked, but the new handler is scheduled in its place.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
el.on('click', this.onClick, this, {
single: true,
delay: 100,
forumId: 4
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
el.on({
'click': {
fn: this.onClick,
scope: this,
delay: 100
},
'mouseover': {
fn: this.onMouseOver,
scope: this
},
'mouseout': {
fn: this.onMouseOut,
scope: this
}
});
Or a shorthand syntax which passes the same scope object to all handlers:
el.on({
'click': this.onClick,
'mouseover': this.onMouseOver,
'mouseout': this.onMouseOut,
scope: this
});
Returns:
clearSelections
public function clearSelections()
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.
This method is defined by RowSelectionModel.
deselectRow
public function deselectRow( Number row
)
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).
getCount
public function getCount()
Gets the number of selected rows.
This method is defined by RowSelectionModel.
getSelected
public function getSelected()
Returns the first selected record.
This method is defined by RowSelectionModel.
getSelections
public function getSelections()
Returns the selected records
This method is defined by RowSelectionModel.
hasListener
public function hasListener( String eventName
)
Checks to see if this object has any listeners for a specified event
hasSelection
public function hasSelection()
Returns True if there is a selection.
This method is defined by RowSelectionModel.
isIdSelected
public function isIdSelected( String id
)
Returns True if the specified record id is selected.
This method is defined by RowSelectionModel.
isLocked
public function isLocked()
Returns true if the selections are locked.
isSelected
public function isSelected( Number/Record record
)
Returns True if the specified row is selected.
This method is defined by RowSelectionModel.
lock
public function lock()
on
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this element (shorthand for addListener)
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler
function. The handler function's "this" context.
options
: Object(optional)
Returns:
purgeListeners
public function purgeListeners()
Removes all listeners for this object
removeListener
public function removeListener( String eventName
, Function handler
, [Object scope
] )
selectAll
public function selectAll()
This method is defined by RowSelectionModel.
selectFirstRow
public function selectFirstRow()
Selects the first row in the grid.
This method is defined by RowSelectionModel.
selectLastRow
public function selectLastRow( [Boolean keepExisting
] )
This method is defined by RowSelectionModel.
selectNext
public function selectNext( [Boolean keepExisting
] )
Selects the row immediately following the last selected row.
This method is defined by RowSelectionModel.
selectPrevious
public function selectPrevious( [Boolean keepExisting
] )
Selects the row that precedes the last selected row.
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
: NumberThe index of the first row in the range
endRow
: NumberThe index of the last row in the range
keepExisting
: Boolean(optional) True to retain existing selections
Returns:
This method is defined by RowSelectionModel.
selectRecords
public function selectRecords( Array records
, [Boolean keepExisting
] )
This method is defined by RowSelectionModel.
selectRow
public function selectRow( Number row
, [Boolean keepExisting
] )
This method is defined by RowSelectionModel.
selectRows
public function selectRows( Array rows
, [Boolean keepExisting
] )
This method is defined by RowSelectionModel.
un
public function un( String eventName
, Function handler
, [Object scope
] )
Removes a listener (shorthand for removeListener)
unlock
public function unlock()