Merge pull request #702 from euphorie/choice-widget

Custom widgets for choice fields in the session @@start view
euphorie · Feb 9, 2024 · 61e157d · 61e157d
2 parents a3d7a09 + 1b89820
commit 61e157d
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 0 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -4,6 +4,9 @@ Changelog
 16.0.0 (unreleased)
 -------------------
 
+- Custom widgets for choice fields in the session @@start view
+  [ale-rt, maurits]
+
 - Fix problem with the identification report not being generated for certain survey sessions.
   Ref: scrum-1846
   Fixes: #688

diff --git a/src/euphorie/client/widgets/choice.py b/src/euphorie/client/widgets/choice.py
@@ -0,0 +1,33 @@
+from functools import cached_property
+from z3c.form.browser.select import SelectWidget
+from z3c.form.interfaces import IFieldWidget
+from z3c.form.widget import FieldWidget
+from zope.interface import implementer
+
+
+class EuphorieChoiceWidget(SelectWidget):
+    """Select widget for z3c.form in the Euphorie context: better display
+    mode."""
+
+    @cached_property
+    def title_value(self):
+        if self.name in self.request.form:
+            token = self.request.form[self.name]
+            vocabulary = self.field.source(self.context)
+            try:
+                return vocabulary.getTermByToken(token).value
+            except LookupError:
+                return
+
+        return getattr(self.context.session, self.field.__name__, None)
+
+    def isSelected(self, term):
+        return term.title == self.title_value
+
+
+@implementer(IFieldWidget)
+def EuphorieChoiceFieldWidget(field, request):
+    """This is identicall to the equivalent in plone.app.z3cform but needs a
+    customization to use the EuphorieSelectWidget class."""
+    widget = FieldWidget(field, EuphorieChoiceWidget(request))
+    return widget
diff --git a/src/euphorie/client/widgets/configure.zcml b/src/euphorie/client/widgets/configure.zcml
@@ -18,6 +18,12 @@
            euphorie.client.interfaces.IClientSkinLayer"
       />
 
+  <adapter
+      factory=".choice.EuphorieChoiceFieldWidget"
+      for="zope.schema.interfaces.IChoice
+           euphorie.client.interfaces.IClientSkinLayer"
+      />
+
   <z3c:widgetTemplate
       for="euphorie.client.adapters.session_traversal.ITraversedSurveySession"
       view="euphorie.client.browser.session.Start"
@@ -36,4 +42,13 @@
       mode="input"
       />
 
+  <z3c:widgetTemplate
+      for="euphorie.client.adapters.session_traversal.ITraversedSurveySession"
+      view="euphorie.client.browser.session.Start"
+      widget="z3c.form.interfaces.ISelectWidget"
+      template="templates/choice_widget.pt"
+      layer="euphorie.client.interfaces.IClientSkinLayer"
+      mode="input"
+      />
+
 </configure>
diff --git a/src/euphorie/client/widgets/templates/choice_widget.pt b/src/euphorie/client/widgets/templates/choice_widget.pt
@@ -0,0 +1,40 @@
+<html xmlns="http://www.w3.org/1999/xhtml"
+      xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+      xmlns:tal="http://xml.zope.org/namespaces/tal"
+      tal:omit-tag=""
+      i18n:domain="nuplone"
+>
+  <div class="z3cFieldContainer ${view/@@dependencies}">
+    <label>
+      <select class="${view/klass}"
+              id="${view/id}"
+              multiple="${view/multiple}"
+              name="${view/name}"
+              size="${view/size}"
+      >
+        <tal:item repeat="item view/items"><option id="${item/id}"
+                  selected="${python:'selected' if selected else None}"
+                  value="${item/value}"
+                  tal:define="
+                    selected item/selected;
+                  "
+          >${item/content}</option></tal:item>
+      </select>
+      <tal:error condition="view/error"
+                 replace="structure view/error/render|nothing"
+      />
+    </label>
+    <dfn class="infoPanel"
+         title="Information"
+         tal:define="
+           description view/field/description;
+         "
+         tal:condition="description"
+         i18n:attributes="title"
+    >${description}</dfn>
+    <input name="${view/name}-empty-marker"
+           type="hidden"
+           value="1"
+    />
+  </div>
+</html>