Package schrodinger :: Package application :: Package desmond :: Module report_helper :: Class NumberedCanvas
[hide private]
[frames] | no frames]

Class NumberedCanvas

reportlab.pdfgen.textobject._PDFColorSetter --+    
                                              |    
                 reportlab.pdfgen.canvas.Canvas --+
                                                  |
                                                 NumberedCanvas

Instance Methods [hide private]
 
__init__(self, *args, **kwargs)
Create a canvas of a given size.
 
showPage(self)
Close the current page and possibly start on a new page.
 
save(self)
add page info to each page (page x of y)
 
drawPageNumber(self, page_count)

Inherited from reportlab.pdfgen.canvas.Canvas: absolutePosition, addFont, addLiteral, addOutlineEntry, addPageLabel, addPostScriptCommand, arc, beginForm, beginPath, beginText, bezier, bookmarkHorizontal, bookmarkHorizontalAbsolute, bookmarkPage, circle, clipPath, delViewerPreference, doForm, drawAlignedString, drawCentredString, drawImage, drawInlineImage, drawPath, drawRightString, drawString, drawText, ellipse, endForm, freeTextAnnotation, getAvailableFonts, getCurrentPageContent, getPageNumber, getViewerPreference, getpdfdata, grid, hasForm, highlightAnnotation, init_graphics_state, inkAnnotation, inkAnnotation0, line, linearGradient, lines, linkAbsolute, linkRect, linkURL, listLoadedFonts0, pageHasData, pop_state_stack, push_state_stack, radialGradient, rect, resetTransforms, restoreState, rotate, roundRect, saveState, scale, setAuthor, setCreator, setDash, setDateFormatter, setEncrypt, setFont, setFontSize, setKeywords, setLineCap, setLineJoin, setLineWidth, setMiterLimit, setOutlineNames0, setPageCallBack, setPageCompression, setPageDuration, setPageRotation, setPageSize, setPageTransition, setSubject, setTitle, setViewerPreference, shade, showFullScreen0, showOutline, skew, stringWidth, textAnnotation, textAnnotation0, transform, translate, wedge

Inherited from reportlab.pdfgen.canvas.Canvas (private): _absRect, _addAnnotation, _addShading, _addStandardFonts, _annotatePage, _bookmarkReference, _escape, _getCmShift, _make_preamble, _pushAccumulators, _restartAccumulators, _setAnnotations, _setColorSpace, _setExtGState, _setFillAlpha, _setFillOverprint, _setOverprintMask, _setShadingUsed, _setStrokeAlpha, _setStrokeOverprint, _setXObjects, _startPage, _strokeAndFill

Inherited from reportlab.pdfgen.textobject._PDFColorSetter: setFillAlpha, setFillColor, setFillColorCMYK, setFillColorRGB, setFillGray, setFillOverprint, setOverprintMask, setStrokeAlpha, setStrokeColor, setStrokeColorCMYK, setStrokeColorRGB, setStrokeGray, setStrokeOverprint

Inherited from reportlab.pdfgen.textobject._PDFColorSetter (private): _checkSeparation

Class Variables [hide private]

Inherited from reportlab.pdfgen.canvas.Canvas: STATE_ATTRIBUTES, STATE_RANGE

Inherited from reportlab.pdfgen.textobject._PDFColorSetter (private): _enforceColorSpace

Method Details [hide private]

__init__(self, *args, **kwargs)
(Constructor)

 

Create a canvas of a given size. etc.

You may pass a file-like object to filename as an alternative to a string. For more information about the encrypt parameter refer to the setEncrypt method.

Most of the attributes are private - we will use set/get methods as the preferred interface. Default page size is A4. cropMarks may be True/False or an object with parameters borderWidth, markColor, markWidth and markLength

if enforceColorSpace is in ('cmyk', 'rgb', 'sep','sep_black','sep_cmyk') then one of the standard _PDFColorSetter callables will be used to enforce appropriate color settings. If it is a callable then that will be used.

Overrides: reportlab.pdfgen.canvas.Canvas.__init__
(inherited documentation)

showPage(self)

 

Close the current page and possibly start on a new page.

Overrides: reportlab.pdfgen.canvas.Canvas.showPage
(inherited documentation)

save(self)

 

add page info to each page (page x of y)

Overrides: reportlab.pdfgen.canvas.Canvas.save