Collapse in admin interface for inline related objects

[jcstover@…]

It would be nice if there is a property to tell the admin interface to collapse the related object.

eg:
organisatie = meta.ForeignKey(Organisatie, edit_inline=meta.STACKED, edit_inline_style='collapse')

I changed line 610 in the django/views/admin/main.py to
t.append('<fieldset class="module%s">\n' % ((rel_field.rel.edit_inline != meta.TABULAR) and ' aligned collapse' or ' collapse'))
and it works. But using a property would be better.

Thanks

[jctover@…]

Since I changed already a few things in the admin view for translation and I'm not experienced with svn yet here are my changes I made to create an inline_style property to make it collapse

in django/core/meta/fields.py line nr 585

• raw_id_admin=kwargs.pop('raw_id_admin', False)) + raw_id_admin=kwargs.pop('raw_id_admin', False), inline_style=kwargs.pop('inline_style', None))

in django/core/meta/fields.py line nr 654

• related_name=None, limit_choices_to=None, lookup_overrides=None, raw_id_admin=False): + related_name=None, limit_choices_to=None, lookup_overrides=None, raw_id_admin=False, inline_style=None):

in django/views/admin/main.py line 610

• t.append('<fieldset class="module%s %s">\n' % ((rel_field.rel.edit_inline != meta.TABULAR) and ' aligned' or )) + t.append('<fieldset class="module%s %s">\n' % ((rel_field.rel.edit_inline != meta.TABULAR) and ' aligned' or , rel_field.rel.inline_style or ))

For using it just include inline_style='collapse' and the related objects are collapsed.
Hope you include a better solution to this problem

Johan

[mdt@…]

even the collapse in the related object has no effect. is that a bug?

[anonymous]

Removed myself from the Cc list (no longer that interested =))

[(none)]

Milestone Version 1.0 deleted

[Marc Fargas <telenieko@…>]

Wy don't you use the method provied by ​http://www.djangoproject.com/documentation/model_api/#id3?
It provides almost this, I think.

If it's enought for the reporter, please close the ticket as "worksforme" ;)

[jcstover@…]

I didn't use django for a while, but from what I remember. For a tablular view of related objects you can collapse that view, but not when it is stacked. That was it about. If it is working for stacked objects now its okay.

[Chris Beaven]

Can someone confirm this?

[Marc Fargas <telenieko@…>]

Confirmed, it has to do with the way [source:django/trunk/django/contrib/admin/templates/admin/change_form.html] works, it can handle the "classes" attribute for fields (line 36), but not for "edit_inline" relations (stacked or inline) on line 57. And I could not find any easy way to get it working. Maybe [source:django/trunk/django/contrib/admin/templates/admin/edit_inline_stacked.html] should get the classes for the related objects but dunno how to pass it.

As a side note, it's models.STACKED not meta.STACKED right now, changing the summary to reflect this.

[Jacob]

-> newforms-admin

[Antonis Christofides <anthony@…>]

Patch with alternative approach

[Antonis Christofides <anthony@…>]

I just uploaded a patch. You append a string with classes to edit_inline, and it uses these classes. For example:

edit_inline = models.TABULAR + 'collapse extrapretty'

[Antonis Christofides <anthony@…>]

Updated patch, fixing a documentation problem

[Yves Serrano]

The patch fails on the newforms-admin branch.
The file structure has changed from
django/contrib/admin/templates/admin/edit_inline_stacked.html
to
django/contrib/admin/templates/admin/edit_inline/stacked.html

[Brian Rosner]

Tagging with nfa-someday as this is functionality that is not critical to the merge of the newforms-admin branch.

[Antonis Christofides <anthony@…>]

Could you please point me to a description of how the newforms-admin branch is managed and what is the policy for patching admin/newforms-admin? Do I need to write two patches, one for old admin and one for new admin?

The second question is whether a better patch in the same spirit would be accepted.

[mrts]

Non-essential for 1.0.

Antonis, you could write a similar patch against trunk when newforms-admin gets merged (and that is really soon now). It will be eventually merged, but probably not before 1.0.

[Antonis Christofides]

Quick and dirty solution for brainstorming

[Antonis Christofides]

I just uploaded another patch (not including documentation), as proof of concept. It works, but I've done it by doing quite some voodoo debugging. The idea is to add a 'classes' InlineModelAdmin option, with a list of classes. For example:

class BookInline(admin.TabularInline):
    model = Book
    classes = ['collapse', 'extrapretty']

If we like this interface, then please review my patch and help me find out what I didn't get right. However, I think that ideally I'd like another interface: the "fieldsets" ModelAdmin option should be reworked in order to somehow include inline objects. This would also give the flexibility to change the order, allowing them to intermingle with other fieldsets, and so on. But this also means that some conceptual changes should be made, because inline objects are not fieldsets, they are formsets. The "fieldsets" option might need to be renamed to "formsections" or so and its structure enhanced or modified.

[Antonis Christofides]

Note: Apparently the patch I submitted only works if the model contains another fieldset that specifies "classes".

[Chris Beaven]

aptiko's patch looks good. It adds useful functionality and I like the addition of a fieldset to the StackedInline template - I always thought it should have it for consistency.

The patch does incorrectly close <fieldset> with </div>.
It also needs to change generic_inlineformset_factory in django.contrib.contenttypes.generic.

[Antonis Christofides]

SmileyChris, thanks for reviewing my patch. I'm working on it.

[Antonis Christofides]

Patch that fixes spotted errors

[Antonis Christofides]

I just uploaded an updated patch, with the following differences from the previous one:

1. Previous patch would only work if the model admin contained another fieldset that specified "classes". I fixed this.
2. It fixes the incorrect closing of <fieldset> with </div>.
3. It includes the necessary changes in generic_inlineformset_factory.
4. It includes documentation.

Please note, however, that I have not tested generic_inlineformset_factory. I merely made the change and checked that the file compiles.

[Jeffrey Gelens]

The patch didn't apply correctly anymore to trunk. Updated with the right offsets.

[(none)]

Milestone post-1.0 deleted

[Antti Kaihola]

Updated offsets and doc file path for trunk r10680

[Alex Gaynor]

classes should not be present on formsets.

[Antti Kaihola]

Replying to Alex:

classes should not be present on formsets.

Do you mean that the API of the patch is good, but it shouldn't touch django.forms and django.contrib.contenttypes?

[ramusus]

2 differences from 494.6.path described below

[ramusus]

.... added property

"classes": self.classes 

to the defaults dictionary inside GenericInlineModelAdmin for activating ability to collapse generic inline admin forms.

And also added ability to define closed by default fieldset without any stumble while page is loading this way:

class BookInline(admin.TabularInline):
    model = Book
    classes = ['collapse', 'collapsed']

[anonymous]

I didn't use django for a while, but from what I remember. 
For a tablular view of related objects you can collapse that 
view, but not when it is stacked. That was it about. If it is
working for stacked objects now its okay.

How can I do that? (aka, is there a work around for doing this w/o patching code?)

[anonymous]

I patched manually the current svn with the 494.7 patch, but it seems that no longer work. Why doesn't submit to milestone?

[ramusus]

works with 12351 rev in development trunk (updated)

[Matthew Schinckel]

I've updated the patch so that it doesn't use an empty list as the default argument for classes: this doesn't necessarily do what you expect it to. A second or tertiary call to the same function will use the same list, even if you have added things to it in the meantime, meaning that classes may get added to other objects that were not supposed to. At this stage, that is unlikely anyway, but it is bad form to create a function definition with an empty list as the default argument to anything. This patch works with r12661.

[Matthew Schinckel]

A version that actually adds the classes properly. Works with r12835, and StackedInlines.

[Adam Nelson]

The patch itself seems to satisfy people's comments, but tests are still needed.

[Alex Gaynor]

For the record (and I thought I'd left this comment before, but apparently not) I'm opposed to formsets having some knowledge of "classes", there's no precedent for it in the forms API, and it further munges the output with the server side issues.

[Adam Nelson]

In that case, reverting needs_better_patch

[Matthew Schinckel]

Replying to Alex:

For the record (and I thought I'd left this comment before, but apparently not) I'm opposed to formsets having some knowledge of "classes", there's no precedent for it in the forms API, and it further munges the output with the server side issues.

In hindsight, I think I agree. I'm not sure if I got that code from someone else, and just updated it, but I was definitely following a pattern of some sort.

Having said that, BoundField in django.forms.forms.py contains a method css_classes, which looks for a property called extra_classes, which it uses to add classes to a field element. Why could the same not apply to a Form?

[Tim Graham]

​PR

[Tim Graham <timograham@…>]

In 5399ccc0:

Fixed #494 -- Added ability to specify classes on admin inline fieldsets.

This includes the ability to collapse inlines by specifying a class named
'collapse'.

[Tim Graham <timograham@…>]

In 99d2469e:

Refs #494 -- Fixed a flaky admin_inlines tests.