cubicweb: comparison web/views/baseviews.py

equal deleted inserted replaced

-:8edb0806dde4
+:982e8616d9a2
 class NoResultView(View):
 """default view when no result has been found"""
 __select__ = empty_rset()
 id = 'noresult'
 def call(self, **kwargs):
 self.w(u'<div class="searchMessage"><strong>%s</strong></div>\n'
 % self.req._('No result matching query'))
 class FinalView(AnyRsetView):
 """display values without any transformation (i.e. get a number for
 entities)
 """
 id = 'final'
 # record generated i18n catalog messages
 _('%d&nbsp;years')
 _('%d&nbsp;months')
 _('%d weeks')
 _('%d days')
 _('%d hours')
 _('%d minutes')
 _('%d seconds')
 def cell_call(self, row, col, props=None, displaytime=False, format='text/html'):
 etype = self.rset.description[row][col]
 value = self.rset.rows[row][col]
 if etype == 'String':
 entity, rtype = self.rset.related_entity(row, col)
 if entity is not None:
 # yes !
 self.w(entity.printable_value(rtype, value, format=format))
 return
 if etype in ('Time', 'Interval'):
 # value is DateTimeDelta but we have no idea about what is the
 # reference date here, so we can only approximate years and months
 if format == 'text/html':
 space = '&nbsp;'
 else:
 space = ' '
 else:
 self.w(self.req.__('%%d%sseconds' % space) % int(value.seconds))
 return
 self.wdata(printable_value(self.req, etype, value, props, displaytime=displaytime))
 PRIMARY_SKIP_RELS = set(['is', 'is_instance_of', 'identity',
 'owned_by', 'created_by',
 'in_state', 'wf_info_for', 'require_permission',
 'from_entity', 'to_entity',
 'see_also'])
 class PrimaryView(EntityView):
 <head> and </head> of the returned page
 by default primary views are indexed
 """
 return []
 def cell_call(self, row, col):
 self.row = row
 # XXX move render_entity implementation here
 self.render_entity(self.complete_entity(row, col))
 def render_entity(self, entity):
 """return html to display the given entity"""
 siderelations = []
 self.render_entity_title(entity)
 self.render_entity_metadata(entity)
 self.w(u'</div>')
 # side boxes
 self.w(u'<div class="primaryRight">')
 self.render_side_related(entity, siderelations)
 self.w(u'</div>')
 self.w(u'<div class="clear"></div>')
 self.content_navigation_components('navcontentbottom')
 def content_navigation_components(self, context):
 self.w(u'<div class="%s">' % context)
 for comp in self.vreg.possible_vobjects('contentnavigation',
 except NotImplementedError:
 warn('component %s doesnt implement cell_call, please update'
 % comp.__class__, DeprecationWarning)
 comp.dispatch(w=self.w, view=self)
 self.w(u'</div>')
 def iter_attributes(self, entity):
 for rschema, targetschema in entity.e_schema.attribute_definitions():
 if rschema.type in self.skip_attrs:
 continue
 yield rschema, targetschema
 def iter_relations(self, entity):
 skip = set(self.skip_rels)
 skip.update(PRIMARY_SKIP_RELS)
 for rschema, targetschemas, x in entity.e_schema.relation_definitions():
 if rschema.type in skip:
 def render_entity_title(self, entity):
 title = self.content_title(entity) # deprecate content_title?
 if title:
 self.w(u'<h1><span class="etype">%s</span> %s</h1>'
 % (entity.dc_type().capitalize(), title))
 def content_title(self, entity):
 """default implementation return an empty string"""
 return u''
 def render_entity_metadata(self, entity):
 entity.view('metadata', w=self.w)
 summary = self.summary(entity) # deprecate summary?
 if summary:
 self.w(u'<div class="summary">%s</div>' % summary)
 def summary(self, entity):
 """default implementation return an empty string"""
 return u''
 def render_entity_attributes(self, entity, siderelations):
 for rschema, targetschema in self.iter_attributes(entity):
 attr = rschema.type
 if targetschema.type in ('Password', 'Bytes'):
 continue
 try:
 box.dispatch(w=self.w, row=self.row)
 except NotImplementedError:
 # much probably a context insensitive box, which only implements
 # .call() and not cell_call()
 box.dispatch(w=self.w)
 def is_side_related(self, rschema, eschema):
 return rschema.meta and \
 not rschema.schema_relation() == eschema.schema_entity()
 def _render_related_entities(self, entity, rschema, related,
 self.req._('see them all'))
 value +=  '</div>'
 label = display_name(self.req, rschema.type, role)
 self.field(label, value, show_label=show_label, w=self.w, tr=False)
 class SecondaryView(EntityView):
 id = 'secondary'
 title = _('secondary')
 def cell_call(self, row, col):
 """the secondary view for an entity
 secondary = icon + view(oneline)
 """
 entity = self.entity(row, col)
 self.wview('oneline', self.rset, row=row, col=col)
 class OneLineView(EntityView):
 id = 'oneline'
 title = _('oneline')
 def cell_call(self, row, col):
 """the one line view for an entity: linked text view
 """
 entity = self.entity(row, col)
 raise NotImplementedError, self
 for i in xrange(len(rset)):
 self.wview(self.id, rset, row=i, **kwargs)
 if len(rset) > 1:
 self.w(u"\n")
 def cell_call(self, row, col=0, **kwargs):
 entity = self.entity(row, col)
 self.w(cut(entity.dc_title(),
 self.req.property_value('navigation.short-line-size')))
 class MetaDataView(EntityView):
 """paragraph view of some metadata"""
 id = 'metadata'
 show_eid = True
 def cell_call(self, row, col):
 _ = self.req._
 entity = self.entity(row, col)
 self.w(u'<div class="metadata">')
 if self.show_eid:
 if entity.modification_date != entity.creation_date:
 self.w(u'<span>%s</span> ' % _('latest update on'))
 self.w(u'<span class="value">%s</span>,&nbsp;'
 % self.format_date(entity.modification_date))
 # entities from external source may not have a creation date (eg ldap)
 if entity.creation_date:
 self.w(u'<span>%s</span> ' % _('created on'))
 self.w(u'<span class="value">%s</span>'
 % self.format_date(entity.creation_date))
 if entity.creator:
 self.w(u'&nbsp;<span>%s</span> ' % _('by'))
 self.w(u'<a href="%s" title="%s">' % (html_escape(entity.absolute_url()),
 html_escape(desc)))
 self.w(html_escape(self.view('textincontext', self.rset, row=row, col=col)))
 self.w(u'</a>')
 class OutOfContextView(EntityView):
 id = 'outofcontext'
 def cell_call(self, row, col):
 self.w(u'<a href="%s">' % self.entity(row, col).absolute_url())
 self.w(html_escape(self.view('textoutofcontext', self.rset, row=row, col=col)))
 self.w(u'</a>')
 # list views ##################################################################
 class ListView(EntityView):
 id = 'list'
 title = _('list')
 item_vid = 'listitem'
 def call(self, klass=None, title=None, subvid=None, listid=None, **kwargs):
 """display a list of entities by calling their <item_vid> view
 :param listid: the DOM id to use for the root element
 """
 if subvid is None and 'subvid' in self.req.form:
 subvid = self.req.form.pop('subvid') # consume it
 if listid:
 if len(self.rset) == 1:
 entity = self.rset.get_entity(0, 0)
 return self.build_url(entity.rest_path(), vid=self.id)
 return self.build_url(rql=self.rset.printable_rql(), vid=self.id)
 class ListItemView(EntityView):
 id = 'listitem'
 @property
 def redirect_vid(self):
 if self.req.search_state[0] == 'normal':
 return 'outofcontext'
 return 'outofcontext-search'
 def cell_call(self, row, col, vid=None, **kwargs):
 if not vid:
 vid = self.redirect_vid
 try:
 self.wview(vid, self.rset, row=row, col=col, **kwargs)
 class CSVView(SimpleListView):
 id = 'csv'
 redirect_vid = 'incontext'
 def call(self, **kwargs):
 rset = self.rset
 for i in xrange(len(rset)):
 self.cell_call(i, 0, vid=kwargs.get('vid'))
 if i < rset.rowcount-1:
 self.w(u", ")
 class TreeItemView(ListItemView):
 id = 'treeitem'
 def cell_call(self, row, col):
 self.wview('incontext', self.rset, row=row, col=col)
 class TextSearchResultView(EntityView):
 if len(ctx) > 30:
 contexts.append(u'...' + ctx[-30:])
 else:
 contexts.append(ctx)
 value = u'\n' + highlighted.join(contexts)
 self.w(value.replace('\n', '<br/>'))
 class TooltipView(EntityView):
 """A entity view used in a tooltip"""
 id = 'tooltip'
 XmlView = class_moved(xmlrss.XmlView)
 XmlItemView = class_moved(xmlrss.XmlItemView)
 XmlRsetView = class_moved(xmlrss.XmlRsetView)
 RssView = class_moved(xmlrss.RssView)
 RssItemView = class_moved(xmlrss.RssItemView)

branch	tls-sprint
changeset 1451	982e8616d9a2
parent 1263	01152fffd593
child 1453	a9841184be7c