Skip to main content

Adds a keyword widget (similar to to Archetypes.Widget:KeywordWidget) to z3cform.

Project description


This product adds a Keyword widget (similar to Archetypes.Widget:KeywordWidget) for plone.z3cform.

How To Use (Doc Tests):

>>> from z3c.form import testing
>>> testing.setupFormDefaults()
>>> import zope.interface
>>> import zope.schema
>>> from zope.schema.fieldproperty import FieldProperty

Use the Keywords field your field type:

>>> from collective.z3cform.keywordwidget.field import Keywords
>>> class IFoo(zope.interface.Interface):
...     keywords = Keywords(title=u'Keywords')
>>> class Foo(object):
...     zope.interface.implements(IFoo)
...     keywords = FieldProperty(IFoo['keywords'])
...     def __init__(self, keywords):
...             self.keywords = keywords
...     def __repr__(self):
...             return '<%s %r>' % (self.__class__.__name__,

We need to make sure that the keywords property is indexed in portal_catalog.

First, we write the indexer. The indexer is a special adapter that adapts the type of an object and provides the value of the attribute to be indexed.

>>> from plone.indexer.decorator import indexer
>>> @indexer(IFoo)
... def keywords(obj):
...     return IFoo(obj).keywords

We need to register our indexer as a named adapter, where the name corresponds to the index name. In ZCML, that may be:

<adapter name="keywords" factory=".indexers.keywords" />

For testing purpoese, we will register it directly.

>>> from zope.component import provideAdapter
>>> provideAdapter(keywords, name='keywords')

Now we add a form in which the widget will be rendered:

Specify the KeywordWidget factory (‘KeywordFieldWidget’) as the field’s widgetFactory.

>>> from z3c.form.testing import TestRequest
>>> from z3c.form import form, field
>>> from collective.z3cform.keywordwidget.widget import KeywordFieldWidget
>>> class FooAddForm(form.AddForm):
...     fields = field.Fields(IFoo)
...     fields['keywords'].widgetFactory = KeywordFieldWidget
...     def create(self, data):
...             return Foo(**data)
...     def add(self, object):
...             self.context[] = object
...     def nextURL(self):
...             return 'index.hml'

Create, update and render the form:

>>> root = app
>>> request = TestRequest()
>>> addForm = FooAddForm(root, request)
>>> addForm.update()
>>> print addForm.render()


1.3 (2017-01-17)

  • Fixed terms list setup. [thomasdesvenain]

  • Added a handler so that it can be used in supermodels. [thomasdesvenain]

  • made it work in Plone 4.3: fixed a problem in vocabulary creation in combination with non-ascii. [jensens]

  • modernized test setup [jensens]

1.2 - 2012-03-19

  • added option to specify index_name as field parameter. This is useful eg. for ‘subjects’ field which should read it’s data from ‘Subject’ index. If not set, field name is used. [naro]

  • Added InAndOutKeywordWidget which is based on z3c.form OrderedSelectWidget [naro]

1.1.1 - 2012-02-24

  • fixed broken 1.1 release [petschki]

1.1 (2012-02-13)

  • fixed unicode errors for non-ascii keyword value support [petschki]

  • ui improved to keep newly entered categories on form errors [petschki]

1.0.1 (2009-09-29)

  • updated setup.cfg

1.0 (2009-09-29)

  • Initial release

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.z3cform.keywordwidget-1.3.tar.gz (12.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page