wuttaweb.forms.widgets

Form widgets

This module defines some custom widgets for use with WuttaWeb.

However for convenience it also makes other Deform widgets available in the namespace:

• deform.widget.Widget (base class)

• deform.widget.TextInputWidget

• deform.widget.TextAreaWidget

• deform.widget.PasswordWidget

• deform.widget.CheckedPasswordWidget

• deform.widget.CheckboxWidget

• deform.widget.SelectWidget

• deform.widget.CheckboxChoiceWidget

• deform.widget.DateInputWidget

• deform.widget.DateTimeInputWidget

• deform.widget.MoneyInputWidget

class wuttaweb.forms.widgets.BatchIdWidget(**kw)

Widget for use with the id field of a batch model.

This widget is “always” read-only and renders the Batch ID as zero-padded 8-char string

class wuttaweb.forms.widgets.EmailRecipientsWidget(**kw)

Widget for email setting recipient fields (To, Cc, Bcc).

This is a subclass of deform.widget.TextAreaWidget. It uses these Deform templates:

• textarea

• readonly/email_recips

See also the EmailRecipients schema type, which uses this widget.

class wuttaweb.forms.widgets.FileDownloadWidget(request, *args, **kwargs)

Widget for use with FileDownload fields.

This only supports readonly, and shows a hyperlink to download the file. Link text is the filename plus file size.

This is a subclass of deform.widget.Widget and uses these Deform templates:

• readonly/filedownload

Parameters:

• request – Current request object.

• url – Optional URL for hyperlink. If not specified, file name/size is shown with no hyperlink.

class wuttaweb.forms.widgets.GridWidget(request, grid, *args, **kwargs)

Widget for fields whose data is represented by a grid.

This is a subclass of deform.widget.Widget but does not use any Deform templates.

This widget only supports “readonly” mode, is not editable. It is merely a convenience around the grid itself, which does the heavy lifting.

Instead of creating this widget directly you probably should call set_grid() on your form.

Parameters:

• request – Current request object.

• grid – Grid instance, used to display the field data.

serialize(field, cstruct, **kw)

This widget simply calls render_table_element() on the grid to serialize.

class wuttaweb.forms.widgets.NotesWidget(**kw)

Widget for use with “notes” fields.

In readonly mode, this shows the notes with a background to make them stand out a bit more.

Otherwise it effectively shows a <textarea> input element.

This is a subclass of deform.widget.TextAreaWidget and uses these Deform templates:

• textarea

• readonly/notes

class wuttaweb.forms.widgets.ObjectRefWidget(request, *args, **kwargs)

Widget for use with model “object reference” fields, e.g. foreign key UUID => TargetModel instance.

While you may create instances of this widget directly, it normally happens automatically when schema nodes of the ObjectRef (sub)type are part of the form schema; via widget_maker().

In readonly mode, this renders a <span> tag around the model_instance (converted to string).

Otherwise it renders a select (dropdown) element allowing user to choose from available records.

This is a subclass of deform.widget.SelectWidget and uses these Deform templates:

• select

• readonly/objectref

model_instance

Reference to the model record instance, i.e. the “far side” of the foreign key relationship.

Note

You do not need to provide the model_instance when constructing the widget. Rather, it is set automatically when the ObjectRef type instance (associated with the node) is serialized.

class wuttaweb.forms.widgets.PermissionsWidget(request, *args, **kwargs)

Widget for use with Role permissions field.

This is a subclass of WuttaCheckboxChoiceWidget. It uses these Deform templates:

• permissions

• readonly/permissions

class wuttaweb.forms.widgets.RoleRefsWidget(request, *args, **kwargs)

Widget for use with User roles field. This is the default widget for the RoleRefs type.

This is a subclass of WuttaCheckboxChoiceWidget.

class wuttaweb.forms.widgets.WuttaCheckboxChoiceWidget(request, *args, **kwargs)

Custom widget for set fields.

This is a subclass of deform.widget.CheckboxChoiceWidget.

Parameters:

request – Current request object.

It uses these Deform templates:

• checkbox_choice

• readonly/checkbox_choice

class wuttaweb.forms.widgets.WuttaCheckedPasswordWidget(**kw)

Custom widget for password+confirmation field.

This widget is used only for Vue 3 + Oruga, but is not used for Vue 2 + Buefy.

This is a subclass of deform.widget.PasswordWidget and uses these Deform templates:

• wutta_checked_password

class wuttaweb.forms.widgets.WuttaDateTimeWidget(request, *args, **kwargs)

Custom widget for datetime.datetime fields.

The main purpose of this widget is to leverage render_datetime() for the readonly display.

It is automatically used for SQLAlchemy mapped classes where the field maps to a sqlalchemy.types.DateTime column. For other (non-mapped) datetime fields, you may have to use it explicitly via set_widget().

This is a subclass of deform.widget.DateTimeInputWidget and uses these Deform templates:

• datetimeinput

class wuttaweb.forms.widgets.WuttaDateWidget(request, *args, **kwargs)

Custom widget for datetime.date fields.

The main purpose of this widget is to leverage render_date() for the readonly display.

It is automatically used for SQLAlchemy mapped classes where the field maps to a sqlalchemy.types.Date column. For other (non-mapped) date fields, or mapped datetime fields for which a date widget is preferred, use set_widget().

This is a subclass of deform.widget.DateInputWidget and uses these Deform templates:

• dateinput

class wuttaweb.forms.widgets.WuttaMoneyInputWidget(request, *args, **kwargs)

Custom widget for “money” fields. This is used by default for WuttaMoney type nodes.

The main purpose of this widget is to leverage render_currency() for the readonly display.

This is a subclass of deform.widget.MoneyInputWidget and uses these Deform templates:

• moneyinput

Parameters:

• request – Current request object.

• scale – If this kwarg is specified, it will be passed along to render_currency() call.