toolkit.forms – Toolkit forms

class toolkit.forms.forms.CCEModelForm(*args, **kwargs)

Django model form using CCE ModelFormMetaClass

class toolkit.forms.forms.CCEModelFormMetaclass

Defines custom Model Form Meta Class

class toolkit.forms.forms.CCEModelSearchForm(*args, **kwargs)

Django Model form with SearchFormMixin to create an Advanced Search form using multiple fields and filters

Allows filtering a queryset using a list of fields, Q objects and custom filter methods

class toolkit.forms.forms.CCESimpleSearchForm(*args, **kwargs)

Model Search Form with a single search field, provides similar functionality to django-admin search box

Allows filtering a queryset using a list of fields, Q objects and custom filter methods

Fields:

• search

class toolkit.forms.forms.DynamicNullBooleanSelect(attrs=None, null_label=None, true_label=None, false_label=None)

An overriden Select widget to be used with NullBooleanField. Takes a kwarg “null_label” that indicates the text on the null option.

class toolkit.forms.forms.ReportSelector(user, reports_list, *args, **kwargs)

Form used for CCE Report Views to provide a dropdown of available reports

class toolkit.forms.forms.SearchForm(data=None, files=None, auto_id=u'id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, field_order=None, use_required_attribute=None, renderer=None)

Regular Django form with SearchFormMixin

toolkit.forms.forms.cce_formfield_callback(f, **kwargs)

overrides django formfield widgets default values

class toolkit.forms.mixins.SearchFormMixin

Mixin used to create a search form. Allows you to define a list of field-filters pairs used to filter the queryset passed to the form

filters can be a combination of list of fields, Q objects and custom filter methods

filters(queryset)

Prepares the dictionary of queryset filters based on the form cleaned data

Parameters:queryset (Queryset) – the queryset to filter through. Returns:tuple of q_objects and kwargs used in filtering the queryset

Warning

method uses cleaned_data, self.full_clean() must be called first.

search(queryset)

Filter the given queryset according to the form’s cleaned data.

Warning

self.full_clean() must be called first.

Parameters:queryset (Queryset) – the queryset to filter through. Returns:filtered version of the initial queryset. Raises:AttributeError, if the form is not valid.