Constructordojox.grid.edit

dojo.require("dojox.grid._grid.edit");
defined in dojox/grid/_grid/edit.js

Controls grid cell editing process. Owned by grid and used internally for editing.

Usage

function (/*dojox.Grid*/ inGrid) (view source)
parametertypedescription
inGriddojox.GridThe dojox.Grid this editor should be attached to

A grid widget with virtual scrolling, cell editing, complex rows, sorting, fixed columns, sizeable columns, etc.
fieldtypedescription
.adaptHeightFunction 
.adaptWidthFunction 
.addRowFunction 
.attributeMapObjectA map of attributes and attachpoints -- typically standard HTML attributes -- to set on the widget's dom, at the "domNode" attach point, by default. Other node references can be specified as properties of 'this'
.autoHeightBooleanIf autoHeight is true, grid height is automatically set to fit the data.
.autoRenderBooleanIf autoRender is true, grid will render itself after initialization.
.autoWidthBooleanIf autoWidth is true, grid width is automatically set to fit the data.
.beginUpdateFunctionUse to make multiple changes to rows while queueing row updating. NOTE: not currently supporting nested begin/endUpdate calls
.buildRenderingFunction 
.buildViewsFunction 
.canEditFunctionDetermines if a given cell may be edited
.canSortFunction 
.classStringHTML class attribute
.classTagStringCSS class applied to the grid's domNode
.closable 
.connectFunctionConnects specified obj/event to specified method of this object and registers for disconnect() on widget destroy. Special event: "ondijitclick" triggers on a click or enter-down or space-up Similar to dojo.connect() but takes three arguments rather than four.
.containerNodeDomNodeholds child elements. "containerNode" is generally set via a dojoAttachPoint assignment and it designates where children of the src dom node will be placed
.createFunctionKick off the life-cycle of a widget
.createLayoutFunctionCreates a new Grid layout
.createManagersFunctioncreate grid managers for various tasks including rows, focus, selection, editing row manager
.createScrollerFunctionCreates a new virtual scroller
.createViewFunction 
.createViewsFunction 
.defaultHeightStringdefault height of the grid, measured in any valid css unit.
.defaultUpdateFunction 
.delayScroll 
.destroyFunction 
.destroyDescendantsFunctionRecursively destroy the children of this widget and their descendants.
.destroyRecursiveFunctionDestroy this widget and it's descendants. This is the generic "destructor" function that all widget users should call to cleanly discard with a widget. Once a widget is destroyed, it's removed from the manager object.
.destroyRenderingFunctionDestroys the DOM nodes associated with this widget
.dirStringUnsupported by Dijit, but here for completeness. Dijit only supports setting text direction on the entire document. Bi-directional support, as defined by the [HTML DIR](http://www.w3.org/TR/html401/struct/dirlang.html#adef-dir) attribute. Either left-to-right "ltr" or right-to-left "rtl".
.disconnectFunctionDisconnects handle created by this.connect. Also removes handle from this widget's list of connects
.dispatchContentEventFunction 
.dispatchHeaderEventFunction 
.dispatchKeyEventFunction 
.doApplyCellEditFunction 
.doApplyEditFunction 
.doCancelEditFunction 
.doclickFunction 
.docontextmenuFunction 
.dodblclickFunction 
.doheaderclickFunction 
.doheadercontextmenuFunction 
.doheaderdblclickFunction 
.dojoAttachEvent 
.dojoAttachPoint 
.dokeydownFunction 
.doKeyEventFunction 
.domNode 
.domNode.onReveal 
.domNode.onSizeChange 
.domNode.parentNode 
.domNode.style.height 
.domNode.style.width 
.domNode.tabIndex 
.doStartEditFunction 
.edit 
.elasticViewIntegerOverride defaults and make the indexed grid view elastic, thus filling available horizontal space.
.endUpdateFunctionUse after calling beginUpdate to render any changes made to rows.
.fastScrollBooleanflag modifies vertical scrolling behavior. Defaults to true but set to false for slower scroll performance but more immediate scrolling feedback
.finishScrollJobFunction 
.fitTo 
.focus 
.getFunctiondata socket (called in cell's context)
.getCellFunctionRetrieves the cell object for a given grid column.
.getCellNameFunction 
.getDescendantsFunctionReturns all the widgets that contained by this, i.e., all widgets underneath this.containerNode.
.getSortAscFunctionReturns true if grid is sorted in an ascending direction.
.getSortFieldFunctionRetrieves the model field on which to sort data.
.getSortIndexFunctionReturns the index of the column on which the grid is sorted
.hasLayoutFunction 
.idStringa unique, opaque ID string that can be assigned by users or by the system. If the developer passes an ID which is known not to be unique, the specified ID is ignored and the system-generated ID is used instead.
.indexCellFieldsFunction 
.invalidated 
.invalidated.all 
.invalidated.rowCount 
.isFocusableFunctionReturn true if this widget can currently be focused and false if not
.isLeftToRightFunctionChecks the DOM to for the text direction for bi-directional support
.keepRowsIntegerNumber of rows to keep in the rendering cache.
.langStringRarely used. Overrides the default Dojo locale used to render this widget, as defined by the [HTML LANG](http://www.w3.org/TR/html401/struct/dirlang.html#adef-lang) attribute. Value must be among the list of locales specified during by the Dojo bootstrap, formatted according to [RFC 3066](http://www.ietf.org/rfc/rfc3066.txt) (like en-us).
.lastScrollTop 
.layout 
.layoutAlign 
.maxSize 
.minSize 
.model 
.modelAllChangeFunction 
.modelDatumChangeFunction 
.modelFieldsChangeFunction 
.modelInsertionFunction 
.modelRemovalFunction 
.modelRowChangeFunction 
.nodesWithKeyClick 
.onBlurFunctionstub function. Override or connect to this method to receive notifications for when the widget moves out of focus.
.onCloseFunctionCallback if someone tries to close the child, child will be closed if func returns true
.onFocusFunctionstub function. Override or connect to this method to receive notifications for when the widget moves into focus.
.onStyleRowFunction 
.params 
.postCreateFunction 
.postMixInPropertiesFunctionCalled after the parameters to the widget have been read-in, but before the widget template is instantiated. Especially useful to set properties that are referenced in the widget template.
.postrenderFunction 
.postresizeFunction 
.postscriptFunction 
.prerenderFunction 
.refreshFunctionRe-render the grid, getting new data from the model
.region 
.removeSelectedRowsFunction 
.render 
.renderOnIdleFunction 
.renderRowFunctionprivate, used internally to render rows
.resizeFunctionUpdate the grid's rendering dimensions and resize it
.rowCount 
.rowHeightChangedFunctionUpdate grid when the height of a row has changed. Row height is handled automatically as rows are rendered. Use this function only to update a row's height outside the normal rendering process.
.rowRemovedFunctionprivate, used internally to remove rows
.rows 
.rowsPerPageIntegerNumber of rows to render at a time.
.scroller 
.scroller.defaultRowHeight 
.scroller.removeRow 
.scroller.renderRow 
.scroller.windowHeight 
.scroller._pageIdPrefix 
.scrollRedrawThresholdIntegerpixel distance a user must scroll vertically to trigger grid scrolling.
.scrollToFunctionVertically scroll the grid to a given pixel position
.scrollTop 
.scrollToRowFunctionScroll the grid to a specific row.
.selected 
.selection 
.setAttributeFunctionSet native HTML attributes reflected in the widget, such as readOnly, disabled, and maxLength in TextBox widgets.
.setCellWidthFunction 
.setModelFunctionSet the grid's data model
.setScrollTopFunction 
.setSortIndexFunctionSort the grid on a column in a specified direction
.setSortInfoFunction 
.setStructureFunctionInstall a new structure and rebuild the grid.
.singleClickEditBooleanSingle-click starts editing. Default is double-click
.sizeChangeFunction 
.sizeMin 
.sizeShare 
.sortFunction 
.sortInfo 
.splitter 
.srcNodeRefDomNodepointer to original dom node
.srcNodeRef.id 
.startupFunctionCalled after a widget's children, and other widgets on the page, have been created. Provides an opportunity to manipulate any children before they are displayed. This is useful for composite widgets that need to control or layout sub-widgets. Many layout widgets can use this as a wiring phase.
.structureObject|StringView layout defintion. Can be set to a layout object, or to the (string) name of a layout object.
.styleStringHTML style attribute
.styleChangedFunction 
.styleRowNodeFunction 
.styleRowStateFunctionPerform row styling
.templateNodeDomNodea node that represents the widget template. Pre-empts both templateString and templatePath.
.templatePath 
.templateStringStringa string that represents the widget template. Pre-empts the
.textSizeChangedFunction 
.themeable 
.title 
.toStringFunction 
.uninitializeFunctionstub function. Override to implement custom widget tear-down behavior.
.update 
.updateRowFunctionRender a single row.
.updateRowCountFunctionChange the number of rows.
.updateRowStylesFunctionUpdate the styles for a row after it's state has changed.
.updating 
.views 
.views.createView 
.viewsHeaderNode.style.display 
.viewsNode.style.height 
.waiRole 
.waiState 
.widgetsInTemplateBooleanshould we parse the template to find widgets that might be declared in markup inside it? false by default.
._attaches 
._attachTemplateNodesFunctionIterate through the template and attach functions and nodes accordingly.
._click 
._connects 
._dispatchFunction 
._fillContentFunctionrelocate source contents to templated container node this.containerNode must be able to receive children, or exceptions will be thrown
._getPadBorderFunction 
._ltr 
._onBlurFunction 
._onFocusFunction 
._padBorder 
._resizeFunction 
._setModelFunction 
._sizeBox 
._skipNodeCache 
._started 
._stringReplFunction 
._structureChangedFunction 
._styleChangedFunction 
._supportingWidgets 
._textSizeChangedFunction 

Jump to PropertiesFunctionsBack to top

Apply a grid edit
FunctionapplyCellEdit(inValue, inCell, inRowIndex)
Cancel a grid edit
FunctioncellFocus(inCell, inRowIndex: Integer)
Invoke editing when cell is focused
FunctionisEditCell(inRowIndex: Integer, inCellIndex: Integer)
Indicates if the given cell is being edited.
Indicates editing state of the grid.
FunctionisEditRow(inRowIndex: Integer)
Indicates if the given row is being edited.
Functionrestore(inView: Object, inRowIndex: Integer)
Restores the grid editing state
Functionsave(inRowIndex: Integer, inView: Object)
Save the grid editing state
FunctionsetEditCell(inCell: Object, inRowIndex: Integer)
Set the given cell to be edited
Functionstart(inCell, inRowIndex, inEditing)
FunctionstyleRow(inRow)
Function_editorDo(inMethod)
Function_focusEditor(inCell, inRowIndex)

Jump to FunctionsPropertiesBack to top