打印版式

Class Ext.grid.ColumnModel

Package:Ext.grid
Class:ColumnModel
Extends:Observable
Defined In:ColumnModel.js
This is the default implementation of a ColumnModel used by the Grid. It defines the columns in the grid.
Usage:
var colModel = new Ext.grid.ColumnModel([
	{header: "Ticker", width: 60, sortable: true, locked: true},
	{header: "Company Name", width: 150, sortable: true},
	{header: "Market Cap.", width: 100, sortable: true},
	{header: "$ Sales", width: 100, sortable: true, renderer: money},
	{header: "Employees", width: 100, sortable: true, resizable: false}
 ]);

The config options listed for this class, are options which may appear in each individual column definition.


属性   -  方法   -  事件

公共属性

属性 定义对象
  config : Object ColumnModel
The config passed into the constructor
  defaultSortable : Boolean ColumnModel
Default sortable of columns which have no sortable specified (defaults to false)
  defaultWidth : Number ColumnModel
The width of columns which have no width specified (defaults to 100)

公共方法

方法 定义对象
  ColumnModel(Object config) ColumnModel
  addEvents(Object object) : void Observable
将对象中没有的事件从给出的对象中复制过来。
  addListener(String eventName, Function handler, [Object scope], [Object options]) : void Observable
为该组件加入事件处理器函数
  fireEvent(String eventName, Object... args) : Boolean Observable
触发指定的事件, 并将参数传入（至少要有事件名称）。
  getCellEditor(Number colIndex, Number rowIndex) : Object ColumnModel
Returns the editor defined for the cell/column.
  getColumnCount() : Number ColumnModel
Returns the number of columns.
  getColumnHeader(Number col) : String ColumnModel
Returns the header for the specified column.
  getColumnId(Number index) : String ColumnModel
* Returns the id of the column at the specified index
  getColumnTooltip(Number col) : String ColumnModel
Returns the tooltip for the specified column.
  getColumnWidth(Number col) : Number ColumnModel
Returns the width for the specified column.
  getDataIndex(Number col) : Number ColumnModel
Returns the dataIndex for the specified column.
  getRenderer(Number col) : Function ColumnModel
Returns the rendering (formatting) function defined for the column.
  getTotalWidth(Boolean includeHidden) : Number ColumnModel
Returns the total width of all columns.
  hasListener(String eventName) : Boolean Observable
检查该对象是否拥有指定事件的侦听器
  isCellEditable(Number colIndex, Number rowIndex) : Boolean ColumnModel
Returns true if the cell is editable.
  isFixed() : void ColumnModel
Returns true if the column width cannot be changed
  isHidden(Number colIndex) : Boolean ColumnModel
Returns true if the column is hidden.
  isResizable() : Boolean ColumnModel
Returns true if the column cannot be resized
  isSortable(Number col) : Boolean ColumnModel
Returns true if the specified column is sortable.
  on(String eventName, Function handler, [Object options]) : void Observable
为该组件加入事件处理器函数, addListener 的简写方式
  purgeListeners() : void Observable
从对象身上移除所有的侦听器
  removeListener(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器
  setColumnHeader(Number col, String header) : void ColumnModel
Sets the header for a column.
  setColumnTooltip(Number col, String tooltip) : void ColumnModel
Sets the tooltip for a column.
  setColumnWidth(Number col, Number width) : void ColumnModel
Sets the width for a column.
  setDataIndex(Number col, Number dataIndex) : void ColumnModel
Sets the dataIndex for a column.
  setEditable(Number col, Boolean editable) : void ColumnModel
Sets if a column is editable.
  setEditor(Number col, Object editor) : void ColumnModel
Sets the editor for a column.
  setHidden(Number colIndex, Boolean hidden) : void ColumnModel
Sets if a column is hidden.
  setRenderer(Number col, Function fn) : void ColumnModel
Sets the rendering (formatting) function for a column.
  un(String eventName, Function handler, [Object scope]) : void Observable
移除侦听器, removeListener 的简写方式

公共事件

事件 定义对象
  columlockchange : (ColumnModel this, Number colIndex, Boolean locked) ColumnModel
Fires when a column's locked state is changed
  columnmoved : (ColumnModel this, Number oldIndex, Number newIndex) ColumnModel
Fires when a column is moved
  headerchange : (ColumnModel this, Number columnIndex, Number newText) ColumnModel
Fires when the text of a header changes
  hiddenchange : (ColumnModel this, Number columnIndex, Number hidden) ColumnModel
Fires when a column is hidden or "unhidden"
  widthchange : (ColumnModel this, Number columnIndex, Number newWidth) ColumnModel
Fires when the width of a column changes

属性详情

config

public Object config
The config passed into the constructor
This property is defined by ColumnModel.

defaultSortable

public Boolean defaultSortable
Default sortable of columns which have no sortable specified (defaults to false)
This property is defined by ColumnModel.

defaultWidth

public Number defaultWidth
The width of columns which have no width specified (defaults to 100)
This property is defined by ColumnModel.

构造函数

ColumnModel

public function ColumnModel(Object config)
参数：
  • config : Object
    An Array of column config objects. See this class's config objects for details.

方法详情

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.

fireEvent

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

getCellEditor

public function getCellEditor(Number colIndex, Number rowIndex)
Returns the editor defined for the cell/column.
参数：
  • colIndex : Number
    The column index
  • rowIndex : Number
    The row index
返回：
  • Object
This method is defined by ColumnModel.

getColumnCount

public function getColumnCount()
Returns the number of columns.
参数：
  • 无。
返回：
  • Number
This method is defined by ColumnModel.

getColumnHeader

public function getColumnHeader(Number col)
Returns the header for the specified column.
参数：
  • col : Number
    The column index
返回：
  • String
This method is defined by ColumnModel.

getColumnId

public function getColumnId(Number index)
* Returns the id of the column at the specified index
参数：
  • index : Number
返回：
  • String
    the id
This method is defined by ColumnModel.

getColumnTooltip

public function getColumnTooltip(Number col)
Returns the tooltip for the specified column.
参数：
  • col : Number
    The column index
返回：
  • String
This method is defined by ColumnModel.

getColumnWidth

public function getColumnWidth(Number col)
Returns the width for the specified column.
参数：
  • col : Number
    The column index
返回：
  • Number
This method is defined by ColumnModel.

getDataIndex

public function getDataIndex(Number col)
Returns the dataIndex for the specified column.
参数：
  • col : Number
    The column index
返回：
  • Number
This method is defined by ColumnModel.

getRenderer

public function getRenderer(Number col)
Returns the rendering (formatting) function defined for the column.
参数：
  • col : Number
    The column index.
返回：
  • Function
    The function used to render the cell. See {@link #setRenderer}.
This method is defined by ColumnModel.

getTotalWidth

public function getTotalWidth(Boolean includeHidden)
Returns the total width of all columns.
参数：
  • includeHidden : Boolean
    True to include hidden column widths
返回：
  • Number
This method is defined by ColumnModel.

hasListener

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

isCellEditable

public function isCellEditable(Number colIndex, Number rowIndex)
Returns true if the cell is editable.
参数：
  • colIndex : Number
    The column index
  • rowIndex : Number
    The row index
返回：
  • Boolean
This method is defined by ColumnModel.

isFixed

public function isFixed()
Returns true if the column width cannot be changed
参数：
  • 无。
返回：
  • void
This method is defined by ColumnModel.

isHidden

public function isHidden(Number colIndex)
Returns true if the column is hidden.
参数：
  • colIndex : Number
    The column index
返回：
  • Boolean
This method is defined by ColumnModel.

isResizable

public function isResizable()
Returns true if the column cannot be resized
参数：
  • 无。
返回：
  • Boolean
This method is defined by ColumnModel.

isSortable

public function isSortable(Number col)
Returns true if the specified column is sortable.
参数：
  • col : Number
    The column index
返回：
  • Boolean
This method is defined by ColumnModel.

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.

setColumnHeader

public function setColumnHeader(Number col, String header)
Sets the header for a column.
参数：
  • col : Number
    The column index
  • header : String
    The new header
返回：
  • void
This method is defined by ColumnModel.

setColumnTooltip

public function setColumnTooltip(Number col, String tooltip)
Sets the tooltip for a column.
参数：
  • col : Number
    The column index
  • tooltip : String
    The new tooltip
返回：
  • void
This method is defined by ColumnModel.

setColumnWidth

public function setColumnWidth(Number col, Number width)
Sets the width for a column.
参数：
  • col : Number
    The column index
  • width : Number
    新宽度
返回：
  • void
This method is defined by ColumnModel.

setDataIndex

public function setDataIndex(Number col, Number dataIndex)
Sets the dataIndex for a column.
参数：
  • col : Number
    The column index
  • dataIndex : Number
    The new dataIndex
返回：
  • void
This method is defined by ColumnModel.

setEditable

public function setEditable(Number col, Boolean editable)
Sets if a column is editable.
参数：
  • col : Number
    The column index
  • editable : Boolean
    True if the column is editable
返回：
  • void
This method is defined by ColumnModel.

setEditor

public function setEditor(Number col, Object editor)
Sets the editor for a column.
参数：
  • col : Number
    The column index
  • editor : Object
    The editor object
返回：
  • void
This method is defined by ColumnModel.

setHidden

public function setHidden(Number colIndex, Boolean hidden)
Sets if a column is hidden.
参数：
  • colIndex : Number
    The column index
  • hidden : Boolean
    True if the column is hidden
返回：
  • void
This method is defined by ColumnModel.

setRenderer

public function setRenderer(Number col, Function fn)
Sets the rendering (formatting) function for a column.
参数：
  • col : Number
    The column index
  • fn : Function
    The function to use to process the cell's raw data to return HTML markup for the grid view. The render function is called with the following parameters:
    • Data value.
    • Cell metadata. An object in which you may set the following attributes:
      • css A CSS style string to apply to the table cell.
      • attr An HTML attribute definition string to apply to the data container element within the table cell.
    • The Ext.data.Record from which the data was extracted.
    • Row index
    • Column index
    • The Ext.data.Store object from which the Record was extracted
返回：
  • void
This method is defined by ColumnModel.

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.

事件详情

columlockchange

public event columlockchange
Fires when a column's locked state is changed
Subscribers will be called with the following parameters:
  • this : ColumnModel
  • colIndex : Number
  • locked : Boolean
    true if locked
This event is defined by ColumnModel.

columnmoved

public event columnmoved
Fires when a column is moved
Subscribers will be called with the following parameters:
  • this : ColumnModel
  • oldIndex : Number
  • newIndex : Number
This event is defined by ColumnModel.

headerchange

public event headerchange
Fires when the text of a header changes
Subscribers will be called with the following parameters:
  • this : ColumnModel
  • columnIndex : Number
    The column index
  • newText : Number
    The new header text
This event is defined by ColumnModel.

hiddenchange

public event hiddenchange
Fires when a column is hidden or "unhidden"
Subscribers will be called with the following parameters:
  • this : ColumnModel
  • columnIndex : Number
    The column index
  • hidden : Number
    true if hidden, false otherwise
This event is defined by ColumnModel.

widthchange

public event widthchange
Fires when the width of a column changes
Subscribers will be called with the following parameters:
  • this : ColumnModel
  • columnIndex : Number
    The column index
  • newWidth : Number
    新宽度
This event is defined by ColumnModel.
Ext - Copyright © 2006-2007 Ext JS, LLC
All rights reserved.