|
| RowSelectionModel( Object config )
+ | RowSelectionModel |
| addEvents( Object|String o , string Optional. )
+ :
+ voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. | Observable |
| addListener( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object. Appends an event handler to this object. Parameters:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -83,8 +85,8 @@ Using the options argument, it is possible to combine different types of listene
A delayed, one-time listener.
myDataView.on('click', this.onClick, this, {
- single: true,
- delay: 100
+single: true,
+delay: 100
});
Attaching multiple handlers in 1 call
@@ -92,142 +94,174 @@ The method also allows for a single argument to be passed which is a config obje
which specify multiple handlers.
myGridPanel.on({
- 'click' : {
- fn: this.onClick,
- scope: this,
- delay: 100
- },
- 'mouseover' : {
- fn: this.onMouseOver,
- scope: this
- },
- 'mouseout' : {
- fn: this.onMouseOut,
- scope: this
- }
+'click' : {
+ fn: this.onClick,
+ scope: this,
+ delay: 100
+},
+'mouseover' : {
+ fn: this.onMouseOver,
+ scope: this
+},
+'mouseout' : {
+ fn: this.onMouseOut,
+ scope: this
+}
});
Or a shorthand syntax:
myGridPanel.on({
- 'click' : this.onClick,
- 'mouseover' : this.onMouseOver,
- 'mouseout' : this.onMouseOut,
- scope: this
-});
Returns: | Observable |
| clearSelections( [Boolean fast ] )
- :
- voidClears all selections if the selection model
+'click' : this.onClick,
+'mouseover' : this.onMouseOver,
+'mouseout' : this.onMouseOut,
+ scope: this
+}); Returns: | Observable |
| clearSelections( [Boolean fast ] )
+ :
+ voidClears all selections if the selection model
is not locked. Clears all selections if the selection model
is not locked. Parameters:fast : Boolean(optional) true to bypass the
-conditional checks and events described in deselectRow. Returns: | RowSelectionModel |
| deselectRange( Number startRow , Number endRow )
- :
- voidDeselects a range of rows if the selection model
-is not locked.
+conditional checks and events described in deselectRow. Returns: | RowSelectionModel |
| deselectRange( Number startRow , Number endRow )
+ :
+ voidDeselects a range of rows if the selection model
+is not locked.
All rows in between startRow and endRow are also de... Deselects a range of rows if the selection model
is not locked.
-All rows in between startRow and endRow are also deselected. | RowSelectionModel |
| deselectRow( Number row , [Boolean preventViewNotify ] )
- :
- voidDeselects a row. Before deselecting a row, checks if the selection model
-is locked.
+All rows in between startRow and endRow are also deselected. | RowSelectionModel |
| deselectRow( Number row , [Boolean preventViewNotify ] )
+ :
+ voidDeselects a row. Before deselecting a row, checks if the selection model
+is locked.
If this check is satisfied the r... Deselects a row. Before deselecting a row, checks if the selection model
is locked.
If this check is satisfied the row will be deselected and followed up by
firing the rowdeselect and selectionchange events. | RowSelectionModel |
| each( Function fn , [Object scope ] )
- :
- BooleanCalls the passed function with each selection. If the function returns
+prevent notifying the view (disables updating the selected appearance) Returns: | RowSelectionModel |
| each( Function fn , [Object scope ] )
+ :
+ BooleanCalls 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:fn : Functionscope : Object(optional) Returns: | RowSelectionModel |
| enableBubble( Object events )
- :
- voidUsed to enable bubbling of events Used to enable bubbling of events | Observable |
| fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
+ false. Otherwise it returns true. Parameters:fn : Functionscope : Object(optional) Returns: | RowSelectionModel |
| enableBubble( Object events )
+ :
+ voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present... Enables events fired by this Observable to bubble up an owner hierarchy by calling
+this.getBubbleTarget() if present. There is no implementation in the Observable base class.
+ This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
+implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to
+access the required target more quickly.
+ Example: Ext.override(Ext.form.Field, {
+// Add functionality to Field's initComponent to enable the change event to bubble
+ initComponent: Ext.form.Field.prototype.initComponent.createSequence(function() {
+ this.enableBubble('change');
+ }),
+
+// We know that we want Field's events to bubble directly to the FormPanel.
+ getBubbleTarget: function() {
+ if (!this.formPanel) {
+ this.formPanel = this.findParentByType('form');
+ }
+ return this.formPanel;
+ }
+});
+
+var myForm = new Ext.formPanel({
+ title: 'User Details',
+ items: [{
+ ...
+ }],
+ listeners: {
+ change: function() {
+// Title goes red if form has been modified.
+ myForm.header.setStyle("color", "red");
+ }
+ }
+});
| Observable |
| fireEvent( String eventName , Object... args )
+ :
+ BooleanFires the specified event with the passed parameters (minus the event name).
An event may be set to bubble up an Obse... | Observable |
| getCount()
- :
- NumberGets the number of selected rows. Gets the number of selected rows. | RowSelectionModel |
| getSelected()
- :
- RecordReturns the first selected record. Returns the first selected record. | RowSelectionModel |
| getSelections()
- :
- ArrayReturns the selected records Returns the selected records | RowSelectionModel |
| hasListener( String eventName )
- :
- BooleanChecks 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 | Observable |
| hasNext()
- :
- BooleanReturns true if there is a next record to select Returns true if there is a next record to select | RowSelectionModel |
| hasPrevious()
- :
- BooleanReturns true if there is a previous record to select Returns true if there is a previous record to select | RowSelectionModel |
| hasSelection()
- :
- BooleanReturns true if there is a selection. Returns true if there is a selection. | RowSelectionModel |
| isIdSelected( String id )
- :
- BooleanReturns true if the specified record id is selected. Returns true if the specified record id is selected. | RowSelectionModel |
| isLocked()
- :
- BooleanReturns true if the selections are locked. Returns true if the selections are locked. | AbstractSelectionModel |
| isSelected( Number/Record index )
- :
- BooleanReturns true if the specified row is selected. Returns true if the specified row is selected. | RowSelectionModel |
| lock()
- :
- void | AbstractSelectionModel |
| on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
+by calling enableBubble. | Observable |
| getCount()
+ :
+ NumberGets the number of selected rows. Gets the number of selected rows. | RowSelectionModel |
| getSelected()
+ :
+ RecordReturns the first selected record. Returns the first selected record. | RowSelectionModel |
| getSelections()
+ :
+ ArrayReturns the selected records Returns the selected records | RowSelectionModel |
| hasListener( String eventName )
+ :
+ BooleanChecks 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 | Observable |
| hasNext()
+ :
+ BooleanReturns true if there is a next record to select Returns true if there is a next record to select | RowSelectionModel |
| hasPrevious()
+ :
+ BooleanReturns true if there is a previous record to select Returns true if there is a previous record to select | RowSelectionModel |
| hasSelection()
+ :
+ BooleanReturns true if there is a selection. Returns true if there is a selection. | RowSelectionModel |
| isIdSelected( String id )
+ :
+ BooleanReturns true if the specified record id is selected. Returns true if the specified record id is selected. | RowSelectionModel |
| isLocked()
+ :
+ BooleanReturns true if the selections are locked. Returns true if the selections are locked. | AbstractSelectionModel |
| isSelected( Number/Record index )
+ :
+ BooleanReturns true if the specified row is selected. Returns true if the specified row is selected. | RowSelectionModel |
| lock()
+ :
+ void | AbstractSelectionModel |
| on( String eventName , Function handler , [Object scope ], [Object options ] )
+ :
voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable |
| purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | Observable |
| relayEvents( Object o , Array events )
- :
- voidRelays 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. | Observable |
| removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable |
| resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable |
| purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | Observable |
| relayEvents( Object o , Array events )
+ :
+ voidRelays 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. | Observable |
| removeListener( String eventName , Function handler , [Object scope ] )
+ :
+ voidRemoves an event handler. Removes an event handler. | Observable |
| resumeEvents()
+ :
+ voidResume firing events. (see suspendEvents)
+If events were suspended using the queueSuspended parameter, then all
event... Resume firing events. (see suspendEvents)
If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. | Observable |
| selectAll()
- :
- voidSelects all rows if the selection model
+events fired during event suspension will be sent to any listeners now. | Observable |
| selectAll()
+ :
+ voidSelects all rows if the selection model
is not locked. | RowSelectionModel |
| selectFirstRow()
- :
- voidSelects the first row in the grid. Selects the first row in the grid. | RowSelectionModel |
| selectLastRow( [Boolean keepExisting ] )
- :
- void | RowSelectionModel |
| selectNext( [Boolean keepExisting ] )
- :
- BooleanSelects the row immediately following the last selected row. Selects the row immediately following the last selected row. | RowSelectionModel |
| selectPrevious( [Boolean keepExisting ] )
- :
- BooleanSelects the row that precedes the last selected row. Selects the row that precedes the last selected row. | RowSelectionModel |
| selectRange( Number startRow , Number endRow , [Boolean keepExisting ] )
- :
- voidSelects a range of rows if the selection model
-is not locked.
+ is not locked. | RowSelectionModel |
| selectFirstRow()
+ :
+ voidSelects the first row in the grid. Selects the first row in the grid. | RowSelectionModel |
| selectLastRow( [Boolean keepExisting ] )
+ :
+ void | RowSelectionModel |
| selectNext( [Boolean keepExisting ] )
+ :
+ BooleanSelects the row immediately following the last selected row. Selects the row immediately following the last selected row. | RowSelectionModel |
| selectPrevious( [Boolean keepExisting ] )
+ :
+ BooleanSelects the row that precedes the last selected row. Selects the row that precedes the last selected row. | RowSelectionModel |
| selectRange( Number startRow , Number endRow , [Boolean keepExisting ] )
+ :
+ voidSelects a range of rows if the selection model
+is not locked.
All rows in between startRow and endRow are also select... Selects a range of rows if the selection model
is not locked.
-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: | RowSelectionModel |
| selectRecords( Array records , [Boolean keepExisting ] )
- :
- void | RowSelectionModel |
| selectRow( Number row , [Boolean keepExisting ], [Boolean preventViewNotify ] )
- :
- voidSelects a row. Before selecting a row, checks if the selection model
-is locked and fires the
+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: | RowSelectionModel |
| selectRecords( Array records , [Boolean keepExisting ] )
+ :
+ void | RowSelectionModel |
| selectRow( Number row , [Boolean keepExisting ], [Boolean preventViewNotify ] )
+ :
+ voidSelects a row. Before selecting a row, checks if the selection model
+is locked and fires the
beforerowselect event. ... Selects a row. Before selecting a row, checks if the selection model
is locked and fires the
beforerowselect event. If these checks are satisfied the row
will be selected and followed up by firing the rowselect and
selectionchange events. Parameters:row : NumberThe index of the row to select keepExisting : Boolean(optional) true to keep existing selections preventViewNotify : Boolean(optional) Specify true to
-prevent notifying the view (disables updating the selected appearance) Returns: | RowSelectionModel |
| selectRows( Array rows , [Boolean keepExisting ] )
- :
+prevent notifying the view (disables updating the selected appearance)Returns: | RowSelectionModel |
| selectRows( Array rows , [Boolean keepExisting ] )
+ :
void | RowSelectionModel |
| suspendEvents( Boolean queueSuspended )
- :
+existing selections (defaults to false)Returns: | RowSelectionModel |
| suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events; Returns: | Observable |
| un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) | Observable |
| unlock()
- :
- void | AbstractSelectionModel |