Package turbogears :: Package widgets :: Module forms :: Class FileField

Class FileField

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

Instance Methods

display(self, value=None, **params)
Display the widget in a Genshi or Kid template.

source code

Inherited from FormField: __init__, field_id, is_required, update_params

Inherited from InputWidget: adjust_value, 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)
	params = `["attrs"]`
	params_doc = `{'attrs': 'Dictionary containing extra (X)HTML at...`
	attrs = `{}`
	file_upload = `True` hash(x)
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

display(self, value=None, **params)

source code

Display the widget in a Genshi or Kid template.

Returns a Genshi Markup stream or an ElementTree node instance,
depending on the template in which the widget shall be displayed.
If you need serialized output in a string, call 'render' instead.

Probably you will not need to override or extend if inheriting from
Widget.

@params:

value   : The value to display in the widget.
**params: Extra parameters specific to the widget. All keyword params
          supplied will pass through the update_params method which
          will have a last chance to modify them before reaching the
          template.

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

Class Variable Details

template

hash(x)

Value:

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

params_doc

Value:

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