Collection

class cruditor.collection.CollectionViewMixin

Bases: object

Mixin to provide some extra default functionality to Cruditor views to make building views for a collection of data (like a Django model) even easier.

collection_list_title = 'Collection'

Title for collection list view

collection_list_urlname = None

URL name to use when linking to the list view (e.g. in breadcrumb)

collection_add_urlname = None

URL name to use when linking to the add view (e.g. in title buttons)

collection_detail_urlname = None

URL name when linking to a detail page of a item (e.g. in list table or breadcrumb)

collection_delete_urlname = None

URL name when linking to the delete page of a item (e.g. in change view)

get_title()

The method calls the get_collection_list_title method when the view is a list view. All other views rely on the default behavior of cruditor.

get_success_url()

get_delete_url()

get_breadcrumb_title()

The breadcrumb title returns “Delete” for delete views, default breadcrumb for all other views.

get_breadcrumb()

This method creates the required breadcrumb items for the collection following some rules:

• No extra items for list view

• list view element when the collection_include_list_crumb method is true.

• detail view element when the collection_include_detail_crumb method is true.

get_titlebuttons()

get_table_class()

This method returns the django-tables2 Table class to use in the list view. If no class is defined, a new Table class is created (with one linked column).

collection_include_add_titlebutton()

If this method returns true, an “Add model verbose name” button should be included in the list view.

collection_include_list_crumb()

If this method returns true, the list view should be included in the breadcrumb.

collection_include_detail_crumb()

If this method returns true, the detail view should be included in the breadcrumb.

get_collection_url_args()

This helper method returns the args that are used to reverse urls for list and add views (views that don’t refer to a object/instance). By default, returns an empty tuple.

get_collection_object_url_args()

This helper method returns the args that are used to reverse urls for views that refer to a detail page (object/instance related views). By default returns the object PK.

get_collection_list_title()

Helper method to override the used collection list title. By default, just returns the class collection_list_title property.

get_collection_list_url()

Helper method to generate the collection list url. By default, just calls reverse with the collection_list_urlname property.

get_collection_detail_title()

Helper method to override the used collection detail title. By default, just returns the str-representation of the requested item.

get_collection_detail_url()

Helper method to generate the collection detail url for the current object. By default, calls reverse with the collection_detail_urlname property and passes the object pk to the function call.

get_collection_add_titlebutton_label()

Helper method to override the used button label for the “Add” title button. By default, returns “Add <model verbose name>”.

get_collection_add_url()

Helper method to generate the collection add url. By default, just calls reverse with the collection_add_urlname property.

get_collection_delete_url()

Helper method to generate the collection delete url for the current object. By default, calls reverse with the collection_delete_urlname property and passes the object pk to the function call.

get_collection_object_success_url()

Helper method to generate the success url after obejct related redirects (e.g. add, change). By default, calls reverse with the get_collection_list_url method.

cruditor.collection.generate_urls(path_prefix, name_prefix, list_view=None, add_view=None, change_view=None, delete_view=None, extra_detail_views=None, detail_path='<int:pk>')

This helper allows creating urls for urlpatterns in urls.py in a fast way by just providing the view classes and some url and name prefix. In addition, one can add extra detail views.