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

Class Button

 object --+            
          |            
base.Widget --+        
              |        
    InputWidget --+    
                  |    
          FormField --+
                      |
                     Button

Known Subclasses:

Nested Classes
Inherited from `base.Widget`: `__metaclass__`

Instance Methods

update_params(self, d)
Update the template parameters.

source code

Inherited from FormField: __init__

Inherited from InputWidget: adjust_value, display, render

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

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

Class Variables
	template = `'\n <input xmlns:py="http://genshi.edgewall.org/...` hash(x)
	params = `['attrs', 'field_class', 'css_classes', 'convert']`
	params_doc = `{'attrs': 'Dictionary containing extra (X)HTML at...`
	attrs = `{}`
	engine_name = `'genshi'` hash(x)
	template_c = `<MarkupTemplate "None">`
Inherited from `FormField`: `css_classes`, `field_class`, `help_text`, `label` Inherited from `InputWidget`: `convert`, `validator` Inherited from `base.Widget`: `css`, `default`, `javascript`

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)

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)

Class Variable Details

template

hash(x)

Value:

'''
    <input xmlns:py="http://genshi.edgewall.org/"
        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'}