Changeset 2704 in products for quintagroup.portlet.collection

Timestamp:

Jul 20, 2010 7:51:26 AM (14 years ago)

Author:

fenix

Message:

added batch navigation

Location:

quintagroup.portlet.collection/trunk/quintagroup/portlet/collection

Files:

• browser/configure.zcml (modified) (1 diff)
• browser/resources (added)
• browser/resources/batch.js (added)
• browser/templates (added)
• browser/templates/items_listing.pt (added)
• browser/templates/navigation.pt (added)
• collection.pt (modified) (2 diffs)
• collection.py (modified) (6 diffs)
• profiles/default/jsregistry.xml (added)

quintagroup.portlet.collection/trunk/quintagroup/portlet/collection/browser/configure.zcml

@@ -14 +14 @@
       />
 
+  <browser:resource
+      name="batch.js"
+      file="resources/batch.js" />
 </configure>

quintagroup.portlet.collection/trunk/quintagroup/portlet/collection/collection.pt

@@ -2 +2 @@
     i18n:domain="plone"
     tal:define="collection_url view/collection_url;
-                styling view/data/styling;
-                plone_view context/@@plone;
-                toLocalizedTime nocall:plone_view/toLocalizedTime;
-                getIcon nocall:plone_view/getIcon;"
+                styling view/data/styling"
     tal:attributes="class string:${attrs/class} ${styling}">
 
@@ -15 +12 @@
         </a>
         <span class="portletTopRight"></span>
+        <span class="portletNavSection"
+              tal:condition="view/data/allow_batching"
+              tal:content="structure view/batch_navigation">
+        </span>
     </dt>
-    
-    <tal:events tal:repeat="obj view/results">
-    <dd class="portletItem"
-        tal:define="oddrow repeat/obj/odd;
-                    item_icon python:getIcon(obj);
-                    show_title python:view.showProperty('Title');
-                    show_description python:view.showProperty('Description')"
-        tal:attributes="class python:oddrow and 'portletItem even' or 'portletItem odd'">
-        <a href="#"
-           class="tile"
-           tal:attributes="href obj/getURL;
-                           title python: show_description and obj.Description or ''">
-            <img tal:replace="structure item_icon/html_tag" />
-            <span class="tileTitle"
-                  tal:condition="show_title"
-                  tal:content="obj/pretty_title_or_id">
-             Title
-            </span>
-            <span class="tileDescription"
-                  tal:condition="show_description">
-              <tal:descr content="obj/Description" />
-              <span class="tileReadMore"
-                    tal:condition="view/data/show_item_more"
-                    tal:attributes="href obj/getURL" i18n:translate="more_url">
-                    &hellip;more
-              </span>            
-            </span>
-            <span class="portletItemDetails"
-                  tal:condition="view/data/show_dates"
-                  tal:content="python:toLocalizedTime(obj.Date)">
-                Date
-            </span>
-        </a>
-    </dd>
-    </tal:events>
-    
+    <tal:items replace="structure view/render_items"/>
     <dd class="portletFooter" tal:condition="view/data/show_more">
         <span class="portletBottomLeft"></span>

quintagroup.portlet.collection/trunk/quintagroup/portlet/collection/collection.py

@@ -16 +16 @@
 from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
 from plone.app.vocabularies.catalog import SearchableTextSourceBinder
+from zope.schema import ValidationError
 from plone.app.form.widgets.uberselectionwidget import UberSelectionWidget
 
 from Products.ATContentTypes.interface import IATTopic
+from Products.CMFPlone.PloneBatch import Batch
 from plone.portlet.collection.collection import ICollectionPortlet
 
 from quintagroup.portlet.collection import MessageFactory as _
+
+MIN_BATCH_SIZE , MAX_BATCHSIZE = 1, 30
+
+class NotValidBatchSizeValue(ValidationError):
+    """This is not valid batch size value.
+    
+    """
+
+def validate_batch_size(value):
+    if MIN_BATCH_SIZE <= value <= MAX_BATCHSIZE:
+        return True
+    raise NotValidBatchSizeValue(value)
 
 class IQCollectionPortlet(ICollectionPortlet):
@@ -52 +66 @@
                                  default=True)
 
+    allow_batching = schema.Bool(title=_(u"Allow batching."),
+                                 description=_(u"If enabled, items will be splited into pages."),
+                                 required=False,
+                                 default=False)
+
+    batch_size = schema.Int(title=_(u"Batch size"),
+                            description=_("Amount of items per page"
+                                          "(if not set 3 items will be displayed as default)."),
+                            required=False,
+                            default=3, 
+                            constraint=validate_batch_size)
+
 class Assignment(base.Assignment):
     """
@@ -68 +94 @@
     def __init__(self, header=u"", target_collection=None, limit=None,
                  random=False, show_more=True, show_dates=False,
-                 item_attributes=[], styling=u"", show_item_more=False, link_title=True):
+                 item_attributes=[], styling=u"", show_item_more=False,
+                 link_title=True, allow_batching=False, batch_size=3):
 
         super(Assignment, self).__init__(header=header,
@@ -79 +106 @@
         self.show_item_more = show_item_more
         self.link_title = link_title
+        self.allow_batching = allow_batching
+        self.batch_size = batch_size
        
     @property
@@ -86 +115 @@
         """
         return self.header
-
-
+    
 class Renderer(base.Renderer):
     """Portlet renderer.
@@ -97 +125 @@
 
     render = ViewPageTemplateFile('collection.pt')
+    navigation = ViewPageTemplateFile('browser/templates/navigation.pt')
+    items_listing = ViewPageTemplateFile('browser/templates/items_listing.pt')
 
     def showProperty(self, name):
         return name in self.data.item_attributes
 
+    def batches(self):
+        items = super(Renderer, self).results()
+        delta = self.data.batch_size
+        return [items[idx:idx + delta] for idx in range(0, len(items), delta)]
+    
+    def batch_navigation(self):
+        return self.navigation(batches=self.batches())
+
+    def render_items(self):
+        if self.data.allow_batching:
+            return ''.join([self.items_listing(portlet_items=batch,
+                                               page_number=str(index))
+                            for index, batch in enumerate(self.batches())])
+        return self.items_listing(portlet_items=self.results())
         
 class AddForm(base.AddForm):