web/views/primary.py
author Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
Wed, 21 Dec 2011 18:26:35 +0100
changeset 8139 f9ebb6d1abc3
parent 7990 a673d1d9a738
child 8190 2a3c1b787688
child 8201 2ceb28e6aa76
permissions -rw-r--r--
[server] use lgd.process_cursor to optimize processing of large resultsets update lgdb dependency to ensure we've a fix necessary for proper behaviour of the previous changeset
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
7837
6f32f142e2da [primary sub views] use entity_call instead of cell_call
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7782
diff changeset
     1
# copyright 2003-2011 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
5421
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
     2
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
     3
#
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
     4
# This file is part of CubicWeb.
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
     5
#
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
     6
# CubicWeb is free software: you can redistribute it and/or modify it under the
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
     7
# terms of the GNU Lesser General Public License as published by the Free
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
     8
# Software Foundation, either version 2.1 of the License, or (at your option)
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
     9
# any later version.
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
    10
#
5424
8ecbcbff9777 replace logilab-common by CubicWeb in disclaimer
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5421
diff changeset
    11
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT
5421
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
    12
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
    13
# FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
    14
# details.
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
    15
#
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
    16
# You should have received a copy of the GNU Lesser General Public License along
8167de96c523 proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
    17
# with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
7838
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    18
"""
7844
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    19
Public API of the PrimaryView class
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    20
````````````````````````````````````
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    21
.. autoclass:: cubicweb.web.views.primary.PrimaryView
7838
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    22
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    23
Views that may be used to display an entity's attribute or relation
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    24
```````````````````````````````````````````````````````````````````
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    25
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    26
Yoy may easily the display of an attribute or relation by simply configuring the
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    27
view using one of `primaryview_display_ctrl` or `reledit_ctrl` to use one of the
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    28
views describled below. For instance:
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    29
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    30
.. sourcecode:: python
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    31
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    32
    primaryview_display_ctrl.tag_attribute(('Foo', 'bar'), {'vid': 'attribute'})
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    33
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    34
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    35
.. autoclass:: AttributeView
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    36
.. autoclass:: URLAttributeView
7847
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
    37
.. autoclass:: VerbatimAttributeView
7838
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
    38
"""
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    39
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
    40
__docformat__ = "restructuredtext en"
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
    41
_ = unicode
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    42
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    43
from warnings import warn
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    44
6634
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
    45
from logilab.common.deprecation import deprecated
2312
af4d8f75c5db use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2237
diff changeset
    46
from logilab.mtconverter import xml_escape
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
    47
6235
d5f7bd102282 [primary view] properly handle case where view specified in pvdc['vid'] isn't selectable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6234
diff changeset
    48
from cubicweb import Unauthorized, NoSelectableObject
6067
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5896
diff changeset
    49
from cubicweb.utils import support_args
6446
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
    50
from cubicweb.selectors import match_kwargs, match_context
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    51
from cubicweb.view import EntityView
6377
3bb415310d4f [schema] introduce some new sets categorizing entity/relation types and benefits from them where possible
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6371
diff changeset
    52
from cubicweb.schema import META_RTYPES, VIRTUAL_RTYPES, display_name
6446
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
    53
from cubicweb.web import uicfg, component
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    54
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    55
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    56
class PrimaryView(EntityView):
7844
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    57
    """
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    58
    The basic layout of a primary view is as in the :ref:`primary_view_layout`
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    59
    section. This layout is actually drawn by the `render_entity` method.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    60
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    61
    The methods you may want to modify while customizing a ``PrimaryView``
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    62
    are:
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    63
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    64
    .. automethod:: cubicweb.web.views.primary.PrimaryView.render_entity_title
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    65
    .. automethod:: cubicweb.web.views.primary.PrimaryView.render_entity_attributes
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    66
    .. automethod:: cubicweb.web.views.primary.PrimaryView.render_entity_relations
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    67
    .. automethod:: cubicweb.web.views.primary.PrimaryView.render_side_boxes
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    68
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    69
    The placement of relations in the relations section or in side boxes
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    70
    can be controlled through the :ref:`primary_view_configuration` mechanism.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    71
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    72
    .. automethod:: cubicweb.web.views.primary.PrimaryView.content_navigation_components
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    73
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    74
    Also, please note that by setting the following attributes in your
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    75
    subclass, you can already customize some of the rendering:
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    76
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    77
    :attr:`show_attr_label`
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    78
        Renders the attribute label next to the attribute value if set to `True`.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    79
        Otherwise, does only display the attribute value.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    80
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    81
    :attr:`show_rel_label`
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    82
        Renders the relation label next to the relation value if set to `True`.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    83
        Otherwise, does only display the relation value.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    84
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    85
    :attr:`skip_none`
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    86
        Does not render an attribute value that is None if set to `True`.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    87
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    88
    :attr:`main_related_section`
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    89
        Renders the relations of the entity if set to `True`.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    90
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    91
    A good practice is for you to identify the content of your entity type for
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    92
    which the default rendering does not answer your need so that you can focus
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    93
    on the specific method (from the list above) that needs to be modified. We
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    94
    do not advise you to overwrite ``render_entity`` unless you want a
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    95
    completely different layout.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    96
    """
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
    97
3377
dd9d292b6a6d use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3072
diff changeset
    98
    __regid__ = 'primary'
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
    99
    title = _('primary')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   100
    show_attr_label = True
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   101
    show_rel_label = True
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   102
    skip_none = True
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   103
    rsection = uicfg.primaryview_section
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   104
    display_ctrl = uicfg.primaryview_display_ctrl
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   105
    main_related_section = True
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   106
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   107
    def html_headers(self):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   108
        """return a list of html headers (eg something to be inserted between
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   109
        <head> and </head> of the returned page
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   110
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   111
        by default primary views are indexed
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   112
        """
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   113
        return []
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   114
6847
c1d33aff7715 [primary view] support for entity_call on primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6634
diff changeset
   115
    def entity_call(self, entity):
c1d33aff7715 [primary view] support for entity_call on primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6634
diff changeset
   116
        entity.complete()
2400
17b1f0b80fe8 [primary] restore render_entity, as it is a bit too much work to update everything accordingly
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2384
diff changeset
   117
        self.render_entity(entity)
17b1f0b80fe8 [primary] restore render_entity, as it is a bit too much work to update everything accordingly
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2384
diff changeset
   118
17b1f0b80fe8 [primary] restore render_entity, as it is a bit too much work to update everything accordingly
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2384
diff changeset
   119
    def render_entity(self, entity):
4566
c49dba55c0a6 [views] toolbox must be rendered before the title to appear at top right
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 4467
diff changeset
   120
        self.render_entity_toolbox(entity)
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   121
        self.render_entity_title(entity)
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   122
        # entity's attributes and relations, excluding meta data
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   123
        # if the entity isn't meta itself
3974
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   124
        if self.is_primary():
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   125
            boxes = self._prepare_side_boxes(entity)
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   126
        else:
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   127
            boxes = None
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   128
        if boxes or hasattr(self, 'render_side_related'):
1558
f63d090eb34a some primary view fixes, need more (eg reledit doesn't work for non final relation
sylvain.thenault@logilab.fr
parents: 1554
diff changeset
   129
            self.w(u'<table width="100%"><tr><td style="width: 75%">')
6634
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   130
        if hasattr(self, 'render_entity_summary'):
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   131
            warn('[3.10] render_entity_summary method is deprecated (%s)' % self,
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   132
                 DeprecationWarning)
7879
9aae456abab5 [pylint] fix pylint detected errors and tweak it so that pylint -E will be much less verbose next time (+ update some copyrights on the way)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7847
diff changeset
   133
            self.render_entity_summary(entity) # pylint: disable=E1101
9aae456abab5 [pylint] fix pylint detected errors and tweak it so that pylint -E will be much less verbose next time (+ update some copyrights on the way)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7847
diff changeset
   134
6634
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   135
        summary = self.summary(entity)
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   136
        if summary:
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   137
            warn('[3.10] summary method is deprecated (%s)' % self,
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   138
                 DeprecationWarning)
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   139
            self.w(u'<div class="summary">%s</div>' % summary)
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   140
        self.w(u'<div class="mainInfo">')
2132
d7ae060cd746 move navcontenttop on the top
Katia Saurfelt <katia.saurfelt@logilab.fr>
parents: 1977
diff changeset
   141
        self.content_navigation_components('navcontenttop')
2384
6220783caa4b [primary] cleanup, render_entity -> cell_call
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2381
diff changeset
   142
        self.render_entity_attributes(entity)
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   143
        if self.main_related_section:
2384
6220783caa4b [primary] cleanup, render_entity -> cell_call
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2381
diff changeset
   144
            self.render_entity_relations(entity)
4742
fac80328a6a3 [primary] navcontentbottom sections should be in the content table as navcontenttop
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4572
diff changeset
   145
        self.content_navigation_components('navcontentbottom')
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   146
        self.w(u'</div>')
2237
7e546c3d6ea5 [primary] fix #344249
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2217
diff changeset
   147
        # side boxes
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   148
        if boxes or hasattr(self, 'render_side_related'):
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   149
            self.w(u'</td><td>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   150
            self.w(u'<div class="primaryRight">')
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   151
            self.render_side_boxes(boxes)
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   152
            self.w(u'</div>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   153
            self.w(u'</td></tr></table>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   154
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   155
    def content_navigation_components(self, context):
7844
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   156
        """This method is applicable only for entity type implementing the
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   157
        interface `IPrevNext`. This interface is for entities which can be
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   158
        linked to a previous and/or next entity. This method will render the
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   159
        navigation links between entities of this type, either at the top or at
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   160
        the bottom of the page given the context (navcontent{top|bottom}).
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   161
        """
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   162
        self.w(u'<div class="%s">' % context)
6141
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6140
diff changeset
   163
        for comp in self._cw.vreg['ctxcomponents'].poss_visible_objects(
6500
e288df2e2f18 [component] remove row argument which is actually discarded by registry's cache (untill we feel we need a per context cache...)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6476
diff changeset
   164
            self._cw, rset=self.cw_rset, view=self, context=context):
6926
2cda8f1b4fae cleanups
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6634
diff changeset
   165
            # XXX bw compat code
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   166
            try:
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   167
                comp.render(w=self.w, row=self.cw_row, view=self)
6616
26587186b856 [primary view bw compat] we should actually drop 3.2 compat and have proper pre 3.10 compat
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6582
diff changeset
   168
            except TypeError:
26587186b856 [primary view bw compat] we should actually drop 3.2 compat and have proper pre 3.10 compat
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6582
diff changeset
   169
                comp.render(w=self.w)
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   170
        self.w(u'</div>')
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   171
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   172
    def render_entity_title(self, entity):
7844
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   173
        """Renders the entity title, by default using entity's
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   174
        :meth:`dc_title()` method.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   175
        """
2312
af4d8f75c5db use xml_escape
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2237
diff changeset
   176
        title = xml_escape(entity.dc_title())
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   177
        if title:
3974
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   178
            if self.is_primary():
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   179
                self.w(u'<h1>%s</h1>' % title)
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   180
            else:
4104
7e478d7caf20 [mq]: small_api_changes_for_3.6
Arthur Lutz <arthur.lutz@logilab.fr>
parents: 4074
diff changeset
   181
                atitle = self._cw._('follow this link for more information on this %s') % entity.dc_type()
3974
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   182
                self.w(u'<h4><a href="%s" title="%s">%s</a></h4>'
1d36d9904c41 slightly adapt title and hide boxes when view is called as a non primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3972
diff changeset
   183
                       % (entity.absolute_url(), atitle, title))
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   184
3845
596044fb7bc5 introduce render_entity_toolbox on default primary view to display components in the ctxtoolbar context, such as pdf icon, notification registration (nosylist)...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3844
diff changeset
   185
    def render_entity_toolbox(self, entity):
596044fb7bc5 introduce render_entity_toolbox on default primary view to display components in the ctxtoolbar context, such as pdf icon, notification registration (nosylist)...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3844
diff changeset
   186
        self.content_navigation_components('ctxtoolbar')
596044fb7bc5 introduce render_entity_toolbox on default primary view to display components in the ctxtoolbar context, such as pdf icon, notification registration (nosylist)...
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3844
diff changeset
   187
6634
0683748bca81 [primary view] properly deprecates render_entity_[summary|metadata]
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6616
diff changeset
   188
    @deprecated('[3.8] render_entity_metadata method is deprecated')
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   189
    def render_entity_metadata(self, entity):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   190
        entity.view('metadata', w=self.w)
3064
3fbcdf220ce9 fix so that entity's summary appears in main content cell to avoid layout pb
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 2655
diff changeset
   191
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   192
    def summary(self, entity):
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   193
        """default implementation return an empty string"""
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   194
        return u''
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   195
5239
471554b842d2 [schema view] the final touch. Things are getting nicely displayed, and code clean
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
   196
    def render_entity_attributes(self, entity):
7844
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   197
        """Renders all attributes and relations in the 'attributes' section. The
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   198
        :attr:`skip_none` attribute controls the display of `None` valued
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   199
        attributes.
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   200
        """
5180
25c3269b2232 [xthml] fix #696079, potential empty table cause xhtml validation error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5065
diff changeset
   201
        display_attributes = []
25c3269b2232 [xthml] fix #696079, potential empty table cause xhtml validation error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5065
diff changeset
   202
        for rschema, _, role, dispctrl in self._section_def(entity, 'attributes'):
2361
8f00836580f1 [reledit] do NOT propose to edit composite-related entities (unlinking would destroy the other side)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 2312
diff changeset
   203
            vid = dispctrl.get('vid', 'reledit')
6070
0ca78eb1a3c2 [primary] use a new rtypevid flag in primary view display controller, allowing to tell the view for a non final relation should be called as an attribute view (eg, not on the target rset)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5896
diff changeset
   204
            if rschema.final or vid == 'reledit' or dispctrl.get('rtypevid'):
6086
2b53a8669c98 [primary] handle final relation (eg attribute) in the relations section, and give dispctrl to view's extra kwargs as for non final relation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6070
diff changeset
   205
                value = entity.view(vid, rtype=rschema.type, role=role,
2b53a8669c98 [primary] handle final relation (eg attribute) in the relations section, and give dispctrl to view's extra kwargs as for non final relation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6070
diff changeset
   206
                                    initargs={'dispctrl': dispctrl})
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   207
            else:
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   208
                rset = self._relation_rset(entity, rschema, role, dispctrl)
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   209
                if rset:
4382
6fb02edd05da 3.6 api update, cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4252
diff changeset
   210
                    value = self._cw.view(vid, rset)
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   211
                else:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   212
                    value = None
5180
25c3269b2232 [xthml] fix #696079, potential empty table cause xhtml validation error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5065
diff changeset
   213
            if not self.skip_none or (value is not None and value != ''):
25c3269b2232 [xthml] fix #696079, potential empty table cause xhtml validation error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5065
diff changeset
   214
                display_attributes.append( (rschema, role, dispctrl, value) )
25c3269b2232 [xthml] fix #696079, potential empty table cause xhtml validation error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5065
diff changeset
   215
        if display_attributes:
25c3269b2232 [xthml] fix #696079, potential empty table cause xhtml validation error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5065
diff changeset
   216
            self.w(u'<table>')
5182
3bc8250731fe [primary] fix name error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5180
diff changeset
   217
            for rschema, role, dispctrl, value in display_attributes:
7879
9aae456abab5 [pylint] fix pylint detected errors and tweak it so that pylint -E will be much less verbose next time (+ update some copyrights on the way)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7847
diff changeset
   218
                # pylint: disable=E1101
6371
9af007a3acb9 fix bad merge
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6366
diff changeset
   219
                if not hasattr(self, '_render_attribute'):
6067
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5896
diff changeset
   220
                    label = self._rel_label(entity, rschema, role, dispctrl)
6366
1806148d6ce8 backport stable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6333 6335
diff changeset
   221
                    self.render_attribute(label, value, table=True)
7990
a673d1d9a738 [diet] drop pre 3.6 API compatibility (but attempt to keep data cmopatibility). Closes #2017916
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7894
diff changeset
   222
                else:
6335
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   223
                    warn('[3.9] _render_attribute prototype has changed and '
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   224
                         'renamed to render_attribute, please update %s'
7879
9aae456abab5 [pylint] fix pylint detected errors and tweak it so that pylint -E will be much less verbose next time (+ update some copyrights on the way)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7847
diff changeset
   225
                         % self.__class__, DeprecationWarning)
6067
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5896
diff changeset
   226
                    self._render_attribute(dispctrl, rschema, value, role=role,
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5896
diff changeset
   227
                                           table=True)
5180
25c3269b2232 [xthml] fix #696079, potential empty table cause xhtml validation error
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5065
diff changeset
   228
            self.w(u'</table>')
1516
288d55a7c5e2 refactor side boxes handling of primary view
sylvain.thenault@logilab.fr
parents: 1491
diff changeset
   229
6335
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   230
    def render_attribute(self, label, value, table=False):
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   231
        self.field(label, value, tr=False, table=table)
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   232
5239
471554b842d2 [schema view] the final touch. Things are getting nicely displayed, and code clean
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5222
diff changeset
   233
    def render_entity_relations(self, entity):
7844
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   234
        """Renders all relations in the 'relations' section."""
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   235
        for rschema, tschemas, role, dispctrl in self._section_def(entity, 'relations'):
6113
dbe17a3ebb9f [primary view] consider rtypevid flag for relations in the 'relations' section as well
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6093
diff changeset
   236
            if rschema.final or dispctrl.get('rtypevid'):
6235
d5f7bd102282 [primary view] properly handle case where view specified in pvdc['vid'] isn't selectable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6234
diff changeset
   237
                vid = dispctrl.get('vid', 'reledit')
d5f7bd102282 [primary view] properly handle case where view specified in pvdc['vid'] isn't selectable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6234
diff changeset
   238
                try:
d5f7bd102282 [primary view] properly handle case where view specified in pvdc['vid'] isn't selectable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6234
diff changeset
   239
                    rview = self._cw.vreg['views'].select(
d5f7bd102282 [primary view] properly handle case where view specified in pvdc['vid'] isn't selectable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6234
diff changeset
   240
                        vid, self._cw, rset=entity.cw_rset, row=entity.cw_row,
6335
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   241
                        col=entity.cw_col, dispctrl=dispctrl,
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   242
                        rtype=rschema, role=role)
6235
d5f7bd102282 [primary view] properly handle case where view specified in pvdc['vid'] isn't selectable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6234
diff changeset
   243
                except NoSelectableObject:
d5f7bd102282 [primary view] properly handle case where view specified in pvdc['vid'] isn't selectable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6234
diff changeset
   244
                    continue
6335
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   245
                value = rview.render(row=entity.cw_row, col=entity.cw_col,
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   246
                                     rtype=rschema.type, role=role)
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   247
            else:
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   248
                rset = self._relation_rset(entity, rschema, role, dispctrl)
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   249
                if not rset:
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   250
                    continue
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   251
                if hasattr(self, '_render_relation'):
7879
9aae456abab5 [pylint] fix pylint detected errors and tweak it so that pylint -E will be much less verbose next time (+ update some copyrights on the way)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7847
diff changeset
   252
                    # pylint: disable=E1101
7990
a673d1d9a738 [diet] drop pre 3.6 API compatibility (but attempt to keep data cmopatibility). Closes #2017916
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7894
diff changeset
   253
                    self._render_relation(dispctrl, rset, 'autolimited')
a673d1d9a738 [diet] drop pre 3.6 API compatibility (but attempt to keep data cmopatibility). Closes #2017916
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7894
diff changeset
   254
                    warn('[3.9] _render_relation prototype has changed and has '
a673d1d9a738 [diet] drop pre 3.6 API compatibility (but attempt to keep data cmopatibility). Closes #2017916
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7894
diff changeset
   255
                         'been renamed to render_relation, please update %s'
a673d1d9a738 [diet] drop pre 3.6 API compatibility (but attempt to keep data cmopatibility). Closes #2017916
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7894
diff changeset
   256
                         % self.__class__, DeprecationWarning)
6335
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   257
                    continue
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   258
                vid = dispctrl.get('vid', 'autolimited')
3970
e4ad7663610b update _render_attribute / _render_relation prototype to gain more control on label through uicfg (for attributes and relations). Keep bw compat for crm/iliane
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3875
diff changeset
   259
                try:
6335
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   260
                    rview = self._cw.vreg['views'].select(
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   261
                        vid, self._cw, rset=rset, dispctrl=dispctrl)
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   262
                except NoSelectableObject:
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   263
                    continue
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   264
                value = rview.render()
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   265
            label = self._rel_label(entity, rschema, role, dispctrl)
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   266
            self.render_relation(label, value)
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   267
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   268
    def render_relation(self, label, value):
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   269
        self.w(u'<div class="section">')
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   270
        if label:
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   271
            self.w(u'<h4>%s</h4>' % label)
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   272
        self.w(value)
d13d488a453e [primary view] refactor label handling (hence render_[attribute|relation]) so we uniformly use _rel_label which provides properly contextified labels
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6291
diff changeset
   273
        self.w(u'</div>')
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   274
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   275
    def render_side_boxes(self, boxes):
7844
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   276
        """Renders side boxes on the right side of the content. This will
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   277
        generate a box for each relation in the 'sidebox' section, as well as
0208c65a88a5 [doc] split API/book part of stuff that has been moved in primary view module docstring
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7838
diff changeset
   278
        explicit box appobjects selectable in this context.
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   279
        """
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   280
        for box in boxes:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   281
            if isinstance(box, tuple):
3975
569771016abb add a fourth item to 'view box' defintion, dispctrl, so that
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3974
diff changeset
   282
                try:
569771016abb add a fourth item to 'view box' defintion, dispctrl, so that
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3974
diff changeset
   283
                    label, rset, vid, dispctrl  = box
569771016abb add a fourth item to 'view box' defintion, dispctrl, so that
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3974
diff changeset
   284
                except ValueError:
5560
b9a8e7109370 [primary view] fix name error on dispctrl w/ pre 3.5 box definition
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5520
diff changeset
   285
                    label, rset, vid = box
b9a8e7109370 [primary view] fix name error on dispctrl w/ pre 3.5 box definition
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5520
diff changeset
   286
                    dispctrl = {}
6140
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   287
                warn('[3.10] box views should now be a RsetBox instance, '
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   288
                     'please update %s' % self.__class__.__name__,
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   289
                     DeprecationWarning)
1885
c2011d238e98 replace sideRelated with sideBox
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents: 1752
diff changeset
   290
                self.w(u'<div class="sideBox">')
5519
bdc6a7e724f3 [primary view] give dispctrl to side box views as for relations section
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5426
diff changeset
   291
                self.wview(vid, rset, title=label, initargs={'dispctrl': dispctrl})
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   292
                self.w(u'</div>')
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   293
            else:
6140
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   294
                 try:
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   295
                     box.render(w=self.w, row=self.cw_row)
6616
26587186b856 [primary view bw compat] we should actually drop 3.2 compat and have proper pre 3.10 compat
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6582
diff changeset
   296
                 except TypeError:
26587186b856 [primary view bw compat] we should actually drop 3.2 compat and have proper pre 3.10 compat
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6582
diff changeset
   297
                     box.render(w=self.w)
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   298
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   299
    def _prepare_side_boxes(self, entity):
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   300
        sideboxes = []
6141
b8287e54b528 [web api] unify 'contentnav' (VComponent) and 'boxes' registries as 'ctxcomponents' (CtxComponent)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6140
diff changeset
   301
        boxesreg = self._cw.vreg['ctxcomponents']
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   302
        for rschema, tschemas, role, dispctrl in self._section_def(entity, 'sideboxes'):
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   303
            rset = self._relation_rset(entity, rschema, role, dispctrl)
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   304
            if not rset:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   305
                continue
6067
efca814587e2 [primary] refactor primary view handling of relation's label
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5896
diff changeset
   306
            label = self._rel_label(entity, rschema, role, dispctrl)
6140
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   307
            vid = dispctrl.get('vid', 'autolimited')
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   308
            box = boxesreg.select('rsetbox', self._cw, rset=rset,
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   309
                                  vid=vid, title=label, dispctrl=dispctrl,
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   310
                                  context='incontext')
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   311
            sideboxes.append(box)
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   312
        sideboxes += boxesreg.poss_visible_objects(
6500
e288df2e2f18 [component] remove row argument which is actually discarded by registry's cache (untill we feel we need a per context cache...)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6476
diff changeset
   313
             self._cw, rset=self.cw_rset, view=self,
6140
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   314
             context='incontext')
3975
569771016abb add a fourth item to 'view box' defintion, dispctrl, so that
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3974
diff changeset
   315
        # XXX since we've two sorted list, it may be worth using bisect
569771016abb add a fourth item to 'view box' defintion, dispctrl, so that
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3974
diff changeset
   316
        def get_order(x):
6140
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   317
            if 'order' in x.cw_property_defs:
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   318
                return x.cw_propval('order')
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   319
            # default to 9999 so view boxes occurs after component boxes
65a619eb31c4 [boxes] introduce new boxes system
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6139
diff changeset
   320
            return x.cw_extra_kwargs.get('dispctrl', {}).get('order', 9999)
3975
569771016abb add a fourth item to 'view box' defintion, dispctrl, so that
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3974
diff changeset
   321
        return sorted(sideboxes, key=get_order)
1491
742aff97dbf7 move AutomaticEntityForm and PrimaryView into their own module
sylvain.thenault@logilab.fr
parents:
diff changeset
   322
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   323
    def _section_def(self, entity, where):
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   324
        rdefs = []
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   325
        eschema = entity.e_schema
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   326
        for rschema, tschemas, role in eschema.relation_definitions(True):
5065
01d85f3a3d9e [primary view] skip virtual rtypes anyway
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4742
diff changeset
   327
            if rschema in VIRTUAL_RTYPES:
01d85f3a3d9e [primary view] skip virtual rtypes anyway
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4742
diff changeset
   328
                continue
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   329
            matchtschemas = []
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   330
            for tschema in tschemas:
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   331
                section = self.rsection.etype_get(eschema, rschema, role,
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   332
                                                  tschema)
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   333
                if section == where:
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   334
                    matchtschemas.append(tschema)
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   335
            if matchtschemas:
6234
ae97a8c818e5 [primary view] don't need to pick arbitrary target, this is properly handled by the rtag
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6113
diff changeset
   336
                dispctrl = self.display_ctrl.etype_get(eschema, rschema, role, '*')
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   337
                rdefs.append( (rschema, matchtschemas, role, dispctrl) )
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   338
        return sorted(rdefs, key=lambda x: x[-1]['order'])
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   339
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   340
    def _relation_rset(self, entity, rschema, role, dispctrl):
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   341
        try:
6291
f6cba3be6ba2 [primary view] we should not limit related rset, else if something else than autolimited view is used, some content will be missed without a 'view all' link
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6290
diff changeset
   342
            rset = entity.related(rschema.type, role)
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   343
        except Unauthorized:
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   344
            return
1739
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   345
        if 'filter' in dispctrl:
78b0819162a8 final rtag api
sylvain.thenault@logilab.fr
parents: 1726
diff changeset
   346
            rset = dispctrl['filter'](rset)
1554
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   347
        return rset
3a3263df6cdd new primary view using uicfg.rdisplay (major api cleanup)
sylvain.thenault@logilab.fr
parents: 1516
diff changeset
   348
6090
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   349
    def _rel_label(self, entity, rschema, role, dispctrl):
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   350
        if rschema.final:
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   351
            showlabel = dispctrl.get('showlabel', self.show_attr_label)
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   352
        else:
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   353
            showlabel = dispctrl.get('showlabel', self.show_rel_label)
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   354
        if showlabel:
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   355
            if dispctrl.get('label'):
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   356
                label = self._cw._(dispctrl['label'])
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   357
            else:
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   358
                label = display_name(self._cw, rschema.type, role,
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   359
                                     context=entity.__regid__)
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   360
            return label
887c069d88df [primary] backport _rel_label method from the default branch
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6086
diff changeset
   361
        return u''
1516
288d55a7c5e2 refactor side boxes handling of primary view
sylvain.thenault@logilab.fr
parents: 1491
diff changeset
   362
6093
9001a74fcc82 more generic dot graph generator
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents: 6090
diff changeset
   363
1516
288d55a7c5e2 refactor side boxes handling of primary view
sylvain.thenault@logilab.fr
parents: 1491
diff changeset
   364
class RelatedView(EntityView):
6283
c827fa795a6b [reledit] more api cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6255
diff changeset
   365
    """Display a rset, usually containing entities linked to another entity
c827fa795a6b [reledit] more api cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6255
diff changeset
   366
    being displayed.
c827fa795a6b [reledit] more api cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6255
diff changeset
   367
c827fa795a6b [reledit] more api cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6255
diff changeset
   368
    It will try to display nicely according to the number of items in the result
c827fa795a6b [reledit] more api cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6255
diff changeset
   369
    set.
7838
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
   370
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
   371
    XXX include me in the doc
6283
c827fa795a6b [reledit] more api cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6255
diff changeset
   372
    """
3377
dd9d292b6a6d use __regid__ instead of id on appobject classes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3072
diff changeset
   373
    __regid__ = 'autolimited'
3681
cdbe4aac1198 fix max-related of related entities handling in primary view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3071
diff changeset
   374
3705
5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3689
diff changeset
   375
    def call(self, **kwargs):
4072
ead446e70c28 some api update
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 4004
diff changeset
   376
        if 'dispctrl' in self.cw_extra_kwargs:
6291
f6cba3be6ba2 [primary view] we should not limit related rset, else if something else than autolimited view is used, some content will be missed without a 'view all' link
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6290
diff changeset
   377
            if 'limit' in self.cw_extra_kwargs['dispctrl']:
f6cba3be6ba2 [primary view] we should not limit related rset, else if something else than autolimited view is used, some content will be missed without a 'view all' link
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6290
diff changeset
   378
                limit = self.cw_extra_kwargs['dispctrl']['limit']
f6cba3be6ba2 [primary view] we should not limit related rset, else if something else than autolimited view is used, some content will be missed without a 'view all' link
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6290
diff changeset
   379
            else:
f6cba3be6ba2 [primary view] we should not limit related rset, else if something else than autolimited view is used, some content will be missed without a 'view all' link
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6290
diff changeset
   380
                limit = self._cw.property_value('navigation.related-limit')
6288
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   381
            list_limit = self.cw_extra_kwargs['dispctrl'].get('use_list_limit', 5)
5520
2d7f135846ee [primary view] allow new 'subvid' parameter in primaryview_display_ctrl
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5519
diff changeset
   382
            subvid = self.cw_extra_kwargs['dispctrl'].get('subvid', 'incontext')
3705
5cd35123866b get dispctrl through extra_kwargs to avoid error when a custom view is specified (potentially not taking any argument)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3689
diff changeset
   383
        else:
6288
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   384
            limit = list_limit = None
5520
2d7f135846ee [primary view] allow new 'subvid' parameter in primaryview_display_ctrl
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5519
diff changeset
   385
            subvid = 'incontext'
3720
5376aaadd16b backport stable
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3451 3705
diff changeset
   386
        if limit is None or self.cw_rset.rowcount <= limit:
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   387
            if self.cw_rset.rowcount == 1:
5520
2d7f135846ee [primary view] allow new 'subvid' parameter in primaryview_display_ctrl
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5519
diff changeset
   388
                self.wview(subvid, self.cw_rset, row=0)
6288
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   389
            elif list_limit is None or 1 < self.cw_rset.rowcount <= list_limit:
5520
2d7f135846ee [primary view] allow new 'subvid' parameter in primaryview_display_ctrl
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5519
diff changeset
   390
                self.wview('csv', self.cw_rset, subvid=subvid)
1516
288d55a7c5e2 refactor side boxes handling of primary view
sylvain.thenault@logilab.fr
parents: 1491
diff changeset
   391
            else:
288d55a7c5e2 refactor side boxes handling of primary view
sylvain.thenault@logilab.fr
parents: 1491
diff changeset
   392
                self.w(u'<div>')
5520
2d7f135846ee [primary view] allow new 'subvid' parameter in primaryview_display_ctrl
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 5519
diff changeset
   393
                self.wview('simplelist', self.cw_rset, subvid=subvid)
1516
288d55a7c5e2 refactor side boxes handling of primary view
sylvain.thenault@logilab.fr
parents: 1491
diff changeset
   394
                self.w(u'</div>')
288d55a7c5e2 refactor side boxes handling of primary view
sylvain.thenault@logilab.fr
parents: 1491
diff changeset
   395
        # else show links to display related entities
288d55a7c5e2 refactor side boxes handling of primary view
sylvain.thenault@logilab.fr
parents: 1491
diff changeset
   396
        else:
3451
6b46d73823f5 [api] work in progress, use __regid__, cw_*, etc.
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 3377
diff changeset
   397
            rql = self.cw_rset.printable_rql()
6476
de7f53cf75ec [primary] fix autolimited view which was not limited at all
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6446
diff changeset
   398
            rset = self.cw_rset.limit(limit) # remove extra entity
6288
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   399
            if list_limit is None:
6476
de7f53cf75ec [primary] fix autolimited view which was not limited at all
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6446
diff changeset
   400
                self.wview('csv', rset, subvid=subvid)
6288
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   401
                self.w(u'[<a href="%s">%s</a>]' % (
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   402
                    xml_escape(self._cw.build_url(rql=rql, vid=subvid)),
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   403
                    self._cw._('see them all')))
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   404
            else:
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   405
                self.w(u'<div>')
6476
de7f53cf75ec [primary] fix autolimited view which was not limited at all
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6446
diff changeset
   406
                self.wview('simplelist', rset, subvid=subvid)
6288
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   407
                self.w(u'[<a href="%s">%s</a>]' % (
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   408
                    xml_escape(self._cw.build_url(rql=rql, vid=subvid)),
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   409
                    self._cw._('see them all')))
17cd9ae3d2d5 [primary view] introducing use_list_limit in pvdc fix reledit regression on the way (introducted a few changesets ago)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6283
diff changeset
   410
                self.w(u'</div>')
2652
3753f3a07ca1 [refactoring] moved rtags specification in web/views
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 2402
diff changeset
   411
3971
7cfbc35dce7e new generic urlattr view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3970
diff changeset
   412
6246
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   413
class AttributeView(EntityView):
7838
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
   414
    """:__regid__: *attribute*
6246
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   415
7838
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
   416
    This view is generally used to disable the *reledit* feature. It works on
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
   417
    both relations and attributes.
6246
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   418
    """
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   419
    __regid__ = 'attribute'
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   420
    __select__ = EntityView.__select__ & match_kwargs('rtype')
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   421
7879
9aae456abab5 [pylint] fix pylint detected errors and tweak it so that pylint -E will be much less verbose next time (+ update some copyrights on the way)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7847
diff changeset
   422
    def entity_call(self, entity, rtype, role, **kwargs):
6246
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   423
        if self._cw.vreg.schema.rschema(rtype).final:
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   424
            self.w(entity.printable_value(rtype))
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   425
        else:
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   426
            dispctrl = uicfg.primaryview_display_ctrl.etype_get(
6582
8eb7883b4223 [pylint] fix a bug of pylint detected errors and i18n pb (calling builtins._ instead of req._)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6500
diff changeset
   427
                entity.e_schema, rtype, role, '*')
6246
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   428
            rset = entity.related(rtype, role)
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   429
            if rset:
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   430
                self.wview('autolimited', rset, initargs={'dispctrl': dispctrl})
62e25fac41cd [views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents: 6235
diff changeset
   431
3971
7cfbc35dce7e new generic urlattr view
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3970
diff changeset
   432
7847
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   433
class URLAttributeView(EntityView):
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   434
    """:__regid__: *urlattr*
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   435
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   436
    This view will wrap an attribute value (hence expect a string) into an '<a>'
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   437
    HTML tag to display a clickable link.
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   438
    """
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   439
    __regid__ = 'urlattr'
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   440
    __select__ = EntityView.__select__ & match_kwargs('rtype')
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   441
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   442
    def entity_call(self, entity, rtype, **kwargs):
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   443
        url = entity.printable_value(rtype)
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   444
        if url:
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   445
            self.w(u'<a href="%s">%s</a>' % (url, url))
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   446
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   447
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   448
class VerbatimAttributeView(EntityView):
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   449
    """:__regid__: *verbatimattr*
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   450
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   451
    This view will wrap an attribute value into an '<pre>' HTML tag to display
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   452
    arbitrary text where EOL will be respected. It usually make sense for
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   453
    attributes whose value is a multi-lines string where new lines matters.
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   454
    """
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   455
    __regid__ = 'verbatimattr'
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   456
    __select__ = EntityView.__select__ & match_kwargs('rtype')
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   457
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   458
    def entity_call(self, entity, rtype, **kwargs):
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   459
        value = entity.printable_value(rtype)
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   460
        if value:
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   461
            self.w(u'<pre>%s</pre>' % value)
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   462
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   463
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   464
7be550fb337b [primary view] add 'verbatim' attribute view (closes #1947475)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7844
diff changeset
   465
6446
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
   466
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
   467
class ToolbarLayout(component.Layout):
7838
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
   468
    # XXX include me in the doc
6446
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
   469
    __select__ = match_context('ctxtoolbar')
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
   470
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
   471
    def render(self, w):
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
   472
        if self.init_rendering():
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
   473
            self.cw_extra_kwargs['view'].render_body(w)
878fcf10cead [contextual components] missing layout for components in the toolbar
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6377
diff changeset
   474
7838
ea1360938033 [doc] backport primary view documentation into the code, also document [URL]AttributeView
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 7837
diff changeset
   475
2652
3753f3a07ca1 [refactoring] moved rtags specification in web/views
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 2402
diff changeset
   476
## default primary ui configuration ###########################################
3753f3a07ca1 [refactoring] moved rtags specification in web/views
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents: 2402
diff changeset
   477
3875
c2bd7922cdaf use shorter notation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3849
diff changeset
   478
_pvs = uicfg.primaryview_section
6377
3bb415310d4f [schema] introduce some new sets categorizing entity/relation types and benefits from them where possible
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 6371
diff changeset
   479
for rtype in META_RTYPES:
3875
c2bd7922cdaf use shorter notation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3849
diff changeset
   480
    _pvs.tag_subject_of(('*', rtype, '*'), 'hidden')
c2bd7922cdaf use shorter notation
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents: 3849
diff changeset
   481
    _pvs.tag_object_of(('*', rtype, '*'), 'hidden')