Class InputWidget

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__

Adjust the value sent to the template on display.

Overrides: base.Widget.adjust_value

(inherited documentation)

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.

Decorators:

• @update_path

Overrides: base.Widget.display

(inherited documentation)

Exactly the same as display() but return serialized output instead.

Useful for debugging or to display the widget in a template other than Genshi or Kid, like Cheetah, Mako, Nevow Stan, ...

Decorators:

• @update_path

Overrides: base.Widget.render

(inherited documentation)

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)

params_doc

Value:

{'convert': 'Should the value be coerced by the validator at display?' }

path

Get Method:

unreachable._update_path(self, *args, **kw)

name_path

Get Method:

unreachable.name_path(self)

is_validated

Get Method:

unreachable.is_validated(self)

fq_name

Get Method:

unreachable._update_path(self, *args, **kw)

error

Get Method:

unreachable._update_path(self, *args, **kw)