Changeset 8257

Timestamp:

23 Apr 2012, 11:56:06 (13 years ago)

Author:

uli

Message:

Support notes in generated PDFs.

Location:

main/waeup.kofa/trunk/src/waeup/kofa

Files:

• applicants/pdf.py (modified) (2 diffs)
• browser/interfaces.py (modified) (2 diffs)
• browser/pdf.py (modified) (3 diffs)
• interfaces.py (modified) (1 diff)
• students/utils.py (modified) (2 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/applicants/pdf.py

@@ -97 +97 @@
         return data
 
-    def __call__(self, view=None):
+    def __call__(self, view=None, note=None):
         """Return a PDF representation of the context applicant.
 
@@ -133 +133 @@
         # append comments
         data = self._addComments(data)
-        return creator.create_pdf(data, None, doc_title)
+
+        return creator.create_pdf(data, None, doc_title, note=note)

main/waeup.kofa/trunk/src/waeup/kofa/browser/interfaces.py

@@ -178 +178 @@
         """A callback function to render background of PDFs.
         """
-    def create_pdf(data, headerline=None, title=None):
+    def create_pdf(data, headerline=None, title=None, note=None):
         """Create a PDF.
 
@@ -188 +188 @@
         the top bar.
 
+        `note` is optional HTML markup added at bottom of created
+        document.
+
         If no `headerline` is given, a default will be rendered (name
         of university).

main/waeup.kofa/trunk/src/waeup/kofa/browser/pdf.py

@@ -71 +71 @@
     )
 
+#: A reportlab paragraph style for notes output at end of documents.
+NOTE_STYLE = ParagraphStyle(
+    name='Note',
+    parent=NORMAL_STYLE,
+    fontName='Helvetica',
+    fontSize=12,
+    )
+
 def format_html(html):
     """Make HTML code usable for use in reportlab paragraphs.
@@ -349 +357 @@
 
     def create_pdf(self, data, headerline=None, title=None, author=None,
-                   footer=''):
+                   footer='', note=None):
         """Returns a binary data stream which is a PDF document.
         """
@@ -367 +375 @@
         doc.kofa_author = author
         doc.kofa_footer = footer
+        if note is not None:
+            html = format_html(note)
+            data.append(Paragraph(html, NOTE_STYLE))
         doc.build(data, onFirstPage=self.paint_background,
                   onLaterPages=self.paint_background,

main/waeup.kofa/trunk/src/waeup/kofa/interfaces.py

@@ -1020 +1020 @@
     """
 
-    def __call__(view=None):
+    def __call__(view=None, note=None):
         """Create a bytestream representing a PDF from context.
 
         If `view` is passed in additional infos might be rendered into
         the document.
+
+        `note` is optional HTML rendered at bottom of the created
+        PDF. Please consider the limited reportlab support for HTML,
+        but using font-tags and friends you certainly can get the
+        desired look.
         """
 

main/waeup.kofa/trunk/src/waeup/kofa/students/utils.py

@@ -311 +311 @@
         return available_beds[0]
 
-    def renderPDF(self, view, filename='slip.pdf',
-        student=None, studentview=None, tableheader=None, tabledata=None):
+    def renderPDF(self, view, filename='slip.pdf', student=None,
+                  studentview=None, tableheader=None, tabledata=None,
+                  note=None):
         """Render pdf slips for various pages.
         """
@@ -359 +360 @@
         try:
             pdf_stream = creator.create_pdf(
-                data, None, doc_title, author=author, footer=footer_text)
+                data, None, doc_title, author=author, footer=footer_text,
+                note=note)
         except IOError:
             view.flash('Error in image file.')