cubicweb: comparison web/views/boxes.py

equal deleted inserted replaced

-:65a619eb31c4
+:b8287e54b528
 Additional boxes (disabled by default):
 * schema box
 * possible views box
 * startup views box
 """
+from __future__ import with_statement
 __docformat__ = "restructuredtext en"
 _ = unicode
 from warnings import warn
 from logilab.mtconverter import xml_escape
 from logilab.common.deprecation import class_deprecated
 from cubicweb import Unauthorized
-from cubicweb.selectors import (match_user_groups, match_context, match_kwargs,
+from cubicweb.selectors import (match_user_groups, match_kwargs,
-non_final_entity, nonempty_rset)
+non_final_entity, nonempty_rset,
+match_context, contextual)
+from cubicweb.utils import wrap_on_write
 from cubicweb.view import EntityView
 from cubicweb.schema import display_name
-from cubicweb.web import box, htmlwidgets
+from cubicweb.web import component, box, htmlwidgets
 # XXX bw compat, some cubes import this class from here
 BoxTemplate = box.BoxTemplate
 BoxHtml = htmlwidgets.BoxHtml
-class EditBox(box.Box): # XXX rename to ActionsBox
+class EditBox(component.CtxComponent): # XXX rename to ActionsBox
 """
 box with all actions impacting the entity displayed: edit, copy, delete
 change state, add related entities
 """
 __regid__ = 'edit_box'
-__select__ = box.Box.__select__ & non_final_entity()
+__select__ = component.CtxComponent.__select__ & non_final_entity()
 title = _('actions')
 order = 2
 contextual = True
 self._menus_in_order.remove(other_menu)
 self._menus_in_order.append(other_menu)
 for submenu in self._menus_in_order:
 self.add_submenu(self, submenu)
 if not self.items:
-raise box.EmptyComponent()
+raise component.EmptyComponent()
 def render_title(self, w):
 title = self._cw._(self.title)
 if self.cw_rset:
 etypes = self.cw_rset.column_types(0)
 box.append(submenu)
 elif appendanyway:
 box.append(xml_escape(submenu.label))
-class SearchBox(box.Box):
+class SearchBox(component.CtxComponent):
 """display a box with a simple search form"""
 __regid__ = 'search_box'
 title = _('search')
 order = 0
 xml_escape(rql), self._cw.next_tabindex()))
 # boxes disabled by default ###################################################
-class PossibleViewsBox(box.Box):
+class PossibleViewsBox(component.CtxComponent):
 """display a box containing links to all possible views"""
 __regid__ = 'possible_views_box'
 visible = False
 title = _('possible views')
 def init_rendering(self):
 self.views = [v for v in self._cw.vreg['views'].possible_views(self._cw,
 rset=self.cw_rset)
 if v.category != 'startupview']
 if not self.views:
-raise box.EmptyComponent()
+raise component.EmptyComponent()
 self.items = []
 def render_body(self, w):
 for category, views in box.sort_by_category(self.views):
 menu = htmlwidgets.BoxMenu(category)
 def init_rendering(self):
 self.views = [v for v in self._cw.vreg['views'].possible_views(self._cw)
 if v.category == 'startupview']
 if not self.views:
-raise box.EmptyComponent()
+raise component.EmptyComponent()
 self.items = []
-class RsetBox(box.Box):
+class RsetBox(component.CtxComponent):
 """helper view class to display an rset in a sidebox"""
 __select__ = nonempty_rset() & match_kwargs('title', 'vid')
 __regid__ = 'rsetbox'
 cw_property_defs = {}
 context = 'incontext'
 @property
 def domid(self):
 return super(RsetBox, self).domid + unicode(abs(id(self)))
 def render_title(self, w):
 w(self.cw_extra_kwargs['title'])
 def render_body(self, w):
 self._cw.view(self.cw_extra_kwargs['vid'], self.cw_rset, w=w)
 # helper classes ##############################################################
 class SideBoxView(EntityView):
 """helper view class to display some entities in a sidebox"""
 __metaclass__ = class_deprecated
-__deprecation_warning__ = 'SideBoxView is deprecated, use RsetBox instead'
+__deprecation_warning__ = '[3.10] SideBoxView is deprecated, use RsetBox instead (%(cls)s)'
 __regid__ = 'sidebox'
 def call(self, **kwargs):
 """display a list of entities by calling their <item_vid> view"""
-box = self._cw.vreg['boxes'].select('rsetbox', self._cw, rset=self.cw_rset,
+box = self._cw.vreg['ctxcomponents'].select(
-vid='autolimited', title=title,
+'rsetbox', self._cw, rset=self.cw_rset, vid='autolimited',
-**self.cw_extra_kwargs)
+title=title, **self.cw_extra_kwargs)
 box.render(self.w)
-class ContextualBoxLayout(box.Layout):
+class ContextualBoxLayout(component.Layout):
-__select__ = match_context('incontext', 'left', 'right') & box.contextual()
+__select__ = match_context('incontext', 'left', 'right') & contextual()
 # predefined class in cubicweb.css: contextualBox | contextFreeBox
 # XXX: navigationBox | actionBox
 cssclass = 'contextualBox'
 def render(self, w):
-view = self.cw_extra_kwargs['view']
+if self.init_rendering():
-try:
+view = self.cw_extra_kwargs['view']
-view.init_rendering()
+w(u'<div class="%s %s" id="%s">' % (self.cssclass, view.cssclass,
-except Unauthorized, ex:
+view.domid))
-self.warning("can't render %s: %s", view, ex)
+with wrap_on_write(w, u'<div class="boxTitle"><span>',
-return
+u'</span></div>') as wow:
-except box.EmptyComponent:
+view.render_title(wow)
-return
+w(u'<div class="boxBody">')
-w(u'<div class="%s %s" id="%s">' % (self.cssclass, view.cssclass,
+view.render_body(w)
-view.domid))
+# boxFooter div is a CSS place holder (for shadow for example)
-w(u'<div class="boxTitle"><span>')
+w(u'</div><div class="boxFooter"></div></div>\n')
-view.render_title(w)
-w(u'</span></div>\n<div class="boxBody">')
-view.render_body(w)
-# boxFooter div is a CSS place holder (for shadow for example)
-w(u'</div><div class="boxFooter"></div></div>\n')
 class ContextFreeBoxLayout(ContextualBoxLayout):
-__select__ = match_context('incontext', 'left', 'right') & ~box.contextual()
+__select__ = match_context('incontext', 'left', 'right') & ~contextual()
 cssclass = 'contextFreeBox'

changeset 6141	b8287e54b528
parent 6140	65a619eb31c4
child 6409	d75535983224