collective.documentgenerator 3.46__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- collective/documentgenerator/AT_renderer.py +98 -0
- collective/documentgenerator/DX_renderer.py +52 -0
- collective/documentgenerator/__init__.py +17 -0
- collective/documentgenerator/adapters.py +23 -0
- collective/documentgenerator/browser/__init__.py +0 -0
- collective/documentgenerator/browser/actionspanel.py +19 -0
- collective/documentgenerator/browser/check_pod_templates.pt +63 -0
- collective/documentgenerator/browser/children_pod_template.pt +16 -0
- collective/documentgenerator/browser/configure.zcml +220 -0
- collective/documentgenerator/browser/controlpanel.py +159 -0
- collective/documentgenerator/browser/converter.py +43 -0
- collective/documentgenerator/browser/generation_view.py +532 -0
- collective/documentgenerator/browser/overrides.py +9 -0
- collective/documentgenerator/browser/resources/css/documentgenerator.css +133 -0
- collective/documentgenerator/browser/static/.gitkeep +0 -0
- collective/documentgenerator/browser/static/configurable.svg +1232 -0
- collective/documentgenerator/browser/static/csv.svg +521 -0
- collective/documentgenerator/browser/static/doc.svg +23 -0
- collective/documentgenerator/browser/static/docx.svg +20 -0
- collective/documentgenerator/browser/static/download_icon.svg +54 -0
- collective/documentgenerator/browser/static/libreoffice-blanck.svg +481 -0
- collective/documentgenerator/browser/static/mailinglooptemplate.svg +1207 -0
- collective/documentgenerator/browser/static/missing_use.svg +42 -0
- collective/documentgenerator/browser/static/nok.svg +38 -0
- collective/documentgenerator/browser/static/nok_use.svg +38 -0
- collective/documentgenerator/browser/static/nok_used.svg +38 -0
- collective/documentgenerator/browser/static/odp.svg +1264 -0
- collective/documentgenerator/browser/static/ods.svg +1354 -0
- collective/documentgenerator/browser/static/odt.svg +1347 -0
- collective/documentgenerator/browser/static/ok.svg +38 -0
- collective/documentgenerator/browser/static/ok_use.svg +38 -0
- collective/documentgenerator/browser/static/ok_used.svg +38 -0
- collective/documentgenerator/browser/static/pdf.svg +557 -0
- collective/documentgenerator/browser/static/podtemplate.svg +1197 -0
- collective/documentgenerator/browser/static/rtf.svg +521 -0
- collective/documentgenerator/browser/static/style.svg +1207 -0
- collective/documentgenerator/browser/static/subtemplate.svg +1250 -0
- collective/documentgenerator/browser/static/xls.svg +159 -0
- collective/documentgenerator/browser/static/xlsx.svg +48 -0
- collective/documentgenerator/browser/table.py +277 -0
- collective/documentgenerator/browser/templates_listing.pt +23 -0
- collective/documentgenerator/browser/views.py +365 -0
- collective/documentgenerator/config.py +162 -0
- collective/documentgenerator/configure.zcml +41 -0
- collective/documentgenerator/content/__init__.py +0 -0
- collective/documentgenerator/content/condition.py +60 -0
- collective/documentgenerator/content/conditions.zcml +29 -0
- collective/documentgenerator/content/configure.zcml +25 -0
- collective/documentgenerator/content/document_factory.py +73 -0
- collective/documentgenerator/content/file_representation.py +73 -0
- collective/documentgenerator/content/file_representation.zcml +28 -0
- collective/documentgenerator/content/merge_templates.py +15 -0
- collective/documentgenerator/content/merge_templates.zcml +10 -0
- collective/documentgenerator/content/pod_template.py +547 -0
- collective/documentgenerator/content/style_template.py +52 -0
- collective/documentgenerator/content/vocabulary.py +315 -0
- collective/documentgenerator/content/vocabulary.zcml +104 -0
- collective/documentgenerator/demo/__init__.py +0 -0
- collective/documentgenerator/demo/archetypes.zcml +10 -0
- collective/documentgenerator/demo/configure.zcml +19 -0
- collective/documentgenerator/demo/helper.py +198 -0
- collective/documentgenerator/events/__init__.py +0 -0
- collective/documentgenerator/events/configure.zcml +30 -0
- collective/documentgenerator/events/pod_templates_events.py +66 -0
- collective/documentgenerator/events/styles_events.py +122 -0
- collective/documentgenerator/helper/__init__.py +9 -0
- collective/documentgenerator/helper/archetypes-adapter.zcml +10 -0
- collective/documentgenerator/helper/archetypes-page.zcml +9 -0
- collective/documentgenerator/helper/archetypes.py +67 -0
- collective/documentgenerator/helper/base.py +266 -0
- collective/documentgenerator/helper/configure.zcml +38 -0
- collective/documentgenerator/helper/dexterity.py +174 -0
- collective/documentgenerator/interfaces.py +165 -0
- collective/documentgenerator/locales/collective.documentgenerator.pot +564 -0
- collective/documentgenerator/locales/es/LC_MESSAGES/collective.documentgenerator.po +572 -0
- collective/documentgenerator/locales/es/LC_MESSAGES/plone.po +32 -0
- collective/documentgenerator/locales/fr/LC_MESSAGES/collective.documentgenerator.po +566 -0
- collective/documentgenerator/locales/fr/LC_MESSAGES/plone.po +27 -0
- collective/documentgenerator/locales/manual.pot +30 -0
- collective/documentgenerator/locales/plone-manual.pot +22 -0
- collective/documentgenerator/locales/plone.pot +30 -0
- collective/documentgenerator/locales/update.sh +22 -0
- collective/documentgenerator/migrations/__init__.py +0 -0
- collective/documentgenerator/migrations/migrate_to_11.py +53 -0
- collective/documentgenerator/migrations/migrate_to_12.py +30 -0
- collective/documentgenerator/migrations/migrate_to_13.py +37 -0
- collective/documentgenerator/migrations/migrate_to_3.py +36 -0
- collective/documentgenerator/migrations/migrate_to_5.py +30 -0
- collective/documentgenerator/migrations/migrate_to_6.py +27 -0
- collective/documentgenerator/migrations/migrate_to_7.py +32 -0
- collective/documentgenerator/migrations/migrate_to_8.py +34 -0
- collective/documentgenerator/migrations/migrate_to_9.py +48 -0
- collective/documentgenerator/profiles/base/browserlayer.xml +7 -0
- collective/documentgenerator/profiles/base/controlpanel.xml +20 -0
- collective/documentgenerator/profiles/base/metadata.xml +7 -0
- collective/documentgenerator/profiles/base/types/ConfigurablePODTemplate.xml +43 -0
- collective/documentgenerator/profiles/base/types/MailingLoopTemplate.xml +42 -0
- collective/documentgenerator/profiles/base/types/PODTemplate.xml +42 -0
- collective/documentgenerator/profiles/base/types/StyleTemplate.xml +42 -0
- collective/documentgenerator/profiles/base/types/SubTemplate.xml +42 -0
- collective/documentgenerator/profiles/base/types.xml +10 -0
- collective/documentgenerator/profiles/base/viewlets.xml +6 -0
- collective/documentgenerator/profiles/demo/browserlayer.xml +7 -0
- collective/documentgenerator/profiles/demo/collectivedocumentgenerator_demo_marker.txt +0 -0
- collective/documentgenerator/profiles/demo/import_steps.xml +11 -0
- collective/documentgenerator/profiles/demo/metadata.xml +7 -0
- collective/documentgenerator/profiles/demo/registry.xml +13 -0
- collective/documentgenerator/profiles/demo/templates/mailing.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/modele_general.ods +0 -0
- collective/documentgenerator/profiles/demo/templates/modele_general.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/mod/303/250le_collection.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/possibly_mailed_model.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/styles.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/styles_2.odt +0 -0
- collective/documentgenerator/profiles/demo/templates/sub_template.odt +0 -0
- collective/documentgenerator/profiles/demo/viewlets.xml +3 -0
- collective/documentgenerator/profiles/plone4/collectivedocumentgenerator_marker.txt +0 -0
- collective/documentgenerator/profiles/plone4/cssregistry.xml +11 -0
- collective/documentgenerator/profiles/plone4/metadata.xml +7 -0
- collective/documentgenerator/profiles/plone4/registry.xml +6 -0
- collective/documentgenerator/profiles/plone5/metadata.xml +7 -0
- collective/documentgenerator/profiles/plone5/registry.xml +15 -0
- collective/documentgenerator/profiles/testing/metadata.xml +7 -0
- collective/documentgenerator/profiles/testing/propertiestool.xml +5 -0
- collective/documentgenerator/profiles/testing/types/member.xml +85 -0
- collective/documentgenerator/profiles/testing/types.xml +5 -0
- collective/documentgenerator/profiles.zcml +186 -0
- collective/documentgenerator/renderer.zcml +145 -0
- collective/documentgenerator/search_replace/__init__.py +0 -0
- collective/documentgenerator/search_replace/configure.zcml +19 -0
- collective/documentgenerator/search_replace/pod_template.py +146 -0
- collective/documentgenerator/search_replace/search_result_form.pt +48 -0
- collective/documentgenerator/search_replace/searchreplace_panel.pt +22 -0
- collective/documentgenerator/search_replace/searchreplace_panel.py +261 -0
- collective/documentgenerator/setuphandlers.py +287 -0
- collective/documentgenerator/testing.py +324 -0
- collective/documentgenerator/testing.zcml +16 -0
- collective/documentgenerator/tests/__init__.py +0 -0
- collective/documentgenerator/tests/failing_template.odt +0 -0
- collective/documentgenerator/tests/robot/.gitkeep +0 -0
- collective/documentgenerator/tests/template_to_clean.odt +0 -0
- collective/documentgenerator/tests/template_without_style_page.odt +0 -0
- collective/documentgenerator/tests/test_AT_helper_view.py +276 -0
- collective/documentgenerator/tests/test_DX_helper_view.py +355 -0
- collective/documentgenerator/tests/test_base_helper_view.py +128 -0
- collective/documentgenerator/tests/test_check_podtemplates_view.py +138 -0
- collective/documentgenerator/tests/test_config.py +106 -0
- collective/documentgenerator/tests/test_configurable_pod_template.py +383 -0
- collective/documentgenerator/tests/test_demo_profile.py +115 -0
- collective/documentgenerator/tests/test_events.py +169 -0
- collective/documentgenerator/tests/test_file.odt +0 -0
- collective/documentgenerator/tests/test_generation_view.py +652 -0
- collective/documentgenerator/tests/test_mailing.odt +0 -0
- collective/documentgenerator/tests/test_mailing_loop_template.py +48 -0
- collective/documentgenerator/tests/test_pod_template.py +178 -0
- collective/documentgenerator/tests/test_robot.py +26 -0
- collective/documentgenerator/tests/test_search_replace.py +419 -0
- collective/documentgenerator/tests/test_setup.py +49 -0
- collective/documentgenerator/tests/test_style_template.py +19 -0
- collective/documentgenerator/tests/test_sub_template.py +49 -0
- collective/documentgenerator/tests/test_templates_listing_view.py +91 -0
- collective/documentgenerator/tests/test_utils.py +244 -0
- collective/documentgenerator/tests/test_vocabulary.py +154 -0
- collective/documentgenerator/utils.py +396 -0
- collective/documentgenerator/viewlets/__init__.py +0 -0
- collective/documentgenerator/viewlets/batchactions.py +14 -0
- collective/documentgenerator/viewlets/configure.zcml +16 -0
- collective/documentgenerator/viewlets/generationlinks.pt +28 -0
- collective/documentgenerator/viewlets/generationlinks.py +58 -0
- collective.documentgenerator-3.46-py3.13-nspkg.pth +1 -0
- collective_documentgenerator-3.46.dist-info/METADATA +1142 -0
- collective_documentgenerator-3.46.dist-info/RECORD +176 -0
- collective_documentgenerator-3.46.dist-info/WHEEL +5 -0
- collective_documentgenerator-3.46.dist-info/entry_points.txt +5 -0
- collective_documentgenerator-3.46.dist-info/namespace_packages.txt +1 -0
- collective_documentgenerator-3.46.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
"""Helper view for dexterity content types."""
|
|
3
|
+
|
|
4
|
+
from ..interfaces import IFieldRendererForDocument
|
|
5
|
+
from .base import DisplayProxyObject
|
|
6
|
+
from .base import DocumentGenerationHelperView
|
|
7
|
+
from bs4 import BeautifulSoup as Soup
|
|
8
|
+
from collective.excelexport.exportables.dexterityfields import get_ordered_fields
|
|
9
|
+
from imio.helpers.content import get_relations as ih_get_relations
|
|
10
|
+
from plone import api
|
|
11
|
+
from plone.app.textfield import RichTextValue
|
|
12
|
+
from plone.autoform.interfaces import IFormFieldProvider
|
|
13
|
+
from plone.autoform.interfaces import READ_PERMISSIONS_KEY
|
|
14
|
+
from plone.behavior.interfaces import IBehavior
|
|
15
|
+
from plone.rfc822.interfaces import IPrimaryFieldInfo
|
|
16
|
+
from plone.supermodel.utils import mergedTaggedValueDict
|
|
17
|
+
from Products.CMFPlone.utils import base_hasattr
|
|
18
|
+
from z3c.form.interfaces import NO_VALUE
|
|
19
|
+
from zope.component import getMultiAdapter
|
|
20
|
+
from zope.component import getUtility
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
class DXDocumentGenerationHelperView(DocumentGenerationHelperView):
|
|
24
|
+
|
|
25
|
+
"""Helper view for dexterity content types."""
|
|
26
|
+
|
|
27
|
+
def __init__(self, context, request):
|
|
28
|
+
super(DXDocumentGenerationHelperView, self).__init__(context, request)
|
|
29
|
+
self.fti = api.portal.get_tool('portal_types')[context.portal_type]
|
|
30
|
+
# reverse fields order so that the content schema have priority on the behaviors fields
|
|
31
|
+
self.fields = dict(reversed(get_ordered_fields(self.fti)))
|
|
32
|
+
|
|
33
|
+
def has_field(self, field_name):
|
|
34
|
+
""" Check if fieldname is a field. Useful when behavior is optional """
|
|
35
|
+
return field_name in self.fields
|
|
36
|
+
|
|
37
|
+
def get_field(self, field_name):
|
|
38
|
+
"""Get field."""
|
|
39
|
+
return self.fields.get(field_name)
|
|
40
|
+
|
|
41
|
+
def get_field_schema(self, field_name):
|
|
42
|
+
"""Get schema for given field."""
|
|
43
|
+
schema = self.fti.lookupSchema()
|
|
44
|
+
if field_name in schema:
|
|
45
|
+
return schema
|
|
46
|
+
else:
|
|
47
|
+
for behavior_id in self.fti.behaviors:
|
|
48
|
+
schema = getUtility(IBehavior, behavior_id).interface
|
|
49
|
+
if field_name in schema:
|
|
50
|
+
return schema
|
|
51
|
+
|
|
52
|
+
return None
|
|
53
|
+
|
|
54
|
+
def get_field_renderer(self, field_name):
|
|
55
|
+
"""Get the dexterity field renderer for this field."""
|
|
56
|
+
field = self.get_field(field_name)
|
|
57
|
+
renderer = getMultiAdapter(
|
|
58
|
+
(field, self.real_context, self.request), IFieldRendererForDocument)
|
|
59
|
+
return renderer
|
|
60
|
+
|
|
61
|
+
def display(self, field_name, no_value='', bypass_check_permission=False):
|
|
62
|
+
"""Display field value."""
|
|
63
|
+
if bypass_check_permission or self.check_permission(field_name):
|
|
64
|
+
field_renderer = self.get_field_renderer(field_name)
|
|
65
|
+
display_value = field_renderer.render_value()
|
|
66
|
+
if not display_value:
|
|
67
|
+
display_value = no_value
|
|
68
|
+
else:
|
|
69
|
+
display_value = u''
|
|
70
|
+
|
|
71
|
+
return display_value
|
|
72
|
+
|
|
73
|
+
def check_permission(self, field_name):
|
|
74
|
+
"""Check field permission."""
|
|
75
|
+
schema = self.get_field_schema(field_name)
|
|
76
|
+
read_permissions = mergedTaggedValueDict(
|
|
77
|
+
schema, READ_PERMISSIONS_KEY)
|
|
78
|
+
permission = read_permissions.get(field_name)
|
|
79
|
+
if permission is None:
|
|
80
|
+
return True
|
|
81
|
+
|
|
82
|
+
user = api.user.get_current()
|
|
83
|
+
return api.user.has_permission(permission, user=user, obj=self.real_context)
|
|
84
|
+
|
|
85
|
+
def get_value(self, field_name, obj=None, default=None, as_utf8=False, strict=True):
|
|
86
|
+
"""Get value of field_name for obj
|
|
87
|
+
|
|
88
|
+
:param field_name: field name
|
|
89
|
+
:param obj: concerned obj (or real_context)
|
|
90
|
+
:param default: default value returned if value is None
|
|
91
|
+
:param as_utf8: as utf8
|
|
92
|
+
:param strict: if False and field doesn't exist, be cool and return default value
|
|
93
|
+
:return: value
|
|
94
|
+
"""
|
|
95
|
+
if obj is None:
|
|
96
|
+
obj = self.real_context
|
|
97
|
+
if not strict and not base_hasattr(obj, field_name):
|
|
98
|
+
return default
|
|
99
|
+
value = getattr(obj, field_name)
|
|
100
|
+
if value is None:
|
|
101
|
+
return default
|
|
102
|
+
if isinstance(value, NO_VALUE.__class__):
|
|
103
|
+
return default
|
|
104
|
+
if isinstance(value, RichTextValue):
|
|
105
|
+
value = value.output
|
|
106
|
+
if as_utf8 and isinstance(value, unicode):
|
|
107
|
+
value = value.encode('utf8')
|
|
108
|
+
return value
|
|
109
|
+
|
|
110
|
+
def display_voc(self, field_name, separator=', '):
|
|
111
|
+
field_renderer = self.get_field_renderer(field_name)
|
|
112
|
+
field_renderer.exportable.separator = separator
|
|
113
|
+
return field_renderer.render_value()
|
|
114
|
+
|
|
115
|
+
def display_widget(self, field_name, clean=True, soup=False):
|
|
116
|
+
obj_view = getMultiAdapter((self.real_context, self.request), name=u'view')
|
|
117
|
+
obj_view.updateFieldsFromSchemata()
|
|
118
|
+
for field in obj_view.fields:
|
|
119
|
+
if field != field_name:
|
|
120
|
+
obj_view.fields = obj_view.fields.omit(field)
|
|
121
|
+
obj_view.updateWidgets()
|
|
122
|
+
widget = obj_view.widgets[field_name]
|
|
123
|
+
rendered = widget.render() # unicode
|
|
124
|
+
if clean or soup:
|
|
125
|
+
souped = Soup(rendered, "html.parser")
|
|
126
|
+
if clean:
|
|
127
|
+
for tag in souped.find_all(class_='required'):
|
|
128
|
+
tag.extract()
|
|
129
|
+
for tag in souped.find_all(type='hidden'):
|
|
130
|
+
tag.extract()
|
|
131
|
+
if soup:
|
|
132
|
+
return souped
|
|
133
|
+
else:
|
|
134
|
+
return str(souped) # is utf8
|
|
135
|
+
else:
|
|
136
|
+
return rendered.encode('utf8')
|
|
137
|
+
|
|
138
|
+
def get_file_binary(self, file_obj):
|
|
139
|
+
""" """
|
|
140
|
+
primary_field_infos = IPrimaryFieldInfo(file_obj)
|
|
141
|
+
return primary_field_infos.value.data
|
|
142
|
+
|
|
143
|
+
def get_relations(self, context=None, attribute=None, backrefs=False, as_obj=False):
|
|
144
|
+
"""Get zc.relations or related objects.
|
|
145
|
+
|
|
146
|
+
:param context: object's relations (real_context if None)
|
|
147
|
+
:param attribute: related attribute name relations
|
|
148
|
+
:param backrefs: get relations where context is the destination (default is where context is the source)
|
|
149
|
+
:param as_obj: get objects pointed by relations
|
|
150
|
+
:return: relation's list or objects list
|
|
151
|
+
"""
|
|
152
|
+
if context is None:
|
|
153
|
+
context = self.real_context
|
|
154
|
+
return ih_get_relations(context, attribute=attribute, backrefs=backrefs, as_obj=as_obj)
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
class DXDisplayProxyObject(DisplayProxyObject):
|
|
158
|
+
|
|
159
|
+
"""Dexterity implementation of DisplayProxyObject."""
|
|
160
|
+
|
|
161
|
+
def is_field(self, attr_name):
|
|
162
|
+
ttool = api.portal.get_tool('portal_types')
|
|
163
|
+
fti = ttool[self.context.portal_type]
|
|
164
|
+
is_field = bool(fti.lookupSchema().get(attr_name))
|
|
165
|
+
if not is_field:
|
|
166
|
+
# check if it is a behavior field
|
|
167
|
+
for behavior_id in fti.behaviors:
|
|
168
|
+
schema = getUtility(IBehavior, behavior_id).interface
|
|
169
|
+
if not IFormFieldProvider.providedBy(schema):
|
|
170
|
+
continue
|
|
171
|
+
|
|
172
|
+
is_field = bool(schema.get(attr_name))
|
|
173
|
+
|
|
174
|
+
return is_field
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
"""Module where all interfaces, events and exceptions live."""
|
|
3
|
+
from collective.documentgenerator import _
|
|
4
|
+
from zope.interface import Interface
|
|
5
|
+
from zope.publisher.interfaces.browser import IDefaultBrowserLayer
|
|
6
|
+
from zope.schema import ValidationError
|
|
7
|
+
|
|
8
|
+
import pkg_resources
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
try:
|
|
12
|
+
pkg_resources.get_distribution('collective.eeafaceted.batchactions')
|
|
13
|
+
from collective.eeafaceted.batchactions.interfaces import IBatchActionsMarker
|
|
14
|
+
|
|
15
|
+
class IBelowContentBodyBatchActionsMarker(IBatchActionsMarker):
|
|
16
|
+
"""Interface to display batch actions in the BelowContentBody viewlet."""
|
|
17
|
+
except pkg_resources.DistributionNotFound:
|
|
18
|
+
pass
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class ICollectiveDocumentGeneratorLayer(IDefaultBrowserLayer):
|
|
22
|
+
"""Browser layer marker interface."""
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
class IDemoLayer(IDefaultBrowserLayer):
|
|
26
|
+
"""Demo browser layer marker interface."""
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
class IDocumentFactory(Interface):
|
|
30
|
+
"""Create a persistent generated document."""
|
|
31
|
+
|
|
32
|
+
def create(doc_file):
|
|
33
|
+
"""Create the object where the document 'doc_file' will be persisted."""
|
|
34
|
+
|
|
35
|
+
def redirect(created_obj):
|
|
36
|
+
"""Return an http redirection after the object creation."""
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
class IDocumentGenerationHelper(Interface):
|
|
40
|
+
"""View implementing all the helpers method needed for document generation."""
|
|
41
|
+
|
|
42
|
+
def get_value(field_name, default=None, as_utf8=False):
|
|
43
|
+
"""
|
|
44
|
+
Return the content stored in the object field_name attribute.
|
|
45
|
+
If content is None, a default can be used.
|
|
46
|
+
If content is unicode and flag as_utf8 is True, it will be encoded.
|
|
47
|
+
"""
|
|
48
|
+
|
|
49
|
+
def display(field_name):
|
|
50
|
+
"""
|
|
51
|
+
Return a string representation of context's field 'field_name'.
|
|
52
|
+
"""
|
|
53
|
+
|
|
54
|
+
def display_date(field_name, long_format=None, time_only=None, custom_format=None):
|
|
55
|
+
"""
|
|
56
|
+
Return a string representation of context's date field 'field_name'.
|
|
57
|
+
It uses toLocalizedTime if no custom_format is given. A custom_format is
|
|
58
|
+
a datetime strftime compatible like '%d/%m/%Y %H:%M'.
|
|
59
|
+
"""
|
|
60
|
+
|
|
61
|
+
def display_voc(field_name, separator=','):
|
|
62
|
+
"""
|
|
63
|
+
Return a join of display values of context's field 'field_name'.
|
|
64
|
+
"""
|
|
65
|
+
|
|
66
|
+
def display_text_as_html(field_name):
|
|
67
|
+
"""
|
|
68
|
+
Return the html version of the simple text field 'field_name'.
|
|
69
|
+
The simple text field doesn't contain html but only text with possible carriage returns.
|
|
70
|
+
"""
|
|
71
|
+
|
|
72
|
+
def display_html_as_text(field_name):
|
|
73
|
+
"""
|
|
74
|
+
Return the plain text version of a rich text 'field_name'.
|
|
75
|
+
"""
|
|
76
|
+
|
|
77
|
+
def render_xhtml(field_name):
|
|
78
|
+
"""
|
|
79
|
+
Return the odt rendered html content of the richtext field 'field_name'.
|
|
80
|
+
"""
|
|
81
|
+
|
|
82
|
+
def display_widget(fieldname, clean=True, soup=False):
|
|
83
|
+
"""
|
|
84
|
+
Display the html widget rendering for special fields (like datagrid or progress bar).
|
|
85
|
+
clean parameter: cleans some useless html parts (hidden, required).
|
|
86
|
+
soup parameter: returns a soup object.
|
|
87
|
+
"""
|
|
88
|
+
|
|
89
|
+
def list_voc(field_name, get='value'):
|
|
90
|
+
"""
|
|
91
|
+
Return all display values of the context's field 'field_name' vocabulary.
|
|
92
|
+
"""
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
class IDisplayProxyObject(Interface):
|
|
96
|
+
"""
|
|
97
|
+
Wrapper returning helper.display(field_name=attr) when trying
|
|
98
|
+
to acces an attribute 'attr' of the wrapped object.
|
|
99
|
+
"""
|
|
100
|
+
|
|
101
|
+
def is_field(attr_name):
|
|
102
|
+
"""
|
|
103
|
+
Return True or False wheter an attribute is a schema field of the object.
|
|
104
|
+
To implements for each content type (dexterity and Archetypes atm).
|
|
105
|
+
"""
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
class IFieldRendererForDocument(Interface):
|
|
109
|
+
""""""
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
class PODTemplateNotFoundError(Exception):
|
|
113
|
+
""" """
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
class IPODTemplateCondition(Interface):
|
|
117
|
+
"""
|
|
118
|
+
Condition object adapting a pod_template and a context.
|
|
119
|
+
"""
|
|
120
|
+
|
|
121
|
+
def evaluate():
|
|
122
|
+
"""
|
|
123
|
+
Represent the condition evaluation by returning True or False.
|
|
124
|
+
"""
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
class ITemplatesToMerge(Interface):
|
|
128
|
+
"""
|
|
129
|
+
Adapts a pod_template to return a dict of templates to merge with appy pod.
|
|
130
|
+
"""
|
|
131
|
+
|
|
132
|
+
def get():
|
|
133
|
+
"""
|
|
134
|
+
Return the templates dict. eg: {'mytemplateid', mytemplateobj} .
|
|
135
|
+
"""
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
class IDocumentGeneratorSettings(Interface):
|
|
139
|
+
"""
|
|
140
|
+
Settings for Document Generator.
|
|
141
|
+
"""
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
class IGenerablePODTemplates(Interface):
|
|
145
|
+
"""
|
|
146
|
+
Marker interface for generable POD templates adapter.
|
|
147
|
+
"""
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
class CyclicMergeTemplatesException(Exception):
|
|
151
|
+
"""
|
|
152
|
+
Templates to merge refers to each othert in a cyclic way.
|
|
153
|
+
"""
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
class InvalidPythonPath(ValidationError):
|
|
157
|
+
__doc__ = _(u'Invalid Python path')
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
class InvalidUnoPath(ValidationError):
|
|
161
|
+
__doc__ = _(u"Can't import python uno library with the python path")
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
class isNotFolderishError(Exception):
|
|
165
|
+
__doc__ = _(u"Can't create a persistent document on a non folderish context.")
|