gridx
Legend: Array Boolean Constructor Date DomNode Error Function Namespace Number Object RegExp Singleton String

gridx.modules.CellWidget

Object » _Module » gridx.modules.CellWidget
dojo.require("gridx.modules.CellWidget");
Defined in gridx/modules/CellWidget.js

Since widget declarations need to be parsed by dojo.parser, it can NOT be directly created by the decorator function. This module takes advantage of the _TemplatedMixin and the _WidgetInTemplateMixin so that users can write "templates" containing widgets in decorator function. This modules also limits the total number of widgets, so that the performance of grid can be configured to a tolerable level when there're lots of widgets in grid.

Property Summary

Method Summary

Event Summary

  • onCellWidgetCreated() Fired when a cell widget is created. widget: gridx.__CellWidget The created cell widget. cell: gridx.core.Cell The cell object containing this widget.

Attached Objects

Properties

cellMixin
Overrides _Module
grid
Overrides _Module

Methods

_beginNavigate
Overrides _Module
ParameterTypeDescription
rowId
colId
_doBlur
Overrides _Module
ParameterTypeDescription
evt
step
_doFocus
Overrides _Module
ParameterTypeDescription
evt
step
_endNavigate
Overrides _Module
_getSpecialCellDec
Overrides _Module
ParameterTypeDescription
rowId
colId
_getSpecialWidget
Overrides _Module
ParameterTypeDescription
cell
_init
Overrides _Module
_initFocus
Overrides _Module
_isNavigable
Overrides _Module
ParameterTypeDescription
colId
_onFocus
Overrides _Module
ParameterTypeDescription
evt
_onKey
Overrides _Module
ParameterTypeDescription
e
_onUnrenderRow
Overrides _Module
ParameterTypeDescription
id
_prepareCellWidget
Overrides _Module
ParameterTypeDescription
cell
_showDijit
Overrides _Module
ParameterTypeDescription
cell
_showDijits
Overrides _Module
ParameterTypeDescription
row
constructor
Overrides _Module
destroy
Overrides _Module
getAPIPath
Overrides _Module
getCellWidget
Overrides _Module

When this module is used, the string returned from decorator function will be the template string of a CellWidget. This method gets this widget so that more control can be applied to it.

ParameterTypeDescription
rowIdstringThe row ID of the cell
colIdstringThe column ID of the cell
preload
Overrides _Module
restoreCellDecorator
Overrides _Module
Remove a cell decorator defined by the "setCellDecorator" method.
ParameterTypeDescription
rowIdStringThe row ID of the cell
colIdStringThe column ID of the cell
setCellDecorator
Overrides _Module
This method is used to decorate a specific cell instead of a whole column.
ParameterTypeDescription
rowIdStringThe row ID of the cell
colIdStringThe column ID of the cell
decoratorFunction(data)The decorator function for this cell.
setCellValueFunction()
Optional.
This function can be provided to customiz the way of setting widget value

Events

onCellWidgetCreated
Overrides _Module
Fired when a cell widget is created. widget: gridx.__CellWidget The created cell widget. cell: gridx.core.Cell The cell object containing this widget.