[Zope3-checkins] CVS: Zope3/src/zope/app/browser/form - vocabularywidget.py:1.1.2.1 configure.zcml:1.6.6.3 widget.py:1.29.4.10
Fred L. Drake, Jr.
fred@zope.com
Fri, 16 May 2003 12:10:10 -0400
Update of /cvs-repository/Zope3/src/zope/app/browser/form
In directory cvs.zope.org:/tmp/cvs-serv2031
Modified Files:
Tag: schema-vocabulary-branch
configure.zcml widget.py
Added Files:
Tag: schema-vocabulary-branch
vocabularywidget.py
Log Message:
- start support for the new way of separating vocabulary types and query
support
- move the vocabulary support from widget to vocabularywidget
- refactor the tests into still more little bitty classes that mix together
to produce interesting flavors
=== Added File Zope3/src/zope/app/browser/form/vocabularywidget.py ===
##############################################################################
#
# Copyright (c) 2003 Zope Corporation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.0 (ZPL). A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
"""Vocabulary widget support.
This includes support for vocabulary fields' use of the vocabulary to
determine the actual widget to display, and support for supplemental
query objects and helper views.
"""
from zope.app.browser.form import widget
from zope.app.i18n import ZopeMessageIDFactory as _
from zope.app.interfaces.browser.form import IVocabularyQueryView
from zope.publisher.browser import BrowserView
from zope.component import getView
# These widget factories delegate to the vocabulary on the field.
def VocabularyFieldDisplayWidget(field, request):
"""Return a display widget based on a vocabulary field."""
return _get_vocabulary_widget(field, request, "display")
def VocabularyFieldEditWidget(field, request):
"""Return a value-selection widget based on a vocabulary field."""
return _get_vocabulary_edit_widget(field, request, ismulti=False)
def VocabularyMultiFieldDisplayWidget(field, request):
"""Return a display widget based on a vocabulary field."""
return _get_vocabulary_widget(field, request, "display-multi")
def VocabularyMultiFieldEditWidget(field, request):
"""Return a value-selection widget based on a vocabulary field."""
return _get_vocabulary_edit_widget(field, request, ismulti=True)
# Helper functions for the factories:
def _get_vocabulary_widget(field, request, viewname):
view = getView(field.vocabulary, "field-%s-widget" % viewname, request)
view.setField(field)
return view
def _get_vocabulary_edit_widget(field, request, ismulti):
if ismulti:
viewname = "edit-multi"
queryname = "widget-query-multi-helper"
else:
viewname = "edit"
queryname = "widget-query-helper"
view = _get_vocabulary_widget(field, request, viewname)
query = field.vocabulary.getQuery()
if query is not None:
queryview = getView(query, queryname, request)
view.setQuery(query, queryview)
return view
# Widget implementation:
class ViewSupport:
"""Helper class for vocabulary and vocabulary-query widgets."""
def __init__(self, context, request):
self.context = context
self.request = request
self.field = None
def textForValue(self, term):
# Extract the value from the term. This can be overridden to
# support more complex term objects.
return term.value
class VocabularyWidgetBase(ViewSupport, widget.BrowserWidget):
"""Convenience base class for vocabulary-based widgets."""
propertyNames = widget.BrowserWidget.propertyNames + ["extra"]
extra = ""
type = "vocabulary"
def _getDefault(self):
# Override this since the context is not the field for
# vocabulary-based widgets.
return self.field.default
def setField(self, field):
assert self.field is None
# only allow this to happen for a bound field
assert field.context is not None
self.field = field
self.name = self._prefix + field.__name__
def __call__(self):
if self.haveData():
value = self._showData()
else:
value = self.field.get(self.field.context)
return self.render(value)
def render(self, value):
raise NotImplementedError(
"render() must be implemented by a subclass")
class VocabularyDisplayWidget(VocabularyWidgetBase):
"""Simple single-selection display that can be used in many cases."""
def render(self, value):
term = self.field.vocabulary.getTerm(value)
return self.textForValue(term)
class VocabularyQueryViewBase(ViewSupport, BrowserView):
"""Vocabulary query support base class."""
__implements__ = IVocabularyQueryView
# This specifically isn't a widget in it's own right, but is a
# form of BrowserView (conceptually).
tag = "div"
def setPrefix(self, prefix):
if not prefix.endswith("."):
prefix += "."
self._prefix = prefix
def _render_element(self, cssClass, contents):
if contents:
return widget.renderElement(self.tag,
cssClass=cssClass,
contents="\n%s\n" % contents)
else:
return ""
def renderInput(self):
return self._render_element("queryinput",
self.renderQueryInput())
def renderResults(self):
results = self.getResults()
if results is not None:
return self._render_element("queryresults",
self.renderQueryResults(results))
else:
return ""
def renderQueryResults(self, results):
raise NotImplementedError(
"renderQueryResults() must be implemented by a subclass")
def renderQueryInput(self):
raise NotImplementedError(
"renderQueryInput() must be implemented by a subclass")
def getResults(self):
# This is responsible for running the query against the query
# object (self.context), and returning a results object. If
# there isn't a query in the form, returns None.
return None
class VocabularyEditWidgetBase(VocabularyWidgetBase):
propertyNames = (VocabularyWidgetBase.propertyNames
+ ['size', 'tag'])
size = 5
tag = 'select'
query = None
queryview = None
def setQuery(self, query, queryview):
assert self.query is None
assert self.queryview is None
if query is None:
assert queryview is None
else:
assert queryview is not None
self.query = query
self.queryview = queryview
# Use of a hyphen to form the prefix for the query widget
# ensures that it won't clash with anything else, since
# field names are normally Python identifier.
queryview.setPrefix(self.name + "-query")
def setPrefix(self, prefix):
VocabularyWidgetBase.setPrefix(self, prefix)
if self.queryview is not None:
self.queryview.setPrefix(self.name + "-query")
def renderItemsWithValues(self, values):
"""Render the list of possible values, with those found in
'values' being marked as selected."""
cssClass = self.getValue('cssClass')
# multiple items with the same value are not allowed from a
# vocabulary, so that need not be considered here
rendered_items = []
count = 0
for term in self.context:
item_value = term.value
item_text = self.textForValue(term)
if item_value in values:
rendered_item = self.renderSelectedItem(count,
item_text,
item_value,
self.name,
cssClass)
else:
rendered_item = self.renderItem(count,
item_text,
item_value,
self.name,
cssClass)
rendered_items.append(rendered_item)
count += 1
return rendered_items
def renderItem(self, index, text, value, name, cssClass):
return widget.renderElement('option',
contents=text,
value=value,
cssClass=cssClass)
def renderSelectedItem(self, index, text, value, name, cssClass):
return widget.renderElement('option',
contents=text,
value=value,
cssClass=cssClass,
selected=None)
class VocabularyEditWidget(VocabularyEditWidgetBase):
"""Vocabulary-backed single-selection edit widget.
This widget can be used when the number of selections isn't going
to be very large.
"""
__implements__ = widget.SingleItemsWidget.__implements__
propertyNames = VocabularyEditWidgetBase.propertyNames + ['firstItem']
firstItem = False
def render(self, value):
rendered_items = self.renderItems(value)
return widget.renderElement(self.getValue('tag'),
type=self.getValue('type'),
name=self.name,
id=self.name,
cssClass=self.getValue('cssClass'),
size=self.getValue('size'),
contents="\n".join(rendered_items),
extra=self.getValue('extra'))
def renderItems(self, value):
vocabulary = self.context
# check if we want to select first item
if (value == self._missing
and getattr(self.context, 'firstItem', False)
and len(vocabulary) > 0):
# Grab the first item from the iterator:
values = [iter(vocabulary).next().value]
elif value != self._missing:
values = [value]
else:
values = ()
return VocabularyEditWidgetBase.renderItemsWithValues(self, values)
def hidden(self):
return widget.renderElement('input',
type='hidden',
name=self.name,
id=self.name,
value=self._showData())
class VocabularyMultiDisplayWidget(VocabularyWidgetBase):
propertyNames = (VocabularyWidgetBase.propertyNames
+ ['itemTag', 'tag'])
itemTag = 'li'
tag = 'ol'
def render(self, value):
if value == self._missing:
return widget.renderElement('span',
type=self.getValue('type'),
name=self.name,
id=self.name,
cssClass=self.getValue('cssClass'),
contents=_("(no values)"),
extra=self.getValue('extra'))
else:
rendered_items = self.renderItems(value)
return widget.renderElement(self.getValue('tag'),
type=self.getValue('type'),
name=self.name,
id=self.name,
cssClass=self.getValue('cssClass'),
contents="\n".join(rendered_items),
extra=self.getValue('extra'))
def renderItems(self, value):
L = []
vocabulary = self.context
cssClass = self.getValue('cssClass') or ''
if cssClass:
cssClass += "-item"
tag = self.getValue('itemTag')
for v in value:
term = vocabulary.getTerm(v)
L.append(widget.renderElement(tag,
cssClass=cssClass,
contents=self.textForValue(term)))
return L
class VocabularyMultiEditWidget(VocabularyEditWidgetBase):
"""Vocabulary-backed widget supporting multiple selections."""
def renderItems(self, value):
if value == self._missing:
values = ()
else:
values = list(value)
return VocabularyEditWidgetBase.renderItemsWithValues(self, values)
def render(self, value):
# All we really add here is the ':list' in the name argument
# to widget.renderElement().
rendered_items = self.renderItems(value)
return widget.renderElement(self.getValue('tag'),
type=self.getValue('type'),
name=self.name + ':list',
multiple=None,
id=self.name,
cssClass=self.getValue('cssClass'),
size=self.getValue('size'),
contents="\n".join(rendered_items),
extra=self.getValue('extra'))
def hidden(self):
L = []
for v in self._showData():
s = widget.renderElement('input',
type='hidden',
name=self.name + ':list',
value=v)
assert s[-1] == '>'
L.append(s[:-1])
L.append('\n>')
return ''.join(L)
=== Zope3/src/zope/app/browser/form/configure.zcml 1.6.6.2 => 1.6.6.3 ===
--- Zope3/src/zope/app/browser/form/configure.zcml:1.6.6.2 Tue May 13 11:05:09 2003
+++ Zope3/src/zope/app/browser/form/configure.zcml Fri May 16 12:09:39 2003
@@ -110,7 +110,7 @@
allowed_interface="zope.app.interfaces.browser.form.IBrowserWidget"
for="zope.schema.vocabulary.IVocabularyField"
name="display"
- factory="zope.app.browser.form.widget.VocabularyFieldDisplayWidget"
+ factory=".vocabularywidget.VocabularyFieldDisplayWidget"
/>
<view
@@ -119,7 +119,7 @@
allowed_interface="zope.app.interfaces.browser.form.IBrowserWidget"
for="zope.schema.vocabulary.IVocabularyField"
name="edit"
- factory="zope.app.browser.form.widget.VocabularyFieldEditWidget"
+ factory=".vocabularywidget.VocabularyFieldEditWidget"
/>
<view
@@ -128,7 +128,7 @@
allowed_interface="zope.app.interfaces.browser.form.IBrowserWidget"
for="zope.schema.vocabulary.IVocabularyMultiField"
name="display"
- factory="zope.app.browser.form.widget.VocabularyMultiFieldDisplayWidget"
+ factory=".vocabularywidget.VocabularyMultiFieldDisplayWidget"
/>
<view
@@ -137,7 +137,7 @@
allowed_interface="zope.app.interfaces.browser.form.IBrowserWidget"
for="zope.schema.vocabulary.IVocabularyMultiField"
name="edit"
- factory="zope.app.browser.form.widget.VocabularyMultiFieldEditWidget"
+ factory=".vocabularywidget.VocabularyMultiFieldEditWidget"
/>
<!-- Default simple display view -->
=== Zope3/src/zope/app/browser/form/widget.py 1.29.4.9 => 1.29.4.10 ===
--- Zope3/src/zope/app/browser/form/widget.py:1.29.4.9 Tue May 13 11:05:09 2003
+++ Zope3/src/zope/app/browser/form/widget.py Fri May 16 12:09:39 2003
@@ -25,9 +25,8 @@
from zope.app.interfaces.form import MissingInputError
from zope.app.datetimeutils import parseDatetimetz
from zope.app.datetimeutils import DateTimeError
-from zope.app.i18n import ZopeMessageIDFactory as _
from zope.schema.interfaces import ValidationError
-from zope.component import getService, getView
+from zope.component import getService
ListTypes = list, tuple
@@ -694,252 +693,6 @@
value = value,
checked = None) + text
-
-# These widget factories delegate to the vocabulary on the field.
-
-def VocabularyFieldDisplayWidget(field, request):
- """Return a display widget based on a vocabulary field."""
- view = getView(field.vocabulary, "field-display-widget", request)
- view.setField(field)
- return view
-
-def VocabularyFieldEditWidget(field, request):
- """Return a value-selection widget based on a vocabulary field."""
- view = getView(field.vocabulary, "field-edit-widget", request)
- view.setField(field)
- return view
-
-def VocabularyMultiFieldDisplayWidget(field, request):
- """Return a display widget based on a vocabulary field."""
- view = getView(field.vocabulary, "field-display-multi-widget", request)
- view.setField(field)
- return view
-
-def VocabularyMultiFieldEditWidget(field, request):
- """Return a value-selection widget based on a vocabulary field."""
- view = getView(field.vocabulary, "field-edit-multi-widget", request)
- view.setField(field)
- return view
-
-
-class VocabularyWidgetBase(BrowserWidget):
- """Convenience base class for vocabulary-based widgets."""
-
- propertyNames = BrowserWidget.propertyNames + ["extra"]
-
- extra = ""
- type = "vocabulary"
-
- def __init__(self, context, request):
- self.context = context
- self.request = request
- self.field = None
-
- def _getDefault(self):
- # Override this since the context is not the field for
- # vocabulary-based widgets.
- return self.field.default
-
- def setField(self, field):
- assert self.field is None
- # only allow this to happen for a bound field
- assert field.context is not None
- self.field = field
- self.name = self._prefix + field.__name__
-
- def __call__(self):
- if self.haveData():
- value = self._showData()
- else:
- value = self.field.get(self.field.context)
- return self.render(value)
-
- def textForValue(self, term):
- # Extract the value from the term. This can be overridden to
- # support more complex term objects.
- return term.value
-
- def render(self, value):
- raise NotImplementedError(
- "render() must be implemented by a subclass")
-
-
-class VocabularyDisplayWidget(VocabularyWidgetBase):
- """Simple single-selection display that can be used in many cases."""
-
- def render(self, value):
- term = self.field.vocabulary.getTerm(value)
- return self.textForValue(term)
-
-
-class VocabularyEditWidgetBase(VocabularyWidgetBase):
- propertyNames = (VocabularyWidgetBase.propertyNames
- + ['size', 'tag'])
- size = 5
- tag = 'select'
-
- def renderItemsWithValues(self, values):
- """Render the list of possible values, with those found in
- 'values' being marked as selected."""
-
- cssClass = self.getValue('cssClass')
-
- # multiple items with the same value are not allowed from a
- # vocabulary, so that need not be considered here
- rendered_items = []
- count = 0
- for term in self.context:
- item_value = term.value
- item_text = self.textForValue(term)
-
- if item_value in values:
- rendered_item = self.renderSelectedItem(count,
- item_text,
- item_value,
- self.name,
- cssClass)
- else:
- rendered_item = self.renderItem(count,
- item_text,
- item_value,
- self.name,
- cssClass)
-
- rendered_items.append(rendered_item)
- count += 1
-
- return rendered_items
-
- def renderItem(self, index, text, value, name, cssClass):
- return renderElement('option', contents=text, value=value,
- cssClass=cssClass)
-
- def renderSelectedItem(self, index, text, value, name, cssClass):
- return renderElement('option', contents=text, value=value,
- cssClass=cssClass, selected=None)
-
-
-class VocabularyEditWidget(VocabularyEditWidgetBase):
- """Vocabulary-backed single-selection edit widget.
-
- This widget can be used when the number of selections isn't going
- to be very large.
- """
- __implements__ = SingleItemsWidget.__implements__
- propertyNames = VocabularyEditWidgetBase.propertyNames + ['firstItem']
- firstItem = False
-
- def render(self, value):
- rendered_items = self.renderItems(value)
- return renderElement(self.getValue('tag'),
- type = self.getValue('type'),
- name = self.name,
- id = self.name,
- cssClass = self.getValue('cssClass'),
- size = self.getValue('size'),
- contents = "\n".join(rendered_items),
- extra = self.getValue('extra'))
-
- def renderItems(self, value):
- vocabulary = self.context
-
- # check if we want to select first item
- if (value == self._missing
- and getattr(self.context, 'firstItem', False)
- and len(vocabulary) > 0):
- # Grab the first item from the iterator:
- values = [iter(vocabulary).next().value]
- elif value != self._missing:
- values = [value]
- else:
- values = ()
-
- return VocabularyEditWidgetBase.renderItemsWithValues(self, values)
-
- def hidden(self):
- return renderElement('input',
- type = 'hidden',
- name = self.name,
- id = self.name,
- value = self._showData())
-
-
-class VocabularyMultiDisplayWidget(VocabularyWidgetBase):
-
- propertyNames = (VocabularyWidgetBase.propertyNames
- + ['itemTag', 'tag'])
-
- itemTag = 'li'
- tag = 'ol'
-
- def render(self, value):
- if value == self._missing:
- return renderElement('span',
- type = self.getValue('type'),
- name = self.name,
- id = self.name,
- cssClass = self.getValue('cssClass'),
- contents = _("(no values)"),
- extra = self.getValue('extra'))
- else:
- rendered_items = self.renderItems(value)
- return renderElement(self.getValue('tag'),
- type = self.getValue('type'),
- name = self.name,
- id = self.name,
- cssClass = self.getValue('cssClass'),
- contents = "\n".join(rendered_items),
- extra = self.getValue('extra'))
-
- def renderItems(self, value):
- L = []
- vocabulary = self.context
- cssClass = self.getValue('cssClass') or ''
- if cssClass:
- cssClass += "-item"
- tag = self.getValue('itemTag')
- for v in value:
- term = vocabulary.getTerm(v)
- L.append(renderElement(tag,
- cssClass = cssClass,
- contents = self.textForValue(term)))
- return L
-
-class VocabularyMultiEditWidget(VocabularyEditWidgetBase):
- """Vocabulary-backed widget supporting multiple selections."""
-
- def renderItems(self, value):
- if value == self._missing:
- values = ()
- else:
- values = list(value)
- return VocabularyEditWidgetBase.renderItemsWithValues(self, values)
-
- def render(self, value):
- # All we really add here is the ':list' in the name argument
- # to renderElement().
- rendered_items = self.renderItems(value)
- return renderElement(self.getValue('tag'),
- type = self.getValue('type'),
- name = self.name + ':list',
- multiple = None,
- id = self.name,
- cssClass = self.getValue('cssClass'),
- size = self.getValue('size'),
- contents = "\n".join(rendered_items),
- extra = self.getValue('extra'))
-
- def hidden(self):
- L = []
- for v in self._showData():
- s = renderElement('input',
- type = 'hidden',
- name = self.name + ':list',
- value = v)
- assert s[-1] == '>'
- L.append(s[:-1])
- L.append('\n>')
- return ''.join(L)
# XXX Note, some HTML quoting is needed in renderTag and renderElement.