Yesterday I wanted to beef up a ListView-based page with additional navigation controls.\u00a0 Specifically, I decided to add buttons to jump back 5 and ahead 5 pages in the list.\u00a0 With a little bit of class extension, this was easy to do.<\/p>\n
Source:<\/p>\n
from django.core.paginator import Page, Paginator\r\n\r\nclass PageFive(Page):class PageFive(Page):\r\n\r\n ''' Include info for next 5 and previous 5 pages '''\r\n\r\n def has_next_five(self): \r\n return self.number < self.paginator.num_pages - 5 \r\n\r\n def has_previous_five(self): \r\n return self.number > 6\r\n\r\n def next_five_page_number(self): \r\n return self.paginator.validate_number(self.number + 5)\r\n\r\n def previous_five_page_number(self): \r\n return self.paginator.validate_number(self.number - 5)\r\n\r\n\r\nclass PaginatorFive(Paginator):\r\n\r\n ''' Uses the PageFive class to report info for next and previous 5 pages\r\n Set pageinator_class in ListView to use '''\r\n\r\n def _get_page(self, *args, **kwargs): \r\n \"\"\" \r\n Return an instance of a single page using the PageFive object \r\n \"\"\" \r\n\r\n return PageFive(*args, **kwargs)<\/pre>\nFirst step was to extend the
Page<\/code>class to add additional methods.\u00a0 Mimicking the existing methods for next and previous pages, these four new functions return information on the previous five and next five pages of the list.<\/p>\nTo use my new
PageFive<\/code>class, I also extended thePaginator<\/code>\u00a0class.\u00a0 Lucky for me, the authors have included the_get_page()<\/code>method as a hook to modify thePage<\/code>class used.\u00a0 Simple to override.<\/p>\nNext, I have to tell
ListView<\/code>to call my redefined paginator.\u00a0 Thepaginator_class<\/code>variable is used to make that change:<\/p>\nclass MyListView(ListView):\r\n model = MyModel\r\n paginate_by = 10\r\n paginator_class = PaginatorFive\r\n\r\n<\/pre>\nFinally, I can use the new methods of the
PageFive<\/code>class in the template:<\/p>\n<!-- PaginatorFive navigation buttons -->\r\n {% if is_paginated %}\r\n <ul class=\"pagination pagination-centered\">\r\n {% if page_obj.has_previous %}\r\n <li><a href=\"?page=1\">First<\/a><\/li>\r\n {% if page_obj.has_previous_five %}\r\n <li><a href=\"?page={{ page_obj.previous_five_page_number }}\">Back 5<\/a><\/li>\r\n {% endif %}\r\n <li><a href=\"?page={{ page_obj.previous_page_number }}\">Prev<\/a><\/li>\r\n {% endif %}\r\n\r\n <li class=\"active\" ><a href=\"?page={{page_obj.number}}\">{{page_obj.number}} of{{ page_obj.paginator.num_pages }}<\/a><\/li>\r\n\r\n {% if page_obj.has_next %}\r\n <li><a href=\"?page={{ page_obj.next_page_number }}\">Next<\/a><\/li>\r\n {% if page_obj.has_next_five %}\r\n <li><a href=\"?page={{ page_obj.next_five_page_number }}\">Ahead 5<\/a><\/li>\r\n {% endif %}\r\n <li><a href=\"?page={{ page_obj.paginator.num_pages }}\">Last<\/a><\/li>\r\n {% endif %}\r\n <\/ul>\r\n {% endif %}<\/pre>\nThis was a fun little exercise.<\/p>\n
<\/p>\n
(Sorry for the word wrap in the code.\u00a0 Copy to your editor for a better view)<\/p>\n","protected":false},"excerpt":{"rendered":"
Yesterday I wanted to beef up a ListView-based page with additional navigation controls.\u00a0 Specifically, I decided to add buttons to jump back 5 and ahead 5 pages in the list.\u00a0 With a little bit of class extension, this was easy to do. Source: from django.core.paginator import Page, Paginator class PageFive(Page):class PageFive(Page): ”’ Include info for … <\/p>\n