Package turbogears :: Package widgets :: Module forms :: Class CheckBox

Class CheckBox

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

Instance Methods

__init__(self, *args, **kw)
Initialize an input widget.

source code

update_params(self, d)
Update the template parameters.

source code

Inherited from FormField: field_id, is_required

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

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

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

Class Variables
	template = `...` hash(x)
	no_input_if_empty = `True` hash(x)
	params = `["attrs"]`
	params_doc = `{'attrs': 'Dictionary containing extra (X)HTML at...`
	attrs = `{}`
Inherited from `FormField`: `css_classes`, `field_class`, `help_text`, `label`, `name` Inherited from `InputWidget`: `convert`, `validator` Inherited from `base.Widget`: `__metaclass__`, `css`, `default`, `engine_name`, `javascript`

Properties
Inherited from `object`: `__class__`

Method Details

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

source code

Initialize an input widget.

It accepts the following parameters (besides those listed at params):

name:
    Name of the input element. Will be the name of the variable
    the widget's input will be available at when submitted.

validator:
    Formencode validator that will validate and coerce the input
    this widget generates.

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)

Class Variable Details

template

hash(x)

Value:

"""
    <input xmlns:py="http://purl.org/kid/ns#"
        type="checkbox"
        name="${name}"
        class="${field_class}"
        id="${field_id}"
        py:attrs="attrs"
    />
...

params_doc

Value:

{'attrs': 'Dictionary containing extra (X)HTML attributes for' ' the c
heckbox input tag'}

Class CheckBox

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

update_params(self, d)

template

params_doc

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