打印版式

Class Ext.grid.RowSelectionModel

Package:Ext.grid
Class:RowSelectionModel
Extends:AbstractSelectionModel
Defined In:RowSelectionModel.js
The default SelectionModel used by Ext.grid.Grid. It supports multiple selections and keyboard selection/navigation.


属性   -  方法   -  事件   -  设置选项

公共属性

此类没有公共属性。

公共方法

方法 定义对象
  RowSelectionModel(Object config) RowSelectionModel
  addEvents(Object object) : void Observable
将对象中没有的事件从给出的对象中复制过来。
  addListener(String eventName, Function handler, [Object scope], [Object options]) : void Observable
为该组件加入事件处理器函数
  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
触发指定的事件, 并将参数传入（至少要有事件名称）。
  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
检查该对象是否拥有指定事件的侦听器
  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
Lock the selections
  on(String eventName, Function handler, [Object options]) : void Observable
为该组件加入事件处理器函数, addListener 的简写方式
  purgeListeners() : void Observable
从对象身上移除所有的侦听器
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器
  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
移除侦听器, removeListener 的简写方式
  unlock() : void AbstractSelectionModel
Unlock the selections

公共事件

事件 定义对象
  beforerowselect : (SelectionModel this, Number rowIndex) RowSelectionModel
Fires when a row is selected being selected, return false to cancel.
  rowselect : (SelectionModel this, Number rowIndex) RowSelectionModel
Fires when a row is selected.
  selectionchange : (SelectionModel this) RowSelectionModel
Fires when the selection changes

设置选项

设置选项 定义对象
  singleSelect : Boolean RowSelectionModel
True to allow selection of only one row at a time (defaults to false)

构造函数

RowSelectionModel

public function RowSelectionModel(Object config)
参数：
  • config : Object

方法详情

addEvents

public function addEvents(Object object)
将对象中没有的事件从给出的对象中复制过来。给出的对象必须也继承于 Observable 对象此方法才会有效果。
参数：
  • object : Object
    要复制事件的源对象
返回：
  • void
This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object scope], [Object options])
为组件添加一个事件监听器
参数：
  • eventName : String
    侦听事件的类型
  • handler : Function
    事件调用的方法
  • scope : Object
    （可选）处理函数执行的作用域。处理函数 "this" 的内容。
  • options : Object
    （可选）一个包含处理设置属性的对象。可以包含下列的属性：
    • scope {Object} 处理函数执行的作用域。处理函数 "this" 的内容。
    • delegate {String} 一个简单的选择器用来过滤目标或查找目标的子节点。
    • stopEvent {Boolean} 值为 True 时用来中止事件。那样将中止传播，并防止缺省动作。
    • preventDefault {Boolean} 值为 True 时用来防止缺省动作。
    • stopPropagation {Boolean} 值为 True 时用来中止事件传播。
    • normalized {Boolean} 值为 False 时向处理函数传递浏览器事件用以代替 Ext.EventObject 对象。
    • delay {Number} 当事件触发后启用处理函数的延迟微秒数。
    • single {Boolean} 值为 True 时将添加一个处理函数用来处理下个触发的事件，并在处理完后移除。
    • buffer {Number} 使处理函数计划在由 Ext.util.DelayedTask 指定的微秒数后执行。如果事件在延迟期间再次触发，原来的处理函数将不再启动，而是由新的计划代替。

    组合选项
    使用选项参数可以组合不同类型的监听器：

    下面是一个标准的、延迟执行的、一次性的监听器，将会自动停止事件并传递一个自定义的参数(forumId)

    代码： 
    el.on('click', this.onClick, this, { single: true, delay: 100, stopEvent : true, forumId: 4 });

    这个方法也允许传递的单个参数是一个包含多个指定处理函数的设置对象。

    一次调用多个处理函数
    代码：

    el.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });

    或者简写为：
    代码：

    el.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
返回：
  • void
This method is defined by Observable.

clearSelections

public function clearSelections()
Clears all selections.
参数：
  • 无。
返回：
  • void
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.
参数：
  • startRow : Number
    The index of the first row in the range
  • endRow : Number
    The index of the last row in the range
返回：
  • void
This method is defined by RowSelectionModel.

deselectRow

public function deselectRow(Number row)
Deselects a row.
参数：
  • row : Number
    The index of the row to deselect
返回：
  • void
This method is defined by RowSelectionModel.

fireEvent

public function fireEvent(String eventName, Object... args)
触发指定的事件并给出参数（至少要有事件名称）。
参数：
  • eventName : String
  • args : Object...
    传入处理函数的参数
返回：
  • Boolean
    如果任何处理函数返回 false 则返回值为 false, 否则返回 true。
This method is defined by Observable.

getCount

public function getCount()
Gets the number of selected rows.
参数：
  • 无。
返回：
  • Number
This method is defined by RowSelectionModel.

getSelected

public function getSelected()
Returns the first selected record.
参数：
  • 无。
返回：
  • Record
This method is defined by RowSelectionModel.

getSelections

public function getSelections()
Returns the selected records
参数：
  • 无。
返回：
  • Array
    Array of selected records
This method is defined by RowSelectionModel.

hasListener

public function hasListener(String eventName)
检查该对象是否拥有指定事件的侦听器
参数：
  • eventName : String
    查询事件之名称
返回：
  • Boolean
    值为 True 值表示事件监听器存在, 否则值为 false。
This method is defined by Observable.

hasSelection

public function hasSelection()
Returns True if there is a selection.
参数：
  • 无。
返回：
  • Boolean
This method is defined by RowSelectionModel.

isIdSelected

public function isIdSelected(String id)
Returns True if the specified record id is selected.
参数：
  • id : String
    The id of record to check
返回：
  • Boolean
This method is defined by RowSelectionModel.

isLocked

public function isLocked()
Returns true if the selections are locked
参数：
  • 无。
返回：
  • Boolean
This method is defined by AbstractSelectionModel.

isSelected

public function isSelected(Number/Record record)
Returns True if the specified row is selected.
参数：
  • record : Number/Record
    The record or index of the record to check
返回：
  • Boolean
This method is defined by RowSelectionModel.

lock

public function lock()
Lock the selections
参数：
  • 无。
返回：
  • void
This method is defined by AbstractSelectionModel.

on

public function on(String eventName, Function handler, [Object options])
为该组件加入事件处理器函数, addListener 的简写方式
参数：
  • eventName : String
    侦听事件的类型
  • handler : Function
    事件调用的方法
  • options : Object
    （可选）
返回：
  • void
This method is defined by Observable.

purgeListeners

public function purgeListeners()
从对象身上移除所有的侦听器
参数：
  • 无。
返回：
  • void
This method is defined by Observable.

removeListener

public function removeListener(String eventName, Function handler, [Object scope])
移除侦听器
参数：
  • eventName : String
    侦听事件的类型
  • handler : Function
    删除的处理函数
  • scope : Object
    （可选） The scope (this object) for the handler
返回：
  • void
This method is defined by Observable.

selectAll

public function selectAll()
Selects all rows.
参数：
  • 无。
返回：
  • void
This method is defined by RowSelectionModel.

selectFirstRow

public function selectFirstRow()
Selects the first row in the grid.
参数：
  • 无。
返回：
  • void
This method is defined by RowSelectionModel.

selectLastRow

public function selectLastRow([Boolean keepExisting])
Select the last row.
参数：
  • keepExisting : Boolean
    （可选） True to keep existing selections
返回：
  • void
This method is defined by RowSelectionModel.

selectNext

public function selectNext([Boolean keepExisting])
Selects the row immediately following the last selected row.
参数：
  • keepExisting : Boolean
    （可选） True to keep existing selections
返回：
  • void
This method is defined by RowSelectionModel.

selectPrevious

public function selectPrevious([Boolean keepExisting])
Selects the row that precedes the last selected row.
参数：
  • keepExisting : Boolean
    （可选） True to keep existing selections
返回：
  • void
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.
参数：
  • startRow : Number
    The index of the first row in the range
  • endRow : Number
    The index of the last row in the range
  • keepExisting : Boolean
    （可选） True to retain existing selections
返回：
  • void
This method is defined by RowSelectionModel.

selectRecords

public function selectRecords(Array records, [Boolean keepExisting])
Select records.
参数：
  • records : Array
    The records to select
  • keepExisting : Boolean
    （可选） True to keep existing selections
返回：
  • void
This method is defined by RowSelectionModel.

selectRow

public function selectRow(Number row, [Boolean keepExisting])
Selects a row.
参数：
  • row : Number
    The index of the row to select
  • keepExisting : Boolean
    （可选） True to keep existing selections
返回：
  • void
This method is defined by RowSelectionModel.

selectRows

public function selectRows(Array rows, [Boolean keepExisting])
Selects multiple rows.
参数：
  • rows : Array
    Array of the indexes of the row to select
  • keepExisting : Boolean
    （可选） True to keep existing selections
返回：
  • void
This method is defined by RowSelectionModel.

un

public function un(String eventName, Function handler, [Object scope])
移除侦听器, removeListener 的简写方式
参数：
  • eventName : String
    侦听事件的类型
  • handler : Function
    删除的处理函数
  • scope : Object
    （可选） The scope (this object) for the handler
返回：
  • void
This method is defined by Observable.

unlock

public function unlock()
Unlock the selections
参数：
  • 无。
返回：
  • void
This method is defined by AbstractSelectionModel.

事件详情

beforerowselect

public event beforerowselect
Fires when a row is selected being selected, return false to cancel.
Subscribers will be called with the following parameters:
  • this : SelectionModel
  • rowIndex : Number
    The selected index
This event is defined by RowSelectionModel.

rowselect

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

selectionchange

public event selectionchange
Fires when the selection changes
Subscribers will be called with the following parameters:
  • this : SelectionModel
This event is defined by RowSelectionModel.

设置详情

singleSelect

singleSelect : Boolean
True to allow selection of only one row at a time (defaults to false)
This config option is defined by RowSelectionModel.
Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.