| 1 | = FormField = |
| 2 | |
| 3 | Manipulators create a "field" attribute that is used to describe the entries in an html form. Each field class takes a list of arguments in its initializer. |
| 4 | |
| 5 | The first argument to all field initializers is the ''field_name''. This is the name that is attached to the field's input. |
| 6 | |
| 7 | == Generic Widgets == |
| 8 | |
| 9 | * '''TextField''' |
| 10 | * field_name, length=30, maxlength=None, is_required=False, validator_list=[], member_name=None |
| 11 | * <input type="text"> |
| 12 | * '''PasswordField''' |
| 13 | * field_name, length=30, maxlength=None, is_required=False, validator_list=[], member_name=None |
| 14 | * <input type="password"> |
| 15 | * '''LargeTextField''' |
| 16 | * field_name, rows=10, cols=40, is_required=False, validator_list=[], maxlength=None |
| 17 | * <textarea> |
| 18 | * '''HiddenField''' |
| 19 | * <input type="hidden"> |
| 20 | * '''CheckboxField''' |
| 21 | * field_name, checked_by_default=False |
| 22 | * <input type="checkbox"> |
| 23 | * '''SelectField''' |
| 24 | * field_name, choices=[], size=1, is_required=False, validator_list=[], member_name=None |
| 25 | * <select> |
| 26 | * '''NullSelectField''' |
| 27 | * ''This !SelectField converts blank fields to None'' |
| 28 | * field_name, choices=[], size=1, is_required=False, validator_list=[], member_name=None |
| 29 | * <select><option></select> |
| 30 | * '''RadioSelectField''' |
| 31 | * ''Returns a special object, !RadioFieldRenderer, that is iterable and has a default str() rendered output.'' |
| 32 | * field_name, choices=[], ul_class="", is_required=False, validator_list=[], member_name=None |
| 33 | * <ul><li><input type="radio"></li> ... </ul> |
| 34 | * '''NullBooleanField''' |
| 35 | * ''This !SelectField provides "Yes", "No" and "Unknown", mapping results to True, False or None'' |
| 36 | * field_name, is_required=False, validator_list=[] |
| 37 | * <select> |
| 38 | * '''CheckboxSelectMultipleField''' |
| 39 | * ''This has an identical interface to !SelectMultipleField, except the rendered widget is different.'' |
| 40 | * field_name, choices=[], size=1, is_required=False, validator_list=[], member_name=None |
| 41 | * <select><option></select> |
| 42 | |
| 43 | == File Uploads == |
| 44 | |
| 45 | * '''FileUploadField''' |
| 46 | * field_name, is_required=False, validator_list=[] |
| 47 | * <input type="file"> |
| 48 | * '''ImageUploadField''' |
| 49 | * ''A !FileUploadField that raises !CriticalValidationError if the uploaded file isn't an image.'' |
| 50 | * field_name, is_required=False, validator_list=[] |
| 51 | * <input type="file"> |
| 52 | |
| 53 | == Numbers == |
| 54 | |
| 55 | * '''IntegerField''' |
| 56 | * field_name, length=10, maxlength=None, is_required=False, validator_list=[], member_name=None |
| 57 | * <input type="text"> |
| 58 | * '''SmallIntegerField''' |
| 59 | * field_name, length=5, maxlength=5, is_required=False, validator_list=[], member_name=None |
| 60 | * <input type="text"> |
| 61 | * '''PositiveIntegerField''' |
| 62 | * field_name, length=10, maxlength=None, is_required=False, validator_list=[], member_name=None |
| 63 | * <input type="text"> |
| 64 | * '''PositiveSmallIntegerField''' |
| 65 | * field_name, length=5, maxlength=5, is_required=False, validator_list=[], member_name=None |
| 66 | * <input type="text"> |
| 67 | * '''FloatField''' |
| 68 | * field_name, max_digits, decimal_places, is_required=False, validator_list=[] |
| 69 | * <input type="text"> |
| 70 | |
| 71 | == Dates and Times == |
| 72 | |
| 73 | * '''DatetimeField''' |
| 74 | * ''A !FormField that automatically converts its data to a datetime.datetime object. The data should be in the format YYYY-MM-DD HH:MM:SS.'' |
| 75 | * field_name, length=30, maxlength=None, is_required=False, validator_list=[] |
| 76 | * <input type="text"> |
| 77 | * '''DateField''' |
| 78 | * ''A !FormField that automatically converts its data to a datetime.date object. The data should be in the format YYYY-MM-DD.'' |
| 79 | * <input type="text"> |
| 80 | * '''TimeField''' |
| 81 | * ''A !FormField that automatically converts its data to a datetime.time object. The data should be in the format HH:MM:SS or HH:MM:SS.mmmmmm.'' |
| 82 | * field_name, is_required=False, validator_list=[] |
| 83 | * <input type="text"> |
| 84 | |
| 85 | == Internet == |
| 86 | |
| 87 | * '''EmailField''' |
| 88 | * '''URLField''' |
| 89 | * '''IPAddressField''' |
| 90 | |
| 91 | == Miscellaneous == |
| 92 | * '''FilePathField''' |
| 93 | * '''PhoneNumberField''' |
| 94 | * '''USStateField''' |
| 95 | * '''CommaSeparatedIntegerField''' |
| 96 | * '''RawIdAdminField''' |
| 97 | * '''XMLLargeTextField''' |
| 98 | |
| 99 | |