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