Print Friendly

Class Ext.grid.CellSelectionModel

Package:Ext.grid
Class:CellSelectionModel
Extends:Observable
Defined In:CellSelectionModel.js

Properties   -  Methods   -  Events

Public Properties

This class has no public properties.

Public Methods

Method Defined By
  CellSelectionModel(Object config) CellSelectionModel
  addListener(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this component
  clearSelections() : void CellSelectionModel
Clears all selections.
  fireEvent(String eventName, Object... args) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  hasSelection() : Boolean CellSelectionModel
Returns True if there is a selection.
  on(String eventName, Function handler, [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
  select(Number rowIndex, Number collIndex) : void CellSelectionModel
Selects a cell.
  un(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener (shorthand for removeListener)

Public Events

Event Defined By
  beforerowselect : (SelectionModel this, Number rowIndex, Number colIndex) CellSelectionModel
Fires before a cell is selected.
  cellselect : (SelectionModel this, Number rowIndex, Number colIndex) CellSelectionModel
Fires when a cell is selected.
  selectionchange : (SelectionModel this, Object selection) CellSelectionModel
Fires when the active selection changes.

Constructor Details

CellSelectionModel

public function CellSelectionModel(Object config)
Parameters:
  • config : Object

Method Details

addListener

public function addListener(String eventName, Function handler, [Object options])
Appends an event handler to this component
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • options : Object
    (optional)
Returns:
  • void
This method is defined by Observable.

clearSelections

public function clearSelections()
Clears all selections.
Parameters:
  • None.
Returns:
  • void
This method is defined by CellSelectionModel.

fireEvent

public function fireEvent(String eventName, Object... args)
Fires the specified event with the passed parameters (minus the event name).
Parameters:
  • eventName : String
  • 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
This method is defined by Observable.

hasSelection

public function hasSelection()
Returns True if there is a selection.
Parameters:
  • None.
Returns:
  • Boolean
This method is defined by CellSelectionModel.

on

public function on(String eventName, Function handler, [Object options])
Appends an event handler to this element (shorthand for addListener)
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The method the event invokes
  • options : Object
    (optional)
Returns:
  • void
This method is defined by Observable.

purgeListeners

public function purgeListeners()
Removes all listeners for this object
Parameters:
  • None.
Returns:
  • void
This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])
Removes a listener
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The handler to remove
  • scope : Object
    (optional) The scope (this object) for the handler
Returns:
  • void
This method is defined by Observable.

select

public function select(Number rowIndex, Number collIndex)
Selects a cell.
Parameters:
  • rowIndex : Number
  • collIndex : Number
Returns:
  • void
This method is defined by CellSelectionModel.

un

public function un(String eventName, Function handler, [Object scope])
Removes a listener (shorthand for removeListener)
Parameters:
  • eventName : String
    The type of event to listen for
  • handler : Function
    The handler to remove
  • scope : Object
    (optional) The scope (this object) for the handler
Returns:
  • void
This method is defined by Observable.

Event Details

beforerowselect

public event beforerowselect
Fires before a cell is selected.
Subscribers will be called with the following parameters:
  • this : SelectionModel
  • rowIndex : Number
    The selected row index
  • colIndex : Number
    The selected cell index
This event is defined by CellSelectionModel.

cellselect

public event cellselect
Fires when a cell is selected.
Subscribers will be called with the following parameters:
  • this : SelectionModel
  • rowIndex : Number
    The selected row index
  • colIndex : Number
    The selected cell index
This event is defined by CellSelectionModel.

selectionchange

public event selectionchange
Fires when the active selection changes.
Subscribers will be called with the following parameters:
  • this : SelectionModel
  • selection : Object
    null for no selection or an object (o) with two properties
    • o.record: the record object for the row the selection is in
    • o.cell: An array of [rowIndex, columnIndex]
This event is defined by CellSelectionModel.

yui-ext - Copyright © 2006 Jack Slocum. | Yahoo! UI - Copyright © 2006 Yahoo! Inc.
All rights reserved.