turbogears.widgets.datagrid.DataGrid

The columns to build the grid from are specified with fields ctor argument which is a list. Currently an element can be either a two-element tuple or instance of DataGrid.Column class. If tuple is used it a Column is then build out of it, first element is assumed to be a title and second element - field accessor.

You can specify columns' data statically, via fields ctor parameter, or dynamically, by via 'fields' key.

init(self, *args, **kw)
(Constructor)

source code

Widget initialization.

All initialization has to take place in this method.
It's not thread-safe to mutate widget's attributes outside this method
or anytime after widget's first display.

*Must* call super(MyWidget, self).__init__(*args, **kw) cooperatively,
unless, of course, you know what you're doing. Preferably this should
be done before any actual work is done in the method.

Parameters:

name:        The widget's name. In input widgets, this will also be the
             name of the variable that the form will send to the
             controller. This is the only param that is safe to pass as a
             positional argument to __init__.
template:    The template that the widget should use to display itself.
             Currently only Genshi and Kid templates are supported. You
             can both initialize with a template string or with the path
             to a file-base template: 'myapp.templates.widget_tmpl'
engine_name: The engine to be used for rendering the template, if not
             specified in the template already.
default:     Default value to display when no value is passed at display
             time.
**params:    Keyword arguments specific to your widget or to any of its
             bases. If listed at class attribute 'params' the will be
             bound automatically to the widget instance.

Note: Do not confuse these parameters with parameters listed at
"params". Some widgets accept parameters at the constructor which are
not listed params, these parameter won't be passed to the template, be
automatically called, etc.

Overrides: object.__init__: (inherited documentation)

update_params(self, d)

source code

Update the template parameters.

This method will have the last chance to update the variables sent to the template for the specific request. All parameters listed at class attribute 'params' will be available at the 'params' dict this method receives.

*Must* call super(MyWidget, self).update_params(params) cooperatively, unless, of course, your know what you're doing. Preferably this should be done before any actual work is done in the method.

Overrides: base.Widget.update_params: (inherited documentation)

Nested Classes
	Column Simple struct that describes single DataGrid column.
	attrwrapper Helper class that returns an object's attribute when called.
Inherited from `base.Widget`: `__metaclass__`

Class Variables
	css = `[CSSLink(name='grid.css', media='all', order=0)]`
	template = `"turbogears.widgets.templates.datagrid"` hash(x)
	fields = `None` hash(x)
	engine_name = `'genshi'` hash(x)
	template_c = `'turbogears.widgets.templates.datagrid'`
Inherited from `base.Widget`: `default`, `javascript`, `name`, `params`, `params_doc`

Class DataGrid

init(self, *args, **kw)
(Constructor)

get_column(self, name)

update_params(self, d)

Class DataGrid

__init__(self, *args, **kw) (Constructor)

get_column(self, name)

update_params(self, d)

init(self, *args, **kw)
(Constructor)