rattail/appypod-rattail
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

[gen] Calendar field: added the possibility to define the part of the legend that is specific to every layer.

Browse source
This commit is contained in:
Gaetan Delannay 2015-03-25 15:13:32 +01:00
parent 01b3681712
commit 44eca07b15
1 changed files with 30 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
fields/calendar.py
View file

@ -146,7 +146,7 @@ class Totals:
class Layer: class Layer:
'''A layer is a set of additional data that can be activated or not on top '''A layer is a set of additional data that can be activated or not on top
of calendar data. Currently available for timelines only.''' of calendar data. Currently available for timelines only.'''
def __init__(self, name, label, onCell, activeByDefault=False): def __init__(self, name, label, onCell, activeByDefault=False, legend=None):
# "name" must hold a short name or acronym, unique among all layers # "name" must hold a short name or acronym, unique among all layers
self.name = name self.name = name
# "label" is a i18n label that will be used to produce the layer name in # "label" is a i18n label that will be used to produce the layer name in
@ -168,6 +168,14 @@ class Layer:
self.onCell = onCell self.onCell = onCell
# Is this layer activated by default ? # Is this layer activated by default ?
self.activeByDefault = activeByDefault self.activeByDefault = activeByDefault
# "legend" is a method that must produce legend items that are specific
# to this layer. The method must accept no arg and must return a list of
# objects (you can use class appy.Object) having these attributes:
# * name - the legend item name as shown in the calendar
# * style - the content of the "style" attribute that will be
# applied to the little square ("td" tag) for this item;
# * content - the content of this "td" (if any).
self.legend = legend
# Layers will be chained: one layer will access the previous one in the # Layers will be chained: one layer will access the previous one in the
# stack via attribute "previous". "previous" fields will automatically # stack via attribute "previous". "previous" fields will automatically
# be filled by the Calendar. # be filled by the Calendar.
@ -185,6 +193,11 @@ class Layer:
return self.previous.getCellInfo(obj, activeLayers, date, other, return self.previous.getCellInfo(obj, activeLayers, date, other,
events, preComputed) events, preComputed)
def getLegendItems(self, obj):
'''Returns the legend items by calling method in self.legend'''
if not self.legend: return
return self.legend(obj)
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
class Event(Persistent): class Event(Persistent):
'''An event as will be stored in the database''' '''An event as will be stored in the database'''
@ -271,12 +284,14 @@ class Calendar(Field):
# Legend for a timeline calendar # Legend for a timeline calendar
pxTimelineLegend = Px(''' pxTimelineLegend = Px('''
<table align="center" class="discreet" <table align="center" class="discreet"
var="items=field.getLegendItems(allEventTypes, allEventNames, \ var="items=field.getLegendItems(obj, allEventTypes, allEventNames, \
colors, url, _)"> colors, url, _, activeLayers)">
<tr for="row in field.splitList(items, 4)"> <tr for="row in field.splitList(items, 4)" valign="top">
<x for="item in row"> <x for="item in row">
<td><table> <!-- A colored cell (as mono-cell sub-table) --> <td><table> <!-- A colored cell (as mono-cell sub-table) -->
<tr height="9px"><td width="9px" style=":item.style">&nbsp;</td></tr> <tr height="9px" valign="middle">
<td width="9px" align="center"
style=":item.style">:item.content or '&nbsp;'</td></tr>
</table></td> </table></td>
<!-- The event name --> <!-- The event name -->
<td width="115px">:item.name</td> <td width="115px">:item.name</td>
@ -979,18 +994,24 @@ class Calendar(Field):
content = events[0].symbol or '' content = events[0].symbol or ''
return '<td%s%s>%s</td>' % (style, title, content) return '<td%s%s>%s</td>' % (style, title, content)
def getLegendItems(self, allEventTypes, allEventNames, colors, url, _): def getLegendItems(self, obj, allEventTypes, allEventNames, colors, url, _,
'''Gets information needed to produce the legend for a timeline.''' activeLayers):
'''Gets information needed to produce the legend for a timeline'''
# Produce one legend item by event type shown and colored # Produce one legend item by event type shown and colored
res = [] res = []
for eventType in allEventTypes: for eventType in allEventTypes:
if eventType not in colors: continue if eventType not in colors: continue
res.append(Object(name=allEventNames[eventType], res.append(Object(name=allEventNames[eventType], content='',
style='background-color: %s' % colors[eventType])) style='background-color: %s' % colors[eventType]))
# Add the background indicating that several events are hidden behind # Add the background indicating that several events are hidden behind
# the timeline cell # the timeline cell
res.append(Object(name=_('several_events'), res.append(Object(name=_('several_events'), content='',
style=url('angled', bg=True))) style=url('angled', bg=True)))
# Add layer-specific items
for layer in self.layers:
if layer.name not in activeLayers: continue
items = layer.getLegendItems(obj)
if items: res += items
return res return res
def getTimelineMonths(self, grid, obj): def getTimelineMonths(self, grid, obj):