Package turbogears :: Package widgets :: Module forms :: Class CheckBoxList

Class CheckBoxList

 object --+                
          |                
base.Widget --+            
              |            
    InputWidget --+        
                  |        
          FormField --+    
                      |    
         SelectionField --+
                          |
                         CheckBoxList

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

Instance Methods

Inherited from SelectionField: __init__, update_params

Inherited from InputWidget: adjust_value, display

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

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

Class Variables
	template = `'\n <ul xmlns:py="http://purl.org/kid/ns#"\n ...` hash(x)
	params = `['list_attrs', 'options', 'field_class', 'css_classes...`
	params_doc = `{'convert': 'Should the value be coerced by the v...`
	list_attrs = `{}`
Inherited from `SelectionField`: `convert`, `no_input_if_empty`, `options` Inherited from `FormField`: `css_classes`, `field_class`, `help_text`, `label` Inherited from `InputWidget`: `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__

Class Variable Details

template

hash(x)

Value:

'''
    <ul xmlns:py="http://purl.org/kid/ns#"
        class="${field_class}"
        id="${field_id}"
        py:attrs="list_attrs"
    >
        <li py:for="value, desc, attrs in options">
            <input type="checkbox"
...

params

Value:

['list_attrs', 'options', 'field_class', 'css_classes', 'convert']

params_doc

Value:

{'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',
 'list_attrs': 'Extra (X)HTML attributes for the ul tag',
 'options': 'A list of tuples with the options for the selectfield'}