Author: mtredinnick
Date: 2008-12-04 22:22:00 -0600 (Thu, 04 Dec 2008)
New Revision: 9569
Modified:
django/trunk/django/forms/forms.py
django/trunk/docs/topics/forms/index.txt
django/trunk/tests/regressiontests/forms/forms.py
Log:
Added a way to iterate over hidden/visible fields in a form. Useful for manual
form layout.
Modified: django/trunk/django/forms/forms.py
===================================================================
--- django/trunk/django/forms/forms.py 2008-12-04 19:34:54 UTC (rev 9568)
+++ django/trunk/django/forms/forms.py 2008-12-05 04:22:00 UTC (rev 9569)
@@ -303,6 +303,20 @@
return True
return False
+ def hidden_fields(self):
+ """
+ Returns a list of all the BoundField objects that correspond to hidden
+ fields in the HTML output. Useful for manual form layout in templates.
+ """
+ return [field for field in self if field.is_hidden]
+
+ def visible_fields(self):
+ """
+ Returns a lits of BoundField objects that do not correspond to hidden
+ fields. The opposite of the hidden_fields() method.
+ """
+ return [field for field in self if not field.is_hidden]
+
class Form(BaseForm):
"A collection of Fields, plus their associated data."
# This is a separate class from BaseForm in order to abstract the way
@@ -363,7 +377,7 @@
else:
name = self.html_initial_name
return widget.render(name, data, attrs=attrs)
-
+
def as_text(self, attrs=None, **kwargs):
"""
Returns a string of HTML for representing this as an <input
type="text">.
Modified: django/trunk/docs/topics/forms/index.txt
===================================================================
--- django/trunk/docs/topics/forms/index.txt 2008-12-04 19:34:54 UTC (rev
9568)
+++ django/trunk/docs/topics/forms/index.txt 2008-12-05 04:22:00 UTC (rev
9569)
@@ -292,6 +292,56 @@
case, each object in the loop is a simple string containing the error
message.
+ ``field.is_hidden``
+ This attribute is ``True`` is the form field is a hidden field and
+ ``False`` otherwise. It's not particularly useful as a template
+ variable, but could be useful in conditional tests such as::
+
+ {% if field.is_hidden %}
+ {# Do something special #}
+ {% endif %}
+
+Looping over hidden and visible fields
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you are manually laying out a form in a template, you will often want to
+work with any hidden fields in a single loop and then treat the visible fields
+differently. For example, since hidden fields don't display anything, putting
+their error messages "next to" the field isn't going to be very clear to the
+reader. So you need to handle errors for those fields a bit differently.
+
+Django provides two methods on a form that allow you to loop over the hidden
+and visible fields independently: ``hidden_fields()`` and
+``visible_fields()``. In a template, you might use these like this (this is a
+modification of an earlier example)::
+
+ <form action="/contact/" method="POST">
+ {% for field in form.visible_fields %}
+ <div class="fieldWrapper">
+
+ {# Include the hidden fields in the form #}
+ {% if forloop.first %}
+ {% for hidden in form.hidden_fields %}
+ {{ field }}
+ {% endfor %}
+ {% endif %}
+
+ {{ field.errors }}
+ {{ field.label_tag }}: {{ field }}
+ </div>
+ {% endfor %}
+ <p><input type="submit" value="Send message" /></p>
+ </form>
+
+This example does not handle any errors in the hidden fields. Usually, an
+error in a hidden field is a sign of form tampering, since normal form
+interaction won't alter them. However, you could easily insert some error
+displays for those form errors as well.
+
+.. versionadded:: 1.1
+ The ``hidden_fields`` and ``visible_fields`` methods are new in Django
+ 1.1.
+
Reusable form templates
-----------------------
Modified: django/trunk/tests/regressiontests/forms/forms.py
===================================================================
--- django/trunk/tests/regressiontests/forms/forms.py 2008-12-04 19:34:54 UTC
(rev 9568)
+++ django/trunk/tests/regressiontests/forms/forms.py 2008-12-05 04:22:00 UTC
(rev 9569)
@@ -1757,4 +1757,16 @@
>>> form.is_valid()
True
+# Extracting hidden and visible fields ######################################
+
+>>> class SongForm(Form):
+... token = CharField(widget=HiddenInput)
+... artist = CharField()
+... name = CharField()
+>>> form = SongForm()
+>>> [f.name for f in form.hidden_fields()]
+['token']
+>>> [f.name for f in form.visible_fields()]
+['artist', 'name']
+
"""
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to django-updates@googlegroups.com
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
