Class Ext.grid.Grid

Package:	Ext.grid
Class:	Grid
Extends:	Observable
Subclasses:	EditorGrid
Defined In:	Grid.js

This class represents the primary interface of a component based grid control.

Usage:

var grid = new Ext.grid.Grid("my-container-id", dataSource, columnModel);
 // set any options
 grid.render();
 // or using a config
 var grid = new Ext.grid.Grid("my-container-id", {
     dataModel: myDataModel,
     colModel: myColModel,
     selModel: mySelectionModel,
     autoSizeColumns: true,
     monitorWindowResize: false,
     trackMouseOver: true
 }).render();

Common Problems:
- Grid does not resize properly when going smaller: Setting overflow hidden on the container element will correct this
- If you get el.style[camel]= NaNpx or -2px or something related, be certain you have given your container element dimensions. The grid adapts to your container's size, if your container has no size defined then the results are unpredictable.
- Do not render the grid into an element with display:none. Try using visibility:hidden. Otherwise there is no way for the grid to calculate dimensions/offsets.

Properties - Methods - Events

Public Properties

Property		Defined By
	allowTextSelectionPattern : Object	Grid
	A regular expression defining tagNames allowed to have text selection (Defaults to `/INPUT\|TEXTAREA\|SELECT/i`)	Grid
	autoExpandColumn : String	Grid
	The id of a column in this grid that should expand to fill unused space	Grid
	autoExpandMax : Number	Grid
	The maximum width the autoExpandColumn can have (if enabled)	Grid
	autoExpandMin : Number	Grid
	The minimum width the autoExpandColumn can have (if enabled)	Grid
	autoHeight : Boolean	Grid
	True to fit the height of the grid container to the height of the data (defaults to false)	Grid
	autoSizeColumns : Boolean	Grid
	True to automatically resize the columns to fit their content on initial render	Grid
	autoSizeHeaders : Boolean	Grid
	True to measure headers with column data when auto sizing columns	Grid
	ddText : String	Grid
	Configures the text is the drag proxy (defaults to "%0 selected row(s)"). %0 is replaced with the number of selected...	Grid
	enableColumnHide : Boolean	Grid
	True to enable hiding of columns with the header context menu	Grid
	enableColumnMove : Boolean	Grid
	True to enable drag and drop reorder of columns	Grid
	enableDragDrop : Boolean	Grid
	True to enable drag and drop of rows	Grid
	enableRowHeightSync : Boolean	Grid
	True to manually sync row heights across locked and not locked rows	Grid
	loadMask : Boolean/Object	Grid
	A Ext.LoadMask config or true to mask the grid while loading (defaults to false)	Grid
	maxRowsToMeasure : Number	Grid
	If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of rows measured to get a columns size - d...	Grid
	minColumnWidth : Number	Grid
	The minimum width a column can be resized to. (Defaults to 25)	Grid
	monitorWindowResize : Object	Grid
	True to autoSize the grid when the window resizes - defaults to true	Grid
	stripeRows : Boolean	Grid
	True to stripe the rows (default is true)	Grid
	trackMouseOver : Boolean	Grid
	True to highlight rows when the mouse is over (default is false)	Grid
	view : Object	Grid
	The view used by the grid. This can be set before a call to render(). Defaults to a Ext.grid.GridView or PagedGridVi...	Grid

Public Methods

Method		Defined By
	Grid(`String/HTMLElement/Ext.Element container`, `Object config`, [`Object colModel`], [`Object selectionModel`])	Grid
		Grid
	addEvents(`Object object`) : void	Observable
	Copies any events from the passed object onto this object if they do not already exist. The passed object must also ...	Observable
	addListener(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this component	Observable
	autoSize() : void	Grid
	Causes the grid to manually recalculate its dimensions. Generally this is done automatically, but if manual update is...	Grid
	destroy(`Boolean removeEl`) : void	Grid
	Destroy this grid.	Grid
	fireEvent(`String eventName`, `Object... args`) : Boolean	Observable
	Fires the specified event with the passed parameters (minus the event name).	Observable
	getColumnModel() : ColumnModel	Grid
	Returns the grid's ColumnModel.	Grid
	getDataSource() : DataSource	Grid
	Returns the grid's DataSource.	Grid
	getDragDropText() : String	Grid
	Called to get grid's drag proxy text, by default returns this.ddText.	Grid
	getSelectionModel() : SelectionModel	Grid
	Returns the grid's SelectionModel.	Grid
	getView() : GridView	Grid
	Returns the grid's GridView object.	Grid
	hasListener(`String eventName`) : Boolean	Observable
	Checks to see if this object is currently listening for a specified event	Observable
	on(`String eventName`, `Function handler`, [`Object options`]) : void	Observable
	Appends an event handler to this element (shorthand for addListener)	Observable
	purgeListeners() : void	Observable
	Removes all listeners for this object	Observable
	removeListener(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener	Observable
	render() : Ext.grid.Grid	Grid
	* Called once after all setup has been completed and the grid is ready to be rendered.	Grid
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable

Public Events

Event		Defined By
	bodyscroll : (`Number scrollLeft`, `Number scrollTop`)	Grid
	Fires when the body element is scrolled	Grid
	cellclick : (`Grid this`, `Number rowIndex`, `Number columnIndex`, `Ext.EventObject e`)	Grid
	Fires when a cell is clicked	Grid
	cellcontextmenu : (`Grid this`, `Number rowIndex`, `Number cellIndex`, `Ext.EventObject e`)	Grid
	Fires when a cell is right clicked	Grid
	celldblclick : (`Grid this`, `Number rowIndex`, `Number columnIndex`, `Ext.EventObject e`)	Grid
	Fires when a cell is double clicked	Grid
	click : (`Ext.EventObject e`)	Grid
	The raw click event for the entire grid.	Grid
	columnmove : (`Number oldIndex`, `Number newIndex`)	Grid
	Fires when the user moves a column	Grid
	columnresize : (`Number columnIndex`, `Number newSize`)	Grid
	Fires when the user resizes a column	Grid
	contextmenu : (`Ext.EventObject e`)	Grid
	The raw contextmenu event for the entire grid.	Grid
	dblclick : (`Ext.EventObject e`)	Grid
	The raw dblclick event for the entire grid.	Grid
	dragdrop : (`Grid this`, `Ext.GridDD dd`, `String targetId`, `event e`)	Grid
	Fires when dragged row(s) are dropped on a valid DD target	Grid
	dragenter : (`Grid this`, `Ext.GridDD dd`, `String targetId`, `event e`)	Grid
	Fires when the dragged row(s) first cross another DD target while being dragged	Grid
	dragout : (`Grid this`, `Ext.GridDD dd`, `String targetId`, `event e`)	Grid
	Fires when the dragged row(s) leave another DD target while being dragged	Grid
	dragover : (`Grid this`, `Ext.GridDD dd`, `String targetId`, `event e`)	Grid
	Fires while row(s) are being dragged. "targetId" is the id of the Yahoo.util.DD object the selected rows are being dr...	Grid
	enddrag : (`Grid this`, `Ext.GridDD dd`, `event e`)	Grid
	Fires when a drag operation is complete	Grid
	headerclick : (`Grid this`, `Number columnIndex`, `Ext.EventObject e`)	Grid
	Fires when a header is clicked	Grid
	headercontextmenu : (`Grid this`, `Number columnIndex`, `Ext.EventObject e`)	Grid
	Fires when a header is right clicked	Grid
	headerdblclick : (`Grid this`, `Number rowIndex`, `Number columnIndex`, `Ext.EventObject e`)	Grid
	Fires when a header cell is double clicked	Grid
	keydown : (`Ext.EventObject e`)	Grid
	The raw keydown event for the entire grid.	Grid
	keypress : (`Ext.EventObject e`)	Grid
	The raw keypress event for the entire grid.	Grid
	mousedown : (`Ext.EventObject e`)	Grid
	The raw mousedown event for the entire grid.	Grid
	mouseout : (`Ext.EventObject e`)	Grid
	The raw mouseout event for the entire grid.	Grid
	mouseover : (`Ext.EventObject e`)	Grid
	The raw mouseover event for the entire grid.	Grid
	mouseup : (`Ext.EventObject e`)	Grid
	The raw mouseup event for the entire grid.	Grid
	rowclick : (`Grid this`, `Number rowIndex`, `Ext.EventObject e`)	Grid
	Fires when a row is clicked	Grid
	rowcontextmenu : (`Grid this`, `Number rowIndex`, `Ext.EventObject e`)	Grid
	Fires when a row is right clicked	Grid
	rowdblclick : (`Grid this`, `Number rowIndex`, `Ext.EventObject e`)	Grid
	Fires when a row is double clicked	Grid
	startdrag : (`Grid this`, `Ext.GridDD dd`, `event e`)	Grid
	Fires when row(s) start being dragged	Grid

Property Details

allowTextSelectionPattern

public Object allowTextSelectionPattern

A regular expression defining tagNames allowed to have text selection (Defaults to /INPUT|TEXTAREA|SELECT/i)

This property is defined by Grid.

autoExpandColumn

public String autoExpandColumn

The id of a column in this grid that should expand to fill unused space

This property is defined by Grid.

autoExpandMax

public Number autoExpandMax

The maximum width the autoExpandColumn can have (if enabled)

This property is defined by Grid.

autoExpandMin

public Number autoExpandMin

The minimum width the autoExpandColumn can have (if enabled)

This property is defined by Grid.

autoHeight

public Boolean autoHeight

True to fit the height of the grid container to the height of the data (defaults to false)

This property is defined by Grid.

autoSizeColumns

public Boolean autoSizeColumns

True to automatically resize the columns to fit their content on initial render

This property is defined by Grid.

autoSizeHeaders

public Boolean autoSizeHeaders

True to measure headers with column data when auto sizing columns

This property is defined by Grid.

ddText

public String ddText

Configures the text is the drag proxy (defaults to "%0 selected row(s)"). %0 is replaced with the number of selected rows.

This property is defined by Grid.

enableColumnHide

public Boolean enableColumnHide

True to enable hiding of columns with the header context menu

This property is defined by Grid.

enableColumnMove

public Boolean enableColumnMove

True to enable drag and drop reorder of columns

This property is defined by Grid.

enableDragDrop

public Boolean enableDragDrop

True to enable drag and drop of rows

This property is defined by Grid.

enableRowHeightSync

public Boolean enableRowHeightSync

True to manually sync row heights across locked and not locked rows

This property is defined by Grid.

loadMask

public Boolean/Object loadMask

A Ext.LoadMask config or true to mask the grid while loading (defaults to false)

This property is defined by Grid.

maxRowsToMeasure

public Number maxRowsToMeasure

If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of rows measured to get a columns size - defaults to 0 (all rows).

This property is defined by Grid.

minColumnWidth

public Number minColumnWidth

The minimum width a column can be resized to. (Defaults to 25)

This property is defined by Grid.

monitorWindowResize

public Object monitorWindowResize

True to autoSize the grid when the window resizes - defaults to true

This property is defined by Grid.

stripeRows

public Boolean stripeRows

True to stripe the rows (default is true)

This property is defined by Grid.

trackMouseOver

public Boolean trackMouseOver

True to highlight rows when the mouse is over (default is false)

This property is defined by Grid.

view

public Object view

The view used by the grid. This can be set before a call to render(). Defaults to a Ext.grid.GridView or PagedGridView depending on the data model.

This property is defined by Grid.

Constructor Details

Grid

public function Grid(String/HTMLElement/Ext.Element container, Object config, [Object colModel], [Object selectionModel])

Parameters:

container : String/HTMLElement/Ext.Element
The element into which this grid will be rendered - The container MUST have some type of size defined for the grid to fill. The container will be automatically set to position relative if it isn't already.
config : Object
A config object that sets properties on this grid OR the data model to bind to
colModel : Object
(optional) The column model with info about this grid's columns
selectionModel : Object
(optional) The selection model for this grid (defaults to DefaultSelectionModel)

Method Details

addEvents

public function addEvents(Object object)

Copies any events from the passed object onto this object if they do not already exist. The passed object must also inherit from Observable for this method to have any effect.

Parameters:

object : Object
The object from which to copy events

Returns:

void

This method is defined by Observable.

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.

autoSize

public function autoSize()

Causes the grid to manually recalculate its dimensions. Generally this is done automatically, but if manual update is required this method will initiate it.

Parameters:

None.

Returns:

void

This method is defined by Grid.

destroy

public function destroy(Boolean removeEl)

Destroy this grid.

Parameters:

removeEl : Boolean
True to remove the element

Returns:

void

This method is defined by Grid.

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.

getColumnModel

public function getColumnModel()

Returns the grid's ColumnModel.

Parameters:

None.

Returns:

ColumnModel

This method is defined by Grid.

getDataSource

public function getDataSource()

Returns the grid's DataSource.

Parameters:

None.

Returns:

DataSource

This method is defined by Grid.

getDragDropText

public function getDragDropText()

Called to get grid's drag proxy text, by default returns this.ddText.

Parameters:

None.

Returns:

String

This method is defined by Grid.

getSelectionModel

public function getSelectionModel()

Returns the grid's SelectionModel.

Parameters:

None.

Returns:

SelectionModel

This method is defined by Grid.

getView

public function getView()

Returns the grid's GridView object.

Parameters:

None.

Returns:

GridView

This method is defined by Grid.

hasListener

public function hasListener(String eventName)

Checks to see if this object is currently listening 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

This method is defined by Observable.

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.

render

public function render()

* Called once after all setup has been completed and the grid is ready to be rendered.

Parameters:

None.

Returns:

Ext.grid.Grid
this

This method is defined by Grid.

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.