Class Ext.grid.EditorGrid

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

Class for creating and editable grid.

Properties - Methods - Events - Config Options

Public Properties

Property		Defined By
	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

Public Methods

Method		Defined By
	addEvents(`Object object`) : void	Observable
	Used to define events on this Observable	Observable
	addListener(`String eventName`, `Function handler`, [`Object scope`], [`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 has any listeners for a specified event	Observable
	on(`String eventName`, `Function handler`, [`Object scope`], [`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
	startEditing(`Number rowIndex`, `Number colIndex`) : void	EditorGrid
	Starts editing the specified for the specified row/column	EditorGrid
	stopEditing() : void	EditorGrid
	Stops any active editing	EditorGrid
	un(`String eventName`, `Function handler`, [`Object scope`]) : void	Observable
	Removes a listener (shorthand for removeListener)	Observable

Public Events

Event		Defined By
	afteredit : (`Object e`)	EditorGrid
	Fires after a cell is edited. grid - This grid record - The record being edited field - The field name being edited...	EditorGrid
	beforeedit : (`Object e`)	EditorGrid
	Fires before cell editing is triggered. The edit event object has the following properties grid - This grid record ...	EditorGrid
	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
	render : (`Grid grid`)	Grid
	Fires when the grid is rendered	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
	validateedit : (`Object e`)	EditorGrid
	Fires after a cell is edited, but before the value is set in the record. Return false to cancel the change. The edit ...	EditorGrid

Config Options

Config Options		Defined By
	autoExpandColumn : String	Grid
	The id of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.	Grid
	autoExpandMax : Number	Grid
	The maximum width the autoExpandColumn can have (if enabled). Default is 1000.	Grid
	autoExpandMin : Number	Grid
	The minimum width the autoExpandColumn can have (if enabled). Default is 50.	Grid
	autoHeight : Boolean	Grid
	True to fit the height of the grid container to the height of the data. Default is false.	Grid
	autoSizeColumns : Boolean	Grid
	True to automatically resize the columns to fit their content on initial render. It is more efficient to explicitly s...	Grid
	autoSizeHeaders : Boolean	Grid
	True to measure headers with column data when auto sizing columns. Default is true.	Grid
	enableColumnHide : Boolean	Grid
	True to enable hiding of columns with the header context menu. Default is true.	Grid
	enableColumnMove : Boolean	Grid
	True to enable drag and drop reorder of columns. Default is true.	Grid
	enableDragDrop : Boolean	Grid
	True to enable drag and drop of rows. Default is false.	Grid
	enableRowHeightSync : Boolean	Grid
	True to manually sync row heights across locked and not locked rows. Default is false.	Grid
	loadMask : Object	Grid
	An Ext.LoadMask config or true to mask the grid while loading. Default is false.	Grid
	maxHeight : Number	Grid
	Sets the maximum height of the grid - ignored if autoHeight is not on.	Grid
	maxRowsToMeasure : Boolean	Grid
	If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of rows measured to get a columns size. De...	Grid
	minColumnWidth : Number	Grid
	The minimum width a column can be resized to. Default is 25.	Grid
	monitorWindowResize : Boolean	Grid
	True to autoSize the grid when the window resizes. Default is 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 true.	Grid
	view : Object	Grid
	The Ext.grid.GridView used by the grid. This can be set before a call to render().	Grid

Property Details

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.

Method Details

addEvents

public function addEvents(Object object)

Used to define events on this Observable

Parameters:

object : Object
The object with the events defined

Returns:

void

This method is defined by Observable.

addListener

public function addListener(String eventName, Function handler, [Object scope], [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
scope : Object
(optional) The scope in which to execute the handler function. The handler function's "this" context.
options : Object
(optional) An object containing handler configuration properties. This may contain any of the following properties:
- scope {Object} The scope in which to execute the handler function. The handler function's "this" context.
- delay {Number} The number of milliseconds to delay the invocation of the handler after te 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.
Combining Options
Using the options argument, it is possible to combine different types of listeners:

A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
Code:
```
 el.on('click', this.onClick, this, { single: true, delay: 100, forumId: 4 });
```
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 handlers.
Code:
```
 foo.on({ 'click' : { fn: this.onClick scope: this, delay: 100 }, 'mouseover' : { fn: this.onMouseOver scope: this }, 'mouseout' : { fn: this.onMouseOut scope: this } });
```
Or a shorthand syntax:
Code:
```
 foo.on({ 'click' : this.onClick, 'mouseover' : this.onMouseOver, 'mouseout' : this.onMouseOut scope: this });
```

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

This method is defined by Observable.

on

public function on(String eventName, Function handler, [Object scope], [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
scope : Object
(optional) The scope in which to execute the handler function. The handler function's "this" context.
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.

startEditing

public function startEditing(Number rowIndex, Number colIndex)

Starts editing the specified for the specified row/column

Parameters:

rowIndex : Number
colIndex : Number

Returns:

void

This method is defined by EditorGrid.

stopEditing

public function stopEditing()

Stops any active editing

Parameters:

None.

Returns:

void

This method is defined by EditorGrid.

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

afteredit

public event afteredit

Fires after a cell is edited.

grid - This grid
record - The record being edited
field - The field name being edited
value - The value being set
originalValue - The original value for the field, before the edit.
row - The grid row index
column - The grid column index

Subscribers will be called with the following parameters:

e : Object
An edit event (see above for description)

This event is defined by EditorGrid.

beforeedit

public event beforeedit

Fires before cell editing is triggered. The edit event object has the following properties

grid - This grid
record - The record being edited
field - The field name being edited
value - The value for the field being edited.
row - The grid row index
column - The grid column index
cancel - Set this to true to cancel the edit or return false from your handler.

Subscribers will be called with the following parameters:

e : Object
An edit event (see above for description)

This event is defined by EditorGrid.

bodyscroll

public event bodyscroll

Fires when the body element is scrolled

Subscribers will be called with the following parameters:

scrollLeft : Number
scrollTop : Number

This event is defined by Grid.

cellclick

public event cellclick

Fires when a cell is clicked

Subscribers will be called with the following parameters:

this : Grid
rowIndex : Number
columnIndex : Number
e : Ext.EventObject

This event is defined by Grid.

cellcontextmenu

public event cellcontextmenu

Fires when a cell is right clicked

Subscribers will be called with the following parameters:

this : Grid
rowIndex : Number
cellIndex : Number
e : Ext.EventObject

This event is defined by Grid.

celldblclick

public event celldblclick

Fires when a cell is double clicked

Subscribers will be called with the following parameters:

this : Grid
rowIndex : Number
columnIndex : Number
e : Ext.EventObject

This event is defined by Grid.

click

public event click

The raw click event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

columnmove

public event columnmove

Fires when the user moves a column

Subscribers will be called with the following parameters:

oldIndex : Number
newIndex : Number

This event is defined by Grid.

columnresize

public event columnresize

Fires when the user resizes a column

Subscribers will be called with the following parameters:

columnIndex : Number
newSize : Number

This event is defined by Grid.

contextmenu

public event contextmenu

The raw contextmenu event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

dblclick

public event dblclick

The raw dblclick event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

dragdrop

public event dragdrop

Fires when dragged row(s) are dropped on a valid DD target

Subscribers will be called with the following parameters:

this : Grid
dd : Ext.GridDD
The drag drop object
targetId : String
The target drag drop object
e : event
The raw browser event

This event is defined by Grid.

dragenter

public event dragenter

Fires when the dragged row(s) first cross another DD target while being dragged

Subscribers will be called with the following parameters:

this : Grid
dd : Ext.GridDD
The drag drop object
targetId : String
The target drag drop object
e : event
The raw browser event

This event is defined by Grid.

dragout

public event dragout

Fires when the dragged row(s) leave another DD target while being dragged

Subscribers will be called with the following parameters:

this : Grid
dd : Ext.GridDD
The drag drop object
targetId : String
The target drag drop object
e : event
The raw browser event

This event is defined by Grid.

dragover

public event dragover

Fires while row(s) are being dragged. "targetId" is the id of the Yahoo.util.DD object the selected rows are being dragged over.

Subscribers will be called with the following parameters:

this : Grid
dd : Ext.GridDD
The drag drop object
targetId : String
The target drag drop object
e : event
The raw browser event

This event is defined by Grid.

enddrag

public event enddrag

Fires when a drag operation is complete

Subscribers will be called with the following parameters:

this : Grid
dd : Ext.GridDD
The drag drop object
e : event
The raw browser event

This event is defined by Grid.

headerclick

public event headerclick

Fires when a header is clicked

Subscribers will be called with the following parameters:

this : Grid
columnIndex : Number
e : Ext.EventObject

This event is defined by Grid.

headercontextmenu

public event headercontextmenu

Fires when a header is right clicked

Subscribers will be called with the following parameters:

this : Grid
columnIndex : Number
e : Ext.EventObject

This event is defined by Grid.

headerdblclick

public event headerdblclick

Fires when a header cell is double clicked

Subscribers will be called with the following parameters:

this : Grid
rowIndex : Number
columnIndex : Number
e : Ext.EventObject

This event is defined by Grid.

keydown

public event keydown

The raw keydown event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

keypress

public event keypress

The raw keypress event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

mousedown

public event mousedown

The raw mousedown event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

mouseout

public event mouseout

The raw mouseout event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

mouseover

public event mouseover

The raw mouseover event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

mouseup

public event mouseup

The raw mouseup event for the entire grid.

Subscribers will be called with the following parameters:

e : Ext.EventObject

This event is defined by Grid.

render

public event render

Fires when the grid is rendered

Subscribers will be called with the following parameters:

grid : Grid

This event is defined by Grid.

rowclick

public event rowclick

Fires when a row is clicked

Subscribers will be called with the following parameters:

this : Grid
rowIndex : Number
e : Ext.EventObject

This event is defined by Grid.

rowcontextmenu

public event rowcontextmenu

Fires when a row is right clicked

Subscribers will be called with the following parameters:

this : Grid
rowIndex : Number
e : Ext.EventObject

This event is defined by Grid.

rowdblclick

public event rowdblclick

Fires when a row is double clicked

Subscribers will be called with the following parameters:

this : Grid
rowIndex : Number
e : Ext.EventObject

This event is defined by Grid.

startdrag

public event startdrag

Fires when row(s) start being dragged

Subscribers will be called with the following parameters:

this : Grid
dd : Ext.GridDD
The drag drop object
e : event
The raw browser event

This event is defined by Grid.

validateedit

public event validateedit

Fires after a cell is edited, but before the value is set in the record. Return false to cancel the change. The edit event object has the following properties

grid - This grid
record - The record being edited
field - The field name being edited
value - The value being set
originalValue - The original value for the field, before the edit.
row - The grid row index
column - The grid column index
cancel - Set this to true to cancel the edit or return false from your handler.

Subscribers will be called with the following parameters:

e : Object
An edit event (see above for description)

This event is defined by EditorGrid.

Config Details

autoExpandColumn

autoExpandColumn : String

The id of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.

This config option is defined by Grid.

autoExpandMax

autoExpandMax : Number

The maximum width the autoExpandColumn can have (if enabled). Default is 1000.

This config option is defined by Grid.

autoExpandMin

autoExpandMin : Number

The minimum width the autoExpandColumn can have (if enabled). Default is 50.

This config option is defined by Grid.

autoHeight

autoHeight : Boolean

True to fit the height of the grid container to the height of the data. Default is false.

This config option is defined by Grid.

autoSizeColumns

autoSizeColumns : Boolean

True to automatically resize the columns to fit their content on initial render. It is more efficient to explicitly size the columns through the ColumnModel's Ext.grid.ColumnModel.width config option. Default is false.

This config option is defined by Grid.

autoSizeHeaders

autoSizeHeaders : Boolean

True to measure headers with column data when auto sizing columns. Default is true.

This config option is defined by Grid.

enableColumnHide

enableColumnHide : Boolean

True to enable hiding of columns with the header context menu. Default is true.

This config option is defined by Grid.

enableColumnMove

enableColumnMove : Boolean

True to enable drag and drop reorder of columns. Default is true.

This config option is defined by Grid.

enableDragDrop

enableDragDrop : Boolean

True to enable drag and drop of rows. Default is false.

This config option is defined by Grid.

enableRowHeightSync

enableRowHeightSync : Boolean

True to manually sync row heights across locked and not locked rows. Default is false.

This config option is defined by Grid.

loadMask

loadMask : Object

An Ext.LoadMask config or true to mask the grid while loading. Default is false.

This config option is defined by Grid.

maxHeight

maxHeight : Number

Sets the maximum height of the grid - ignored if autoHeight is not on.

This config option is defined by Grid.

maxRowsToMeasure

maxRowsToMeasure : Boolean

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

This config option is defined by Grid.

minColumnWidth

minColumnWidth : Number

The minimum width a column can be resized to. Default is 25.

This config option is defined by Grid.

monitorWindowResize

monitorWindowResize : Boolean

True to autoSize the grid when the window resizes. Default is true.

This config option is defined by Grid.

stripeRows

stripeRows : Boolean

True to stripe the rows. Default is true.

This config option is defined by Grid.

trackMouseOver

trackMouseOver : Boolean

True to highlight rows when the mouse is over. Default is true.

This config option is defined by Grid.

view

view : Object

The Ext.grid.GridView used by the grid. This can be set before a call to render().

This config option is defined by Grid.