reportlab/platypus/doctemplate.py
author rgbecker
Mon, 08 May 2006 15:04:15 +0000
changeset 2593 3adaab508968
parent 2575 0cba68b93555
child 2654 202c2b5e100e
permissions -rw-r--r--
reportlab: minor fixes to platypus, tests and fix jap splitting bug
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2332
2a7ab4405e18 Remove $Header:, fix CopyRight & history
rgbecker
parents: 2216
diff changeset
     1
#Copyright ReportLab Europe Ltd. 2000-2004
494
54257447cfe9 Changed to indirect copyright
rgbecker
parents: 405
diff changeset
     2
#see license.txt for license details
2332
2a7ab4405e18 Remove $Header:, fix CopyRight & history
rgbecker
parents: 2216
diff changeset
     3
#history http://www.reportlab.co.uk/cgi-bin/viewcvs.cgi/public/reportlab/trunk/reportlab/platypus/doctemplate.py
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
     4
2332
2a7ab4405e18 Remove $Header:, fix CopyRight & history
rgbecker
parents: 2216
diff changeset
     5
__version__=''' $Id$ '''
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
     6
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     7
__doc__="""
268
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
     8
This module contains the core structure of platypus.
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
     9
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    10
Platypus constructs documents.  Document styles are determined by DocumentTemplates.
268
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    11
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    12
Each DocumentTemplate contains one or more PageTemplates which defines the look of the
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    13
pages of the document.
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    14
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    15
Each PageTemplate has a procedure for drawing the "non-flowing" part of the page
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    16
(for example the header, footer, page number, fixed logo graphic, watermark, etcetera) and
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    17
a set of Frames which enclose the flowing part of the page (for example the paragraphs,
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    18
tables, or non-fixed diagrams of the text).
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    19
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    20
A document is built when a DocumentTemplate is fed a sequence of Flowables.
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    21
The action of the build consumes the flowables in order and places them onto
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    22
frames on pages as space allows.  When a frame runs out of space the next frame
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    23
of the page is used.  If no frame remains a new page is created.  A new page
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    24
can also be created if a page break is forced.
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    25
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    26
The special invisible flowable NextPageTemplate can be used to specify
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    27
the page template for the next page (which by default is the one being used
8414113fa500 more documentation changes
aaron_watters
parents: 255
diff changeset
    28
for the current frame).
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    29
"""
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
    30
279
e7d8b3631d5c Global sequencer put in the 'story builder'.
andy_robinson
parents: 272
diff changeset
    31
from reportlab.platypus.flowables import *
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
    32
from reportlab.lib.units import inch
279
e7d8b3631d5c Global sequencer put in the 'story builder'.
andy_robinson
parents: 272
diff changeset
    33
from reportlab.platypus.paragraph import Paragraph
e7d8b3631d5c Global sequencer put in the 'story builder'.
andy_robinson
parents: 272
diff changeset
    34
from reportlab.platypus.frames import Frame
1530
1dedd3370a99 rl_config._verbose ==> verbose
rgbecker
parents: 1505
diff changeset
    35
from reportlab.rl_config import defaultPageSize, verbose
279
e7d8b3631d5c Global sequencer put in the 'story builder'.
andy_robinson
parents: 272
diff changeset
    36
import reportlab.lib.sequencer
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
    37
from reportlab.pdfgen import canvas
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
    38
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    39
from types import *
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    40
import sys
2500
ea0e8cec358c added a platypus logger
andy
parents: 2492
diff changeset
    41
import logging
ea0e8cec358c added a platypus logger
andy
parents: 2492
diff changeset
    42
logger = logging.getLogger("reportlab.platypus")
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    43
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
    44
class LayoutError(Exception):
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
    45
    pass
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
    46
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents: 249
diff changeset
    47
def _doNothing(canvas, doc):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    48
    "Dummy callback for onPage"
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    49
    pass
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    50
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
    51
1440
243d35446390 Removed 0 from multiBuild stuff prior to further changes;
andy_robinson
parents: 1428
diff changeset
    52
class IndexingFlowable(Flowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    53
    """Abstract interface definition for flowables which might
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    54
    hold references to other pages or themselves be targets
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    55
    of cross-references.  XRefStart, XRefDest, Table of Contents,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    56
    Indexes etc."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    57
    def isIndexing(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    58
        return 1
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    59
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    60
    def isSatisfied(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    61
        return 1
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    62
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    63
    def notify(self, kind, stuff):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    64
        """This will be called by the framework wherever 'stuff' happens.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    65
        'kind' will be a value that can be used to decide whether to
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    66
        pay attention or not."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    67
        pass
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    68
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    69
    def beforeBuild(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    70
        """Called by multiBuild before it starts; use this to clear
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    71
        old contents"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    72
        pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
    73
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    74
    def afterBuild(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    75
        """Called after build ends but before isSatisfied"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    76
        pass
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents: 249
diff changeset
    77
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    78
class ActionFlowable(Flowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    79
    '''This Flowable is never drawn, it can be used for data driven controls
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    80
       For example to change a page template (from one column to two, for example)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    81
       use NextPageTemplate which creates an ActionFlowable.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    82
    '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    83
    def __init__(self,action=()):
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
    84
        #must call super init to ensure it has a width and height (of zero),
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
    85
        #as in some cases the packer might get called on it...
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
    86
        Flowable.__init__(self)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    87
        if type(action) not in (ListType, TupleType):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    88
            action = (action,)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    89
        self.action = tuple(action)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    90
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    91
    def apply(self,doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    92
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    93
        This is called by the doc.build processing to allow the instance to
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    94
        implement its behaviour
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    95
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    96
        action = self.action[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    97
        args = tuple(self.action[1:])
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    98
        arn = 'handle_'+action
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    99
        try:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   100
            apply(getattr(doc,arn), args)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   101
        except AttributeError, aerr:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   102
            if aerr.args[0]==arn:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   103
                raise NotImplementedError, "Can't handle ActionFlowable(%s)" % action
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   104
            else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   105
                raise
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   106
        except "bogus":
2098
57b8eadaf3de Eliminate 2.3 problem assignement to None
rgbecker
parents: 2083
diff changeset
   107
            t, v, unused = sys.exc_info()
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   108
            raise t, "%s\n   handle_%s args=%s"%(v,action,args)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   109
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   110
    def __call__(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   111
        return self
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   112
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   113
    def identity(self, maxLen=None):
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   114
        return "ActionFlowable: %s%s" % (str(self.action),self._frameName())
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   115
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   116
class LCActionFlowable(ActionFlowable):
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   117
    locChanger = 1                  #we cause a frame or page change
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   118
2450
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   119
    def wrap(self, availWidth, availHeight):
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   120
        '''Should never be called.'''
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   121
        raise NotImplementedError
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   122
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   123
    def draw(self):
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   124
        '''Should never be called.'''
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   125
        raise NotImplementedError
f2ae0122a66a platypus: make LCActionFlowable the bad ones
rgbecker
parents: 2449
diff changeset
   126
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   127
class NextFrameFlowable(ActionFlowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   128
    def __init__(self,ix,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   129
        ActionFlowable.__init__(self,('nextFrame',ix,resume))
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   130
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   131
class CurrentFrameFlowable(LCActionFlowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   132
    def __init__(self,ix,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   133
        ActionFlowable.__init__(self,('currentFrame',ix,resume))
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   134
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   135
class NullActionFlowable(ActionFlowable):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   136
    def apply(self):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   137
        pass
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   138
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   139
class _FrameBreak(LCActionFlowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   140
    '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   141
    A special ActionFlowable that allows setting doc._nextFrameIndex
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   142
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   143
    eg story.append(FrameBreak('mySpecialFrame'))
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   144
    '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   145
    def __call__(self,ix=None,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   146
        r = self.__class__(self.action+(resume,))
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   147
        r._ix = ix
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   148
        return r
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   149
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   150
    def apply(self,doc):
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2525
diff changeset
   151
        if getattr(self,'_ix',None):
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2525
diff changeset
   152
            doc.handle_nextFrame(self._ix)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   153
        ActionFlowable.apply(self,doc)
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   154
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   155
FrameBreak = _FrameBreak('frameEnd')
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   156
PageBegin = LCActionFlowable('pageBegin')
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   157
2366
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   158
def _evalMeasurement(n):
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   159
    if type(n) is type(''):
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   160
        from paraparser import _num
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   161
        n = _num(n)
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   162
        if type(n) is type(()): n = n[1]
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   163
    return n
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   164
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   165
class FrameActionFlowable(Flowable):
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   166
    def __init__(self,*arg,**kw):
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   167
        raise NotImplementedError('Abstract Class')
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   168
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   169
    def frameAction(self,frame):
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   170
        raise NotImplementedError('Abstract Class')
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   171
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   172
class Indenter(FrameActionFlowable):
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   173
    """Increases or decreases left and right margins of frame.
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   174
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   175
    This allows one to have a 'context-sensitive' indentation
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   176
    and makes nested lists way easier.
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   177
    """
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   178
    def __init__(self, left=0, right=0):
2366
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   179
        self.left = _evalMeasurement(left)
7dd247980b7d minor twitching on Indenter
rgbecker
parents: 2332
diff changeset
   180
        self.right = _evalMeasurement(right)
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   181
2525
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   182
    def frameAction(self, frame):
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   183
        frame._leftExtraIndent += self.left
634ec1f48514 platypus: initial FrameFlowable implementation
rgbecker
parents: 2500
diff changeset
   184
        frame._rightExtraIndent += self.right
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   185
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   186
class NextPageTemplate(ActionFlowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   187
    """When you get to the next page, use the template specified (change to two column, for example)  """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   188
    def __init__(self,pt):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   189
        ActionFlowable.__init__(self,('nextPageTemplate',pt))
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   190
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   191
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   192
class PageTemplate:
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   193
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   194
    essentially a list of Frames and an onPage routine to call at the start
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   195
    of a page when this is selected. onPageEnd gets called at the end.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   196
    derived classes can also implement beforeDrawPage and afterDrawPage if they want
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   197
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   198
    def __init__(self,id=None,frames=[],onPage=_doNothing, onPageEnd=_doNothing,
1926
1c1f652b73d3 Make PageTemplate default size None
rgbecker
parents: 1923
diff changeset
   199
                 pagesize=None):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   200
        if type(frames) not in (ListType,TupleType): frames = [frames]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   201
        assert filter(lambda x: not isinstance(x,Frame), frames)==[], "frames argument error"
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   202
        self.id = id
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   203
        self.frames = frames
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   204
        self.onPage = onPage
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   205
        self.onPageEnd = onPageEnd
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   206
        self.pagesize = pagesize
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   207
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   208
    def beforeDrawPage(self,canv,doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   209
        """Override this if you want additional functionality or prefer
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   210
        a class based page routine.  Called before any flowables for
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   211
        this page are processed."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   212
        pass
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   213
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   214
    def checkPageSize(self,canv,doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   215
        '''This gets called by the template framework
1926
1c1f652b73d3 Make PageTemplate default size None
rgbecker
parents: 1923
diff changeset
   216
        If canv size != template size then the canv size is set to
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   217
        the template size or if that's not available to the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   218
        doc size.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   219
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   220
        #### NEVER EVER EVER COMPARE FLOATS FOR EQUALITY
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   221
        #RGB converting pagesizes to ints means we are accurate to one point
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   222
        #RGB I suggest we should be aiming a little better
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   223
        cp = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   224
        dp = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   225
        sp = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   226
        if canv._pagesize: cp = map(int, canv._pagesize)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   227
        if self.pagesize: sp = map(int, self.pagesize)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   228
        if doc.pagesize: dp = map(int, doc.pagesize)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   229
        if cp!=sp:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   230
            if sp:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   231
                canv.setPageSize(self.pagesize)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   232
            elif cp!=dp:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   233
                canv.setPageSize(doc.pagesize)
936
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   234
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   235
    def afterDrawPage(self, canv, doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   236
        """This is called after the last flowable for the page has
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   237
        been processed.  You might use this if the page header or
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   238
        footer needed knowledge of what flowables were drawn on
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   239
        this page."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   240
        pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   241
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   242
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   243
class BaseDocTemplate:
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   244
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   245
    First attempt at defining a document template class.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   246
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   247
    The basic idea is simple.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   248
    0)  The document has a list of data associated with it
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   249
        this data should derive from flowables. We'll have
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   250
        special classes like PageBreak, FrameBreak to do things
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   251
        like forcing a page end etc.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   252
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   253
    1)  The document has one or more page templates.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   254
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   255
    2)  Each page template has one or more frames.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   256
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   257
    3)  The document class provides base methods for handling the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   258
        story events and some reasonable methods for getting the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   259
        story flowables into the frames.
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   260
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   261
    4)  The document instances can override the base handler routines.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   262
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   263
    Most of the methods for this class are not called directly by the user,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   264
    but in some advanced usages they may need to be overridden via subclassing.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   265
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   266
    EXCEPTION: doctemplate.build(...) must be called for most reasonable uses
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   267
    since it builds a document using the page template.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   268
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   269
    Each document template builds exactly one document into a file specified
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   270
    by the filename argument on initialization.
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   271
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   272
    Possible keyword arguments for the initialization:
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   273
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   274
    pageTemplates: A list of templates.  Must be nonempty.  Names
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   275
      assigned to the templates are used for referring to them so no two used
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   276
      templates should have the same name.  For example you might want one template
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   277
      for a title page, one for a section first page, one for a first page of
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   278
      a chapter and two more for the interior of a chapter on odd and even pages.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   279
      If this argument is omitted then at least one pageTemplate should be provided
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   280
      using the addPageTemplates method before the document is built.
2216
aadcd9dc9480 Font reregistration cleanup
andy_robinson
parents: 2200
diff changeset
   281
    pageSize: a 2-tuple or a size constant from reportlab/lib/pagesizes.pu.
aadcd9dc9480 Font reregistration cleanup
andy_robinson
parents: 2200
diff changeset
   282
     Used by the SimpleDocTemplate subclass which does NOT accept a list of
aadcd9dc9480 Font reregistration cleanup
andy_robinson
parents: 2200
diff changeset
   283
     pageTemplates but makes one for you; ignored when using pageTemplates.
aadcd9dc9480 Font reregistration cleanup
andy_robinson
parents: 2200
diff changeset
   284
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   285
    showBoundary: if set draw a box around the frame boundaries.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   286
    leftMargin:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   287
    rightMargin:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   288
    topMargin:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   289
    bottomMargin:  Margin sizes in points (default 1 inch)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   290
      These margins may be overridden by the pageTemplates.  They are primarily of interest
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   291
      for the SimpleDocumentTemplate subclass.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   292
    allowSplitting:  If set flowables (eg, paragraphs) may be split across frames or pages
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   293
      (default: 1)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   294
    title: Internal title for document (does not automatically display on any page)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   295
    author: Internal author for document (does not automatically display on any page)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   296
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   297
    _initArgs = {   'pagesize':defaultPageSize,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   298
                    'pageTemplates':[],
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   299
                    'showBoundary':0,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   300
                    'leftMargin':inch,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   301
                    'rightMargin':inch,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   302
                    'topMargin':inch,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   303
                    'bottomMargin':inch,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   304
                    'allowSplitting':1,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   305
                    'title':None,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   306
                    'author':None,
1839
084e4af662dc Passing invariant argument through to canvas
andy_robinson
parents: 1838
diff changeset
   307
                    'invariant':None,
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   308
                    'pageCompression':None,
2492
8142a1737889 doctemplate.py: add rotation argument to BaseDocTemplate
rgbecker
parents: 2491
diff changeset
   309
                    '_pageBreakQuick':1,
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   310
                    'rotation':0,
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   311
                    '_debug':0}
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   312
    _invalidInitArgs = ()
2104
f5e5b7a4fb29 Allow for different first page template index
rgbecker
parents: 2098
diff changeset
   313
    _firstPageTemplateIndex = 0
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   314
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   315
    def __init__(self, filename, **kw):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   316
        """create a document template bound to a filename (see class documentation for keyword arguments)"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   317
        self.filename = filename
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   318
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   319
        for k in self._initArgs.keys():
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   320
            if not kw.has_key(k):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   321
                v = self._initArgs[k]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   322
            else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   323
                if k in self._invalidInitArgs:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   324
                    raise ValueError, "Invalid argument %s" % k
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   325
                v = kw[k]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   326
            setattr(self,k,v)
310
cbec783cfb81 Documentation changes
rgbecker
parents: 305
diff changeset
   327
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   328
        p = self.pageTemplates
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   329
        self.pageTemplates = []
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   330
        self.addPageTemplates(p)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   331
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   332
        # facility to assist multi-build and cross-referencing.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   333
        # various hooks can put things into here - key is what
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   334
        # you want, value is a page number.  This can then be
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   335
        # passed to indexing flowables.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   336
        self._pageRefs = {}
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   337
        self._indexingFlowables = []
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   338
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   339
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   340
        #callback facility for progress monitoring
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   341
        self._onPage = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   342
        self._onProgress = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   343
        self._flowableCount = 0  # so we know how far to go
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   344
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   345
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   346
        #infinite loop detection if we start doing lots of empty pages
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   347
        self._curPageFlowableCount = 0
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   348
        self._emptyPages = 0
2193
e19196dc3942 Upped empty page limit to 10
andy_robinson
parents: 2192
diff changeset
   349
        self._emptyPagesAllowed = 10
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   350
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   351
        #context sensitive margins - set by story, not from outside
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   352
        self._leftExtraIndent = 0.0
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   353
        self._rightExtraIndent = 0.0
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   354
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   355
        self._calc()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   356
        self.afterInit()
1502
125b52eb0a8e Added callbacks throughout
andy_robinson
parents: 1440
diff changeset
   357
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   358
    def _calc(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   359
        self._rightMargin = self.pagesize[0] - self.rightMargin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   360
        self._topMargin = self.pagesize[1] - self.topMargin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   361
        self.width = self._rightMargin - self.leftMargin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   362
        self.height = self._topMargin - self.bottomMargin
1502
125b52eb0a8e Added callbacks throughout
andy_robinson
parents: 1440
diff changeset
   363
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   364
    def setPageCallBack(self, func):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   365
        'Simple progress monitor - func(pageNo) called on each new page'
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   366
        self._onPage = func
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   367
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   368
    def setProgressCallBack(self, func):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   369
        '''Cleverer progress monitor - func(typ, value) called regularly'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   370
        self._onProgress = func
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   371
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   372
    def clean_hanging(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   373
        'handle internal postponed actions'
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   374
        while len(self._hanging):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   375
            self.handle_flowable(self._hanging)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   376
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   377
    def addPageTemplates(self,pageTemplates):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   378
        'add one or a sequence of pageTemplates'
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   379
        if type(pageTemplates) not in (ListType,TupleType):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   380
            pageTemplates = [pageTemplates]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   381
        #this test below fails due to inconsistent imports!
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   382
        #assert filter(lambda x: not isinstance(x,PageTemplate), pageTemplates)==[], "pageTemplates argument error"
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   383
        for t in pageTemplates:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   384
            self.pageTemplates.append(t)
1502
125b52eb0a8e Added callbacks throughout
andy_robinson
parents: 1440
diff changeset
   385
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   386
    def handle_documentBegin(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   387
        '''implement actions at beginning of document'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   388
        self._hanging = [PageBegin]
2104
f5e5b7a4fb29 Allow for different first page template index
rgbecker
parents: 2098
diff changeset
   389
        self.pageTemplate = self.pageTemplates[self._firstPageTemplateIndex]
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   390
        self.page = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   391
        self.beforeDocument()
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents: 249
diff changeset
   392
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   393
    def handle_pageBegin(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   394
        '''Perform actions required at beginning of page.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   395
        shouldn't normally be called directly'''
2593
3adaab508968 reportlab: minor fixes to platypus, tests and fix jap splitting bug
rgbecker
parents: 2575
diff changeset
   396
        self.page += 1
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   397
        if self._debug: logger.debug("beginning page %d" % self.page)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   398
        self.pageTemplate.beforeDrawPage(self.canv,self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   399
        self.pageTemplate.checkPageSize(self.canv,self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   400
        self.pageTemplate.onPage(self.canv,self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   401
        for f in self.pageTemplate.frames: f._reset()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   402
        self.beforePage()
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   403
        #keep a count of flowables added to this page.  zero indicates bad stuff
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   404
        self._curPageFlowableCount = 0
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   405
        if hasattr(self,'_nextFrameIndex'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   406
            del self._nextFrameIndex
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   407
        self.frame = self.pageTemplate.frames[0]
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   408
        self.frame._debug = self._debug
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   409
        self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   410
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   411
    def handle_pageEnd(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   412
        ''' show the current page
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   413
            check the next page template
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   414
            hang a page begin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   415
        '''
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   416
        #detect infinite loops...
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   417
        if self._curPageFlowableCount == 0:
2593
3adaab508968 reportlab: minor fixes to platypus, tests and fix jap splitting bug
rgbecker
parents: 2575
diff changeset
   418
            self._emptyPages += 1
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   419
        else:
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   420
            self._emptyPages = 0
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   421
        if self._emptyPages >= self._emptyPagesAllowed:
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   422
            if 1:
2466
0edb3b4ab6ff doctemplate.py: fix cgitb recursion problem
rgbecker
parents: 2460
diff changeset
   423
                ident = "More than %d pages generated without content - halting layout.  Likely that a flowable is too large for any frame." % self._emptyPagesAllowed
0edb3b4ab6ff doctemplate.py: fix cgitb recursion problem
rgbecker
parents: 2460
diff changeset
   424
                #leave to keep apart from the raise
0edb3b4ab6ff doctemplate.py: fix cgitb recursion problem
rgbecker
parents: 2460
diff changeset
   425
                raise LayoutError(ident)
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   426
            else:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   427
                pass    #attempt to restore to good state
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   428
        else:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   429
            if self._onProgress:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   430
                self._onProgress('PAGE', self.canv.getPageNumber())
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   431
            self.pageTemplate.afterDrawPage(self.canv, self)
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   432
            self.pageTemplate.onPageEnd(self.canv, self)
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   433
            self.afterPage()
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   434
            if self._debug: logger.debug("ending page %d" % self.page)
2492
8142a1737889 doctemplate.py: add rotation argument to BaseDocTemplate
rgbecker
parents: 2491
diff changeset
   435
            self.canv.setPageRotation(getattr(self.pageTemplate,'rotation',self.rotation))
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   436
            self.canv.showPage()
2418
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   437
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   438
            if hasattr(self,'_nextPageTemplateCycle'):
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   439
                #they are cycling through pages'; we keep the index
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   440
                cyc = self._nextPageTemplateCycle
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   441
                idx = self._nextPageTemplateIndex
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   442
                self.pageTemplate = cyc[idx]  #which is one of the ones in the list anyway
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   443
                #bump up by 1
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   444
                self._nextPageTemplateIndex = (idx + 1) % len(cyc)
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   445
            elif hasattr(self,'_nextPageTemplateIndex'):
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   446
                self.pageTemplate = self.pageTemplates[self._nextPageTemplateIndex]
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   447
                del self._nextPageTemplateIndex
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   448
            if self._emptyPages==0:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   449
                pass    #store good state here
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   450
        self._hanging.append(PageBegin)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   451
2408
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2366
diff changeset
   452
    def handle_pageBreak(self,slow=None):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   453
        '''some might choose not to end all the frames'''
2408
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2366
diff changeset
   454
        if self._pageBreakQuick and not slow:
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   455
            self.handle_pageEnd()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   456
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   457
            n = len(self._hanging)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   458
            while len(self._hanging)==n:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   459
                self.handle_frameEnd()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   460
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   461
    def handle_frameBegin(self,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   462
        '''What to do at the beginning of a frame'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   463
        f = self.frame
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   464
        if f._atTop:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   465
            if self.showBoundary or self.frame.showBoundary:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   466
                self.frame.drawBoundary(self.canv)
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   467
        f._leftExtraIndent = self._leftExtraIndent
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   468
        f._rightExtraIndent = self._rightExtraIndent
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   469
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   470
    def handle_frameEnd(self,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   471
        ''' Handles the semantics of the end of a frame. This includes the selection of
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   472
            the next frame or if this is the last frame then invoke pageEnd.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   473
        '''
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   474
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   475
        self._leftExtraIndent = self.frame._leftExtraIndent
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   476
        self._rightExtraIndent = self.frame._rightExtraIndent
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   477
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   478
        if hasattr(self,'_nextFrameIndex'):
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2525
diff changeset
   479
            self.frame = self.pageTemplate.frames[self._nextFrameIndex]
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   480
            self.frame._debug = self._debug
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   481
            del self._nextFrameIndex
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   482
            self.handle_frameBegin(resume)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   483
        elif hasattr(self.frame,'lastFrame') or self.frame is self.pageTemplate.frames[-1]:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   484
            self.handle_pageEnd()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   485
            self.frame = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   486
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   487
            f = self.frame
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   488
            self.frame = self.pageTemplate.frames[self.pageTemplate.frames.index(f) + 1]
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   489
            self.frame._debug = self._debug
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   490
            self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   491
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   492
    def handle_nextPageTemplate(self,pt):
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   493
        '''On endPage change to the page template with name or index pt'''
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   494
        if type(pt) is StringType:
2418
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   495
            if hasattr(self, '_nextPageTemplateCycle'): del self._nextPageTemplateCycle
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   496
            for t in self.pageTemplates:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   497
                if t.id == pt:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   498
                    self._nextPageTemplateIndex = self.pageTemplates.index(t)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   499
                    return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   500
            raise ValueError, "can't find template('%s')"%pt
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   501
        elif type(pt) is IntType:
2418
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   502
            if hasattr(self, '_nextPageTemplateCycle'): del self._nextPageTemplateCycle
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   503
            self._nextPageTemplateIndex = pt
2418
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   504
        elif type(pt) in (ListType, TupleType):
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   505
            #used for alternating left/right pages
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   506
            #collect the refs to the template objects, complain if any are bad
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   507
            cycle = []
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   508
            for templateName in pt:
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   509
                found = 0
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   510
                for t in self.pageTemplates:
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   511
                    if t.id == templateName:
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   512
                        cycle.append(t)
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   513
                        found = 1
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   514
                if not found:
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   515
                    raise ValueError("Cannot find page template called %s" % templateName)
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   516
            #double-check all of them are there...
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   517
            
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   518
            first = cycle[0]
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   519
            #ensure we start on the first one
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   520
            self._nextPageTemplateCycle = cycle
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   521
            self._nextPageTemplateIndex = 0  #indexes into the cycle
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   522
        else:
2418
9f4ad36c767f left/right template support
andy
parents: 2408
diff changeset
   523
            raise TypeError, "argument pt should be string or integer or list"
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   524
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2525
diff changeset
   525
    def handle_nextFrame(self,fx,resume=0):
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   526
        '''On endFrame change to the frame with name or index fx'''
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   527
        if type(fx) is StringType:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   528
            for f in self.pageTemplate.frames:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   529
                if f.id == fx:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   530
                    self._nextFrameIndex = self.pageTemplate.frames.index(f)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   531
                    return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   532
            raise ValueError, "can't find frame('%s')"%fx
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   533
        elif type(fx) is IntType:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   534
            self._nextFrameIndex = fx
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   535
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   536
            raise TypeError, "argument fx should be string or integer"
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   537
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2525
diff changeset
   538
    def handle_currentFrame(self,fx,resume=0):
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   539
        '''change to the frame with name or index fx'''
2529
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2525
diff changeset
   540
        self.handle_nextFrame(fx,resume)
dced304f8584 flowables.py: keepInFrame now truncates etc properly, doctemplate.py: fix handle_frameEnd
rgbecker
parents: 2525
diff changeset
   541
        self.handle_frameEnd(resume)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   542
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   543
    def handle_breakBefore(self, flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   544
        '''preprocessing step to allow pageBreakBefore and frameBreakBefore attributes'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   545
        first = flowables[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   546
        # if we insert a page break before, we'll process that, see it again,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   547
        # and go in an infinite loop.  So we need to set a flag on the object
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   548
        # saying 'skip me'.  This should be unset on the next pass
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   549
        if hasattr(first, '_skipMeNextTime'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   550
            delattr(first, '_skipMeNextTime')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   551
            return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   552
        # this could all be made much quicker by putting the attributes
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   553
        # in to the flowables with a defult value of 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   554
        if hasattr(first,'pageBreakBefore') and first.pageBreakBefore == 1:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   555
            first._skipMeNextTime = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   556
            first.insert(0, PageBreak())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   557
            return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   558
        if hasattr(first,'style') and hasattr(first.style, 'pageBreakBefore') and first.style.pageBreakBefore == 1:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   559
            first._skipMeNextTime = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   560
            flowables.insert(0, PageBreak())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   561
            return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   562
        if hasattr(first,'frameBreakBefore') and first.frameBreakBefore == 1:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   563
            first._skipMeNextTime = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   564
            flowables.insert(0, FrameBreak())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   565
            return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   566
        if hasattr(first,'style') and hasattr(first.style, 'frameBreakBefore') and first.style.frameBreakBefore == 1:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   567
            first._skipMeNextTime = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   568
            flowables.insert(0, FrameBreak())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   569
            return
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   570
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   571
    def handle_keepWithNext(self, flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   572
        "implements keepWithNext"
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   573
        i = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   574
        n = len(flowables)
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   575
        while i<n and flowables[i].getKeepWithNext(): i += 1
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   576
        if i:
2449
47b15f941325 platypus: attempt to make KeepTogether/keepWithNext more robust
rgbecker
parents: 2418
diff changeset
   577
            if not getattr(flowables[i],'locChanger',None): i += 1
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   578
            K = KeepTogether(flowables[:i])
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   579
            for f in K._content:
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   580
                f.keepWithNext = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   581
            del flowables[:i]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   582
            flowables.insert(0,K)
1425
fa9f74f1a701 Experiments with platypus
andy_robinson
parents: 1324
diff changeset
   583
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   584
    def _fIdent(self,f,maxLen=None,frame=None):
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   585
        if frame: f._frame = frame
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   586
        try:
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   587
            return f.identity(maxLen)
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   588
        finally:
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   589
            if frame: del f._frame
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   590
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   591
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   592
    def handle_flowable(self,flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   593
        '''try to handle one flowable from the front of list flowables.'''
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   594
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   595
        #allow document a chance to look at, modify or ignore
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   596
        #the object(s) about to be processed
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   597
        self.filterFlowables(flowables)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   598
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   599
        self.handle_breakBefore(flowables)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   600
        self.handle_keepWithNext(flowables)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   601
        f = flowables[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   602
        del flowables[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   603
        if f is None:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   604
            return
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   605
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   606
        if isinstance(f,PageBreak):
2408
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2366
diff changeset
   607
            if isinstance(f,SlowPageBreak):
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2366
diff changeset
   608
                self.handle_pageBreak(slow=1)
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2366
diff changeset
   609
            else:
1c5e79611b59 flowables: add SlowPageBreak
rgbecker
parents: 2366
diff changeset
   610
                self.handle_pageBreak()
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   611
            self.afterFlowable(f)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   612
        elif isinstance(f,ActionFlowable):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   613
            f.apply(self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   614
            self.afterFlowable(f)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   615
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   616
            #try to fit it then draw it
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   617
            if self.frame.add(f, self.canv, trySplit=self.allowSplitting):
2593
3adaab508968 reportlab: minor fixes to platypus, tests and fix jap splitting bug
rgbecker
parents: 2575
diff changeset
   618
                self._curPageFlowableCount += 1
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   619
                self.afterFlowable(f)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   620
            else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   621
                if self.allowSplitting:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   622
                    # see if this is a splittable thing
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   623
                    S = self.frame.split(f,self.canv)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   624
                    n = len(S)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   625
                else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   626
                    n = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   627
                if n:
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   628
                    if not isinstance(S[0],(PageBreak,SlowPageBreak,ActionFlowable)):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   629
                        if self.frame.add(S[0], self.canv, trySplit=0):
2593
3adaab508968 reportlab: minor fixes to platypus, tests and fix jap splitting bug
rgbecker
parents: 2575
diff changeset
   630
                            self._curPageFlowableCount += 1
2575
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   631
                            self.afterFlowable(S[0])
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   632
                        else:
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   633
                            ident = "Splitting error(n==%d) on page %d in\n%s" % (n,self.page,self._fIdent(f,30,self.frame))
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   634
                            #leave to keep apart from the raise
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   635
                            raise LayoutError(ident)
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   636
                        del S[0]
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   637
                    for i,f in enumerate(S):
0cba68b93555 reportlab-utf8 moved to trunk
rgbecker
parents: 2531
diff changeset
   638
                        flowables.insert(i,f)   # put split flowables back on the list
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   639
                else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   640
                    if hasattr(f,'_postponed'):
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   641
                        ident = "Flowable %s too large on page %d" % (self._fIdent(f,30,self.frame), self.page)
2466
0edb3b4ab6ff doctemplate.py: fix cgitb recursion problem
rgbecker
parents: 2460
diff changeset
   642
                        #leave to keep apart from the raise
0edb3b4ab6ff doctemplate.py: fix cgitb recursion problem
rgbecker
parents: 2460
diff changeset
   643
                        raise LayoutError(ident)
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   644
                    # this ought to be cleared when they are finally drawn!
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   645
                    f._postponed = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   646
                    flowables.insert(0,f)           # put the flowable back
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   647
                    self.handle_frameEnd()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   648
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   649
    #these are provided so that deriving classes can refer to them
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   650
    _handle_documentBegin = handle_documentBegin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   651
    _handle_pageBegin = handle_pageBegin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   652
    _handle_pageEnd = handle_pageEnd
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   653
    _handle_frameBegin = handle_frameBegin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   654
    _handle_frameEnd = handle_frameEnd
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   655
    _handle_flowable = handle_flowable
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   656
    _handle_nextPageTemplate = handle_nextPageTemplate
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   657
    _handle_currentFrame = handle_currentFrame
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   658
    _handle_nextFrame = handle_nextFrame
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   659
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   660
    def _startBuild(self, filename=None, canvasmaker=canvas.Canvas):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   661
        self._calc()
1839
084e4af662dc Passing invariant argument through to canvas
andy_robinson
parents: 1838
diff changeset
   662
        self.canv = canvasmaker(filename or self.filename,
084e4af662dc Passing invariant argument through to canvas
andy_robinson
parents: 1838
diff changeset
   663
                                pagesize=self.pagesize,
2531
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   664
                                invariant=self.invariant,
40b6f4b41f7c platypus: changes to make identity more useful
rgbecker
parents: 2529
diff changeset
   665
                                pageCompression=self.pageCompression)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   666
        if self._onPage:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   667
            self.canv.setPageCallBack(self._onPage)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   668
        self.handle_documentBegin()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   669
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   670
    def _endBuild(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   671
        if self._hanging!=[] and self._hanging[-1] is PageBegin:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   672
            del self._hanging[-1]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   673
            self.clean_hanging()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   674
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   675
            self.clean_hanging()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   676
            self.handle_pageBreak()
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   677
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   678
        if getattr(self,'_doSave',1): self.canv.save()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   679
        if self._onPage: self.canv.setPageCallBack(None)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   680
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   681
    def build(self, flowables, filename=None, canvasmaker=canvas.Canvas):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   682
        """Build the document from a list of flowables.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   683
           If the filename argument is provided then that filename is used
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   684
           rather than the one provided upon initialization.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   685
           If the canvasmaker argument is provided then it will be used
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   686
           instead of the default.  For example a slideshow might use
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   687
           an alternate canvas which places 6 slides on a page (by
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   688
           doing translations, scalings and redefining the page break
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   689
           operations).
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   690
        """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   691
        #assert filter(lambda x: not isinstance(x,Flowable), flowables)==[], "flowables argument error"
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   692
        flowableCount = len(flowables)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   693
        if self._onProgress:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   694
            self._onProgress('STARTED',0)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   695
            self._onProgress('SIZE_EST', len(flowables))
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   696
        self._startBuild(filename,canvasmaker)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   697
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   698
        while len(flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   699
            self.clean_hanging()
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   700
            try:
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   701
                first = flowables[0]
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   702
                self.handle_flowable(flowables)
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   703
            except:
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   704
                #if it has trace info, add it to the traceback message.
2127
d5e43db37d59 Allowing for strange flowables with no _traceIfo object
william_ng
parents: 2113
diff changeset
   705
                if hasattr(first, '_traceInfo') and first._traceInfo:
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   706
                    exc = sys.exc_info()[1]
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   707
                    args = list(exc.args)
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   708
                    tr = first._traceInfo
2593
3adaab508968 reportlab: minor fixes to platypus, tests and fix jap splitting bug
rgbecker
parents: 2575
diff changeset
   709
                    args[0] += '\n(srcFile %s, line %d char %d to line %d char %d)' % (
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   710
                        tr.srcFile,
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   711
                        tr.startLineNo,
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   712
                        tr.startLinePos,
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   713
                        tr.endLineNo,
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   714
                        tr.endLinePos
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   715
                        )
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   716
                    exc.args = tuple(args)
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   717
                raise
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   718
            if self._onProgress:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   719
                self._onProgress('PROGRESS',flowableCount - len(flowables))
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   720
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   721
        self._endBuild()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   722
        if self._onProgress:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   723
            self._onProgress('FINISHED',0)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   724
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   725
    def _allSatisfied(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   726
        """Called by multi-build - are all cross-references resolved?"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   727
        allHappy = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   728
        for f in self._indexingFlowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   729
            if not f.isSatisfied():
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   730
                allHappy = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   731
                break
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   732
        return allHappy
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   733
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   734
    def notify(self, kind, stuff):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   735
        """"Forward to any listeners"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   736
        for l in self._indexingFlowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   737
            l.notify(kind, stuff)
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   738
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   739
    def pageRef(self, label):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   740
        """hook to register a page number"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   741
        if verbose: print "pageRef called with label '%s' on page %d" % (
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   742
            label, self.page)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   743
        self._pageRefs[label] = self.page
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   744
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   745
    def multiBuild(self, story,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   746
                   filename=None,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   747
                   canvasmaker=canvas.Canvas,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   748
                   maxPasses = 10):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   749
        """Makes multiple passes until all indexing flowables
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   750
        are happy."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   751
        self._indexingFlowables = []
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   752
        #scan the story and keep a copy
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   753
        for thing in story:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   754
            if thing.isIndexing():
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   755
                self._indexingFlowables.append(thing)
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   756
1829
ce5ceec32eab Fix up multiBuild to be cleverer about initial saves
rgbecker
parents: 1824
diff changeset
   757
        #better fix for filename is a 'file' problem
ce5ceec32eab Fix up multiBuild to be cleverer about initial saves
rgbecker
parents: 1824
diff changeset
   758
        self._doSave = 0
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   759
        passes = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   760
        while 1:
2593
3adaab508968 reportlab: minor fixes to platypus, tests and fix jap splitting bug
rgbecker
parents: 2575
diff changeset
   761
            passes += 1
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   762
            if self._onProgress:
2460
dc28c1738ea9 doctemplate.py: fix buglet reported by Steve Halasz
rgbecker
parents: 2450
diff changeset
   763
                self._onProgress('PASS', passes)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   764
            if verbose: print 'building pass '+str(passes) + '...',
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   765
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   766
            for fl in self._indexingFlowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   767
                fl.beforeBuild()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   768
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   769
            # work with a copy of the story, since it is consumed
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   770
            tempStory = story[:]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   771
            self.build(tempStory, filename, canvasmaker)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   772
            #self.notify('debug',None)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   773
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   774
            #clean up so multi-build does not go wrong - the frame
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   775
            #packer might have tacked an attribute onto some flowables
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   776
            for elem in story:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   777
                if hasattr(elem, '_postponed'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   778
                    del elem._postponed
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   779
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   780
            for fl in self._indexingFlowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   781
                fl.afterBuild()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   782
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   783
            happy = self._allSatisfied()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   784
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   785
            if happy:
1829
ce5ceec32eab Fix up multiBuild to be cleverer about initial saves
rgbecker
parents: 1824
diff changeset
   786
                self._doSave = 0
ce5ceec32eab Fix up multiBuild to be cleverer about initial saves
rgbecker
parents: 1824
diff changeset
   787
                self.canv.save()
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   788
                break
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   789
            if passes > maxPasses:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   790
                raise IndexError, "Index entries not resolved after %d passes" % maxPasses
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   791
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   792
        if verbose: print 'saved'
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   793
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   794
    #these are pure virtuals override in derived classes
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   795
    #NB these get called at suitable places by the base class
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   796
    #so if you derive and override the handle_xxx methods
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   797
    #it's up to you to ensure that they maintain the needed consistency
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   798
    def afterInit(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   799
        """This is called after initialisation of the base class."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   800
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   801
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   802
    def beforeDocument(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   803
        """This is called before any processing is
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   804
        done on the document."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   805
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   806
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   807
    def beforePage(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   808
        """This is called at the beginning of page
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   809
        processing, and immediately before the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   810
        beforeDrawPage method of the current page
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   811
        template."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   812
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   813
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   814
    def afterPage(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   815
        """This is called after page processing, and
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   816
        immediately after the afterDrawPage method
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   817
        of the current page template."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   818
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   819
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   820
    def filterFlowables(self,flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   821
        '''called to filter flowables at the start of the main handle_flowable method.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   822
        Upon return if flowables[0] has been set to None it is discarded and the main
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   823
        method returns.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   824
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   825
        pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   826
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   827
    def afterFlowable(self, flowable):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   828
        '''called after a flowable has been rendered'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   829
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   830
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   831
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   832
class SimpleDocTemplate(BaseDocTemplate):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   833
    """A special case document template that will handle many simple documents.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   834
       See documentation for BaseDocTemplate.  No pageTemplates are required
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   835
       for this special case.   A page templates are inferred from the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   836
       margin information and the onFirstPage, onLaterPages arguments to the build method.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   837
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   838
       A document which has all pages with the same look except for the first
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   839
       page may can be built using this special approach.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   840
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   841
    _invalidInitArgs = ('pageTemplates',)
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   842
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   843
    def handle_pageBegin(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   844
        '''override base method to add a change of page template after the firstpage.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   845
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   846
        self._handle_pageBegin()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   847
        self._handle_nextPageTemplate('Later')
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   848
2488
8bc9673fffa6 doctemplate.py: support for canvasmaker and rotation
rgbecker
parents: 2466
diff changeset
   849
    def build(self,flowables,onFirstPage=_doNothing, onLaterPages=_doNothing, canvasmaker=canvas.Canvas):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   850
        """build the document using the flowables.  Annotate the first page using the onFirstPage
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   851
               function and later pages using the onLaterPages function.  The onXXX pages should follow
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   852
               the signature
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   853
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   854
                  def myOnFirstPage(canvas, document):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   855
                      # do annotations and modify the document
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   856
                      ...
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   857
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   858
               The functions can do things like draw logos, page numbers,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   859
               footers, etcetera. They can use external variables to vary
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   860
               the look (for example providing page numbering or section names).
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   861
        """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   862
        self._calc()    #in case we changed margins sizes etc
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   863
        frameT = Frame(self.leftMargin, self.bottomMargin, self.width, self.height, id='normal')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   864
        self.addPageTemplates([PageTemplate(id='First',frames=frameT, onPage=onFirstPage,pagesize=self.pagesize),
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   865
                        PageTemplate(id='Later',frames=frameT, onPage=onLaterPages,pagesize=self.pagesize)])
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   866
        if onFirstPage is _doNothing and hasattr(self,'onFirstPage'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   867
            self.pageTemplates[0].beforeDrawPage = self.onFirstPage
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   868
        if onLaterPages is _doNothing and hasattr(self,'onLaterPages'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   869
            self.pageTemplates[1].beforeDrawPage = self.onLaterPages
2488
8bc9673fffa6 doctemplate.py: support for canvasmaker and rotation
rgbecker
parents: 2466
diff changeset
   870
        BaseDocTemplate.build(self,flowables, canvasmaker=canvasmaker)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   871
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   872
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   873
def progressCB(typ, value):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   874
    """Example prototype for progress monitoring.
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   875
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   876
    This aims to provide info about what is going on
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   877
    during a big job.  It should enable, for example, a reasonably
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   878
    smooth progress bar to be drawn.  We design the argument
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   879
    signature to be predictable and conducive to programming in
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   880
    other (type safe) languages.  If set, this will be called
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   881
    repeatedly with pairs of values.  The first is a string
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   882
    indicating the type of call; the second is a numeric value.
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   883
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   884
    typ 'STARTING', value = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   885
    typ 'SIZE_EST', value = numeric estimate of job size
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   886
    typ 'PASS', value = number of this rendering pass
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   887
    typ 'PROGRESS', value = number between 0 and SIZE_EST
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   888
    typ 'PAGE', value = page number of page
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   889
    type 'FINISHED', value = 0
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   890
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   891
    The sequence is
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   892
        STARTING - always called once
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   893
        SIZE_EST - always called once
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   894
        PROGRESS - called often
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   895
        PAGE - called often when page is emitted
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   896
        FINISHED - called when really, really finished
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   897
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   898
    some juggling is needed to accurately estimate numbers of
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   899
    pages in pageDrawing mode.
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   900
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   901
    NOTE: the SIZE_EST is a guess.  It is possible that the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   902
    PROGRESS value may slightly exceed it, or may even step
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   903
    back a little on rare occasions.  The only way to be
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   904
    really accurate would be to do two passes, and I don't
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   905
    want to take that performance hit.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   906
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   907
    print 'PROGRESS MONITOR:  %-10s   %d' % (typ, value)
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   908
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   909
if __name__ == '__main__':
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   910
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   911
    def myFirstPage(canvas, doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   912
        canvas.saveState()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   913
        canvas.setStrokeColor(red)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   914
        canvas.setLineWidth(5)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   915
        canvas.line(66,72,66,PAGE_HEIGHT-72)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   916
        canvas.setFont('Times-Bold',24)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   917
        canvas.drawString(108, PAGE_HEIGHT-108, "TABLE OF CONTENTS DEMO")
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   918
        canvas.setFont('Times-Roman',12)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   919
        canvas.drawString(4 * inch, 0.75 * inch, "First Page")
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   920
        canvas.restoreState()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   921
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   922
    def myLaterPages(canvas, doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   923
        canvas.saveState()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   924
        canvas.setStrokeColor(red)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   925
        canvas.setLineWidth(5)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   926
        canvas.line(66,72,66,PAGE_HEIGHT-72)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   927
        canvas.setFont('Times-Roman',12)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   928
        canvas.drawString(4 * inch, 0.75 * inch, "Page %d" % doc.page)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   929
        canvas.restoreState()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   930
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   931
    def run():
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   932
        objects_to_draw = []
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   933
        from reportlab.lib.styles import ParagraphStyle
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   934
        #from paragraph import Paragraph
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   935
        from doctemplate import SimpleDocTemplate
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   936
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   937
        #need a style
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   938
        normal = ParagraphStyle('normal')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   939
        normal.firstLineIndent = 18
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   940
        normal.spaceBefore = 6
2083
52aae853f269 Use randomText from lib
rgbecker
parents: 1926
diff changeset
   941
        from reportlab.lib.randomtext import randomText
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   942
        import random
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   943
        for i in range(15):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   944
            height = 0.5 + (2*random.random())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   945
            box = XBox(6 * inch, height * inch, 'Box Number %d' % i)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   946
            objects_to_draw.append(box)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   947
            para = Paragraph(randomText(), normal)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   948
            objects_to_draw.append(para)
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   949
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   950
        SimpleDocTemplate('doctemplate.pdf').build(objects_to_draw,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   951
            onFirstPage=myFirstPage,onLaterPages=myLaterPages)
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   952
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   953
    run()