web/formrenderers.py
author sylvain.thenault@logilab.fr
Mon, 11 May 2009 17:50:17 +0200
branchtls-sprint
changeset 1733 94c36d679454
parent 1710 8c717cc0b353
child 1757 fbb9928bf4f1
permissions -rw-r--r--
use html for rss description
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     1
"""form renderers, responsible to layout a form to html
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     2
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     3
:organization: Logilab
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     4
:copyright: 2009 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     5
:contact: http://www.logilab.fr/ -- mailto:contact@logilab.fr
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     6
"""
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     7
__docformat__ = "restructuredtext en"
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     8
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
     9
from logilab.common import dictattr
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    10
from logilab.mtconverter import html_escape
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    11
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    12
from simplejson import dumps
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    13
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    14
from cubicweb.common import tags
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    15
from cubicweb.web import eid_param
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    16
from cubicweb.web import formwidgets as fwdgs
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    17
from cubicweb.web.widgets import checkbox
1601
171afa270086 hidden input fields : compute displayability using the associated visible field
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 1576
diff changeset
    18
from cubicweb.web.formfields import HiddenInitialValueField
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    19
1319
sylvain.thenault@logilab.fr
parents: 1305
diff changeset
    20
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    21
class FormRenderer(object):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    22
    """basic renderer displaying fields in a two columns table label | value
1401
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    23
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    24
    +--------------+--------------+
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    25
    | field1 label | field1 input |
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    26
    +--------------+--------------+
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    27
    | field1 label | field2 input |
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    28
    +--------------+--------------+
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    29
    +---------+
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    30
    | buttons |
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
    31
    +---------+
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    32
    """
1434
42e57dbbc585 new display_relations_form option on EntityFormRender
sylvain.thenault@logilab.fr
parents: 1412
diff changeset
    33
    _options = ('display_fields', 'display_label', 'display_help',
1710
8c717cc0b353 refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents: 1691
diff changeset
    34
                'display_progress_div', 'table_class', 'button_bar_class')
1362
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    35
    display_fields = None # None -> all fields
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    36
    display_label = True
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    37
    display_help = True
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    38
    display_progress_div = True
1710
8c717cc0b353 refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents: 1691
diff changeset
    39
    table_class = u'attributeForm'
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    40
    button_bar_class = u'formButtonBar'
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
    41
1362
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    42
    def __init__(self, **kwargs):
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    43
        if self._set_options(kwargs):
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    44
            raise ValueError('unconsumed arguments %s' % kwargs)
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    45
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    46
    def _set_options(self, kwargs):
1434
42e57dbbc585 new display_relations_form option on EntityFormRender
sylvain.thenault@logilab.fr
parents: 1412
diff changeset
    47
        for key in self._options:
1362
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    48
            try:
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    49
                setattr(self, key, kwargs.pop(key))
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    50
            except KeyError:
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    51
                continue
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    52
        return kwargs
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
    53
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    54
    # renderer interface ######################################################
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
    55
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    56
    def render(self, form, values):
1362
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    57
        self._set_options(values)
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    58
        form.add_media()
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    59
        data = []
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    60
        w = data.append
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    61
        w(self.open_form(form, values))
1362
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    62
        if self.display_progress_div:
decb7507fa91 nicer renderer options handling: can be passed to __init__ or to render
sylvain.thenault@logilab.fr
parents: 1340
diff changeset
    63
            w(u'<div id="progress">%s</div>' % form.req._('validating...'))
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    64
        w(u'<fieldset>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    65
        w(tags.input(type=u'hidden', name=u'__form_id',
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    66
                     value=values.get('formvid', form.id)))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    67
        if form.redirect_path:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    68
            w(tags.input(type='hidden', name='__redirectpath', value=form.redirect_path))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    69
        self.render_fields(w, form, values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    70
        self.render_buttons(w, form)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    71
        w(u'</fieldset>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    72
        w(u'</form>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    73
        errormsg = self.error_message(form)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    74
        if errormsg:
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
    75
            data.insert(0, errormsg)
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    76
        return '\n'.join(data)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    77
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    78
    def render_label(self, form, field):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    79
        label = form.req._(field.label)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    80
        attrs = {'for': form.context[field]['id']}
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    81
        if field.required:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    82
            attrs['class'] = 'required'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    83
        return tags.label(label, **attrs)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    84
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    85
    def render_help(self, form, field):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    86
        help = [ u'<br/>' ]
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    87
        descr = field.help
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    88
        if descr:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    89
            help.append('<span class="helper">%s</span>' % form.req._(descr))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    90
        example = field.example_format(form.req)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    91
        if example:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    92
            help.append('<span class="helper">(%s: %s)</span>'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    93
                        % (form.req._('sample format'), example))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    94
        return u'&nbsp;'.join(help)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    95
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    96
    # specific methods (mostly to ease overriding) #############################
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    97
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    98
    def error_message(self, form):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
    99
        """return formatted error message
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   100
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   101
        This method should be called once inlined field errors has been consumed
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   102
        """
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   103
        req = form.req
1710
8c717cc0b353 refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents: 1691
diff changeset
   104
        errex = form.form_valerror
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   105
        # get extra errors
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   106
        if errex is not None:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   107
            errormsg = req._('please correct the following errors:')
1710
8c717cc0b353 refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents: 1691
diff changeset
   108
            displayed = form.form_displayed_errors
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   109
            errors = sorted((field, err) for field, err in errex.errors.items()
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   110
                            if not field in displayed)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   111
            if errors:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   112
                if len(errors) > 1:
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   113
                    templstr = '<li>%s</li>\n'
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   114
                else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   115
                    templstr = '&nbsp;%s\n'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   116
                for field, err in errors:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   117
                    if field is None:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   118
                        errormsg += templstr % err
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   119
                    else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   120
                        errormsg += templstr % '%s: %s' % (req._(field), err)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   121
                if len(errors) > 1:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   122
                    errormsg = '<ul>%s</ul>' % errormsg
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   123
            return u'<div class="errorMessage">%s</div>' % errormsg
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   124
        return u''
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   125
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   126
    def open_form(self, form, values):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   127
        if form.form_needs_multipart:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   128
            enctype = 'multipart/form-data'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   129
        else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   130
            enctype = 'application/x-www-form-urlencoded'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   131
        if form.action is None:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   132
            action = form.req.build_url('edit')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   133
        else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   134
            action = form.action
1274
b730932a79b7 we don't want dom id systematically
sylvain.thenault@logilab.fr
parents: 1181
diff changeset
   135
        tag = ('<form action="%s" method="post" enctype="%s"' % (
b730932a79b7 we don't want dom id systematically
sylvain.thenault@logilab.fr
parents: 1181
diff changeset
   136
            html_escape(action or '#'), enctype))
b730932a79b7 we don't want dom id systematically
sylvain.thenault@logilab.fr
parents: 1181
diff changeset
   137
        if form.domid:
b730932a79b7 we don't want dom id systematically
sylvain.thenault@logilab.fr
parents: 1181
diff changeset
   138
            tag += ' id="%s"' % form.domid
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   139
        if form.onsubmit:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   140
            tag += ' onsubmit="%s"' % html_escape(form.onsubmit % dictattr(form))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   141
        if form.cssstyle:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   142
            tag += ' style="%s"' % html_escape(form.cssstyle)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   143
        if form.cssclass:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   144
            tag += ' class="%s"' % html_escape(form.cssclass)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   145
        if form.cwtarget:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   146
            tag += ' cubicweb:target="%s"' % html_escape(form.cwtarget)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   147
        return tag + '>'
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   148
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   149
    def display_field(self, form, field):
1601
171afa270086 hidden input fields : compute displayability using the associated visible field
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 1576
diff changeset
   150
        if isinstance(field, HiddenInitialValueField):
171afa270086 hidden input fields : compute displayability using the associated visible field
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 1576
diff changeset
   151
            field = field.visible_field
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   152
        return (self.display_fields is None
1628
888871a071d9 display internal_fields
sylvain.thenault@logilab.fr
parents: 1601
diff changeset
   153
                or field.name in form.internal_fields
1576
3bfcf1e4eb26 display_fields should search for name+role
sylvain.thenault@logilab.fr
parents: 1436
diff changeset
   154
                or (field.name, field.role) in self.display_fields
3bfcf1e4eb26 display_fields should search for name+role
sylvain.thenault@logilab.fr
parents: 1436
diff changeset
   155
                or (field.name, field.role) in form.internal_fields)
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   156
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   157
    def render_fields(self, w, form, values):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   158
        form.form_build_context(values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   159
        fields = self._render_hidden_fields(w, form)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   160
        if fields:
1403
425892e14e67 _render_fields don't need values argument
sylvain.thenault@logilab.fr
parents: 1401
diff changeset
   161
            self._render_fields(fields, w, form)
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   162
        self.render_child_forms(w, form, values)
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   163
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   164
    def render_child_forms(self, w, form, values):
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   165
        # render
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   166
        for childform in getattr(form, 'forms', []):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   167
            self.render_fields(w, childform, values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   168
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   169
    def _render_hidden_fields(self, w, form):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   170
        fields = form.fields[:]
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   171
        for field in form.fields:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   172
            if not self.display_field(form, field):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   173
                fields.remove(field)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   174
            elif not field.is_visible():
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   175
                w(field.render(form, self))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   176
                fields.remove(field)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   177
        return fields
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   178
1403
425892e14e67 _render_fields don't need values argument
sylvain.thenault@logilab.fr
parents: 1401
diff changeset
   179
    def _render_fields(self, fields, w, form):
1710
8c717cc0b353 refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents: 1691
diff changeset
   180
        w(u'<table class="%s">' % self.table_class)
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   181
        for field in fields:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   182
            w(u'<tr>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   183
            if self.display_label:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   184
                w(u'<th class="labelCol">%s</th>' % self.render_label(form, field))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   185
            error = form.form_field_error(field)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   186
            if error:
1412
f3361e29d91f give more space to labels in forms
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 1403
diff changeset
   187
                w(u'<td class="error">')
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   188
                w(error)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   189
            else:
1412
f3361e29d91f give more space to labels in forms
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 1403
diff changeset
   190
                w(u'<td>')
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   191
            w(field.render(form, self))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   192
            if self.display_help:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   193
                w(self.render_help(form, field))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   194
            w(u'</td></tr>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   195
        w(u'</table>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   196
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   197
    def render_buttons(self, w, form):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   198
        w(u'<table class="%s">\n<tr>\n' % self.button_bar_class)
1304
8975c8e520a9 refactor button handling
sylvain.thenault@logilab.fr
parents: 1293
diff changeset
   199
        for button in form.form_buttons:
8975c8e520a9 refactor button handling
sylvain.thenault@logilab.fr
parents: 1293
diff changeset
   200
            w(u'<td>%s</td>\n' % button.render(form))
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   201
        w(u'</tr></table>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   202
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   203
1401
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   204
class HTableFormRenderer(FormRenderer):
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   205
    """display fields horizontally in a table
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   206
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   207
    +--------------+--------------+---------+
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   208
    | field1 label | field2 label |         |
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   209
    +--------------+--------------+---------+
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   210
    | field1 input | field2 input | buttons
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   211
    +--------------+--------------+---------+
1401
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   212
    """
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   213
    display_help = False
1403
425892e14e67 _render_fields don't need values argument
sylvain.thenault@logilab.fr
parents: 1401
diff changeset
   214
    def _render_fields(self, fields, w, form):
1401
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   215
        w(u'<table border="0">')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   216
        w(u'<tr>')
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   217
        for field in fields:
1401
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   218
            if self.display_label:
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   219
                w(u'<th class="labelCol">%s</th>' % self.render_label(form, field))
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   220
            if self.display_help:
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   221
                w(self.render_help(form, field))
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   222
        # empty slot for buttons
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   223
        w(u'<th class="labelCol">&nbsp;</th>')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   224
        w(u'</tr>')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   225
        w(u'<tr>')
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   226
        for field in fields:
1401
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   227
            error = form.form_field_error(field)
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   228
            if error:
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   229
                w(u'<td class="error" style="width:100%;">')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   230
                w(error)
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   231
            else:
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   232
                w(u'<td style="width:100%;">')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   233
            w(field.render(form, self))
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   234
            w(u'</td>')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   235
        w(u'<td>')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   236
        for button in form.form_buttons:
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   237
            w(button.render(form))
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   238
        w(u'</td>')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   239
        w(u'</tr>')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   240
        w(u'</table>')
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   241
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   242
    def render_buttons(self, w, form):
56764b1b4887 new renderer displaying field in an horizontable table
sylvain.thenault@logilab.fr
parents: 1362
diff changeset
   243
        pass
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   244
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   245
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   246
class EntityCompositeFormRenderer(FormRenderer):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   247
    """specific renderer for multiple entities edition form (muledit)"""
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   248
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   249
    def render_fields(self, w, form, values):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   250
        if not form.is_subform:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   251
            w(u'<table class="listing">')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   252
        super(EntityCompositeFormRenderer, self).render_fields(w, form, values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   253
        if not form.is_subform:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   254
            w(u'</table>')
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   255
1403
425892e14e67 _render_fields don't need values argument
sylvain.thenault@logilab.fr
parents: 1401
diff changeset
   256
    def _render_fields(self, fields, w, form):
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   257
        if form.is_subform:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   258
            entity = form.edited_entity
1710
8c717cc0b353 refactor error handling: get validation error information from a form attribute instead of req.data to avoid pb when multiple forms are displayed
sylvain.thenault@logilab.fr
parents: 1691
diff changeset
   259
            values = form.form_previous_values
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   260
            qeid = eid_param('eid', entity.eid)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   261
            cbsetstate = "setCheckboxesState2('eid', %s, 'checked')" % html_escape(dumps(entity.eid))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   262
            w(u'<tr class="%s">' % (entity.row % 2 and u'even' or u'odd'))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   263
            # XXX turn this into a widget used on the eid field
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   264
            w(u'<td>%s</td>' % checkbox('eid', entity.eid, checked=qeid in values))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   265
            for field in fields:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   266
                error = form.form_field_error(field)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   267
                if error:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   268
                    w(u'<td class="error">')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   269
                    w(error)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   270
                else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   271
                    w(u'<td>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   272
                if isinstance(field.widget, (fwdgs.Select, fwdgs.CheckBox, fwdgs.Radio)):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   273
                    field.widget.attrs['onchange'] = cbsetstate
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   274
                elif isinstance(field.widget, fwdgs.Input):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   275
                    field.widget.attrs['onkeypress'] = cbsetstate
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   276
                w(u'<div>%s</div>' % field.render(form, self))
1691
e35c7179ff8f fix closing td
sylvain.thenault@logilab.fr
parents: 1683
diff changeset
   277
                w(u'</td>')
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   278
        else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   279
            # main form, display table headers
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   280
            w(u'<tr class="header">')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   281
            w(u'<th align="left">%s</th>'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   282
              % tags.input(type='checkbox', title=form.req._('toggle check boxes'),
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   283
                           onclick="setCheckboxesState('eid', this.checked)"))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   284
            for field in self.forms[0].fields:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   285
                if self.display_field(form, field) and field.is_visible():
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   286
                    w(u'<th>%s</th>' % form.req._(field.label))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   287
        w(u'</tr>')
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   288
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   289
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   290
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   291
class EntityFormRenderer(FormRenderer):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   292
    """specific renderer for entity edition form (edition)"""
1434
42e57dbbc585 new display_relations_form option on EntityFormRender
sylvain.thenault@logilab.fr
parents: 1412
diff changeset
   293
    _options = FormRenderer._options + ('display_relations_form',)
42e57dbbc585 new display_relations_form option on EntityFormRender
sylvain.thenault@logilab.fr
parents: 1412
diff changeset
   294
    display_relations_form = True
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   295
1181
620ec8e6ae19 cleanup, various fix to get something working
sylvain.thenault@logilab.fr
parents: 1147
diff changeset
   296
    def render(self, form, values):
620ec8e6ae19 cleanup, various fix to get something working
sylvain.thenault@logilab.fr
parents: 1147
diff changeset
   297
        rendered = super(EntityFormRenderer, self).render(form, values)
620ec8e6ae19 cleanup, various fix to get something working
sylvain.thenault@logilab.fr
parents: 1147
diff changeset
   298
        return rendered + u'</div>' # close extra div introducted by open_form
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   299
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   300
    def open_form(self, form, values):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   301
        attrs_fs_label = ('<div class="iformTitle"><span>%s</span></div>'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   302
                          % form.req._('main informations'))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   303
        attrs_fs_label += '<div class="formBody">'
1181
620ec8e6ae19 cleanup, various fix to get something working
sylvain.thenault@logilab.fr
parents: 1147
diff changeset
   304
        return attrs_fs_label + super(EntityFormRenderer, self).open_form(form, values)
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   305
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   306
    def render_fields(self, w, form, values):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   307
        super(EntityFormRenderer, self).render_fields(w, form, values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   308
        self.inline_entities_form(w, form)
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   309
        if form.edited_entity.has_eid() and self.display_relations_form:
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   310
            self.relations_form(w, form)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   311
1403
425892e14e67 _render_fields don't need values argument
sylvain.thenault@logilab.fr
parents: 1401
diff changeset
   312
    def _render_fields(self, fields, w, form):
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   313
        if not form.edited_entity.has_eid() or form.edited_entity.has_perm('update'):
1403
425892e14e67 _render_fields don't need values argument
sylvain.thenault@logilab.fr
parents: 1401
diff changeset
   314
            super(EntityFormRenderer, self)._render_fields(fields, w, form)
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   315
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   316
    def render_buttons(self, w, form):
1304
8975c8e520a9 refactor button handling
sylvain.thenault@logilab.fr
parents: 1293
diff changeset
   317
        if len(form.form_buttons) == 3:
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   318
            w("""<table width="100%%">
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   319
  <tbody>
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   320
   <tr><td align="center">
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   321
     %s
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   322
   </td><td style="align: right; width: 50%%;">
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   323
     %s
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   324
     %s
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   325
   </td></tr>
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   326
  </tbody>
1304
8975c8e520a9 refactor button handling
sylvain.thenault@logilab.fr
parents: 1293
diff changeset
   327
 </table>""" % tuple(button.render(form) for button in form.form_buttons))
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   328
        else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   329
            super(EntityFormRenderer, self).render_buttons(w, form)
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   330
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   331
    def relations_form(self, w, form):
1683
c74566e61f1a don't display relation in the metadata category here
Graziella Toutoungis <graziella.toutoungis@logilab.fr>
parents: 1628
diff changeset
   332
        srels_by_cat = form.srelations_by_category('generic', 'add')
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   333
        if not srels_by_cat:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   334
            return u''
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   335
        req = form.req
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   336
        _ = req._
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   337
        label = u'%s :' % _('This %s' % form.edited_entity.e_schema).capitalize()
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   338
        eid = form.edited_entity.eid
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   339
        w(u'<fieldset class="subentity">')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   340
        w(u'<legend class="iformTitle">%s</legend>' % label)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   341
        w(u'<table id="relatedEntities">')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   342
        for rschema, target, related in form.relations_table():
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   343
            # already linked entities
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   344
            if related:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   345
                w(u'<tr><th class="labelCol">%s</th>' % rschema.display_name(req, target))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   346
                w(u'<td>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   347
                w(u'<ul>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   348
                for viewparams in related:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   349
                    w(u'<li class="invisible">%s<div id="span%s" class="%s">%s</div></li>'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   350
                      % (viewparams[1], viewparams[0], viewparams[2], viewparams[3]))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   351
                if not form.force_display and form.maxrelitems < len(related):
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   352
                    link = (u'<span class="invisible">'
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   353
                            '[<a href="javascript: window.location.href+=\'&amp;__force_display=1\'">%s</a>]'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   354
                            '</span>' % form.req._('view all'))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   355
                    w(u'<li class="invisible">%s</li>' % link)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   356
                w(u'</ul>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   357
                w(u'</td>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   358
                w(u'</tr>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   359
        pendings = list(form.restore_pending_inserts())
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   360
        if not pendings:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   361
            w(u'<tr><th>&nbsp;</th><td>&nbsp;</td></tr>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   362
        else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   363
            for row in pendings:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   364
                # soon to be linked to entities
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   365
                w(u'<tr id="tr%s">' % row[1])
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   366
                w(u'<th>%s</th>' % row[3])
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   367
                w(u'<td>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   368
                w(u'<a class="handle" title="%s" href="%s">[x]</a>' %
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   369
                  (_('cancel this insert'), row[2]))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   370
                w(u'<a id="a%s" class="editionPending" href="%s">%s</a>'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   371
                  % (row[1], row[4], html_escape(row[5])))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   372
                w(u'</td>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   373
                w(u'</tr>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   374
        w(u'<tr id="relationSelectorRow_%s" class="separator">' % eid)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   375
        w(u'<th class="labelCol">')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   376
        w(u'<span>%s</span>' % _('add relation'))
1305
395ef7f2b95b cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents: 1304
diff changeset
   377
        w(u'<select id="relationSelector_%s" tabindex="%s" '
395ef7f2b95b cleanup, remove some unnecessary (sometime buggy) stuff
sylvain.thenault@logilab.fr
parents: 1304
diff changeset
   378
          'onchange="javascript:showMatchingSelect(this.options[this.selectedIndex].value,%s);">'
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   379
          % (eid, req.next_tabindex(), html_escape(dumps(eid))))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   380
        w(u'<option value="">%s</option>' % _('select a relation'))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   381
        for i18nrtype, rschema, target in srels_by_cat:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   382
            # more entities to link to
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   383
            w(u'<option value="%s_%s">%s</option>' % (rschema, target, i18nrtype))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   384
        w(u'</select>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   385
        w(u'</th>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   386
        w(u'<td id="unrelatedDivs_%s"></td>' % eid)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   387
        w(u'</tr>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   388
        w(u'</table>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   389
        w(u'</fieldset>')
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   390
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   391
    def inline_entities_form(self, w, form):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   392
        """create a form to edit entity's inlined relations"""
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   393
        entity = form.edited_entity
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   394
        __ = form.req.__
1291
22b4d300d18d inlineview is no more a 'category', needs specific handling
sylvain.thenault@logilab.fr
parents: 1274
diff changeset
   395
        for rschema, targettypes, role in form.inlined_relations():
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   396
            # show inline forms only if there's one possible target type
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   397
            # for rschema
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   398
            if len(targettypes) != 1:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   399
                self.warning('entity related by the %s relation should have '
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   400
                             'inlined form but there is multiple target types, '
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   401
                             'dunno what to do', rschema)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   402
                continue
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   403
            targettype = targettypes[0].type
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   404
            if form.should_inline_relation_form(rschema, targettype, role):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   405
                w(u'<div id="inline%sslot">' % rschema)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   406
                existant = entity.has_eid() and entity.related(rschema)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   407
                if existant:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   408
                    # display inline-edition view for all existing related entities
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   409
                    w(form.view('inline-edition', existant, rtype=rschema, role=role,
1292
18a86192c9c4 inline_creation_form doesn't take ptype argument anymore
sylvain.thenault@logilab.fr
parents: 1291
diff changeset
   410
                                ptype=entity.e_schema, peid=entity.eid))
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   411
                if role == 'subject':
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   412
                    card = rschema.rproperty(entity.e_schema, targettype, 'cardinality')[0]
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   413
                else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   414
                    card = rschema.rproperty(targettype, entity.e_schema, 'cardinality')[1]
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   415
                # there is no related entity and we need at least one: we need to
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   416
                # display one explicit inline-creation view
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   417
                if form.should_display_inline_creation_form(rschema, existant, card):
1319
sylvain.thenault@logilab.fr
parents: 1305
diff changeset
   418
                    w(form.view('inline-creation', None, etype=targettype,
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   419
                                peid=entity.eid, ptype=entity.e_schema,
1319
sylvain.thenault@logilab.fr
parents: 1305
diff changeset
   420
                                rtype=rschema, role=role))
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   421
                # we can create more than one related entity, we thus display a link
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   422
                # to add new related entities
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   423
                if form.should_display_add_new_relation_link(rschema, existant, card):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   424
                    divid = "addNew%s%s%s:%s" % (targettype, rschema, role, entity.eid)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   425
                    w(u'<div class="inlinedform" id="%s" cubicweb:limit="true">'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   426
                      % divid)
1292
18a86192c9c4 inline_creation_form doesn't take ptype argument anymore
sylvain.thenault@logilab.fr
parents: 1291
diff changeset
   427
                    js = "addInlineCreationForm('%s', '%s', '%s', '%s')" % (
18a86192c9c4 inline_creation_form doesn't take ptype argument anymore
sylvain.thenault@logilab.fr
parents: 1291
diff changeset
   428
                        entity.eid, targettype, rschema, role)
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   429
                    if card in '1?':
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   430
                        js = "toggleVisibility('%s'); %s" % (divid, js)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   431
                    w(u'<a class="addEntity" id="add%s:%slink" href="javascript: %s" >+ %s.</a>'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   432
                      % (rschema, entity.eid, js, __('add a %s' % targettype)))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   433
                    w(u'</div>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   434
                    w(u'<div class="trame_grise">&nbsp;</div>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   435
                w(u'</div>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   436
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   437
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   438
class EntityInlinedFormRenderer(EntityFormRenderer):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   439
    """specific renderer for entity inlined edition form
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   440
    (inline-[creation|edition])
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   441
    """
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   442
    def render(self, form, values):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   443
        form.add_media()
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   444
        data = []
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   445
        w = data.append
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   446
        try:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   447
            w(u'<div id="div-%(divid)s" onclick="%(divonclick)s">' % values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   448
        except KeyError:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   449
            w(u'<div id="div-%(divid)s">' % values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   450
        else:
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   451
            w(u'<div id="notice-%s" class="notice">%s</div>' % (
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   452
                values['divid'], form.req._('click on the box to cancel the deletion')))
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   453
        w(u'<div class="iformBody">')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   454
        values['removemsg'] = form.req.__('remove this %s' % form.edited_entity.e_schema)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   455
        w(u'<div class="iformTitle"><span>%(title)s</span> '
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   456
          '#<span class="icounter">1</span> '
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   457
          '[<a href="javascript: %(removejs)s;noop();">%(removemsg)s</a>]</div>'
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   458
          % values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   459
        self.render_fields(w, form, values)
1293
aae1516b6426 missing closing div
sylvain.thenault@logilab.fr
parents: 1292
diff changeset
   460
        w(u'</div></div>')
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   461
        return '\n'.join(data)
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   462
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   463
    def render_fields(self, w, form, values):
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   464
        form.form_build_context(values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   465
        w(u'<fieldset id="fs-%(divid)s">' % values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   466
        fields = self._render_hidden_fields(w, form)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   467
        w(u'</fieldset>')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   468
        w(u'<fieldset class="subentity">')
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   469
        if fields:
1403
425892e14e67 _render_fields don't need values argument
sylvain.thenault@logilab.fr
parents: 1401
diff changeset
   470
            self._render_fields(fields, w, form)
1147
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   471
        self.render_child_forms(w, form, values)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   472
        self.inline_entities_form(w, form)
402e8a8b1d6a more form works
sylvain.thenault@logilab.fr
parents:
diff changeset
   473
        w(u'</fieldset>')
1436
97774eb6443b delete-trailing-whitespaces
sylvain.thenault@logilab.fr
parents: 1434
diff changeset
   474