dojox/grid/cells/_base (version 1.10)

Summary

Represents a grid cell and contains information about column options and methods for retrieving cell related information. Each column in a grid layout has a cell object and most events and many methods provide access to these objects.

Usage

var foo = new _base(inProps);
dojox/grid/cells/_base
Parameter Type Description
inProps undefined

Property Summary

Method Summary

Event Summary

Properties

_formatPending
Defined by: dojox/grid/cells/_base
_valueProp
Defined by: dojox/grid/cells/_base
alwaysEditing
Defined by: dojox/grid/cells/_base
classes
Defined by: dojox/grid/cells/_base
defaultValue
Defined by: dojox/grid/cells/_base
draggable
Defined by: dojox/grid/cells/_base
editable
Defined by: dojox/grid/cells/_base
formatter
Defined by: dojox/grid/cells/_base
hidden
Defined by: dojox/grid/cells/_base
noresize
Defined by: dojox/grid/cells/_base
styles
Defined by: dojox/grid/cells/_base
value
Defined by: dojox/grid/cells/_base

Methods

_defaultFormat(inValue,callArgs)
Defined by dojox/grid/cells/_base
Parameter Type Description
inValue undefined
callArgs undefined
Returns:undefined | string | instance
_finish(inRowIndex)
Defined by dojox/grid/cells/_base

called when editing is completed to clean up editor

Parameter Type Description
inRowIndex int

grid row index
_formatNode(inDatum,inRowIndex)
Defined by dojox/grid/cells/_base
Parameter Type Description
inDatum undefined
inRowIndex undefined
AlwaysEdit()
Defined by dojox/grid/cells/_base
apply(inRowIndex)
Defined by dojox/grid/cells/_base

apply edit from cell editor

Parameter Type Description
inRowIndex int

grid row index
applyEdit(inValue,inRowIndex)
Defined by dojox/grid/cells/_base
Parameter Type Description
inValue undefined
inRowIndex undefined
Bool()
Defined by dojox/grid/cells/_base
cancel(inRowIndex)
Defined by dojox/grid/cells/_base

cancel cell edit

Parameter Type Description
inRowIndex int

grid row index
cancelEdit(inRowIndex)
Defined by dojox/grid/cells/_base
Parameter Type Description
inRowIndex undefined
cancelFormatNode()
Defined by dojox/grid/cells/_base
canResize()
Defined by dojox/grid/cells/_base
Returns:undefined
Cell()
Defined by dojox/grid/cells/_base
dispatchEvent(m,e)
Defined by dojox/grid/cells/_base
Parameter Type Description
m undefined
e undefined
Returns:undefined
focus(inRowIndex,inNode)
Defined by dojox/grid/cells/_base

focus the grid editor

Parameter Type Description
inRowIndex int

grid row index
inNode undefined

editor node
format(inRowIndex,inItem)
Defined by dojox/grid/cells/_base

provides the html for a given grid cell.

Parameter Type Description
inRowIndex int

grid row index
inItem undefined
Returns:any | undefined

html for a given grid cell

formatEditing(inDatum,inRowIndex)
Defined by dojox/grid/cells/_base

formats the cell for editing

Parameter Type Description
inDatum anything

cell data to edit
inRowIndex int

grid row index
Returns:any

string of html to place in grid cell

formatNode(inNode,inDatum,inRowIndex)
Defined by dojox/grid/cells/_base

format the editing dom node. Use when editor is a widget.

Parameter Type Description
inNode undefined

dom node for the editor
inDatum anything

cell data to edit
inRowIndex int

grid row index
getEditNode(inRowIndex)
Defined by dojox/grid/cells/_base
Parameter Type Description
inRowIndex undefined
Returns:number
getHeaderNode()
Defined by dojox/grid/cells/_base
Returns:undefined
getNode(inRowIndex)
Defined by dojox/grid/cells/_base

gets the dom node for a given grid cell.

Parameter Type Description
inRowIndex int

grid row index
Returns:any | undefined

dom node for a given grid cell

getValue(inRowIndex)
Defined by dojox/grid/cells/_base

returns value entered into editor

Parameter Type Description
inRowIndex int

grid row index
Returns:any | undefined

value of editor

isFlex()
Defined by dojox/grid/cells/_base
Returns:undefined
markupFactory(node,cellDef)
Defined by dojox/grid/cells/_base
Parameter Type Description
node undefined
cellDef undefined
needFormatNode(inDatum,inRowIndex)
Defined by dojox/grid/cells/_base
Parameter Type Description
inDatum undefined
inRowIndex undefined
registerOnBlur(inNode,inRowIndex)
Defined by dojox/grid/cells/_base
Parameter Type Description
inNode undefined
inRowIndex undefined
restore(inRowIndex)
Defined by dojox/grid/cells/_base

restore editor state

Parameter Type Description
inRowIndex int

grid row index
RowIndex()
Defined by dojox/grid/cells/_base
save(inRowIndex)
Defined by dojox/grid/cells/_base

save editor state

Parameter Type Description
inRowIndex int

grid row index
Select()
Defined by dojox/grid/cells/_base
setValue(inRowIndex,inValue)
Defined by dojox/grid/cells/_base

set the value of the grid editor

Parameter Type Description
inRowIndex int

grid row index
inValue anything

value of editor

Events

_onEditBlur(inRowIndex)
Defined by: dojox/grid/cells/_base
Parameter Type Description
inRowIndex undefined
Error in the documentation? Can’t find what you are looking for? Let us know!