Fixed #16841 - Documented a couple ModelAdmin methods

* ModelAdmin.get_changelist_form and get_changelist_formset
* InlineModelAdmin.get_formset

Thanks Jordan Reiter for the report.
This commit is contained in:
Tim Graham 2012-11-03 05:22:34 -04:00
parent 965cc0b1ff
commit 39f5bc7fc3
1 changed files with 34 additions and 1 deletions

View File

@ -1233,10 +1233,39 @@ templates used by the :class:`ModelAdmin` views:
.. method:: ModelAdmin.get_changelist(self, request, **kwargs) .. method:: ModelAdmin.get_changelist(self, request, **kwargs)
Returns the Changelist class to be used for listing. By default, Returns the ``Changelist`` class to be used for listing. By default,
``django.contrib.admin.views.main.ChangeList`` is used. By inheriting this ``django.contrib.admin.views.main.ChangeList`` is used. By inheriting this
class you can change the behavior of the listing. class you can change the behavior of the listing.
.. method:: ModelAdmin.get_changelist_form(self, request, **kwargs)
Returns a :class:`~django.forms.ModelForm` class for use in the ``Formset``
on the changelist page. To use a custom form, for example::
class MyForm(forms.ModelForm):
class Meta:
model = MyModel
class MyModelAdmin(admin.ModelAdmin):
def get_changelist_form(self, request, **kwargs):
return MyForm
.. method:: ModelAdmin.get_changelist_formset(self, request, **kwargs)
Returns a :ref:`ModelFormSet <model-formsets>` class for use on the
changelist page if :attr:`~ModelAdmin.list_editable` is used. To use a
custom formset, for example::
from django.forms.models import BaseModelFormSet
class MyAdminFormSet(BaseModelFormSet):
pass
class MyModelAdmin(admin.ModelAdmin):
def get_changelist_formset(self, request, **kwargs):
kwargs['formset'] = MyAdminFormSet
return super(MyModelAdmin, self).get_changelist_formset(request, **kwargs)
.. method:: ModelAdmin.has_add_permission(self, request) .. method:: ModelAdmin.has_add_permission(self, request)
Should return ``True`` if adding an object is permitted, ``False`` Should return ``True`` if adding an object is permitted, ``False``
@ -1552,6 +1581,10 @@ The ``InlineModelAdmin`` class adds:
Specifies whether or not inline objects can be deleted in the inline. Specifies whether or not inline objects can be deleted in the inline.
Defaults to ``True``. Defaults to ``True``.
.. method:: InlineModelAdmin.get_formset(self, request, obj=None, **kwargs)
Returns a ``BaseInlineFormSet`` class for use in admin add/change views.
See the example for :class:`ModelAdmin.get_formsets`.
Working with a model with two or more foreign keys to the same parent model Working with a model with two or more foreign keys to the same parent model
--------------------------------------------------------------------------- ---------------------------------------------------------------------------