reportlab/platypus/doctemplate.py
author rgbecker
Thu, 17 Jun 2004 15:26:05 +0000
changeset 2332 2a7ab4405e18
parent 2216 aadcd9dc9480
child 2366 7dd247980b7d
permissions -rw-r--r--
Remove $Header:, fix CopyRight & history
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 *
e7d8b3631d5c Global sequencer put in the 'story builder'.
andy_robinson
parents: 272
diff changeset
    32
from reportlab.platypus.paragraph import Paragraph
e7d8b3631d5c Global sequencer put in the 'story builder'.
andy_robinson
parents: 272
diff changeset
    33
from reportlab.platypus.frames import Frame
1530
1dedd3370a99 rl_config._verbose ==> verbose
rgbecker
parents: 1505
diff changeset
    34
from reportlab.rl_config import defaultPageSize, verbose
279
e7d8b3631d5c Global sequencer put in the 'story builder'.
andy_robinson
parents: 272
diff changeset
    35
import reportlab.lib.sequencer
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
    36
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    37
from types import *
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    38
import sys
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    39
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
    40
class LayoutError(Exception):
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
    41
    pass
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
    42
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents: 249
diff changeset
    43
def _doNothing(canvas, doc):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    44
    "Dummy callback for onPage"
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    45
    pass
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    46
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
    47
1440
243d35446390 Removed 0 from multiBuild stuff prior to further changes;
andy_robinson
parents: 1428
diff changeset
    48
class IndexingFlowable(Flowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    49
    """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
    50
    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
    51
    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
    52
    Indexes etc."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    53
    def isIndexing(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    54
        return 1
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    55
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    56
    def isSatisfied(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    57
        return 1
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    58
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    59
    def notify(self, kind, stuff):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    60
        """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
    61
        '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
    62
        pay attention or not."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    63
        pass
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    64
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    65
    def beforeBuild(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    66
        """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
    67
        old contents"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    68
        pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
    69
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    70
    def afterBuild(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    71
        """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
    72
        pass
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents: 249
diff changeset
    73
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
    74
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    75
class ActionFlowable(Flowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    76
    '''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
    77
       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
    78
       use NextPageTemplate which creates an ActionFlowable.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    79
    '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    80
    def __init__(self,action=()):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    81
        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
    82
            action = (action,)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    83
        self.action = tuple(action)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    84
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    85
    def wrap(self, availWidth, availHeight):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    86
        '''Should never be called.'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    87
        raise NotImplementedError
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    88
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    89
    def draw(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    90
        '''Should never be called.'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    91
        raise NotImplementedError
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    92
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    93
    def apply(self,doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    94
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    95
        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
    96
        implement its behaviour
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    97
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    98
        action = self.action[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
    99
        args = tuple(self.action[1:])
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   100
        arn = 'handle_'+action
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   101
        try:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   102
            apply(getattr(doc,arn), args)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   103
        except AttributeError, aerr:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   104
            if aerr.args[0]==arn:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   105
                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
   106
            else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   107
                raise
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   108
        except "bogus":
2098
57b8eadaf3de Eliminate 2.3 problem assignement to None
rgbecker
parents: 2083
diff changeset
   109
            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
   110
            raise t, "%s\n   handle_%s args=%s"%(v,action,args)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   111
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   112
    def __call__(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   113
        return self
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   114
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   115
    def identity(self, maxLen=None):
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   116
        return "ActionFlowable: %s" % str(self.action)
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   117
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   118
class NextFrameFlowable(ActionFlowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   119
    def __init__(self,ix,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   120
        ActionFlowable.__init__(self,('nextFrame',ix,resume))
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   121
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   122
class CurrentFrameFlowable(ActionFlowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   123
    def __init__(self,ix,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   124
        ActionFlowable.__init__(self,('currentFrame',ix,resume))
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   125
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   126
class _FrameBreak(ActionFlowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   127
    '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   128
    A special ActionFlowable that allows setting doc._nextFrameIndex
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   129
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   130
    eg story.append(FrameBreak('mySpecialFrame'))
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   131
    '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   132
    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
   133
        r = self.__class__(self.action+(resume,))
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   134
        r._ix = ix
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   135
        return r
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   136
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   137
    def apply(self,doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   138
        if getattr(self,'_ix',None): doc._nextFrameIndex = self._ix
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   139
        ActionFlowable.apply(self,doc)
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   140
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   141
FrameBreak = _FrameBreak('frameEnd')
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   142
PageBegin = ActionFlowable('pageBegin')
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   143
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   144
class Indenter(ActionFlowable):
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   145
    """Increases or decreases left and right margins of frame.
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   146
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   147
    This allows one to have a 'context-sensitive' indentation
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   148
    and makes nested lists way easier.
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   149
    """
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   150
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   151
    def __init__(self, left=0, right=0):
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   152
        self.left = left
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   153
        self.right = right
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   154
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   155
    def apply(self, doc):
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   156
        doc.frame._leftExtraIndent = doc.frame._leftExtraIndent + self.left
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   157
        doc.frame._rightExtraIndent = doc.frame._rightExtraIndent + self.right
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   158
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   159
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   160
class NextPageTemplate(ActionFlowable):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   161
    """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
   162
    def __init__(self,pt):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   163
        ActionFlowable.__init__(self,('nextPageTemplate',pt))
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   164
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   165
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   166
class PageTemplate:
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   167
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   168
    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
   169
    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
   170
    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
   171
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   172
    def __init__(self,id=None,frames=[],onPage=_doNothing, onPageEnd=_doNothing,
1926
1c1f652b73d3 Make PageTemplate default size None
rgbecker
parents: 1923
diff changeset
   173
                 pagesize=None):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   174
        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
   175
        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
   176
        self.id = id
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   177
        self.frames = frames
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   178
        self.onPage = onPage
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   179
        self.onPageEnd = onPageEnd
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   180
        self.pagesize = pagesize
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   181
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   182
    def beforeDrawPage(self,canv,doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   183
        """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
   184
        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
   185
        this page are processed."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   186
        pass
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   187
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   188
    def checkPageSize(self,canv,doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   189
        '''This gets called by the template framework
1926
1c1f652b73d3 Make PageTemplate default size None
rgbecker
parents: 1923
diff changeset
   190
        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
   191
        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
   192
        doc size.
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
        #### 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
   195
        #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
   196
        #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
   197
        cp = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   198
        dp = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   199
        sp = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   200
        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
   201
        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
   202
        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
   203
        if cp!=sp:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   204
            if sp:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   205
                canv.setPageSize(self.pagesize)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   206
            elif cp!=dp:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   207
                canv.setPageSize(doc.pagesize)
936
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   208
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   209
    def afterDrawPage(self, canv, doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   210
        """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
   211
        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
   212
        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
   213
        this page."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   214
        pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   215
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   216
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   217
class BaseDocTemplate:
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   218
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   219
    First attempt at defining a document template class.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   220
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   221
    The basic idea is simple.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   222
    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
   223
        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
   224
        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
   225
        like forcing a page end etc.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   226
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   227
    1)  The document has one or more page templates.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   228
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   229
    2)  Each page template has one or more frames.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   230
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   231
    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
   232
        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
   233
        story flowables into the frames.
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   234
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   235
    4)  The document instances can override the base handler routines.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   236
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   237
    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
   238
    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
   239
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   240
    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
   241
    since it builds a document using the page template.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   242
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   243
    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
   244
    by the filename argument on initialization.
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   245
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   246
    Possible keyword arguments for the initialization:
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   247
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   248
    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
   249
      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
   250
      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
   251
      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
   252
      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
   253
      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
   254
      using the addPageTemplates method before the document is built.
2216
aadcd9dc9480 Font reregistration cleanup
andy_robinson
parents: 2200
diff changeset
   255
    pageSize: a 2-tuple or a size constant from reportlab/lib/pagesizes.pu.
aadcd9dc9480 Font reregistration cleanup
andy_robinson
parents: 2200
diff changeset
   256
     Used by the SimpleDocTemplate subclass which does NOT accept a list of
aadcd9dc9480 Font reregistration cleanup
andy_robinson
parents: 2200
diff changeset
   257
     pageTemplates but makes one for you; ignored when using pageTemplates.
aadcd9dc9480 Font reregistration cleanup
andy_robinson
parents: 2200
diff changeset
   258
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   259
    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
   260
    leftMargin:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   261
    rightMargin:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   262
    topMargin:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   263
    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
   264
      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
   265
      for the SimpleDocumentTemplate subclass.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   266
    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
   267
      (default: 1)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   268
    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
   269
    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
   270
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   271
    _initArgs = {   'pagesize':defaultPageSize,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   272
                    'pageTemplates':[],
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   273
                    'showBoundary':0,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   274
                    'leftMargin':inch,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   275
                    'rightMargin':inch,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   276
                    'topMargin':inch,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   277
                    'bottomMargin':inch,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   278
                    'allowSplitting':1,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   279
                    'title':None,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   280
                    'author':None,
1839
084e4af662dc Passing invariant argument through to canvas
andy_robinson
parents: 1838
diff changeset
   281
                    'invariant':None,
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   282
                    '_pageBreakQuick':1}
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   283
    _invalidInitArgs = ()
2104
f5e5b7a4fb29 Allow for different first page template index
rgbecker
parents: 2098
diff changeset
   284
    _firstPageTemplateIndex = 0
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   285
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   286
    def __init__(self, filename, **kw):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   287
        """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
   288
        self.filename = filename
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   289
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   290
        for k in self._initArgs.keys():
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   291
            if not kw.has_key(k):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   292
                v = self._initArgs[k]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   293
            else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   294
                if k in self._invalidInitArgs:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   295
                    raise ValueError, "Invalid argument %s" % k
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   296
                v = kw[k]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   297
            setattr(self,k,v)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   298
        #print "pagesize is", self.pagesize
310
cbec783cfb81 Documentation changes
rgbecker
parents: 305
diff changeset
   299
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   300
        p = self.pageTemplates
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   301
        self.pageTemplates = []
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   302
        self.addPageTemplates(p)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   303
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   304
        # 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
   305
        # 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
   306
        # 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
   307
        # passed to indexing flowables.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   308
        self._pageRefs = {}
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   309
        self._indexingFlowables = []
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   310
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   311
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   312
        #callback facility for progress monitoring
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   313
        self._onPage = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   314
        self._onProgress = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   315
        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
   316
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   317
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   318
        #infinite loop detection if we start doing lots of empty pages
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   319
        self._curPageFlowableCount = 0
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   320
        self._emptyPages = 0
2193
e19196dc3942 Upped empty page limit to 10
andy_robinson
parents: 2192
diff changeset
   321
        self._emptyPagesAllowed = 10
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   322
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   323
        #context sensitive margins - set by story, not from outside
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   324
        self._leftExtraIndent = 0.0
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   325
        self._rightExtraIndent = 0.0
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   326
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   327
        self._calc()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   328
        self.afterInit()
1502
125b52eb0a8e Added callbacks throughout
andy_robinson
parents: 1440
diff changeset
   329
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   330
    def _calc(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   331
        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
   332
        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
   333
        self.width = self._rightMargin - self.leftMargin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   334
        self.height = self._topMargin - self.bottomMargin
1502
125b52eb0a8e Added callbacks throughout
andy_robinson
parents: 1440
diff changeset
   335
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   336
    def setPageCallBack(self, func):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   337
        '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
   338
        self._onPage = func
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   339
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   340
    def setProgressCallBack(self, func):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   341
        '''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
   342
        self._onProgress = func
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   343
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   344
    def clean_hanging(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   345
        'handle internal postponed actions'
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   346
        while len(self._hanging):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   347
            self.handle_flowable(self._hanging)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   348
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   349
    def addPageTemplates(self,pageTemplates):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   350
        '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
   351
        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
   352
            pageTemplates = [pageTemplates]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   353
        #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
   354
        #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
   355
        for t in pageTemplates:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   356
            self.pageTemplates.append(t)
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 handle_documentBegin(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   359
        '''implement actions at beginning of document'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   360
        self._hanging = [PageBegin]
2104
f5e5b7a4fb29 Allow for different first page template index
rgbecker
parents: 2098
diff changeset
   361
        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
   362
        self.page = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   363
        self.beforeDocument()
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents: 249
diff changeset
   364
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   365
    def handle_pageBegin(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   366
        '''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
   367
        shouldn't normally be called directly'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   368
        self.page = self.page + 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   369
        self.pageTemplate.beforeDrawPage(self.canv,self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   370
        self.pageTemplate.checkPageSize(self.canv,self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   371
        self.pageTemplate.onPage(self.canv,self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   372
        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
   373
        self.beforePage()
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   374
        #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
   375
        self._curPageFlowableCount = 0
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   376
        if hasattr(self,'_nextFrameIndex'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   377
            del self._nextFrameIndex
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   378
        self.frame = self.pageTemplate.frames[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   379
        self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   380
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   381
    def handle_pageEnd(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   382
        ''' show the current page
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   383
            check the next page template
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   384
            hang a page begin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   385
        '''
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   386
        #detect infinite loops...
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   387
        if self._curPageFlowableCount == 0:
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   388
            self._emptyPages = self._emptyPages + 1
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   389
        else:
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   390
            self._emptyPages = 0
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   391
        if self._emptyPages >= self._emptyPagesAllowed:
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   392
            if 1:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   393
                raise LayoutError("More than %d pages generated without content - halting layout.  Likely that a flowable is too large for any frame." % self._emptyPagesAllowed)
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   394
            else:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   395
                pass    #attempt to restore to good state
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   396
        else:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   397
            if self._onProgress:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   398
                self._onProgress('PAGE', self.canv.getPageNumber())
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   399
            self.pageTemplate.afterDrawPage(self.canv, self)
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   400
            self.pageTemplate.onPageEnd(self.canv, self)
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   401
            self.afterPage()
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   402
            self.canv.showPage()
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   403
            if hasattr(self,'_nextPageTemplateIndex'):
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   404
                self.pageTemplate = self.pageTemplates[self._nextPageTemplateIndex]
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   405
                del self._nextPageTemplateIndex
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   406
            if self._emptyPages==0:
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   407
                pass    #store good state here
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   408
        self._hanging.append(PageBegin)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   409
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   410
    def handle_pageBreak(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   411
        '''some might choose not to end all the frames'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   412
        if self._pageBreakQuick:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   413
            self.handle_pageEnd()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   414
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   415
            n = len(self._hanging)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   416
            while len(self._hanging)==n:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   417
                self.handle_frameEnd()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   418
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   419
    def handle_frameBegin(self,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   420
        '''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
   421
        f = self.frame
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   422
        if f._atTop:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   423
            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
   424
                self.frame.drawBoundary(self.canv)
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   425
        f._leftExtraIndent = self._leftExtraIndent
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   426
        f._rightExtraIndent = self._rightExtraIndent
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   427
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   428
    def handle_frameEnd(self,resume=0):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   429
        ''' 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
   430
            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
   431
        '''
2200
be0cfccc662a Fixed up tabs and whitespace in all source files
andy_robinson
parents: 2196
diff changeset
   432
1923
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   433
        self._leftExtraIndent = self.frame._leftExtraIndent
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   434
        self._rightExtraIndent = self.frame._rightExtraIndent
e692491f0967 Added relative indentation
andy_robinson
parents: 1839
diff changeset
   435
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   436
        if hasattr(self,'_nextFrameIndex'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   437
            frame = self.pageTemplate.frames[self._nextFrameIndex]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   438
            del self._nextFrameIndex
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   439
            self.handle_frameBegin(resume)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   440
        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
   441
            self.handle_pageEnd()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   442
            self.frame = None
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   443
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   444
            f = self.frame
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   445
            self.frame = self.pageTemplate.frames[self.pageTemplate.frames.index(f) + 1]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   446
            self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   447
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   448
    def handle_nextPageTemplate(self,pt):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   449
        '''On endPage chenge to the page template with name or index pt'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   450
        if type(pt) is StringType:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   451
            for t in self.pageTemplates:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   452
                if t.id == pt:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   453
                    self._nextPageTemplateIndex = self.pageTemplates.index(t)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   454
                    return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   455
            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
   456
        elif type(pt) is IntType:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   457
            self._nextPageTemplateIndex = pt
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   458
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   459
            raise TypeError, "argument pt should be string or integer"
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
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_nextFrame(self,fx):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   462
        '''On endFrame chenge to the frame with name or index fx'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   463
        if type(fx) is StringType:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   464
            for f in self.pageTemplate.frames:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   465
                if f.id == fx:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   466
                    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
   467
                    return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   468
            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
   469
        elif type(fx) is IntType:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   470
            self._nextFrameIndex = fx
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   471
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   472
            raise TypeError, "argument fx should be string or integer"
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   473
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   474
    def handle_currentFrame(self,fx):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   475
        '''chenge to the frame with name or index fx'''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   476
        if type(fx) is StringType:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   477
            for f in self.pageTemplate.frames:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   478
                if f.id == fx:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   479
                    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
   480
                    return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   481
            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
   482
        elif type(fx) is IntType:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   483
            self._nextFrameIndex = fx
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   484
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   485
            raise TypeError, "argument fx should be string or integer"
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   486
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   487
    def handle_breakBefore(self, flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   488
        '''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
   489
        first = flowables[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   490
        # 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
   491
        # 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
   492
        # 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
   493
        if hasattr(first, '_skipMeNextTime'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   494
            delattr(first, '_skipMeNextTime')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   495
            return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   496
        # 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
   497
        # 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
   498
        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
   499
            first._skipMeNextTime = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   500
            first.insert(0, PageBreak())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   501
            return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   502
        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
   503
            first._skipMeNextTime = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   504
            flowables.insert(0, PageBreak())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   505
            return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   506
        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
   507
            first._skipMeNextTime = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   508
            flowables.insert(0, FrameBreak())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   509
            return
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   510
        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
   511
            first._skipMeNextTime = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   512
            flowables.insert(0, FrameBreak())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   513
            return
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   514
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   515
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   516
    def handle_keepWithNext(self, flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   517
        "implements keepWithNext"
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   518
        i = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   519
        n = len(flowables)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   520
        while i<n and flowables[i].getKeepWithNext(): i = i + 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   521
        if i:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   522
            i = i + 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   523
            K = KeepTogether(flowables[:i])
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   524
            for f in K._flowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   525
                f.keepWithNext = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   526
            del flowables[:i]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   527
            flowables.insert(0,K)
1425
fa9f74f1a701 Experiments with platypus
andy_robinson
parents: 1324
diff changeset
   528
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   529
    def handle_flowable(self,flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   530
        '''try to handle one flowable from the front of list flowables.'''
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   531
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   532
        #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
   533
        #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
   534
        self.filterFlowables(flowables)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   535
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   536
        self.handle_breakBefore(flowables)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   537
        self.handle_keepWithNext(flowables)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   538
        f = flowables[0]
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   539
        #print 'handling flowable %s' % f.identity()
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   540
        del flowables[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   541
        if f is None:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   542
            return
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   543
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   544
        if isinstance(f,PageBreak):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   545
            self.handle_pageBreak()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   546
            self.afterFlowable(f)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   547
        elif isinstance(f,ActionFlowable):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   548
            f.apply(self)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   549
            self.afterFlowable(f)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   550
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   551
            #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
   552
            if self.frame.add(f, self.canv, trySplit=self.allowSplitting):
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   553
                self._curPageFlowableCount = self._curPageFlowableCount + 1
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   554
                self.afterFlowable(f)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   555
            else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   556
                #if isinstance(f, KeepTogether): print 'could not add it to frame'
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   557
                if self.allowSplitting:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   558
                    # 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
   559
                    S = self.frame.split(f,self.canv)
1838
f7eeee67832c Changes to allow invariant documents when needed
andy_robinson
parents: 1829
diff changeset
   560
                    #print '%d parts to sequence on page %d' % (len(S), self.page)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   561
                    n = len(S)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   562
                else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   563
                    n = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   564
                #if isinstance(f, KeepTogether): print 'n=%d' % n
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   565
                if n:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   566
                    if self.frame.add(S[0], self.canv, trySplit=0):
2192
955d4bf3b9d2 Candidate fix for infinite looping
andy_robinson
parents: 2127
diff changeset
   567
                        self._curPageFlowableCount = self._curPageFlowableCount + 1
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   568
                        self.afterFlowable(S[0])
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   569
                    else:
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   570
                        raise LayoutError("Splitting error(n==%d) on page %d in\n%s" % (n,self.page,f.identity(30)))
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   571
                    del S[0]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   572
                    for f in xrange(n-1):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   573
                        flowables.insert(f,S[f])    # put split flowables back on the list
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   574
                else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   575
                    if hasattr(f,'_postponed'):
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   576
                        raise LayoutError("Flowable %s too large on page %d" % (f.identity(30), self.page))
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   577
                    # 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
   578
                    f._postponed = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   579
                    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
   580
                    self.handle_frameEnd()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   581
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   582
    #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
   583
    _handle_documentBegin = handle_documentBegin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   584
    _handle_pageBegin = handle_pageBegin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   585
    _handle_pageEnd = handle_pageEnd
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   586
    _handle_frameBegin = handle_frameBegin
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   587
    _handle_frameEnd = handle_frameEnd
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   588
    _handle_flowable = handle_flowable
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   589
    _handle_nextPageTemplate = handle_nextPageTemplate
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   590
    _handle_currentFrame = handle_currentFrame
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   591
    _handle_nextFrame = handle_nextFrame
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   592
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   593
    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
   594
        self._calc()
1839
084e4af662dc Passing invariant argument through to canvas
andy_robinson
parents: 1838
diff changeset
   595
        self.canv = canvasmaker(filename or self.filename,
084e4af662dc Passing invariant argument through to canvas
andy_robinson
parents: 1838
diff changeset
   596
                                pagesize=self.pagesize,
084e4af662dc Passing invariant argument through to canvas
andy_robinson
parents: 1838
diff changeset
   597
                                invariant=self.invariant)
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   598
        if self._onPage:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   599
            self.canv.setPageCallBack(self._onPage)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   600
        self.handle_documentBegin()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   601
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   602
    def _endBuild(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   603
        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
   604
            del self._hanging[-1]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   605
            self.clean_hanging()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   606
        else:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   607
            self.clean_hanging()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   608
            self.handle_pageBreak()
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   609
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   610
        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
   611
        if self._onPage: self.canv.setPageCallBack(None)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   612
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   613
    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
   614
        """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
   615
           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
   616
           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
   617
           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
   618
           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
   619
           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
   620
           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
   621
           operations).
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   622
        """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   623
        #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
   624
        flowableCount = len(flowables)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   625
        if self._onProgress:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   626
            self._onProgress('STARTED',0)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   627
            self._onProgress('SIZE_EST', len(flowables))
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   628
        self._startBuild(filename,canvasmaker)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   629
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   630
        while len(flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   631
            self.clean_hanging()
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   632
            try:
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   633
                first = flowables[0]
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   634
                self.handle_flowable(flowables)
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   635
            except:
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   636
                #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
   637
                if hasattr(first, '_traceInfo') and first._traceInfo:
2113
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   638
                    exc = sys.exc_info()[1]
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   639
                    args = list(exc.args)
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   640
                    tr = first._traceInfo
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   641
                    args[0] = args[0] + '\n(srcFile %s, line %d char %d to line %d char %d)' % (
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   642
                        tr.srcFile,
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   643
                        tr.startLineNo,
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   644
                        tr.startLinePos,
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   645
                        tr.endLineNo,
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   646
                        tr.endLinePos
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   647
                        )
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   648
                    exc.args = tuple(args)
e82d8b3880d8 Preliminary support for tracing through doc builds
andy_robinson
parents: 2104
diff changeset
   649
                raise
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   650
            if self._onProgress:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   651
                self._onProgress('PROGRESS',flowableCount - len(flowables))
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   652
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   653
        self._endBuild()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   654
        if self._onProgress:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   655
            self._onProgress('FINISHED',0)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   656
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   657
    def _allSatisfied(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   658
        """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
   659
        allHappy = 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   660
        for f in self._indexingFlowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   661
            if not f.isSatisfied():
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   662
                allHappy = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   663
                break
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   664
        return allHappy
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   665
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   666
    def notify(self, kind, stuff):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   667
        """"Forward to any listeners"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   668
        for l in self._indexingFlowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   669
            l.notify(kind, stuff)
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   670
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   671
    def pageRef(self, label):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   672
        """hook to register a page number"""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   673
        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
   674
            label, self.page)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   675
        self._pageRefs[label] = self.page
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   676
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   677
    def multiBuild(self, story,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   678
                   filename=None,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   679
                   canvasmaker=canvas.Canvas,
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   680
                   maxPasses = 10):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   681
        """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
   682
        are happy."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   683
        self._indexingFlowables = []
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   684
        #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
   685
        for thing in story:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   686
            if thing.isIndexing():
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   687
                self._indexingFlowables.append(thing)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   688
        #print 'scanned story, found these indexing flowables:\n'
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   689
        #print self._indexingFlowables
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   690
1829
ce5ceec32eab Fix up multiBuild to be cleverer about initial saves
rgbecker
parents: 1824
diff changeset
   691
        #better fix for filename is a 'file' problem
ce5ceec32eab Fix up multiBuild to be cleverer about initial saves
rgbecker
parents: 1824
diff changeset
   692
        self._doSave = 0
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   693
        passes = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   694
        while 1:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   695
            passes = passes + 1
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   696
            if self._onProgress:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   697
                self.onProgress('PASS', passes)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   698
            if verbose: print 'building pass '+str(passes) + '...',
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   699
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   700
            for fl in self._indexingFlowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   701
                fl.beforeBuild()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   702
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   703
            # 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
   704
            tempStory = story[:]
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   705
            self.build(tempStory, filename, canvasmaker)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   706
            #self.notify('debug',None)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   707
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   708
            #clean up so multi-build does not go wrong - the frame
2196
c04e09c8635e Allow for simple loop detection
rgbecker
parents: 2193
diff changeset
   709
            #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
   710
            for elem in story:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   711
                if hasattr(elem, '_postponed'):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   712
                    del elem._postponed
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   713
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   714
            for fl in self._indexingFlowables:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   715
                fl.afterBuild()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   716
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   717
            happy = self._allSatisfied()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   718
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   719
            if happy:
1829
ce5ceec32eab Fix up multiBuild to be cleverer about initial saves
rgbecker
parents: 1824
diff changeset
   720
                self._doSave = 0
ce5ceec32eab Fix up multiBuild to be cleverer about initial saves
rgbecker
parents: 1824
diff changeset
   721
                self.canv.save()
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   722
                break
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   723
            if passes > maxPasses:
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   724
                raise IndexError, "Index entries not resolved after %d passes" % maxPasses
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   725
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   726
        if verbose: print 'saved'
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   727
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   728
    #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
   729
    #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
   730
    #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
   731
    #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
   732
    def afterInit(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   733
        """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
   734
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   735
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   736
    def beforeDocument(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   737
        """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
   738
        done on the document."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   739
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   740
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   741
    def beforePage(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   742
        """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
   743
        processing, and immediately before the
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   744
        beforeDrawPage method of the current page
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   745
        template."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   746
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   747
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   748
    def afterPage(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   749
        """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
   750
        immediately after the afterDrawPage method
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   751
        of the current page template."""
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   752
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   753
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   754
    def filterFlowables(self,flowables):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   755
        '''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
   756
        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
   757
        method returns.
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   758
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   759
        pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   760
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   761
    def afterFlowable(self, flowable):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   762
        '''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
   763
        pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   764
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   765
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   766
class SimpleDocTemplate(BaseDocTemplate):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   767
    """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
   768
       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
   769
       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
   770
       margin information and the onFirstPage, onLaterPages arguments to the build method.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   771
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   772
       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
   773
       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
   774
    """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   775
    _invalidInitArgs = ('pageTemplates',)
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   776
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   777
    def handle_pageBegin(self):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   778
        '''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
   779
        '''
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   780
        self._handle_pageBegin()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   781
        self._handle_nextPageTemplate('Later')
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   782
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   783
    def build(self,flowables,onFirstPage=_doNothing, onLaterPages=_doNothing):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   784
        """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
   785
               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
   786
               the signature
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   787
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   788
                  def myOnFirstPage(canvas, document):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   789
                      # do annotations and modify the document
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   790
                      ...
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
               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
   793
               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
   794
               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
   795
        """
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   796
        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
   797
        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
   798
        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
   799
                        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
   800
        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
   801
            self.pageTemplates[0].beforeDrawPage = self.onFirstPage
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   802
        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
   803
            self.pageTemplates[1].beforeDrawPage = self.onLaterPages
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   804
        BaseDocTemplate.build(self,flowables)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   805
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   806
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   807
def progressCB(typ, value):
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   808
    """Example prototype for progress monitoring.
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   809
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   810
    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
   811
    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
   812
    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
   813
    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
   814
    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
   815
    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
   816
    indicating the type of call; the second is a numeric value.
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   817
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   818
    typ 'STARTING', value = 0
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   819
    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
   820
    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
   821
    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
   822
    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
   823
    type 'FINISHED', value = 0
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   824
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   825
    The sequence is
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   826
        STARTING - always called once
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   827
        SIZE_EST - always called once
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   828
        PROGRESS - called often
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   829
        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
   830
        FINISHED - called when really, really finished
1683
7fa753e4420a Removed all trailing whitespace
andy_robinson
parents: 1677
diff changeset
   831
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   832
    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
   833
    pages in pageDrawing mode.
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   834
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   835
    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
   836
    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
   837
    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
   838
    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
   839
    want to take that performance hit.
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
    print 'PROGRESS MONITOR:  %-10s   %d' % (typ, value)
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   842
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   843
if __name__ == '__main__':
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   844
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   845
    def myFirstPage(canvas, doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   846
        canvas.saveState()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   847
        canvas.setStrokeColor(red)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   848
        canvas.setLineWidth(5)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   849
        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
   850
        canvas.setFont('Times-Bold',24)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   851
        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
   852
        canvas.setFont('Times-Roman',12)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   853
        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
   854
        canvas.restoreState()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   855
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   856
    def myLaterPages(canvas, doc):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   857
        canvas.saveState()
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   858
        canvas.setStrokeColor(red)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   859
        canvas.setLineWidth(5)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   860
        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
   861
        canvas.setFont('Times-Roman',12)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   862
        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
   863
        canvas.restoreState()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   864
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   865
    def run():
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   866
        objects_to_draw = []
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   867
        from reportlab.lib.styles import ParagraphStyle
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   868
        #from paragraph import Paragraph
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   869
        from doctemplate import SimpleDocTemplate
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   870
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   871
        #need a style
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   872
        normal = ParagraphStyle('normal')
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   873
        normal.firstLineIndent = 18
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   874
        normal.spaceBefore = 6
2083
52aae853f269 Use randomText from lib
rgbecker
parents: 1926
diff changeset
   875
        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
   876
        import random
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   877
        for i in range(15):
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   878
            height = 0.5 + (2*random.random())
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   879
            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
   880
            objects_to_draw.append(box)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   881
            para = Paragraph(randomText(), normal)
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   882
            objects_to_draw.append(para)
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   883
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   884
        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
   885
            onFirstPage=myFirstPage,onLaterPages=myLaterPages)
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   886
1677
1450177dd19e Exterminated all tab characters and added a test to make sure
andy_robinson
parents: 1672
diff changeset
   887
    run()