X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/api/Ext.selection.CheckboxModel.html?ds=sidebyside diff --git a/docs/api/Ext.selection.CheckboxModel.html b/docs/api/Ext.selection.CheckboxModel.html deleted file mode 100644 index dd21f4f3..00000000 --- a/docs/api/Ext.selection.CheckboxModel.html +++ /dev/null @@ -1,481 +0,0 @@ -Ext.selection.CheckboxModel | Ext JS 4.0 Documentation -
For up to date documentation and features, visit -http://docs.sencha.com/ext-js/4-0

Sencha Documentation

- - - - - -

Hierarchy

A selection model that renders a column of checkboxes that can be toggled to -select or deselect rows. The default mode for this selection model is MULTI.

- -

The selection model will inject a header for the checkboxes in the first view -and according to the 'injectCheckbox' configuration.

-
Defined By

Config Options

Other Configs

 
Allow users to deselect a record in a DataView, List or Grid. Only applicable when the SelectionModel's mode is 'SING...

Allow users to deselect a record in a DataView, List or Grid. Only applicable when the SelectionModel's mode is 'SINGLE'. Defaults to false.

-
 

true if rows can only be selected by clicking on the -checkbox column (defaults to false).

-

true if rows can only be selected by clicking on the -checkbox column (defaults to false).

-
 

Turns on/off keyboard navigation within the grid. Defaults to true.

-

Turns on/off keyboard navigation within the grid. Defaults to true.

-
 
Instructs the SelectionModel whether or not to inject the checkbox header -automatically or not. (Note: By not placing...

Instructs the SelectionModel whether or not to inject the checkbox header -automatically or not. (Note: By not placing the checkbox in manually, the -grid view will need to be rendered 2x on initial render.) -Supported values are a Number index, false and the strings 'first' and 'last'. -Default is 0.

-
 
(optional) A config object containing one or more event handlers to be added to this -object during initialization. T...

(optional)

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.

- -

DOM events from ExtJs Components

- - -

While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this - - -

is usually only done when extra value can be added. For example the DataView's -click event passing the node clicked on. To access DOM -events directly from a child element of a Component, we need to specify the element option to -identify the Component property to add a DOM listener to:

- -
new Ext.panel.Panel({
-    width: 400,
-    height: 200,
-    dockedItems: [{
-        xtype: 'toolbar'
-    }],
-    listeners: {
-        click: {
-            element: 'el', //bind to the underlying el property on the panel
-            fn: function(){ console.log('click el'); }
-        },
-        dblclick: {
-            element: 'body', //bind to the underlying body property on the panel
-            fn: function(){ console.log('dblclick body'); }
-        }
-    }
-});
-
- - -

-
 

Modes of selection. -Valid values are SINGLE, SIMPLE, and MULTI. Defaults to 'MULTI'

-

Modes of selection. -Valid values are SINGLE, SIMPLE, and MULTI. Defaults to 'MULTI'

-
Defined By

Properties

 

READ-ONLY A MixedCollection that maintains all of the currently selected -records.

-

READ-ONLY A MixedCollection that maintains all of the currently selected -records.

-
Defined By

Methods

 
addEvents( -Object/String o, String ) - : void

Adds 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.

-

Parameters

  • o : Object/String

    Either an object with event names as properties with a value of true -or the first event name string if multiple event names are being passed as separate parameters.

    -
  • : String

    [additional] Optional additional event names if multiple event names are being passed as separate parameters. -Usage:

    - -
    this.addEvents('storeloaded', 'storecleared');
    -
    - -

Returns

  • void    -
 
addListener( -String eventName, Function handler, [Object scope], [Object options]) - : void

Appends an event handler to this object.

-

Appends an event handler to this object.

-

Parameters

  • eventName : String

    The name of the event to listen for. May also be an object who's property names are event names. See

    -
  • handler : Function

    The 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:

      -
    • scope : Object
      The scope (this reference) in which the handler function is executed. -If omitted, defaults to the object which fired the event.
    • -
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the 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.
    • -
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not -if the event was bubbled up from a child Observable.
    • -
    • element : String
      This option is only valid for listeners bound to Components. -The name of a Component property which references an element to add a listener to.

      - -

      This option is useful during Component construction to add DOM event listeners to elements of Components which -will exist only after the Component is rendered. For example, to add a click listener to a Panel's body: -

      new Ext.panel.Panel({
      -    title: 'The title',
      -    listeners: {
      -        click: this.handlePanelClick,
      -        element: 'body'
      -    }
      -});
      -

      - - -

      When added in this way, the options available are the options applicable to Ext.core.Element.addListener

      - - -

    • -

    - -

    -Combining Options
    -Using the options argument, it is possible to combine different types of listeners:
    -
    -A delayed, one-time listener. -

    myPanel.on('hide', this.handleClick, this, {
    -single: true,
    -delay: 100
    -});
    -

    -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 events. For example: -

    myGridPanel.on({
    -    cellClick: this.onCellClick,
    -    mouseover: this.onMouseOver,
    -    mouseout: this.onMouseOut,
    -    scope: this // Important. Ensure "this" is correct during handler execution
    -});
    -
    . -

    - -

Returns

  • void    -
 
addManagedListener( -Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) - : void

Adds listeners to any Observable object (or Element) which are automatically removed when this Component -is destroyed. - -

Adds listeners to any Observable object (or Element) which are automatically removed when this Component -is destroyed. - -

Parameters

  • item : Observable/Element

    The item to which to add a listener/listeners.

    -
  • ename : Object/String

    The event name, or an object containing event name properties.

    -
  • fn : Function

    Optional. If the ename parameter was an event name, this -is the handler function.

    -
  • scope : Object

    Optional. If the ename parameter was an event name, this -is the scope (this reference) in which the handler function is executed.

    -
  • opt : Object

    Optional. If the ename parameter was an event name, this -is the addListener options.

    -

Returns

  • void    -
 
capture( -Observable o, Function fn, [Object scope]) - : void
Starts capture on the specified Observable. All events will be passed -to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed -to the supplied function with the event name + standard signature of the event -before the event is fired. If the supplied function returns false, -the event will not fire.

-

Parameters

  • o : Observable

    The Observable to capture events from.

    -
  • fn : Function

    The function to call when an event is fired.

    -
  • scope : Object

    (optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.

    -

Returns

  • void    -
 

Removes all listeners for this object including the managed listeners

-

Removes all listeners for this object including the managed listeners

-

Returns

  • void    -
 

Removes all managed listeners for this object.

-

Removes all managed listeners for this object.

-

Returns

  • void    -
 
deselect( -Ext.data.Model/Index records, Boolean suppressEvent) - : void

Deselects a record instance by record instance or index.

-

Deselects a record instance by record instance or index.

-

Parameters

  • records : Ext.data.Model/Index

    An array of records or an index

    -
  • suppressEvent : Boolean

    Set to false to not fire a deselect event

    -

Returns

  • void    -
 
enableBubble( -String/Array events) - : void
Enables 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.Base, {
-//  Add functionality to Field's initComponent to enable the change event to bubble
-initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, 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');
-    }
-}
-});
-
- -

Parameters

  • events : String/Array

    The event name to bubble, or an Array of event names.

    -

Returns

  • void    -
 
fireEvent( -String eventName, Object... args) - : Boolean
Fires the specified event with the passed parameters (minus the event name). - - -An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

- - -

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) -by calling enableBubble.

- -

Parameters

  • eventName : String

    The name of the event to fire.

    -
  • args : Object...

    Variable number of parameters are passed to handlers.

    -

Returns

  • Boolean   

    returns false if any of the handlers return false otherwise it returns true.

    -
 

Retrieve a configuration to be used in a HeaderContainer. -This should be used when injectCheckbox is set to false.

-

Retrieve a configuration to be used in a HeaderContainer. -This should be used when injectCheckbox is set to false.

-

Returns

  • void    -
 

Returns the last selected record.

-

Returns the last selected record.

-

Returns

  • void    -
 

Returns an array of the currently selected records.

-

Returns an array of the currently selected records.

-

Returns

  • void    -
 

Returns the current selectionMode. SINGLE, MULTI or SIMPLE.

-

Returns the current selectionMode. SINGLE, MULTI or SIMPLE.

-

Returns

  • void    -
 
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

  • eventName : String

    The name of the event to check for

    -

Returns

  • Boolean   

    True if the event is being listened for, else false

    -
 

Returns true if there is a selected record.

-

Returns true if there is a selected record.

-

Returns

  • Boolean    -
 

Determines if this record is currently focused.

-

Determines if this record is currently focused.

-

Parameters

  • Ext : Object

    .data.Record record

    -

Returns

  • void    -
 

Returns true if the selections are locked.

-

Returns true if the selections are locked.

-

Returns

  • Boolean    -
 
isSelected( -Record/Number record) - : Boolean

Returns true if the specified row is selected.

-

Returns true if the specified row is selected.

-

Parameters

  • record : Record/Number

    The record or index of the record to check

    -

Returns

  • Boolean    -
 
observe( -Function c, Object listeners) - : void
Sets observability on the passed class constructor. - -This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

- -

This makes any event fired on any instance of the passed class also fire a single event through -the class allowing for central handling of events on many instances at once.

- -

Usage:

- -
Ext.util.Observable.observe(Ext.data.Connection);
-Ext.data.Connection.on('beforerequest', function(con, options) {
-    console.log('Ajax request made to ' + options.url);
-});
-
-

Parameters

  • c : Function

    The class constructor to make observable.

    -
  • listeners : Object

    An object containing a series of listeners to add. See addListener.

    -

Returns

  • void    -
 
on( -String eventName, Function handler, [Object scope], [Object options]) - : void

Appends an event handler to this object (shorthand for addListener.)

-

Appends an event handler to this object (shorthand for addListener.)

-

Parameters

  • eventName : String

    The type of event to listen for

    -
  • handler : Function

    The 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

  • void    -
 
onHeaderClick( -Object headerCt, Object header, Object e) - : void

Toggle between selecting all and deselecting all when clicking on -a checkbox header.

-

Toggle between selecting all and deselecting all when clicking on -a checkbox header.

-

Parameters

  • headerCt : Object
    -
  • header : Object
    -
  • e : Object
    -

Returns

  • void    -
 
relayEvents( -Object origin, Array events, Object prefix) - : 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

  • origin : Object

    The Observable whose events this object is to relay.

    -
  • events : Array

    Array of event names to relay.

    -
  • prefix : Object
    -

Returns

  • void    -
 

Removes all added captures from the Observable.

-

Removes all added captures from the Observable.

-

Parameters

  • o : Observable

    The Observable to release

    -

Returns

  • void    -
 
removeListener( -String eventName, Function handler, [Object scope]) - : void

Removes an event handler.

-

Removes an event handler.

-

Parameters

  • eventName : String

    The type of event the handler was associated with.

    -
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    -
  • scope : Object

    (optional) The scope originally specified for the handler.

    -

Returns

  • void    -
 
removeManagedListener( -Observable|Element item, Object|String ename, Function fn, Object scope) - : void

Removes listeners that were added by the mon method.

-

Removes listeners that were added by the mon method.

-

Parameters

  • item : Observable|Element

    The item from which to remove a listener/listeners.

    -
  • ename : Object|String

    The event name, or an object containing event name properties.

    -
  • fn : Function

    Optional. If the ename parameter was an event name, this -is the handler function.

    -
  • scope : Object

    Optional. If the ename parameter was an event name, this -is the scope (this reference) in which the handler function is executed.

    -

Returns

  • void    -
 
renderer( -Object value, Object metaData, Object record, Object rowIndex, Object colIndex, Object store, Object view) - : void
Generates the HTML to be rendered in the injected checkbox column for each row. -Creates the standard checkbox markup ...

Generates the HTML to be rendered in the injected checkbox column for each row. -Creates the standard checkbox markup by default; can be overridden to provide custom rendering. -See Ext.grid.column.Column.renderer for description of allowed parameters.

-

Parameters

  • value : Object
    -
  • metaData : Object
    -
  • record : Object
    -
  • rowIndex : Object
    -
  • colIndex : Object
    -
  • store : Object
    -
  • view : Object
    -

Returns

  • void    -
 
Resume 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.

-

Returns

  • void    -
 
select( -Ext.data.Model/Index records, Boolean keepExisting, Boolean suppressEvent) - : void

Selects a record instance by record instance or index.

-

Selects a record instance by record instance or index.

-

Parameters

  • records : Ext.data.Model/Index

    An array of records or an index

    -
  • keepExisting : Boolean
    -
  • suppressEvent : Boolean

    Set to false to not fire a select event

    -

Returns

  • void    -
 
selectRange( -Ext.data.Model/Number startRow, Ext.data.Model/Number endRow, [Boolean keepExisting], Object dir) - : void
Selects 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 : Ext.data.Model/Number

    The record or index of the first row in the range

    -
  • endRow : Ext.data.Model/Number

    The record or index of the last row in the range

    -
  • keepExisting : Boolean

    (optional) True to retain existing selections

    -
  • dir : Object
    -

Returns

  • void    -
 
setLastFocused( -Ext.data.Model record, Object supressFocus) - : void

 

-

Parameters

  • record : Ext.data.Model

    Set a record as the last focused record. This does NOT mean -that the record has been selected.

    -
  • supressFocus : Object
    -

Returns

  • void    -
 
setLocked( -Boolean locked) - : void

Locks the current selection and disables any changes from -happening to the selection.

-

Locks the current selection and disables any changes from -happening to the selection.

-

Parameters

  • locked : Boolean
    -

Returns

  • void    -
 

Sets the current selectionMode. SINGLE, MULTI or SIMPLE.

-

Sets the current selectionMode. SINGLE, MULTI or SIMPLE.

-

Parameters

  • selMode : Object
    -

Returns

  • void    -
 
suspendEvents( -Boolean queueSuspended) - : void

Suspend the firing of all events. (see resumeEvents)

-

Suspend the firing of all events. (see resumeEvents)

-

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired -after the resumeEvents call instead of discarding all suspended events;

    -

Returns

  • void    -
 
un( -String eventName, Function handler, [Object scope]) - : void

Removes an event handler (shorthand for removeListener.)

-

Removes an event handler (shorthand for removeListener.)

-

Parameters

  • eventName : String

    The type of event the handler was associated with.

    -
  • handler : Function

    The handler to remove. This must be a reference to the function passed into the addListener call.

    -
  • scope : Object

    (optional) The scope originally specified for the handler.

    -

Returns

  • void    -
Defined By

Events

 
deselect( -Ext.selection.RowSelectionModel this, Ext.data.Model record, Number index) -

Fired after a record is deselected

-

Fired after a record is deselected

-

Parameters

  • this : Ext.selection.RowSelectionModel
    -
  • record : Ext.data.Model

    The deselected record

    -
  • index : Number

    The row index deselected

    -
 
select( -Ext.selection.RowSelectionModel this, Ext.data.Model record, Number index) -

Fired after a record is selected

-

Fired after a record is selected

-

Parameters

  • this : Ext.selection.RowSelectionModel
    -
  • record : Ext.data.Model

    The selected record

    -
  • index : Number

    The row index selected

    -
 
selectionchange( -Ext.selection.Model this, Array selected) -

Fired after a selection change has occurred

-

Fired after a selection change has occurred

-

Parameters

  • this : Ext.selection.Model
    -
  • selected : Array

    The selected records

    -
\ No newline at end of file