Package turbogears :: Package widgets :: Module forms :: Class Button

Class Button

Nested Classes

template_c

Inherited from base.Widget: __metaclass__

Instance Methods

update_params(self, d)
This method will have the last chance to update the variables sent to the template for the specific request.

source code

Inherited from FormField: __init__

Inherited from FormField (private): _get_field_id, _get_is_required, _get_name, _set_name

Inherited from InputWidget: adjust_value, display

Inherited from InputWidget (private): _get_error, _get_fq_name, _get_is_validated, _get_name_path, _get_path, _retrieve_validator_from_validation_schema

Inherited from base.Widget: __call__, __repr__, __setattr__, render, retrieve_css, retrieve_javascript, update_data

Inherited from base.Widget (private): _get_is_named

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __str__

Class Variables

template = '\n <input xmlns:py="http://purl.org/kid/ns#"\n ...

params = ['attrs', 'field_class', 'css_classes', 'convert']

params_doc = {'attrs': 'Dictionary containing extra (X)HTML at...

attrs = {}

_param_attrs = {}

template_vars = ['attrs', 'field_class', 'css_classes', 'conve...

Inherited from FormField: css_classes, field_class, help_text, label

Inherited from FormField (private): _name, _param_css_classes, _param_field_class

Inherited from InputWidget: convert, validator

Inherited from InputWidget (private): _param_convert

Inherited from base.Widget: css, default, javascript

Inherited from base.Widget (private): _locked

Properties

Inherited from FormField: field_id, is_required, name

Inherited from InputWidget: error, fq_name, is_validated, name_path, path

Inherited from base.Widget: is_named

Inherited from object: __class__

Method Details

update_params(self, d)

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)

Class Variable Details

template

Value:

'''
    <input xmlns:py="http://purl.org/kid/ns#"
        type="button"
        class="${field_class}"
        value="${value}"
        py:attrs="attrs"
    />
    '''

params_doc

Value:

{'attrs': 'Dictionary containing extra (X)HTML attributes for the butt
on input tag',
 'convert': 'Should the value be coerced by the validator at display?'
,
 'css_classes': 'List of extra CSS classes for the field',
 'field_class': 'CSS class for the field'}

template_vars

Value:

['attrs', 'field_class', 'css_classes', 'convert']