Implement pat-contentbrowser widget

plone · Sep 16, 2024 · a783df5 · a783df5
1 parent 8feba93
commit a783df5
Show file tree

Hide file tree

Showing 7 changed files with 356 additions and 58 deletions.
diff --git a/plone/app/z3cform/converters.py b/plone/app/z3cform/converters.py
@@ -3,11 +3,11 @@
 from datetime import time
 from plone.app.z3cform import utils
 from plone.app.z3cform.interfaces import IAjaxSelectWidget
+from plone.app.z3cform.interfaces import IContentBrowserWidget
 from plone.app.z3cform.interfaces import IDatetimeWidget
 from plone.app.z3cform.interfaces import IDateWidget
 from plone.app.z3cform.interfaces import ILinkWidget
 from plone.app.z3cform.interfaces import IQueryStringWidget
-from plone.app.z3cform.interfaces import IRelatedItemsWidget
 from plone.app.z3cform.interfaces import ISelectWidget
 from plone.app.z3cform.interfaces import ISingleCheckBoxBoolWidget
 from plone.app.z3cform.interfaces import ITimeWidget
@@ -304,9 +304,9 @@ def toFieldValue(self, value):
         return collectionType(untokenized_value)
 
 
-@adapter(IRelation, IRelatedItemsWidget)
-class RelationChoiceRelatedItemsWidgetConverter(BaseDataConverter):
-    """Data converter for RelationChoice fields using the RelatedItemsWidget."""
+@adapter(IRelation, IContentBrowserWidget)
+class RelationChoiceContentBrowserWidgetConverter(BaseDataConverter):
+    """Data converter for RelationChoice fields using the ContentBrowserWidget."""
 
     def toWidgetValue(self, value):
         if not value:
@@ -328,8 +328,15 @@ def toFieldValue(self, value):
             return self.field.missing_value
 
 
+# BBB
+class RelationChoiceRelatedItemsWidgetConverter(
+    RelationChoiceContentBrowserWidgetConverter
+):
+    """backwards compatibility"""
+
+
 @adapter(IRelation, ISequenceWidget)
-class RelationChoiceSelectWidgetConverter(RelationChoiceRelatedItemsWidgetConverter):
+class RelationChoiceSelectWidgetConverter(RelationChoiceContentBrowserWidgetConverter):
     """Data converter for RelationChoice fields using with SequenceWidgets,
     which expect sequence values.
     """
@@ -341,9 +348,9 @@ def toWidgetValue(self, value):
         return [IUUID(value)]
 
 
-@adapter(ICollection, IRelatedItemsWidget)
-class RelatedItemsDataConverter(BaseDataConverter):
-    """Data converter for ICollection fields using the RelatedItemsWidget."""
+@adapter(ICollection, IContentBrowserWidget)
+class ContentBrowserDataConverter(BaseDataConverter):
+    """Data converter for ICollection fields using the ContentBrowserWidget."""
 
     def toWidgetValue(self, value):
         """Converts from field value to widget.
@@ -405,8 +412,13 @@ def toFieldValue(self, value):
             return collectionType(valueType(v) for v in value)
 
 
+# BBB
+class RelatedItemsDataConverter(ContentBrowserDataConverter):
+    """backwards compatibility"""
+
+
 @adapter(IRelationList, ISequenceWidget)
-class RelationListSelectWidgetDataConverter(RelatedItemsDataConverter):
+class RelationListSelectWidgetDataConverter(ContentBrowserDataConverter):
     """Data converter for RelationChoice fields using with SequenceWidgets,
     which expect sequence values.
     """

diff --git a/plone/app/z3cform/converters.zcml b/plone/app/z3cform/converters.zcml
@@ -8,16 +8,16 @@
   <adapter factory=".converters.SequenceSelect2WidgetConverter" />
   <adapter factory=".converters.AjaxSelectWidgetConverter" />
   <adapter factory=".converters.QueryStringDataConverter" />
-  <adapter factory=".converters.RelationChoiceRelatedItemsWidgetConverter" />
+  <adapter factory=".converters.RelationChoiceContentBrowserWidgetConverter" />
   <adapter
-      factory=".converters.RelationChoiceRelatedItemsWidgetConverter"
+      factory=".converters.RelationChoiceContentBrowserWidgetConverter"
       for="z3c.relationfield.interfaces.IRelationChoice
            .interfaces.ITextWidget"
       />
   <adapter factory=".converters.RelationChoiceSelectWidgetConverter" />
-  <adapter factory=".converters.RelatedItemsDataConverter" />
+  <adapter factory=".converters.ContentBrowserDataConverter" />
   <adapter
-      factory=".converters.RelatedItemsDataConverter"
+      factory=".converters.ContentBrowserDataConverter"
       for="z3c.relationfield.interfaces.IRelationList
            .interfaces.ITextWidget"
       />

diff --git a/plone/app/z3cform/interfaces.py b/plone/app/z3cform/interfaces.py
@@ -91,6 +91,10 @@ class IRelatedItemsWidget(ITextWidget):
     """Marker interface for the RelatedItemsWidget."""
 
 
+class IContentBrowserWidget(ITextWidget):
+    """Marker interface for the RelatedItemsWidget."""
+
+
 class IRichTextWidget(patextfield_IRichTextWidget):
     """Marker interface for the TinyMCEWidget."""
 

diff --git a/plone/app/z3cform/templates/contentbrowser_display.pt b/plone/app/z3cform/templates/contentbrowser_display.pt
@@ -0,0 +1,44 @@
+<div class="contentbrowser-widget ${python:normalizeString(view.field.__class__.__name__)}-field"
+     id="form-widgets-${python:view.__name__}"
+     tal:define="
+       plone_view nocall:context/@@plone;
+       normalizeString python:plone_view.normalizeString;
+       items python: view.items();
+     "
+     tal:condition="items"
+     i18n:domain="plone"
+>
+  <ul>
+    <li tal:repeat="item items">
+      <span title="${item_type}"
+            tal:define="
+              item_type           python:item.portal_type;
+              item_type_class     python:item.ContentTypeClass();
+              item_wf_state_class python:item.ReviewStateClass();
+              appendViewAction    python:item.appendViewAction();
+              item_url            python:item.getURL();
+              item_url            python:item_url+'/view' if appendViewAction else item_url;
+            "
+      >
+
+        <a href="${item_url}">
+          <img class="mime-icon"
+               src="${python:item.MimeTypeIcon()}"
+               tal:condition="python:item_type =='File'"
+          />
+
+          <span class="${item_type_class} ${item_wf_state_class} url"
+                tal:content="python:item.Title()"
+          >
+                    Title
+          </span>
+          <span class="discreet"
+                tal:content="python:item.Description()"
+          >
+                    Description
+          </span>
+        </a>
+      </span>
+    </li>
+  </ul>
+</div>
diff --git a/plone/app/z3cform/templates/relateditems_display.pt b/plone/app/z3cform/templates/relateditems_display.pt
@@ -1,46 +1,44 @@
-<span class="relateditems-widget ${python:normalizeString(view.field.__class__.__name__)}-field"
-      id="form-widgets-${python:view.__name__}"
-      tal:define="
-        plone_view nocall:context/@@plone;
-        normalizeString python:plone_view.normalizeString;
-        items python: view.items();
-      "
-      tal:condition="items"
-      i18n:domain="plone"
+<div class="relateditems-widget ${python:normalizeString(view.field.__class__.__name__)}-field"
+     id="form-widgets-${python:view.__name__}"
+     tal:define="
+       plone_view nocall:context/@@plone;
+       normalizeString python:plone_view.normalizeString;
+       items python: view.items();
+     "
+     tal:condition="items"
+     i18n:domain="plone"
 >
-  <div>
-    <ul>
-      <li tal:repeat="item items">
-        <span title="${item_type}"
-              tal:define="
-                item_type           python:item.portal_type;
-                item_type_class     python:item.ContentTypeClass();
-                item_wf_state_class python:item.ReviewStateClass();
-                appendViewAction    python:item.appendViewAction();
-                item_url            python:item.getURL();
-                item_url            python:item_url+'/view' if appendViewAction else item_url;
-              "
-        >
+  <ul>
+    <li tal:repeat="item items">
+      <span title="${item_type}"
+            tal:define="
+              item_type           python:item.portal_type;
+              item_type_class     python:item.ContentTypeClass();
+              item_wf_state_class python:item.ReviewStateClass();
+              appendViewAction    python:item.appendViewAction();
+              item_url            python:item.getURL();
+              item_url            python:item_url+'/view' if appendViewAction else item_url;
+            "
+      >
 
-          <a href="${item_url}">
-            <img class="mime-icon"
-                 src="${python:item.MimeTypeIcon()}"
-                 tal:condition="python:item_type =='File'"
-            />
+        <a href="${item_url}">
+          <img class="mime-icon"
+               src="${python:item.MimeTypeIcon()}"
+               tal:condition="python:item_type =='File'"
+          />
 
-            <span class="${item_type_class} ${item_wf_state_class} url"
-                  tal:content="python:item.Title()"
-            >
+          <span class="${item_type_class} ${item_wf_state_class} url"
+                tal:content="python:item.Title()"
+          >
                     Title
-            </span>
-            <span class="discreet"
-                  tal:content="python:item.Description()"
-            >
+          </span>
+          <span class="discreet"
+                tal:content="python:item.Description()"
+          >
                     Description
-            </span>
-          </a>
-        </span>
-      </li>
-    </ul>
-  </div>
-</span>
+          </span>
+        </a>
+      </span>
+    </li>
+  </ul>
+</div>
diff --git a/plone/app/z3cform/widgets.zcml b/plone/app/z3cform/widgets.zcml
@@ -223,27 +223,36 @@
 
   <!-- relateditems -->
 
+  <z3c:widgetTemplate
+      widget=".interfaces.IRelatedItemsWidget"
+      template="templates/relateditems_display.pt"
+      layer=".interfaces.IPloneFormLayer"
+      mode="display"
+      />
+
+  <!-- contentbrowser -->
+
   <adapter
-      factory=".widgets.relateditems.RelatedItemsFieldWidget"
+      factory=".widgets.contentbrowser.ContentBrowserFieldWidget"
       for="z3c.relationfield.interfaces.IRelationChoice
            plone.app.z3cform.interfaces.IPloneFormLayer"
       />
 
   <adapter
-      factory=".widgets.relateditems.RelatedItemsFieldWidget"
+      factory=".widgets.contentbrowser.ContentBrowserFieldWidget"
       for="z3c.relationfield.interfaces.IRelationList
            plone.app.z3cform.interfaces.IPloneFormLayer"
       />
 
   <adapter
-      factory=".widgets.relateditems.RelatedItemsFieldWidget"
+      factory=".widgets.contentbrowser.ContentBrowserFieldWidget"
       for="zope.schema.interfaces.IChoice
            plone.app.vocabularies.catalog.CatalogSource
            plone.app.z3cform.interfaces.IPloneFormLayer"
       />
 
   <z3c:widgetTemplate
-      widget=".interfaces.IRelatedItemsWidget"
+      widget=".interfaces.IContentBrowserWidget"
       template="templates/relateditems_display.pt"
       layer=".interfaces.IPloneFormLayer"
       mode="display"