reportlab/platypus/flowables.py
author rgbecker
Thu, 21 Aug 2008 16:50:11 +0000
changeset 2955 cc16265295fb
parent 2950 6c243412b06c
child 2956 5c17941635bd
permissions -rw-r--r--
reportlab: start of doc programming
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2332
2a7ab4405e18 Remove $Header:, fix CopyRight & history
rgbecker
parents: 2321
diff changeset
     1
#Copyright ReportLab Europe Ltd. 2000-2004
494
54257447cfe9 Changed to indirect copyright
rgbecker
parents: 445
diff changeset
     2
#see license.txt for license details
2332
2a7ab4405e18 Remove $Header:, fix CopyRight & history
rgbecker
parents: 2321
diff changeset
     3
#history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/platypus/flowables.py
2321
3454f5b41760 Unicode and UTF8 support changes
andy
parents: 2284
diff changeset
     4
__version__=''' $Id$ '''
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
     5
__doc__="""
268
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
     6
A flowable is a "floating element" in a document whose exact position is determined by the
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
     7
other elements that precede it, such as a paragraph, a diagram interspersed between paragraphs,
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
     8
a section header, etcetera.  Examples of non-flowables include page numbering annotations,
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
     9
headers, footers, fixed diagrams or logos, among others.
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    10
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    11
Flowables are defined here as objects which know how to determine their size and which
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    12
can draw themselves onto a page with respect to a relative "origin" position determined
426
36a228f3e085 Changing to packer led positioning
rgbecker
parents: 368
diff changeset
    13
at a higher level. The object's draw() method should assume that (0,0) corresponds to the
36a228f3e085 Changing to packer led positioning
rgbecker
parents: 368
diff changeset
    14
bottom left corner of the enclosing rectangle that will contain the object. The attributes
36a228f3e085 Changing to packer led positioning
rgbecker
parents: 368
diff changeset
    15
vAlign and hAlign may be used by 'packers' as hints as to how the object should be placed.
36a228f3e085 Changing to packer led positioning
rgbecker
parents: 368
diff changeset
    16
36a228f3e085 Changing to packer led positioning
rgbecker
parents: 368
diff changeset
    17
Some Flowables also know how to "split themselves".  For example a
268
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    18
long paragraph might split itself between one page and the next.
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    19
1490
d6d958390ff0 Added api instructions
rgbecker
parents: 1486
diff changeset
    20
Packers should set the canv attribute during wrap, split & draw operations to allow
d6d958390ff0 Added api instructions
rgbecker
parents: 1486
diff changeset
    21
the flowable to work out sizes etc in the proper context.
d6d958390ff0 Added api instructions
rgbecker
parents: 1486
diff changeset
    22
268
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    23
The "text" of a document usually consists mainly of a sequence of flowables which
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    24
flow into a document from top to bottom (with column and page breaks controlled by
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    25
higher level components).
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    26
"""
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    27
import os
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    28
import string
2834
8bafca0cc650 flowables.py: use semi-deep copy for PTO split
rgbecker
parents: 2788
diff changeset
    29
from copy import deepcopy, copy
557
0ed50942f243 Allow for non string file names in Image.__init__
rgbecker
parents: 541
diff changeset
    30
from types import ListType, TupleType, StringType
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    31
2276
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
    32
from reportlab.lib.colors import red, gray, lightgrey
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
    33
from reportlab.lib.utils import fp_str
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    34
from reportlab.pdfbase import pdfutils
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    35
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
    36
from reportlab.rl_config import _FUZZ, overlapAttachedSpace
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
    37
__all__=('TraceInfo','Flowable','XBox','Preformatted','Image','Spacer','PageBreak','SlowPageBreak',
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
    38
        'CondPageBreak','KeepTogether','Macro','CallerMacro','ParagraphAndImage',
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
    39
        'FailOnWrap','HRFlowable','PTOContainer','KeepInFrame','UseUpSpace')
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    40
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    41
class TraceInfo:
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    42
    "Holder for info about where an object originated"
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    43
    def __init__(self):
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    44
        self.srcFile = '(unknown)'
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    45
        self.startLineNo = -1
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    46
        self.startLinePos = -1
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    47
        self.endLineNo = -1
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    48
        self.endLinePos = -1
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2192
diff changeset
    49
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    50
#############################################################
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    51
#   Flowable Objects - a base class and a few examples.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    52
#   One is just a box to get some metrics.  We also have
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    53
#   a paragraph, an image and a special 'page break'
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    54
#   object which fills the space.
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    55
#############################################################
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    56
class Flowable:
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    57
    """Abstract base class for things to be drawn.  Key concepts:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    58
    1. It knows its size
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    59
    2. It draws in its own coordinate system (this requires the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    60
        base API to provide a translate() function.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    61
    """
1917
25b37daf5ab7 Prepare for a more general idea of cell size
rgbecker
parents: 1882
diff changeset
    62
    _fixedWidth = 0         #assume wrap results depend on arguments?
25b37daf5ab7 Prepare for a more general idea of cell size
rgbecker
parents: 1882
diff changeset
    63
    _fixedHeight = 0
25b37daf5ab7 Prepare for a more general idea of cell size
rgbecker
parents: 1882
diff changeset
    64
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    65
    def __init__(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    66
        self.width = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    67
        self.height = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    68
        self.wrapped = 0
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
    69
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    70
        #these are hints to packers/frames as to how the floable should be positioned
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    71
        self.hAlign = 'LEFT'    #CENTER/CENTRE or RIGHT
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    72
        self.vAlign = 'BOTTOM'  #MIDDLE or TOP
426
36a228f3e085 Changing to packer led positioning
rgbecker
parents: 368
diff changeset
    73
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    74
        #optional holder for trace info
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
    75
        self._traceInfo = None
2158
e9c34b93e317 Whoops, platform specific slashes.
andy_robinson
parents: 2113
diff changeset
    76
        self._showBoundary = None
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2192
diff changeset
    77
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
    78
        #many flowables handle text and must be processed in the
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
    79
        #absence of a canvas.  tagging them with their encoding
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
    80
        #helps us to get conversions right.  Use Python codec names.
2762
48eadc6faff2 platypus: added in NotAtTopPageBreak and support
rgbecker
parents: 2750
diff changeset
    81
        self.encoding = None
1494
b0707e45102e Added _drawOn method
rgbecker
parents: 1491
diff changeset
    82
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    83
    def _drawOn(self,canv):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    84
        '''ensure canv is set on and then draw'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    85
        self.canv = canv
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    86
        self.draw()#this is the bit you overload
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    87
        del self.canv
1494
b0707e45102e Added _drawOn method
rgbecker
parents: 1491
diff changeset
    88
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    89
    def drawOn(self, canvas, x, y, _sW=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    90
        "Tell it to draw itself on the canvas.  Do not override"
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    91
        if _sW and hasattr(self,'hAlign'):
2773
b7dff8053a35 flowablse.py: allow TA_LEFT/CENTER/RIGHT as hAligns
rgbecker
parents: 2769
diff changeset
    92
            from reportlab.lib.enums import TA_LEFT, TA_CENTER, TA_RIGHT, TA_JUSTIFY
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    93
            a = self.hAlign
2773
b7dff8053a35 flowablse.py: allow TA_LEFT/CENTER/RIGHT as hAligns
rgbecker
parents: 2769
diff changeset
    94
            if a in ('CENTER','CENTRE', TA_CENTER):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    95
                x = x + 0.5*_sW
2773
b7dff8053a35 flowablse.py: allow TA_LEFT/CENTER/RIGHT as hAligns
rgbecker
parents: 2769
diff changeset
    96
            elif a in ('RIGHT',TA_RIGHT):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    97
                x = x + _sW
2773
b7dff8053a35 flowablse.py: allow TA_LEFT/CENTER/RIGHT as hAligns
rgbecker
parents: 2769
diff changeset
    98
            elif a not in ('LEFT',TA_LEFT):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
    99
                raise ValueError, "Bad hAlign value "+str(a)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   100
        canvas.saveState()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   101
        canvas.translate(x, y)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   102
        self._drawOn(canvas)
2158
e9c34b93e317 Whoops, platform specific slashes.
andy_robinson
parents: 2113
diff changeset
   103
        if hasattr(self, '_showBoundary') and self._showBoundary:
e9c34b93e317 Whoops, platform specific slashes.
andy_robinson
parents: 2113
diff changeset
   104
            #diagnostic tool support
e9c34b93e317 Whoops, platform specific slashes.
andy_robinson
parents: 2113
diff changeset
   105
            canvas.setStrokeColor(gray)
e9c34b93e317 Whoops, platform specific slashes.
andy_robinson
parents: 2113
diff changeset
   106
            canvas.rect(0,0,self.width, self.height)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   107
        canvas.restoreState()
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   108
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   109
    def wrapOn(self, canv, aW, aH):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   110
        '''intended for use by packers allows setting the canvas on
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   111
        during the actual wrap'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   112
        self.canv = canv
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   113
        w, h = self.wrap(aW,aH)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   114
        del self.canv
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   115
        return w, h
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   116
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   117
    def wrap(self, availWidth, availHeight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   118
        """This will be called by the enclosing frame before objects
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   119
        are asked their size, drawn or whatever.  It returns the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   120
        size actually used."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   121
        return (self.width, self.height)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   122
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   123
    def minWidth(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   124
        """This should return the minimum required width"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   125
        return getattr(self,'_minWidth',self.width)
954
bf9f434cb08a added minWidth method to Flowable, Paragraph
rgbecker
parents: 760
diff changeset
   126
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   127
    def splitOn(self, canv, aW, aH):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   128
        '''intended for use by packers allows setting the canvas on
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   129
        during the actual split'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   130
        self.canv = canv
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   131
        S = self.split(aW,aH)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   132
        del self.canv
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   133
        return S
1491
8cb77f6ac40d Introduce wrapOn & splitOn
rgbecker
parents: 1490
diff changeset
   134
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   135
    def split(self, availWidth, availheight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   136
        """This will be called by more sophisticated frames when
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   137
        wrap fails. Stupid flowables should return []. Clever flowables
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   138
        should split themselves and return a list of flowables"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   139
        return []
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   140
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   141
    def getKeepWithNext(self):
1879
c1dc90e2f470 Fix trivial spelling burble
rgbecker
parents: 1768
diff changeset
   142
        """returns boolean determining whether the next flowable should stay with this one"""
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   143
        if hasattr(self,'keepWithNext'): return self.keepWithNext
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   144
        elif hasattr(self,'style') and hasattr(self.style,'keepWithNext'): return self.style.keepWithNext
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   145
        else: return 0
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   146
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   147
    def getSpaceAfter(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   148
        """returns how much space should follow this item if another item follows on the same page."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   149
        if hasattr(self,'spaceAfter'): return self.spaceAfter
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   150
        elif hasattr(self,'style') and hasattr(self.style,'spaceAfter'): return self.style.spaceAfter
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   151
        else: return 0
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   152
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   153
    def getSpaceBefore(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   154
        """returns how much space should precede this item if another item precedess on the same page."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   155
        if hasattr(self,'spaceBefore'): return self.spaceBefore
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   156
        elif hasattr(self,'style') and hasattr(self.style,'spaceBefore'): return self.style.spaceBefore
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   157
        else: return 0
1426
377351bbe539 Add getKeepWithNext to Flowable
rgbecker
parents: 1360
diff changeset
   158
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   159
    def isIndexing(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   160
        """Hook for IndexingFlowables - things which have cross references"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   161
        return 0
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 496
diff changeset
   162
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   163
    def identity(self, maxLen=None):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   164
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   165
        This method should attempt to return a string that can be used to identify
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   166
        a particular flowable uniquely. The result can then be used for debugging
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   167
        and or error printouts
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   168
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   169
        if hasattr(self, 'getPlainText'):
2172
2740f571bd24 Fixes to cope with rml2pdf weirds
rgbecker
parents: 2158
diff changeset
   170
            r = self.getPlainText(identify=1)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   171
        elif hasattr(self, 'text'):
2461
9c24d39d05e8 enhanced decimal alignment
andy
parents: 2451
diff changeset
   172
            r = str(self.text)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   173
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   174
            r = '...'
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   175
        if r and maxLen:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   176
            r = r[:maxLen]
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   177
        return "<%s at %s%s>%s" % (self.__class__.__name__, hex(id(self)), self._frameName(), r)
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   178
2950
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   179
    def _doctemplateAttr(self,a):
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   180
        return getattr(getattr(getattr(self,'canv',None),'_doctemplate',None),a,None)
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   181
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   182
    def _frameName(self):
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   183
        f = getattr(self,'_frame',None)
2950
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   184
        if not f: f = self._doctemplateAttr('frame')
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   185
        if f and f.id: return ' frame=%s' % f.id
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   186
        return ''
1103
857af510186d Added identity method to Flowables
rgbecker
parents: 1036
diff changeset
   187
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   188
class XBox(Flowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   189
    """Example flowable - a box with an x through it and a caption.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   190
    This has a known size, so does not need to respond to wrap()."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   191
    def __init__(self, width, height, text = 'A Box'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   192
        Flowable.__init__(self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   193
        self.width = width
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   194
        self.height = height
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   195
        self.text = text
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   196
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   197
    def __repr__(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   198
        return "XBox(w=%s, h=%s, t=%s)" % (self.width, self.height, self.text)
541
33de80b3655c added __repr__s and enhanced exception messages for debugging
aaron_watters
parents: 512
diff changeset
   199
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   200
    def draw(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   201
        self.canv.rect(0, 0, self.width, self.height)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   202
        self.canv.line(0, 0, self.width, self.height)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   203
        self.canv.line(0, self.height, self.width, 0)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   204
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   205
        #centre the text
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   206
        self.canv.setFont('Times-Roman',12)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   207
        self.canv.drawCentredString(0.5*self.width, 0.5*self.height, self.text)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   208
445
8b64b9812ca6 Fixes to _dedenter
rgbecker
parents: 442
diff changeset
   209
def _trimEmptyLines(lines):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   210
    #don't want the first or last to be empty
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   211
    while len(lines) and string.strip(lines[0]) == '':
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   212
        lines = lines[1:]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   213
    while len(lines) and string.strip(lines[-1]) == '':
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   214
        lines = lines[:-1]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   215
    return lines
445
8b64b9812ca6 Fixes to _dedenter
rgbecker
parents: 442
diff changeset
   216
442
e3eac15cddbd XPreformatted first fixes; now runs
rgbecker
parents: 426
diff changeset
   217
def _dedenter(text,dedent=0):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   218
    '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   219
    tidy up text - carefully, it is probably code.  If people want to
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   220
    indent code within a source script, you can supply an arg to dedent
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   221
    and it will chop off that many character, otherwise it leaves
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   222
    left edge intact.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   223
    '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   224
    lines = string.split(text, '\n')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   225
    if dedent>0:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   226
        templines = _trimEmptyLines(lines)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   227
        lines = []
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   228
        for line in templines:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   229
            line = string.rstrip(line[dedent:])
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   230
            lines.append(line)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   231
    else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   232
        lines = _trimEmptyLines(lines)
445
8b64b9812ca6 Fixes to _dedenter
rgbecker
parents: 442
diff changeset
   233
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   234
    return lines
442
e3eac15cddbd XPreformatted first fixes; now runs
rgbecker
parents: 426
diff changeset
   235
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   236
class Preformatted(Flowable):
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   237
    """This is like the HTML <PRE> tag.
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   238
    It attempts to display text exactly as you typed it in a fixed width "typewriter" font.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   239
    The line breaks are exactly where you put
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   240
    them, and it will not be wrapped."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   241
    def __init__(self, text, style, bulletText = None, dedent=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   242
        """text is the text to display. If dedent is set then common leading space
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   243
        will be chopped off the front (for example if the entire text is indented
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   244
        6 spaces or more then each line will have 6 spaces removed from the front).
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   245
        """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   246
        self.style = style
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   247
        self.bulletText = bulletText
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   248
        self.lines = _dedenter(text,dedent)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   249
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   250
    def __repr__(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   251
        bT = self.bulletText
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   252
        H = "Preformatted("
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   253
        if bT is not None:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   254
            H = "Preformatted(bulletText=%s," % repr(bT)
2023
2d5def514733 Fix typo found by Christoph Devenoges
rgbecker
parents: 1994
diff changeset
   255
        return "%s'''\\ \n%s''')" % (H, string.join(self.lines,'\n'))
541
33de80b3655c added __repr__s and enhanced exception messages for debugging
aaron_watters
parents: 512
diff changeset
   256
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   257
    def wrap(self, availWidth, availHeight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   258
        self.width = availWidth
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   259
        self.height = self.style.leading*len(self.lines)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   260
        return (self.width, self.height)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   261
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   262
    def split(self, availWidth, availHeight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   263
        #returns two Preformatted objects
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   264
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   265
        #not sure why they can be called with a negative height
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   266
        if availHeight < self.style.leading:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   267
            return []
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   268
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   269
        linesThatFit = int(availHeight * 1.0 / self.style.leading)
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   270
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   271
        text1 = string.join(self.lines[0:linesThatFit], '\n')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   272
        text2 = string.join(self.lines[linesThatFit:], '\n')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   273
        style = self.style
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   274
        if style.firstLineIndent != 0:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   275
            style = deepcopy(style)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   276
            style.firstLineIndent = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   277
        return [Preformatted(text1, self.style), Preformatted(text2, style)]
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   278
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   279
    def draw(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   280
        #call another method for historical reasons.  Besides, I
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   281
        #suspect I will be playing with alternate drawing routines
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   282
        #so not doing it here makes it easier to switch.
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   283
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   284
        cur_x = self.style.leftIndent
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   285
        cur_y = self.height - self.style.fontSize
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   286
        self.canv.addLiteral('%PreformattedPara')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   287
        if self.style.textColor:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   288
            self.canv.setFillColor(self.style.textColor)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   289
        tx = self.canv.beginText(cur_x, cur_y)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   290
        #set up the font etc.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   291
        tx.setFont( self.style.fontName,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   292
                    self.style.fontSize,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   293
                    self.style.leading)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   294
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   295
        for text in self.lines:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   296
            tx.textLine(text)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   297
        self.canv.drawText(tx)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   298
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   299
class Image(Flowable):
2045
cc042609c62e hack to ImageReader
rgbecker
parents: 2023
diff changeset
   300
    """an image (digital picture).  Formats supported by PIL/Java 1.4 (the Python/Java Imaging Library
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   301
       are supported.  At the present time images as flowables are always centered horozontally
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   302
       in the frame. We allow for two kinds of lazyness to allow for many images in a document
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   303
       which could lead to file handle starvation.
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   304
       lazy=1 don't open image until required.
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   305
       lazy=2 open image when required then shut it.
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   306
    """
1917
25b37daf5ab7 Prepare for a more general idea of cell size
rgbecker
parents: 1882
diff changeset
   307
    _fixedWidth = 1
25b37daf5ab7 Prepare for a more general idea of cell size
rgbecker
parents: 1882
diff changeset
   308
    _fixedHeight = 1
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   309
    def __init__(self, filename, width=None, height=None, kind='direct', mask="auto", lazy=1):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   310
        """If size to draw at not specified, get it from the image."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   311
        self.hAlign = 'CENTER'
1880
5444027dd195 Allow for image transparancy mask
rgbecker
parents: 1879
diff changeset
   312
        self._mask = mask
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   313
        fp = hasattr(filename,'read')
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   314
        if fp:
2237
005d070deb87 Fix up more Image cases
rgbecker
parents: 2200
diff changeset
   315
            self._file = filename
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   316
            self.filename = `filename`
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   317
        else:
2237
005d070deb87 Fix up more Image cases
rgbecker
parents: 2200
diff changeset
   318
            self._file = self.filename = filename
2851
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   319
        if not fp and os.path.splitext(filename)[1] in ['.jpg', '.JPG', '.jpeg', '.JPEG']:
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   320
            # if it is a JPEG, will be inlined within the file -
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   321
            # but we still need to know its size now
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   322
            from reportlab.lib.utils import open_for_read
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   323
            f = open_for_read(filename, 'b')
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   324
            try:
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   325
                try:
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   326
                    info = pdfutils.readJPEGInfo(f)
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   327
                except:
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   328
                    #couldn't read as a JPEG, try like normal
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   329
                    self._setup(width,height,kind,lazy)
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   330
                    return
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   331
            finally:
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   332
                f.close()
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   333
            self.imageWidth = info[0]
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   334
            self.imageHeight = info[1]
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   335
            self._img = None
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   336
            self._setup(width,height,kind,0)
09d164c60442 flowables.py: restore attempted jpeg read as a memory saver, but alow to fail
rgbecker
parents: 2850
diff changeset
   337
        elif fp:
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   338
            self._setup(width,height,kind,0)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   339
        else:
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   340
            self._setup(width,height,kind,lazy)
1477
dc5c2ba1005a Allow for various Image kinds
rgbecker
parents: 1426
diff changeset
   341
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   342
    def _setup(self,width,height,kind,lazy):
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   343
        self._lazy = lazy
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   344
        self._width = width
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   345
        self._height = height
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   346
        self._kind = kind
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   347
        if lazy<=0: self._setup_inner()
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   348
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   349
    def _setup_inner(self):
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   350
        width = self._width
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   351
        height = self._height
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   352
        kind = self._kind
2404
8bc8743cc5ec flowables.py: fix no PIL jpg problem reported by Martin.Zohlhuber@tttech.com
rgbecker
parents: 2403
diff changeset
   353
        img = self._img
8bc8743cc5ec flowables.py: fix no PIL jpg problem reported by Martin.Zohlhuber@tttech.com
rgbecker
parents: 2403
diff changeset
   354
        if img: self.imageWidth, self.imageHeight = img.getSize()
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   355
        if self._lazy>=2: del self._img
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   356
        if kind in ['direct','absolute']:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   357
            self.drawWidth = width or self.imageWidth
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   358
            self.drawHeight = height or self.imageHeight
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   359
        elif kind in ['percentage','%']:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   360
            self.drawWidth = self.imageWidth*width*0.01
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   361
            self.drawHeight = self.imageHeight*height*0.01
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   362
        elif kind in ['bound','proportional']:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   363
            factor = min(float(width)/self.imageWidth,float(height)/self.imageHeight)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   364
            self.drawWidth = self.imageWidth*factor
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   365
            self.drawHeight = self.imageHeight*factor
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   366
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   367
    def __getattr__(self,a):
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   368
        if a=='_img':
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   369
            from reportlab.lib.utils import ImageReader  #this may raise an error
2237
005d070deb87 Fix up more Image cases
rgbecker
parents: 2200
diff changeset
   370
            self._img = ImageReader(self._file)
005d070deb87 Fix up more Image cases
rgbecker
parents: 2200
diff changeset
   371
            del self._file
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   372
            return self._img
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   373
        elif a in ('drawWidth','drawHeight','imageWidth','imageHeight'):
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   374
            self._setup_inner()
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   375
            return self.__dict__[a]
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   376
        raise AttributeError(a)
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   377
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   378
    def wrap(self, availWidth, availHeight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   379
        #the caller may decide it does not fit.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   380
        return (self.drawWidth, self.drawHeight)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   381
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   382
    def draw(self):
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   383
        lazy = self._lazy
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   384
        if lazy>=2: self._lazy = 1
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   385
        self.canv.drawImage(    self._img or self.filename,
2903
7bf831d085a3 canvas.py: attempt to fix possible redefines of the soft mask thingy
rgbecker
parents: 2873
diff changeset
   386
                                getattr(self,'_offs_x',0),
7bf831d085a3 canvas.py: attempt to fix possible redefines of the soft mask thingy
rgbecker
parents: 2873
diff changeset
   387
                                getattr(self,'_offs_y',0),
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   388
                                self.drawWidth,
1880
5444027dd195 Allow for image transparancy mask
rgbecker
parents: 1879
diff changeset
   389
                                self.drawHeight,
1882
ce334775a5b2 Fixed mask bug (lexical/dynamic scoping?)
andy_robinson
parents: 1880
diff changeset
   390
                                mask=self._mask,
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   391
                                )
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   392
        if lazy>=2:
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   393
            self._img = None
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   394
            self._lazy = lazy
1103
857af510186d Added identity method to Flowables
rgbecker
parents: 1036
diff changeset
   395
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2172
diff changeset
   396
    def identity(self,maxLen=None):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   397
        r = Flowable.identity(self,maxLen)
2080
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   398
        if r[-4:]=='>...' and type(self.filename) is StringType:
39156f56ab6f Added in lazy Image stuff
rgbecker
parents: 2045
diff changeset
   399
            r = "%s filename=%s>" % (r[:-4],self.filename)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   400
        return r
1103
857af510186d Added identity method to Flowables
rgbecker
parents: 1036
diff changeset
   401
2955
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
   402
class NullDraw(Flowable):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
   403
    def draw(self):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
   404
        pass
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
   405
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
   406
class Spacer(NullDraw):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   407
    """A spacer just takes up space and doesn't draw anything - it guarantees
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   408
       a gap between objects."""
1917
25b37daf5ab7 Prepare for a more general idea of cell size
rgbecker
parents: 1882
diff changeset
   409
    _fixedWidth = 1
25b37daf5ab7 Prepare for a more general idea of cell size
rgbecker
parents: 1882
diff changeset
   410
    _fixedHeight = 1
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   411
    def __init__(self, width, height):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   412
        self.width = width
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   413
        self.height = height
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   414
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   415
    def __repr__(self):
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   416
        return "%s(%s, %s)" % (self.__class__.__name__,self.width, self.height)
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   417
2955
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
   418
class UseUpSpace(NullDraw):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   419
    def __init__(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   420
        pass
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   421
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   422
    def __repr__(self):
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   423
        return "%s()" % self.__class__.__name__
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   424
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   425
    def wrap(self, availWidth, availHeight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   426
        self.width = availWidth
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   427
        self.height = availHeight
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   428
        return (availWidth,availHeight-1e-8)  #step back a point
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   429
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   430
class PageBreak(UseUpSpace):
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   431
    """Move on to the next page in the document.
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   432
       This works by consuming all remaining space in the frame!"""
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   433
2408
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2404
diff changeset
   434
class SlowPageBreak(PageBreak):
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2404
diff changeset
   435
    pass
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2404
diff changeset
   436
307
c439e402b404 Added CondPageBreak
rgbecker
parents: 268
diff changeset
   437
class CondPageBreak(Spacer):
2950
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   438
    """use up a frame if not enough vertical space effectively CondFrameBreak"""
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   439
    def __init__(self, height):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   440
        self.height = height
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   441
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   442
    def __repr__(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   443
        return "CondPageBreak(%s)" %(self.height,)
307
c439e402b404 Added CondPageBreak
rgbecker
parents: 268
diff changeset
   444
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   445
    def wrap(self, availWidth, availHeight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   446
        if availHeight<self.height:
2950
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   447
            f = self._doctemplateAttr('frame')
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   448
            if not f: return availWidth, availHeight
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   449
            from doctemplate import FrameBreak
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   450
            f.add_generated_content(FrameBreak)
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   451
        return 0, 0
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   452
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   453
    def identity(self,maxLen=None):
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
   454
        return repr(self).replace(')',',frame=%s)'%self._frameName())
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   455
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   456
def _listWrapOn(F,availWidth,canv,mergeSpace=1,obj=None,dims=None):
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   457
    '''return max width, required height for a list of flowables F'''
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   458
    W = 0
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   459
    H = 0
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   460
    pS = 0
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   461
    atTop = 1
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   462
    for f in F:
2660
c147aff8edae reportlab: minor fixes and add strokeDashArray
rgbecker
parents: 2575
diff changeset
   463
        if hasattr(f,'frameAction'): continue
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   464
        w,h = f.wrapOn(canv,availWidth,0xfffffff)
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   465
        if dims is not None: dims.append((w,h))
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   466
        if w<=_FUZZ or h<=_FUZZ: continue
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   467
        W = max(W,w)
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   468
        H += h
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   469
        if not atTop:
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   470
            h = f.getSpaceBefore()
2762
48eadc6faff2 platypus: added in NotAtTopPageBreak and support
rgbecker
parents: 2750
diff changeset
   471
            if mergeSpace: h = max(h-pS,0)
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   472
            H += h
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   473
        else:
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   474
            if obj is not None: obj._spaceBefore = f.getSpaceBefore()
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   475
            atTop = 0
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   476
        pS = f.getSpaceAfter()
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   477
        H += pS
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   478
    if obj is not None: obj._spaceAfter = pS
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   479
    return W, H-pS
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   480
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2408
diff changeset
   481
def _flowableSublist(V):
2392
6c59b0eb312d table color cycle changes
andy
parents: 2388
diff changeset
   482
    "if it isn't a list or tuple, wrap it in a list"
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   483
    if type(V) not in (ListType, TupleType): V = V is not None and [V] or []
2450
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   484
    from doctemplate import LCActionFlowable
2451
19bf750c3c26 flowables.py: fix 2.1 breakage
rgbecker
parents: 2450
diff changeset
   485
    assert not [x for x in V if isinstance(x,LCActionFlowable)],'LCActionFlowables not allowed in sublists'
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   486
    return V
558
f9013e25af9d Added a random text module
andy_robinson
parents: 557
diff changeset
   487
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   488
class _ContainerSpace:  #Abstract some common container like behaviour
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   489
    def getSpaceBefore(self):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   490
        for c in self._content:
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   491
            if not hasattr(c,'frameAction'):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   492
                return c.getSpaceBefore()
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   493
        return 0
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   494
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   495
    def getSpaceAfter(self,content=None):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   496
        #this needs 2.4
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   497
        #for c in reversed(content or self._content):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   498
        reverseContent = (content or self._content)[:]
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   499
        reverseContent.reverse()
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   500
        for c in reverseContent:
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   501
            if not hasattr(c,'frameAction'):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   502
                return c.getSpaceAfter()
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   503
        return 0
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   504
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   505
class KeepTogether(_ContainerSpace,Flowable):
1994
fdb2334c338a Attempt to allow for overlong KeepTogethers
rgbecker
parents: 1917
diff changeset
   506
    def __init__(self,flowables,maxHeight=None):
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   507
        self._content = _flowableSublist(flowables)
1994
fdb2334c338a Attempt to allow for overlong KeepTogethers
rgbecker
parents: 1917
diff changeset
   508
        self._maxHeight = maxHeight
367
ca1adb0294f0 Added KeepTogether
rgbecker
parents: 307
diff changeset
   509
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   510
    def __repr__(self):
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   511
        f = self._content
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   512
        L = map(repr,f)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   513
        import string
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   514
        L = "\n"+string.join(L, "\n")
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   515
        L = string.replace(L, "\n", "\n  ")
1994
fdb2334c338a Attempt to allow for overlong KeepTogethers
rgbecker
parents: 1917
diff changeset
   516
        return "KeepTogether(%s,maxHeight=%s) # end KeepTogether" % (L,self._maxHeight)
541
33de80b3655c added __repr__s and enhanced exception messages for debugging
aaron_watters
parents: 512
diff changeset
   517
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   518
    def wrap(self, aW, aH):
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   519
        dims = []
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   520
        W,H = _listWrapOn(self._content,aW,self.canv,dims=dims)
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   521
        self._H = H
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   522
        self._H0 = dims and dims[0][1] or 0
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   523
        self._wrapInfo = aW,aH
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   524
        return W, 0xffffff  # force a split
367
ca1adb0294f0 Added KeepTogether
rgbecker
parents: 307
diff changeset
   525
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   526
    def split(self, aW, aH):
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   527
        if getattr(self,'_wrapInfo',None)!=(aW,aH): self.wrap(aW,aH)
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   528
        S = self._content[:]
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   529
        C0 = self._H>aH and (not self._maxHeight or aH>self._maxHeight)
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   530
        C1 = self._H0>aH
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   531
        if C0 or C1:
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   532
            if C0:
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   533
                from doctemplate import FrameBreak
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   534
                A = FrameBreak
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   535
            else:
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   536
                from doctemplate import NullActionFlowable
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   537
                A = NullActionFlowable
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   538
            S.insert(0,A())
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   539
        return S
367
ca1adb0294f0 Added KeepTogether
rgbecker
parents: 307
diff changeset
   540
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   541
    def identity(self, maxLen=None):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   542
        msg = "<KeepTogether at %s%s> containing :%s" % (hex(id(self)),self._frameName(),"\n".join([f.identity() for f in self._content]))
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   543
        if maxLen:
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   544
            return msg[0:maxLen]
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   545
        else:
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   546
            return msg
2461
9c24d39d05e8 enhanced decimal alignment
andy
parents: 2451
diff changeset
   547
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents:
diff changeset
   548
class Macro(Flowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   549
    """This is not actually drawn (i.e. it has zero height)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   550
    but is executed when it would fit in the frame.  Allows direct
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   551
    access to the canvas through the object 'canvas'"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   552
    def __init__(self, command):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   553
        self.command = command
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   554
    def __repr__(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   555
        return "Macro(%s)" % repr(self.command)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   556
    def wrap(self, availWidth, availHeight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   557
        return (0,0)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1554
diff changeset
   558
    def draw(self):
1768
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   559
        exec self.command in globals(), {'canvas':self.canv}
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   560
2403
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   561
class CallerMacro(Flowable):
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   562
    '''
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   563
    like Macro, but with callable command(s)
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   564
    drawCallable(self)
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   565
    wrapCallable(self,aW,aH)
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   566
    '''
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   567
    def __init__(self, drawCallable=None, wrapCallable=None):
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   568
        _ = lambda *args: None
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   569
        self._drawCallable = drawCallable or _
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   570
        self._wrapCallable = wrapCallable or _
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   571
    def __repr__(self):
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   572
        return "CallerMacro(%s)" % repr(self.command)
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   573
    def wrap(self, aW, aH):
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   574
        self._wrapCallable(self,aW,aH)
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   575
        return (0,0)
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   576
    def draw(self):
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   577
        self._drawCallable(self)
cbfa501fb840 canvasadapter.py fixes
rgbecker
parents: 2392
diff changeset
   578
1768
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   579
class ParagraphAndImage(Flowable):
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   580
    '''combine a Paragraph and an Image'''
2557
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   581
    def __init__(self,P,I,xpad=3,ypad=3,side='right'):
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   582
        self.P = P
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   583
        self.I = I
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   584
        self.xpad = xpad
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   585
        self.ypad = ypad
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   586
        self._side = side
1768
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   587
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   588
    def getSpaceBefore(self):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   589
        return max(self.P.getSpaceBefore(),self.I.getSpaceBefore())
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   590
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   591
    def getSpaceAfter(self):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   592
        return max(self.P.getSpaceAfter(),self.I.getSpaceAfter())
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   593
1768
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   594
    def wrap(self,availWidth,availHeight):
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   595
        wI, hI = self.I.wrap(availWidth,availHeight)
2557
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   596
        self.wI = wI
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   597
        self.hI = hI
1768
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   598
        # work out widths array for breaking
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   599
        self.width = availWidth
2557
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   600
        P = self.P
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   601
        style = P.style
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   602
        xpad = self.xpad
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   603
        ypad = self.ypad
1768
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   604
        leading = style.leading
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   605
        leftIndent = style.leftIndent
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   606
        later_widths = availWidth - leftIndent - style.rightIndent
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   607
        intermediate_widths = later_widths - xpad - wI
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   608
        first_line_width = intermediate_widths - style.firstLineIndent
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   609
        P.width = 0
2557
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   610
        nIW = int((hI+ypad)/leading)
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   611
        P.blPara = P.breakLines([first_line_width] + nIW*[intermediate_widths]+[later_widths])
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   612
        if self._side=='left':
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   613
            self._offsets = [wI+xpad]*(1+nIW)+[0]
1768
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   614
        P.height = len(P.blPara.lines)*leading
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   615
        self.height = max(hI,P.height)
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   616
        return (self.width, self.height)
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   617
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   618
    def split(self,availWidth, availHeight):
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   619
        P, wI, hI, ypad = self.P, self.wI, self.hI, self.ypad
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   620
        if hI+ypad>availHeight or len(P.frags)<=0: return []
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   621
        S = P.split(availWidth,availHeight)
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   622
        if not S: return S
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   623
        P = self.P = S[0]
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   624
        del S[0]
2557
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   625
        style = P.style
1768
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   626
        P.height = len(self.P.blPara.lines)*style.leading
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   627
        self.height = max(hI,P.height)
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   628
        return [self]+S
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   629
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   630
    def draw(self):
ea95b92748cc Added ParagraphAndImage
rgbecker
parents: 1683
diff changeset
   631
        canv = self.canv
2557
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   632
        if self._side=='left':
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   633
            self.I.drawOn(canv,0,self.height-self.hI)
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   634
            self.P._offsets = self._offsets
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   635
            try:
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   636
                self.P.drawOn(canv,0,0)
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   637
            finally:
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   638
                del self.P._offsets
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   639
        else:
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   640
            self.I.drawOn(canv,self.width-self.wI-self.xpad,self.height-self.hI)
d84c18fb377f added _offsets handling to paragraph for flow around on left side
rgbecker
parents: 2542
diff changeset
   641
            self.P.drawOn(canv,0,0)
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
   642
2955
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
   643
class FailOnWrap(NullDraw):
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
   644
    def wrap(self, availWidth, availHeight):
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
   645
        raise ValueError("FailOnWrap flowable wrapped and failing as ordered!")
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2192
diff changeset
   646
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
   647
class FailOnDraw(Flowable):
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
   648
    def wrap(self, availWidth, availHeight):
2955
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
   649
        return 0,0
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2192
diff changeset
   650
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
   651
    def draw(self):
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2080
diff changeset
   652
        raise ValueError("FailOnDraw flowable drawn, and failing as ordered!")
2276
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   653
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   654
class HRFlowable(Flowable):
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   655
    '''Like the hr tag'''
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   656
    def __init__(self,
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   657
            width="80%",
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   658
            thickness=1,
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   659
            lineCap='round',
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   660
            color=lightgrey,
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   661
            spaceBefore=1, spaceAfter=1,
2523
0473810aff11 platypus: fix up None defaults for table line commands, add HRFlowable dash arg
rgbecker
parents: 2461
diff changeset
   662
            hAlign='CENTER', vAlign='BOTTOM',
0473810aff11 platypus: fix up None defaults for table line commands, add HRFlowable dash arg
rgbecker
parents: 2461
diff changeset
   663
            dash=None):
2276
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   664
        Flowable.__init__(self)
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   665
        self.width = width
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   666
        self.lineWidth = thickness
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   667
        self.lineCap=lineCap
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   668
        self.spaceBefore = spaceBefore
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   669
        self.spaceAfter = spaceAfter
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   670
        self.color = color
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   671
        self.hAlign = hAlign
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   672
        self.vAlign = vAlign
2523
0473810aff11 platypus: fix up None defaults for table line commands, add HRFlowable dash arg
rgbecker
parents: 2461
diff changeset
   673
        self.dash = dash
2276
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   674
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   675
    def __repr__(self):
2284
b181b45c6792 Minor changes
rgbecker
parents: 2276
diff changeset
   676
        return "HRFlowable(width=%s, height=%s)" % (self.width, self.height)
2276
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   677
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   678
    def wrap(self, availWidth, availHeight):
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   679
        w = self.width
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   680
        if type(w) is type(''):
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   681
            w = w.strip()
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   682
            if w.endswith('%'): w = availWidth*float(w[:-1])*0.01
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   683
            else: w = float(w)
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   684
        w = min(w,availWidth)
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   685
        self._width = w
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   686
        return w, self.lineWidth
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   687
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   688
    def draw(self):
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   689
        canv = self.canv
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   690
        canv.saveState()
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   691
        canv.setLineWidth(self.lineWidth)
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   692
        canv.setLineCap({'butt':0,'round':1, 'square': 2}[self.lineCap.lower()])
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   693
        canv.setStrokeColor(self.color)
2523
0473810aff11 platypus: fix up None defaults for table line commands, add HRFlowable dash arg
rgbecker
parents: 2461
diff changeset
   694
        if self.dash: canv.setDash(self.dash)
2276
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   695
        canv.line(0, 0, self._width, self.height)
10fc2ce1114f Added HRFlowable
rgbecker
parents: 2241
diff changeset
   696
        canv.restoreState()
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   697
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   698
class _PTOInfo:
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   699
    def __init__(self,trailer,header):
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2408
diff changeset
   700
        self.trailer = _flowableSublist(trailer)
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2408
diff changeset
   701
        self.header = _flowableSublist(header)
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   702
2873
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   703
def cdeepcopy(obj):
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   704
    if hasattr(obj,'deepcopy'):
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   705
        return obj.deepcopy()
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   706
    else:
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   707
        return deepcopy(obj)
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   708
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   709
class _Container(_ContainerSpace):  #Abstract some common container like behaviour
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   710
    def drawOn(self, canv, x, y, _sW=0, scale=1.0, content=None, aW=None):
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   711
        '''we simulate being added to a frame'''
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   712
        pS = 0
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   713
        if aW is None: aW = self.width
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   714
        aW = scale*(aW+_sW)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   715
        if content is None:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   716
            content = self._content
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   717
        y += self.height*scale
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   718
        for c in content:
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   719
            w, h = c.wrapOn(canv,aW,0xfffffff)
2750
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
   720
            if (w<_FUZZ or h<_FUZZ) and not getattr(c,'_ZEROSIZE',None): continue
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   721
            if c is not content[0]: h += max(c.getSpaceBefore()-pS,0)
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   722
            y -= h
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   723
            c.drawOn(canv,x,y,_sW=aW-w)
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   724
            if c is not content[-1]:
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   725
                pS = c.getSpaceAfter()
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   726
                y -= pS
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   727
2873
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   728
    def copyContent(self,content=None):
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   729
        C = [].append
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   730
        for c in (content or self._content):
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   731
            C(cdeepcopy(c))
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   732
        self._content = C.__self__
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   733
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   734
class PTOContainer(_Container,Flowable):
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   735
    '''PTOContainer(contentList,trailerList,headerList)
2762
48eadc6faff2 platypus: added in NotAtTopPageBreak and support
rgbecker
parents: 2750
diff changeset
   736
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   737
    A container for flowables decorated with trailer & header lists.
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   738
    If the split operation would be called then the trailer and header
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   739
    lists are injected before and after the split. This allows specialist
2762
48eadc6faff2 platypus: added in NotAtTopPageBreak and support
rgbecker
parents: 2750
diff changeset
   740
    "please turn over" and "continued from previous" like behaviours.'''
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   741
    def __init__(self,content,trailer=None,header=None):
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   742
        I = _PTOInfo(trailer,header)
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   743
        self._content = C = []
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2408
diff changeset
   744
        for _ in _flowableSublist(content):
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   745
            if isinstance(_,PTOContainer):
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   746
                C.extend(_._content)
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   747
            else:
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   748
                C.append(_)
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   749
                if not hasattr(_,'_ptoinfo'): _._ptoinfo = I
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   750
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   751
    def wrap(self,availWidth,availHeight):
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   752
        self.width, self.height = _listWrapOn(self._content,availWidth,self.canv)
2384
6d44252e1042 platypus: added ptocontainer, moved tables test
rgbecker
parents: 2376
diff changeset
   753
        return self.width,self.height
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   754
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   755
    def split(self, availWidth, availHeight):
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   756
        if availHeight<0: return []
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   757
        canv = self.canv
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   758
        C = self._content
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   759
        x = i = H = pS = hx = 0
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   760
        n = len(C)
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   761
        I2W = {}
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   762
        for x in xrange(n):
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   763
            c = C[x]
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   764
            I = c._ptoinfo
2388
5fa400f5d46b flowables.py: remove 2.1 incompatibility
rgbecker
parents: 2387
diff changeset
   765
            if I not in I2W.keys():
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   766
                T = I.trailer
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   767
                Hdr = I.header
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   768
                tW, tH = _listWrapOn(T, availWidth, self.canv)
2694
dd0ea6474ea0 fixes to crashing PTO trailer when empty, and numbering
andy
parents: 2662
diff changeset
   769
                if len(T):  #trailer may have no content
dd0ea6474ea0 fixes to crashing PTO trailer when empty, and numbering
andy
parents: 2662
diff changeset
   770
                    tSB = T[0].getSpaceBefore()
dd0ea6474ea0 fixes to crashing PTO trailer when empty, and numbering
andy
parents: 2662
diff changeset
   771
                else:
dd0ea6474ea0 fixes to crashing PTO trailer when empty, and numbering
andy
parents: 2662
diff changeset
   772
                    tSB = 0
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   773
                I2W[I] = T,tW,tH,tSB
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   774
            else:
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   775
                T,tW,tH,tSB = I2W[I]
2384
6d44252e1042 platypus: added ptocontainer, moved tables test
rgbecker
parents: 2376
diff changeset
   776
            _, h = c.wrapOn(canv,availWidth,0xfffffff)
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   777
            if x:
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   778
                hx = max(c.getSpaceBefore()-pS,0)
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   779
                h += hx
2384
6d44252e1042 platypus: added ptocontainer, moved tables test
rgbecker
parents: 2376
diff changeset
   780
            pS = c.getSpaceAfter()
6d44252e1042 platypus: added ptocontainer, moved tables test
rgbecker
parents: 2376
diff changeset
   781
            H += h+pS
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   782
            tHS = tH+max(tSB,pS)
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   783
            if H+tHS>=availHeight-_FUZZ: break
2384
6d44252e1042 platypus: added ptocontainer, moved tables test
rgbecker
parents: 2376
diff changeset
   784
            i += 1
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   785
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   786
        #first retract last thing we tried
2384
6d44252e1042 platypus: added ptocontainer, moved tables test
rgbecker
parents: 2376
diff changeset
   787
        H -= (h+pS)
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   788
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   789
        #attempt a sub split on the last one we have
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   790
        aH = (availHeight-H-tHS-hx)*0.99999
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   791
        if aH>=0.05*availHeight:
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   792
            SS = c.splitOn(canv,availWidth,aH)
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   793
        else:
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   794
            SS = []
2788
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   795
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   796
        if not SS:
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   797
            j = i
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   798
            while i>1 and C[i-1].getKeepWithNext():
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   799
                i -= 1
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   800
                C[i].keepWithNext = 0
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   801
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   802
            if i==1 and C[0].getKeepWithNext():
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   803
                #robin's black sheep
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   804
                i = j
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   805
                C[0].keepWithNext = 0
e245da8fbe2b flowables: allow for keepWithNext in PTO
rgbecker
parents: 2773
diff changeset
   806
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   807
        F = [UseUpSpace()]
2376
7e70411a7236 flowables.py: minor change to PTOContainer
rgbecker
parents: 2375
diff changeset
   808
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   809
        if len(SS)>1:
2387
75caa41a818f platypus/test: working pto (& inner pto)
rgbecker
parents: 2384
diff changeset
   810
            R1 = C[:i] + SS[:1] + T + F
2376
7e70411a7236 flowables.py: minor change to PTOContainer
rgbecker
parents: 2375
diff changeset
   811
            R2 = Hdr + SS[1:]+C[i+1:]
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   812
        elif not i:
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   813
            return []
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   814
        else:
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   815
            R1 = C[:i]+T+F
2376
7e70411a7236 flowables.py: minor change to PTOContainer
rgbecker
parents: 2375
diff changeset
   816
            R2 = Hdr + C[i:]
2834
8bafca0cc650 flowables.py: use semi-deep copy for PTO split
rgbecker
parents: 2788
diff changeset
   817
        T =  R1 + [PTOContainer(R2,[copy(x) for x in I.trailer],[copy(x) for x in I.header])]
2535
714a951e4f64 flowables.py: fixes to PTOContainer
rgbecker
parents: 2534
diff changeset
   818
        return T
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   819
2528
39a609be559a renamed FrameFlowable to KeepInFrame
andy
parents: 2527
diff changeset
   820
#utility functions used by KeepInFrame
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   821
def _hmodel(s0,s1,h0,h1):
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   822
    # calculate the parameters in the model
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   823
    # h = a/s**2 + b/s
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   824
    a11 = 1./s0**2
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   825
    a12 = 1./s0
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   826
    a21 = 1./s1**2
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   827
    a22 = 1./s1
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   828
    det = a11*a22-a12*a21
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   829
    b11 = a22/det
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   830
    b12 = -a12/det
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   831
    b21 = -a21/det
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   832
    b22 = a11/det
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   833
    a = b11*h0+b12*h1
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   834
    b = b21*h0+b22*h1
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   835
    return a,b
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   836
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   837
def _qsolve(h,(a,b)):
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   838
    '''solve the model v = a/s**2 + b/s for an s which gives us v==h'''
2569
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   839
    if abs(a)<=_FUZZ:
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   840
        return b/h
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   841
    t = 0.5*b/a
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   842
    from math import sqrt
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   843
    f = -h/a
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   844
    r = t*t-f
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   845
    if r<0: return None
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   846
    r = sqrt(r)
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   847
    if t>=0:
2762
48eadc6faff2 platypus: added in NotAtTopPageBreak and support
rgbecker
parents: 2750
diff changeset
   848
        s1 = -t - r
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   849
    else:
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   850
        s1 = -t + r
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   851
    s2 = f/s1
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   852
    return max(1./s1, 1./s2)
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   853
2528
39a609be559a renamed FrameFlowable to KeepInFrame
andy
parents: 2527
diff changeset
   854
class KeepInFrame(_Container,Flowable):
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   855
    def __init__(self, maxWidth, maxHeight, content=[], mergeSpace=1, mode='shrink', name=''):
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   856
        '''mode describes the action to take when overflowing
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   857
            error       raise an error in the normal way
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   858
            continue    ignore ie just draw it and report maxWidth, maxHeight
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   859
            shrink      shrinkToFit
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   860
            truncate    fit as much as possible
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   861
        '''
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   862
        self.name = name
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   863
        self.maxWidth = maxWidth
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   864
        self.maxHeight = maxHeight
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   865
        self.mode = mode
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   866
        assert mode in ('error','overflow','shrink','truncate'), '%s invalid mode value %s' % (self.identity(),mode)
2528
39a609be559a renamed FrameFlowable to KeepInFrame
andy
parents: 2527
diff changeset
   867
        assert maxHeight>=0,  '%s invalid maxHeight value %s' % (self.identity(),maxHeight)
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   868
        if mergeSpace is None: mergeSpace = overlapAttachedSpace
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   869
        self.mergespace = mergeSpace
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   870
        self._content = content
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   871
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   872
    def _getAvailableWidth(self):
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   873
        return self.maxWidth - self._leftExtraIndent - self._rightExtraIndent
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   874
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   875
    def identity(self, maxLen=None):
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   876
        return "<%s at %s%s%s> size=%sx%s" % (self.__class__.__name__, hex(id(self)), self._frameName(),
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   877
                getattr(self,'name','') and (' name="%s"'% getattr(self,'name','')) or '',
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   878
                getattr(self,'maxWidth','') and (' maxWidth=%s'%fp_str(getattr(self,'maxWidth',0))) or '',
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2569
diff changeset
   879
                getattr(self,'maxHeight','')and (' maxHeight=%s' % fp_str(getattr(self,'maxHeight')))or '')
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   880
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   881
    def wrap(self,availWidth,availHeight):
2534
809c000dbbb3 platypus: fixup KeepInFrame error handling
rgbecker
parents: 2533
diff changeset
   882
        from doctemplate import LayoutError
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   883
        mode = self.mode
2695
feb999d5dbd1 flowables.py: fix KeepInFrame behaviour to be more rational
rgbecker
parents: 2694
diff changeset
   884
        maxWidth = float(min(self.maxWidth or availWidth,availWidth))
feb999d5dbd1 flowables.py: fix KeepInFrame behaviour to be more rational
rgbecker
parents: 2694
diff changeset
   885
        maxHeight = float(min(self.maxHeight or availHeight,availHeight))
feb999d5dbd1 flowables.py: fix KeepInFrame behaviour to be more rational
rgbecker
parents: 2694
diff changeset
   886
        W, H = _listWrapOn(self._content,maxWidth,self.canv)
feb999d5dbd1 flowables.py: fix KeepInFrame behaviour to be more rational
rgbecker
parents: 2694
diff changeset
   887
        if (mode=='error' and (W>maxWidth+_FUZZ or H>maxHeight+_FUZZ)):
2534
809c000dbbb3 platypus: fixup KeepInFrame error handling
rgbecker
parents: 2533
diff changeset
   888
            ident = 'content %sx%s too large for %s' % (W,H,self.identity(30))
809c000dbbb3 platypus: fixup KeepInFrame error handling
rgbecker
parents: 2533
diff changeset
   889
            #leave to keep apart from the raise
809c000dbbb3 platypus: fixup KeepInFrame error handling
rgbecker
parents: 2533
diff changeset
   890
            raise LayoutError(ident)
2695
feb999d5dbd1 flowables.py: fix KeepInFrame behaviour to be more rational
rgbecker
parents: 2694
diff changeset
   891
        elif W<=maxWidth+_FUZZ and H<=maxHeight+_FUZZ:
2534
809c000dbbb3 platypus: fixup KeepInFrame error handling
rgbecker
parents: 2533
diff changeset
   892
            self.width = W-_FUZZ      #we take what we get
809c000dbbb3 platypus: fixup KeepInFrame error handling
rgbecker
parents: 2533
diff changeset
   893
            self.height = H-_FUZZ
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   894
        elif mode in ('overflow','truncate'):   #we lie
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   895
            self.width = min(maxWidth,W)-_FUZZ
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   896
            self.height = min(maxHeight,H)-_FUZZ
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   897
        else:
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   898
            def func(x):
2695
feb999d5dbd1 flowables.py: fix KeepInFrame behaviour to be more rational
rgbecker
parents: 2694
diff changeset
   899
                W, H = _listWrapOn(self._content,x*maxWidth,self.canv)
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   900
                W /= x
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   901
                H /= x
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   902
                return W, H
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   903
            W0 = W
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   904
            H0 = H
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   905
            s0 = 1
2527
edff938c5e89 flowablse.py: minor fix and hack to FrameFlowable
rgbecker
parents: 2526
diff changeset
   906
            if W>maxWidth+_FUZZ:
2569
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   907
                #squeeze out the excess width and or Height
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   908
                s1 = W/maxWidth
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   909
                W, H = func(s1)
2569
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   910
                if H<=maxHeight+_FUZZ:
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   911
                    self.width = W-_FUZZ
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   912
                    self.height = H-_FUZZ
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   913
                    self._scale = s1
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   914
                    return W,H
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   915
                s0 = s1
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   916
                H0 = H
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   917
                W0 = W
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   918
            s1 = H/maxHeight
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   919
            W, H = func(s1)
2569
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   920
            self.width = W-_FUZZ
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   921
            self.height = H-_FUZZ
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   922
            self._scale = s1
2569
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   923
            if H<min(0.95*maxHeight,maxHeight-10) or H>=maxHeight+_FUZZ:
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   924
                #the standard case W should be OK, H is short we want
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   925
                #to find the smallest s with H<=maxHeight
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   926
                H1 = H
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   927
                for f in 0, 0.01, 0.05, 0.10, 0.15:
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   928
                    #apply the quadratic model
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   929
                    s = _qsolve(maxHeight*(1-f),_hmodel(s0,s1,H0,H1))
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   930
                    W, H = func(s)
2569
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   931
                    if H<=maxHeight+_FUZZ and W<=maxWidth+_FUZZ:
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   932
                        self.width = W-_FUZZ
f7ac857ad20d flowables.py: attempt to fix up keepInFrame for one more case
rgbecker
parents: 2562
diff changeset
   933
                        self.height = H-_FUZZ
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   934
                        self._scale = s
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   935
                        break
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   936
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   937
        return self.width, self.height
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   938
2375
1e175a4474d0 platypus: almost finished PTOContainer
rgbecker
parents: 2341
diff changeset
   939
    def drawOn(self, canv, x, y, _sW=0):
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   940
        scale = getattr(self,'_scale',1.0)
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   941
        truncate = self.mode=='truncate'
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   942
        ss = scale!=1.0 or truncate
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   943
        if ss:
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   944
            canv.saveState()
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   945
            if truncate:
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   946
                p = canv.beginPath()
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   947
                p.rect(x, y, self.width,self.height)
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   948
                canv.clipPath(p,stroke=0)
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   949
            else:
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   950
                canv.translate(x,y)
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   951
                x=y=0
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   952
                canv.scale(1.0/scale, 1.0/scale)
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2523
diff changeset
   953
        _Container.drawOn(self, canv, x, y, _sW=_sW, scale=scale)
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2528
diff changeset
   954
        if ss: canv.restoreState()
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   955
2562
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
   956
class ImageAndFlowables(_Container,Flowable):
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   957
    '''combine a list of flowables and an Image'''
2562
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
   958
    def __init__(self,I,F,imageLeftPadding=0,imageRightPadding=3,imageTopPadding=0,imageBottomPadding=3,
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
   959
                    imageSide='right'):
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   960
        self._content = _flowableSublist(F)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   961
        self._I = I
2562
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
   962
        self._irpad = imageRightPadding
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
   963
        self._ilpad = imageLeftPadding
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
   964
        self._ibpad = imageBottomPadding
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
   965
        self._itpad = imageTopPadding
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
   966
        self._side = imageSide
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   967
2873
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   968
    def deepcopy(self):
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   969
        c = copy(self)  #shallow
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   970
        self._reset()
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   971
        c.copyContent() #partially deep?
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   972
        return c
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
   973
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   974
    def getSpaceAfter(self):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   975
        if hasattr(self,'_C1'):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   976
            C = self._C1
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   977
        elif hasattr(self,'_C0'):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   978
            C = self._C0
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   979
        else:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   980
            C = self._content
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   981
        return _Container.getSpaceAfter(self,C)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   982
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   983
    def getSpaceBefore(self):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   984
        return max(self._I.getSpaceBefore(),_Container.getSpaceBefore(self))
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   985
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   986
    def _reset(self):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   987
        for a in ('_wrapArgs','_C0','_C1'):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   988
            try:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   989
                delattr(self,a)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   990
            except:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   991
                pass
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   992
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   993
    def wrap(self,availWidth,availHeight):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   994
        canv = self.canv
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   995
        if hasattr(self,'_wrapArgs'):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   996
            if self._wrapArgs==(availWidth,availHeight):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   997
                return self.width,self.height
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   998
            self._reset()
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
   999
        self._wrapArgs = availWidth, availHeight
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1000
        wI, hI = self._I.wrap(availWidth,availHeight)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1001
        self._wI = wI
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1002
        self._hI = hI
2562
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1003
        ilpad = self._ilpad
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1004
        irpad = self._irpad
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1005
        ibpad = self._ibpad
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1006
        itpad = self._itpad
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1007
        self._iW = availWidth - irpad - wI - ilpad
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1008
        aH = itpad + hI + ibpad
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1009
        W,H0,self._C0,self._C1 = self._findSplit(canv,self._iW,aH)
2662
0a5217162c3f fix narrow space case for ImageAndFlowables
rgbecker
parents: 2660
diff changeset
  1010
        if W>self._iW+_FUZZ:
0a5217162c3f fix narrow space case for ImageAndFlowables
rgbecker
parents: 2660
diff changeset
  1011
            self._C0 = None
0a5217162c3f fix narrow space case for ImageAndFlowables
rgbecker
parents: 2660
diff changeset
  1012
            self._C1 = self._content
0a5217162c3f fix narrow space case for ImageAndFlowables
rgbecker
parents: 2660
diff changeset
  1013
        aH = self._aH = max(aH,H0)
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1014
        self.width = availWidth
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1015
        if not self._C1:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1016
            self.height = aH
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1017
        else:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1018
            W1,H1 = _listWrapOn(self._C1,availWidth,canv)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1019
            self.height = aH+H1
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1020
        return self.width, self.height
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1021
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1022
    def split(self,availWidth, availHeight):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1023
        if hasattr(self,'_wrapArgs'):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1024
            if self._wrapArgs!=(availWidth,availHeight):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1025
                self._reset()
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1026
        W,H=self.wrap(availWidth,availHeight)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1027
        if self._aH>availHeight: return []
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1028
        C1 = self._C1
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1029
        if C1:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1030
            c0 = C1[0]
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1031
            S = c0.split(availWidth,availHeight-self._aH)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1032
            if not S:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1033
                self._C1 = []
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1034
                self.height = self._aH
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1035
            else:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1036
                self._C1 = [S[0]]
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1037
                self.height = self._aH + S[0].height
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1038
                C1 = S[1:]+C1[1:]
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1039
        else:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1040
            self._C1 = []
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1041
            self.height = self._aH
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1042
        return [self]+C1
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1043
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1044
    def drawOn(self, canv, x, y, _sW=0):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1045
        if self._side=='left':
2562
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1046
            Ix = x + self._ilpad
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1047
            Fx = Ix+ self._irpad + self._wI
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1048
        else:
2837
6a30c8fc4686 imageAndFlowables rightPadding fix
hassan
parents: 2834
diff changeset
  1049
            Ix = x + self.width-self._wI-self._irpad
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1050
            Fx = x
2562
3c77a70414d9 platypus: ImagesAndFlowables in final form
rgbecker
parents: 2561
diff changeset
  1051
        self._I.drawOn(canv,Ix,y+self.height-self._itpad-self._hI)
2662
0a5217162c3f fix narrow space case for ImageAndFlowables
rgbecker
parents: 2660
diff changeset
  1052
        if self._C0:
0a5217162c3f fix narrow space case for ImageAndFlowables
rgbecker
parents: 2660
diff changeset
  1053
            _Container.drawOn(self, canv, Fx, y, content=self._C0, aW=self._iW)
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1054
        if self._C1:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1055
            _Container.drawOn(self, canv, x, y-self._aH,content=self._C1)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1056
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1057
    def _findSplit(self,canv,availWidth,availHeight,mergeSpace=1,obj=None):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1058
        '''return max width, required height for a list of flowables F'''
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1059
        W = 0
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1060
        H = 0
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1061
        pS = sB = 0
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1062
        atTop = 1
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1063
        F = self._content
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1064
        for i,f in enumerate(F):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1065
            w,h = f.wrapOn(canv,availWidth,0xfffffff)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1066
            if w<=_FUZZ or h<=_FUZZ: continue
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1067
            W = max(W,w)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1068
            if not atTop:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1069
                s = f.getSpaceBefore()
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1070
                if mergeSpace: s = max(s-pS,0)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1071
                H += s
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1072
            else:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1073
                if obj is not None: obj._spaceBefore = f.getSpaceBefore()
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1074
                atTop = 0
2873
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
  1075
            if H>=availHeight or w>availWidth:
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1076
                return W, availHeight, F[:i],F[i:]
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1077
            H += h
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1078
            if H>availHeight:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1079
                from paragraph import Paragraph
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1080
                aH = availHeight-(H-h)
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1081
                if isinstance(f,(Paragraph,Preformatted)):
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1082
                    leading = f.style.leading
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1083
                    nH = leading*int(aH/float(leading))+_FUZZ
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1084
                    if nH<aH: nH += leading
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1085
                    availHeight += nH-aH
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1086
                    aH = nH
2873
0fcfd487c548 flowables.py: start on fix for copying problems in imageAndFlowables
rgbecker
parents: 2851
diff changeset
  1087
                S = cdeepcopy(f).splitOn(canv,availWidth,aH)
2561
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1088
                if not S:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1089
                    return W, availHeight, F[:i],F[i:]
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1090
                else:
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1091
                    return W,availHeight,F[:i]+S[:1],S[1:]+F[i+1:]
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1092
            pS = f.getSpaceAfter()
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1093
            H += pS
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1094
        if obj is not None: obj._spaceAfter = pS
a2409b6627e6 reportlab: added FlowablesAndImage
rgbecker
parents: 2557
diff changeset
  1095
        return W, H-pS, F, []
2750
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1096
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1097
class AnchorFlowable(Spacer):
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1098
    '''create a bookmark in the pdf'''
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1099
    _ZEROSIZE=1
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1100
    def __init__(self,name):
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1101
        Spacer.__init__(self,0,0)
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1102
        self._name = name
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1103
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1104
    def __repr__(self):
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1105
        return "%s(%s)" % (self.__class__.__name__,self._name)
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1106
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1107
    def wrap(self,aW,aH):
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1108
        return 0,0
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1109
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1110
    def draw(self):
05229265aff3 reportlab: fix special case <a> tag problem, add AnchorFlowable class
rgbecker
parents: 2695
diff changeset
  1111
        self.canv.bookmarkHorizontal(self._name,0,0)
2950
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1112
2955
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1113
class FrameSplitter(NullDraw):
2950
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1114
    '''When encountered this flowable should either switch directly to nextTemplate
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1115
    if remaining space in the current frame is less than gap+required or it should
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1116
    temporarily modify the current template to have the frames from nextTemplate
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1117
    that are listed in nextFrames and switch to the first of those frames. 
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1118
    '''
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1119
    _ZEROSIZE=1
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1120
    def __init__(self,nextTemplate,nextFrames=[],gap=10,required=72):
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1121
        self.nextTemplate=nextTemplate
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1122
        self.nextFrames=nextFrames
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1123
        self.gap=gap
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1124
        self.required=required
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1125
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1126
    def wrap(self,aW,aH):
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1127
        frame = self._frame
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1128
        from reportlab.platypus.doctemplate import NextPageTemplate,CurrentFrameFlowable,LayoutError
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1129
        G=[NextPageTemplate(self.nextTemplate)]
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1130
        if aH<self.gap+self.required-_FUZZ:
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1131
            #we are going straight to the nextTemplate with no attempt to modify the frames
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1132
            G.append(PageBreak())
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1133
        else:
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1134
            #we are going to modify the incoming templates
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1135
            templates = self._doctemplateAttr('pageTemplates')
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1136
            if templates is None:
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1137
                raise LayoutError('%s called in non-doctemplate environment'%self.identity())
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1138
            T=[t for t in templates if t.id==self.nextTemplate]
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1139
            if not T:
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1140
                raise LayoutError('%s.nextTemplate=%s not found' % (self.identity(),self.nextTemplate))
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1141
            T=T[0]
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1142
            F=[f for f in T.frames if f.id in self.nextFrames]
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1143
            N=[f.id for f in F]
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1144
            N=[f for f in self.nextFrames if f not in N]
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1145
            if N:
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1146
                raise LayoutError('%s frames=%r not found in pageTemplate(%s)\n%r has frames %r' % (self.identity(),N,T.id,T,[f.id for f in T.frames]))
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1147
            T=self._doctemplateAttr('pageTemplate')
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1148
            def unwrap(canv,doc,T=T,onPage=T.onPage,oldFrames=T.frames):
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1149
                T.frames=oldFrames
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1150
                T.onPage=onPage
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1151
                onPage(canv,doc)
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1152
            T.onPage=unwrap
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1153
            h=aH-self.gap
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1154
            for i,f in enumerate(F):
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1155
                f=copy(f)
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1156
                f.height=h
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1157
                f._reset()
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1158
                F[i]=f
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1159
            T.frames=F
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1160
            G.append(CurrentFrameFlowable(F[0].id))
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1161
        frame.add_generated_content(*G)
6c243412b06c platypus: add support for FramSplitter flowable
rgbecker
parents: 2903
diff changeset
  1162
        return 0,0
2955
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1163
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1164
class DocAssign(NullDraw):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1165
    '''At wrap time this flowable evaluates var=expr in the doctemplate namespace'''
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1166
    _ZEROSIZE=1
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1167
    def __init__(self,var,expr,life='frame'):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1168
        Flowable.__init__(self)
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1169
        self.args = var,expr,life
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1170
    def wrap(self,aW,aH):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1171
        NS=self._doctemplateAttr('_nameSpace')
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1172
        NS.update(dict(availableWidth=aW,availableHeight=aH))
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1173
        try:
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1174
            self._doctemplateAttr('d'+self.__class__.__name__[1:])(*self.args)
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1175
        finally:
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1176
            for k in 'availableWidth','availableHeight':
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1177
                try:
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1178
                    del NS[k]
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1179
                except:
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1180
                    pass
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1181
        return 0,0
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1182
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1183
class DocExec(DocAssign):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1184
    '''at wrap time exec stmt in doc._nameSpace'''
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1185
    def __init__(self,stmt):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1186
        Flowable.__init__(self)
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1187
        self.args=stmt,
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1188
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1189
class DocPara(DocAssign):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1190
    '''at wrap time create a paragraph with the value of expr as text
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1191
    if paraTemplate is specified it should use %(value)s for string interpolation
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1192
    suitable defaults will be used if style and klass are None
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1193
    '''
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1194
    def __init__(self,expr,paraTemplate=None,style=None,klass=None):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1195
        Flowable.__init__(self)
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1196
        self.expr=expr
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1197
        self.paraTemplate=paraTemplate
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1198
        self.style=style
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1199
        self.klass=klass
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1200
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1201
    def wrap(self,aW,aH):
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1202
        value=self._doctemplateAttr('docEval')(self.expr)
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1203
        if self.paraTemplate:
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1204
            value = self.paraTemplate % dict(value=value)
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1205
        else:
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1206
            value = str(value)
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1207
        P = self.klass
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1208
        if not P:
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1209
            from reportlab.platypus.paragraph import Paragraph as P
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1210
        style = self.style
cc16265295fb reportlab: start of doc programming
rgbecker
parents: 2950
diff changeset
  1211
        if not style:
cc16265295fb reportlab: start of doc programming
rgb&