mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-08-04 02:48:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fixed #20999 - Allow overriding formfield class with choices, without subclass restrictions.

Browse source 
Refs #18162. Thanks claudep and mjtamlyn for review.
This commit is contained in:
Carl Meyer 2013-08-29 21:44:37 -06:00
parent b04f8ddbaa
commit 7211741fc5
3 changed files with 22 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/howto/custom-model-fields.txt
View file

@ -617,17 +617,23 @@ prepared with :meth:`.get_prep_lookup`.
Specifying the form field for a model field
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. method:: Field.formfield(self, form_class=forms.CharField, **kwargs)
.. method:: Field.formfield(self, form_class=None, choices_form_class=None, **kwargs)
Returns the default form field to use when this field is displayed in a model.
This method is called by the :class:`~django.forms.ModelForm` helper.
Returns the default form field to use when this model field is displayed in a
form. This method is called by the :class:`~django.forms.ModelForm` helper.
The form field class can be specified via the ``form_class`` and
``choices_form_class`` arguments; the latter is used if the field has choices
specified, the former otherwise. If these arguments are not provided,
:class:`~django.forms.CharField` or :class:`~django.forms.TypedChoiceField`
will be used.
All of the ``kwargs`` dictionary is passed directly to the form field's
``__init__()`` method. Normally, all you need to do is set up a good default
for the ``form_class`` argument and then delegate further handling to the
parent class. This might require you to write a custom form field (and even a
form widget). See the :doc:`forms documentation </topics/forms/index>` for
information about this.
for the ``form_class`` (and maybe ``choices_form_class``) argument and then
delegate further handling to the parent class. This might require you to write
a custom form field (and even a form widget). See the :doc:`forms documentation
</topics/forms/index>` for information about this.
Continuing our ongoing example, we can write the :meth:`.formfield` method as::