Print Friendly

Class Ext.grid.EditorGrid

Package:Ext.grid
Class:EditorGrid
Extends:Grid
Defined In:EditorGrid.js
Shortcut class for creating and editable grid.

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)
  autoHeight : Boolean Grid
True to fit the height of the grid container to the height of the data (defaults to false)
  autoSizeColumns : Boolean Grid
True to automatically resize the columns to fit their content on initial render
  autoSizeHeaders : Boolean Grid
True to measure headers with column data when auto sizing columns
  autoWidth : Boolean Grid
True to fit the width of the grid container to the width of the columns (defaults to false)
  ddText : String Grid
Configures the text is the drag proxy (defaults to "%0 selected row(s)"). %0 is replaced with the number of selected...
  enableColumnMove : Boolean Grid
True to enable drag and drop reorder of columns
  enableDragDrop : Boolean Grid
True to enable drag and drop of rows
  enableRowHeightSync : Boolean Grid
True to manually sync row heights across locked and not locked rows
  maxRowsToMeasure : Number Grid
If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of rows measured to get a columns size - d...
  minColumnWidth : Number Grid
The minimum width a column can be resized to. (Defaults to 25)
  monitorWindowResize : Object Grid
True to autoSize the grid when the window resizes - defaults to true
  stripeRows : Boolean Grid
True to stripe the rows (default is true)
  trackMouseOver : Boolean Grid
True to highlight rows when the mouse is over (default is false)
  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...

Public Methods

Method Defined By
  addListener(String eventName, Function handler, [Object options]) : void Observable
Appends an event handler to this component
  autoSize() : void Grid
Causes the grid to manually recalculate its dimensions. Generally this is done automatically, but if manual update is...
  destroy(Boolean removeEl) : void Grid
Destroy this grid.
  fireEvent(String eventName, Object... args) : Boolean Observable
Fires the specified event with the passed parameters (minus the event name).
  getColumnModel() : ColumnModel Grid
Returns the grid's ColumnModel.
  getDataSource() : DataSource Grid
Returns the grid's DataSource.
  getDragDropText() : String Grid
Called to get grid's drag proxy text, by default returns this.ddText.
  getSelectionModel() : SelectionModel Grid
Returns the grid's SelectionModel.
  getView() : GridView Grid
Returns the grid's GridView object.
  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
  render() : Ext.grid.Grid Grid
Called once after all setup has been completed and the grid is ready to be rendered.
  startEditing(Number rowIndex, Number colIndex) : void EditorGrid
Starts editing the specified for the specified row/column
  stopEditing() : void EditorGrid
Stops any active editing
  un(String eventName, Function handler, [Object scope]) : void Observable
Removes a listener (shorthand for removeListener)

Public Events

Event Defined By
  afteredit : (Grid this, Number rowIndex, Number columnIndex) EditorGrid
Fires after a cell is edited
  beforeedit : (Grid this, Number rowIndex, Number columnIndex) EditorGrid
Fires before a cell is edited
  bodyscroll : (Number scrollLeft, Number scrollTop) Grid
Fires when the body element is scrolled
  cellclick : (Grid this, Number rowIndex, Number columnIndex, Ext.EventObject e) Grid
Fires when a cell is clicked
  cellcontextmenu : (Grid this, Number rowIndex, Number cellIndex, Ext.EventObject e) Grid
Fires when a cell is right clicked
  celldblclick : (Grid this, Number rowIndex, Number columnIndex, Ext.EventObject e) Grid
Fires when a cell is double clicked
  click : (Ext.EventObject e) Grid
The raw click event for the entire grid.
  columnmove : (Number oldIndex, Number newIndex) Grid
Fires when the user moves a column
  columnresize : (Number columnIndex, Number newSize) Grid
Fires when the user resizes a column
  contextmenu : (Ext.EventObject e) Grid
The raw contextmenu event for the entire grid.
  dblclick : (Ext.EventObject e) Grid
The raw dblclick event for the entire grid.
  dragdrop : (Grid this, Ext.GridDD dd, String targetId, event e) Grid
Fires when dragged row(s) are dropped on a valid DD target
  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
  dragout : (Grid this, Ext.GridDD dd, String targetId, event e) Grid
Fires when the dragged row(s) leave another DD target while being dragged
  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...
  enddrag : (Grid this, Ext.GridDD dd, event e) Grid
Fires when a drag operation is complete
  headerclick : (Grid this, Number columnIndex, Ext.EventObject e) Grid
Fires when a header is clicked
  headercontextmenu : (Grid this, Number columnIndex, Ext.EventObject e) Grid
Fires when a header is right clicked
  headerdblclick : (Grid this, Number rowIndex, Number columnIndex, Ext.EventObject e) Grid
Fires when a header cell is double clicked
  keydown : (Ext.EventObject e) Grid
The raw keydown event for the entire grid.
  keypress : (Ext.EventObject e) Grid
The raw keypress event for the entire grid.
  mousedown : (Ext.EventObject e) Grid
The raw mousedown event for the entire grid.
  mouseout : (Ext.EventObject e) Grid
The raw mouseout event for the entire grid.
  mouseover : (Ext.EventObject e) Grid
The raw mouseover event for the entire grid.
  mouseup : (Ext.EventObject e) Grid
The raw mouseup event for the entire grid.
  rowclick : (Grid this, Number rowIndex, Ext.EventObject e) Grid
Fires when a row is clicked
  rowcontextmenu : (Grid this, Number rowIndex, Ext.EventObject e) Grid
Fires when a row is right clicked
  rowdblclick : (Grid this, Number rowIndex, Ext.EventObject e) Grid
Fires when a row is double clicked
  startdrag : (Grid this, Ext.GridDD dd, event e) Grid
Fires when row(s) start being dragged

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.

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.

autoWidth

public Boolean autoWidth
True to fit the width of the grid container to the width of the columns (defaults to false)
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.

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.

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.

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.

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.

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.

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
Subscribers will be called with the following parameters:
  • this : Grid
  • rowIndex : Number
  • columnIndex : Number
This event is defined by EditorGrid.

beforeedit

public event beforeedit
Fires before a cell is edited
Subscribers will be called with the following parameters:
  • this : Grid
  • rowIndex : Number
  • columnIndex : Number
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.

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.

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