Skip to content

Add TreeVocabulary field and fix imports for Plone 6.1 #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add TreeVocabulary field and fix imports for Plone 6.1 #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
028e9f0
Add TreeVocabulary field and fix imports for Plone 6.1
petschki May 24, 2025
1d9340b
use Contentbrowser for Plone 6.1
petschki May 26, 2025
a3f92d6
fix icon setup
petschki May 26, 2025
a345b18
fix TreeVocabulary definition with correct title
petschki May 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 49 additions & 27 deletions src/example/contenttype/example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,35 @@
from plone.app.textfield import RichText
from plone.app.vocabularies.catalog import CatalogSource
from plone.app.vocabularies.catalog import StaticCatalogVocabulary
from plone.app.z3cform.widget import AjaxSelectFieldWidget
from plone.app.z3cform.widget import RelatedItemsFieldWidget
from plone.app.z3cform.widget import SelectFieldWidget
from plone.autoform import directives
from plone.dexterity.content import Container

from plone.namedfile.field import NamedBlobFile
from plone.namedfile.field import NamedBlobImage
from plone.schema import Email

# from plone.schema import (
# Dict,
# ) # take Dict field from plone.schema to use the widget attribute
from plone.supermodel import model
from plone.supermodel.directives import fieldset
from plone.supermodel.directives import primary

from z3c.form.browser.checkbox import CheckBoxFieldWidget
from z3c.form.browser.radio import RadioFieldWidget
from z3c.relationfield.schema import RelationChoice
from z3c.relationfield.schema import RelationList
from zope import schema
from zope.interface import implementer

from zope.interface import Interface

try:
# Plone 6.1
from plone.app.z3cform.widgets.contentbrowser import ContentBrowserFieldWidget
from plone.app.z3cform.widgets.select import AjaxSelectFieldWidget
from plone.app.z3cform.widgets.select import Select2FieldWidget
except ImportError:
# Plone 6.0
from plone.app.z3cform.widget import (
RelatedItemsFieldWidget as ContentBrowserFieldWidget,
)
from plone.app.z3cform.widget import AjaxSelectFieldWidget
from plone.app.z3cform.widget import SelectFieldWidget as Select2FieldWidget


class IExample(model.Schema):
"""Dexterity-Schema with all field-types."""
Expand Down Expand Up @@ -59,6 +62,7 @@ class IExample(model.Schema):
"choice_field",
"choice_field_radio",
"choice_field_select",
"choice_field_treevocabulary",
"choice_field_voc",
"list_field",
"list_field_checkbox",
Expand Down Expand Up @@ -194,14 +198,32 @@ class IExample(model.Schema):
required=False,
)

directives.widget(choice_field_select=SelectFieldWidget)
directives.widget(choice_field_select=Select2FieldWidget)
choice_field_select = schema.Choice(
title="Choicefield with select2 widget",
description="zope.schema.Choice",
vocabulary="plone.app.vocabularies.PortalTypes",
required=False,
)

directives.widget(choice_field_treevocabulary=Select2FieldWidget)
choice_field_treevocabulary = schema.Choice(
title="Choicefield with TreeVocabulary",
vocabulary=schema.vocabulary.TreeVocabulary.fromDict(
{
("foo_group", "Foo Group"): {
("bar_group", "bar_group", "Bar Group"): {},
("qux_group", "qux_group", "Qux Group"): {},
},
("corge_group", "Corge Group"): {
("grault_group", "grault_group", "Grault Group"): {},
("garply_group", "garply_group", "Garply Group"): {},
},
}
),
required=False,
)

list_field = schema.List(
title="List field",
description="zope.schema.List",
Expand All @@ -225,7 +247,7 @@ class IExample(model.Schema):
default=[],
)

directives.widget(list_field_select=SelectFieldWidget)
directives.widget(list_field_select=Select2FieldWidget)
list_field_select = schema.List(
title="List field with select widget",
description="zope.schema.List",
Expand Down Expand Up @@ -351,7 +373,7 @@ class IExample(model.Schema):
)
directives.widget(
"relationchoice_field_constrained",
RelatedItemsFieldWidget,
ContentBrowserFieldWidget,
pattern_options={"selectableTypes": ["Document"]},
)

Expand All @@ -365,7 +387,7 @@ class IExample(model.Schema):
)
directives.widget(
"relationlist_field_constrained",
RelatedItemsFieldWidget,
ContentBrowserFieldWidget,
pattern_options={"selectableTypes": ["Document", "Event"]},
)

Expand All @@ -383,7 +405,7 @@ class IExample(model.Schema):
)
directives.widget(
"relationlist_field_search_mode",
RelatedItemsFieldWidget,
ContentBrowserFieldWidget,
pattern_options={
"baseCriteria": [ # This is a optimization that limits the catalog-query
{
Expand All @@ -401,7 +423,7 @@ class IExample(model.Schema):
},
)

# From here on we use other widgets than the default RelatedItemsFieldWidget
# From here on we use other widgets than the default ContentBrowserFieldWidget

# # This one also works in Volto!
# # All other options use the default ObjectWidget in Volto so far.
Expand All @@ -417,7 +439,7 @@ class IExample(model.Schema):
# )
# directives.widget(
# "relationchoice_field_select",
# SelectFieldWidget,
# Select2FieldWidget,
# )

# relationchoice_field_radio = RelationChoice(
Expand Down Expand Up @@ -445,7 +467,7 @@ class IExample(model.Schema):
)
directives.widget(
"relationlist_field_select",
SelectFieldWidget,
Select2FieldWidget,
pattern_options={
"closeOnSelect": False, # Select2 option to leave dropdown open for multiple selection
},
Expand Down Expand Up @@ -524,7 +546,7 @@ class IExample(model.Schema):
vocabulary="plone.app.vocabularies.Catalog",
required=False,
)
directives.widget("uuid_choice_field", RelatedItemsFieldWidget)
directives.widget("uuid_choice_field", ContentBrowserFieldWidget)

uuid_list_field = schema.List(
title="List Field with RelatedItems widget storing uuids",
Expand All @@ -534,7 +556,7 @@ class IExample(model.Schema):
required=False,
missing_value=[],
)
directives.widget("uuid_list_field", RelatedItemsFieldWidget)
directives.widget("uuid_list_field", ContentBrowserFieldWidget)

uuid_choice_field_constrained = schema.Choice(
title="Choice field with RelatedItems widget storing uuids (only allows Documents)",
Expand All @@ -544,7 +566,7 @@ class IExample(model.Schema):
)
directives.widget(
"uuid_choice_field_constrained",
RelatedItemsFieldWidget,
ContentBrowserFieldWidget,
pattern_options={"selectableTypes": ["Document"]},
)

Expand All @@ -558,12 +580,12 @@ class IExample(model.Schema):
)
directives.widget(
"uuid_list_field_constrained",
RelatedItemsFieldWidget,
ContentBrowserFieldWidget,
pattern_options={"selectableTypes": ["Document", "Folder"]},
)

uuid_list_field_search_mode = schema.List(
title="List Field with RelatedItems widget in Search Mode storing uuids",
title="List Field with RelatedItems widget in Search Mode storing uuids (constrained to published Documents and Events)",
description="zope.schema.List",
default=[],
value_type=schema.Choice(
Expand All @@ -576,15 +598,15 @@ class IExample(model.Schema):
)
directives.widget(
"uuid_list_field_search_mode",
RelatedItemsFieldWidget,
ContentBrowserFieldWidget,
pattern_options={
"selectableTypes": ["Document", "Folder"],
"basePath": "", # Start the search at the portal root
"mode": "search",
},
)

# From here on we use other widgets than the default RelatedItemsFieldWidget
# From here on we use other widgets than the default ContentBrowserFieldWidget

# uuid_choice_field_select = schema.Choice(
# title="UUID Choice with select widget storing uuids",
Expand All @@ -598,7 +620,7 @@ class IExample(model.Schema):
# )
# directives.widget(
# "uuid_choice_field_select",
# SelectFieldWidget,
# Select2FieldWidget,
# )

# uuid_choice_field_radio = schema.Choice(
Expand Down Expand Up @@ -626,7 +648,7 @@ class IExample(model.Schema):
)
directives.widget(
"uuid_list_field_select",
SelectFieldWidget,
Select2FieldWidget,
pattern_options={
"closeOnSelect": False, # Select2 option to leave dropdown open for multiple selection
},
Expand Down
8 changes: 4 additions & 4 deletions src/example/contenttype/profiles/default/types/example.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
xmlns:i18n="http://xml.zope.org/namespaces/i18n">
<property name="title" i18n:translate="">Example</property>
<property name="description" i18n:translate=""></property>
<property name="icon_expr"></property>
<property name="icon_expr">string:file-check</property>
<property name="factory">example</property>
<property name="add_view_expr">string:${folder_url}/++add++example</property>
<property name="link_target"></property>
Expand Down Expand Up @@ -37,13 +37,13 @@
<alias from="sharing" to="@@sharing"/>
<alias from="view" to="(selected layout)"/>
<action title="View" action_id="view" category="object" condition_expr=""
description="" icon_expr="" link_target="" url_expr="string:${object_url}"
description="" icon_expr="string:toolbar-action/view" link_target="" url_expr="string:${object_url}"
visible="True">
<permission value="View"/>
</action>
<action title="Edit" action_id="edit" category="object" condition_expr=""
description="" icon_expr="" link_target=""
description="" icon_expr="string:toolbar-action/edit" link_target=""
url_expr="string:${object_url}/edit" visible="True">
<permission value="Modify portal content"/>
</action>
</object>
</object>