reportlab/platypus/doctemplate.py
author rgbecker
Tue, 09 Jul 2002 16:47:43 +0000
changeset 1669 31cb4c337e0d
parent 1668 448a9205be12
child 1672 d16919470fea
permissions -rw-r--r--
Andy's progress stuff
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
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
     4
#$Header: /tmp/reportlab/reportlab/platypus/doctemplate.py,v 1.54 2002/07/09 16:47:43 rgbecker Exp $
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
     5
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
     6
__version__=''' $Id: doctemplate.py,v 1.54 2002/07/09 16:47:43 rgbecker 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
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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):
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    43
	"Dummy callback for onPage"
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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):
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    48
	"""Abstract interface definition for flowables which might
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    49
	hold references to other pages or themselves be targets
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    50
	of cross-references.  XRefStart, XRefDest, Table of Contents,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    51
	Indexes etc."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    52
	def isIndexing(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    53
		return 1
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    54
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    55
	def isSatisfied(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    56
		return 1
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    57
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    58
	def notify(self, kind, stuff):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    59
		"""This will be called by the framework wherever 'stuff' happens.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    60
		'kind' will be a value that can be used to decide whether to
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    61
		pay attention or not."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    62
		pass
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    63
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    64
	def beforeBuild(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    65
		"""Called by multiBuild before it starts; use this to clear
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    66
		old contents"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    67
		pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
    68
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    69
	def afterBuild(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    70
		"""Called after build ends but before isSatisfied"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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):
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    75
	'''This Flowable is never drawn, it can be used for data driven controls
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    76
	   For example to change a page template (from one column to two, for example)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    77
	   use NextPageTemplate which creates an ActionFlowable.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    78
	'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    79
	def __init__(self,action=()):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    80
		if type(action) not in (ListType, TupleType):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    81
			action = (action,)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    82
		self.action = tuple(action)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    83
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    84
	def wrap(self, availWidth, availHeight):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    85
		'''Should never be called.'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    86
		raise NotImplementedError
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    87
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    88
	def draw(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    89
		'''Should never be called.'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    90
		raise NotImplementedError
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    91
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    92
	def apply(self,doc):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    93
		'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    94
		This is called by the doc.build processing to allow the instance to
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    95
		implement its behaviour
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    96
		'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    97
		action = self.action[0]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    98
		args = tuple(self.action[1:])
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
    99
		arn = 'handle_'+action
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   100
		try:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   101
			apply(getattr(doc,arn), args)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   102
		except AttributeError, aerr:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   103
			if aerr.args[0]==arn:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   104
				raise NotImplementedError, "Can't handle ActionFlowable(%s)" % action
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   105
			else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   106
				raise
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   107
		except "bogus":
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   108
			t, v, None = sys.exc_info()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   111
	def __call__(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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):
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   115
	def __init__(self,ix,resume=0):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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):
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   119
	def __init__(self,ix,resume=0):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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):
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   123
	'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   126
	eg story.append(FrameBreak('mySpecialFrame'))
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   127
	'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   128
	def __call__(self,ix=None,resume=0):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   129
		r = self.__class__(self.action+(resume,))
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   130
		r._ix = ix
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   131
		return r
1324
3335a8e81e7b Possible improvements to FrameBreak et al
rgbecker
parents: 1268
diff changeset
   132
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   133
	def apply(self,doc):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   134
		if getattr(self,'_ix',None): doc._nextFrameIndex = self._ix
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
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
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   140
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   141
class NextPageTemplate(ActionFlowable):
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   142
	"""When you get to the next page, use the template specified (change to two column, for example)  """
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   143
	def __init__(self,pt):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   144
		ActionFlowable.__init__(self,('nextPageTemplate',pt))
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   145
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   146
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   147
class PageTemplate:
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   148
	"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   149
	essentially a list of Frames and an onPage routine to call at the start
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   150
	of a page when this is selected. onPageEnd gets called at the end.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   151
	derived classes can also implement beforeDrawPage and afterDrawPage if they want
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   152
	"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   153
	def __init__(self,id=None,frames=[],onPage=_doNothing, onPageEnd=_doNothing,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   154
				 pagesize=defaultPageSize):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   155
		if type(frames) not in (ListType,TupleType): frames = [frames]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   156
		assert filter(lambda x: not isinstance(x,Frame), frames)==[], "frames argument error"
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   157
		self.id = id
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   158
		self.frames = frames
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   159
		self.onPage = onPage
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   160
		self.onPageEnd = onPageEnd
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   161
		self.pagesize = pagesize
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   162
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   163
	def beforeDrawPage(self,canv,doc):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   164
		"""Override this if you want additional functionality or prefer
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   165
		a class based page routine.  Called before any flowables for
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   166
		this page are processed."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   167
		pass
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   168
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   169
	def checkPageSize(self,canv,doc):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   170
		'''This gets called by the template framework
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   171
		If canv size != doc size then the canv size is set to
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   172
		the template size or if that's not available to the
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   173
		doc size.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   174
		'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   175
		#### NEVER EVER EVER COMPARE FLOATS FOR EQUALITY
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   176
		#RGB converting pagesizes to ints means we are accurate to one point
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   177
		#RGB I suggest we should be aiming a little better
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   178
		cp = None
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   179
		dp = None
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   180
		sp = None
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   181
		if canv._pagesize: cp = map(int, canv._pagesize)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   182
		if self.pagesize: sp = map(int, self.pagesize)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   183
		if doc.pagesize: dp = map(int, doc.pagesize)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   184
		if cp!=sp:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   185
			if sp:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   186
				canv.setPageSize(self.pagesize)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   187
			elif cp!=dp:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   188
				canv.setPageSize(doc.pagesize)
936
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   189
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   190
	def afterDrawPage(self, canv, doc):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   191
		"""This is called after the last flowable for the page has
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   192
		been processed.  You might use this if the page header or
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   193
		footer needed knowledge of what flowables were drawn on
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   194
		this page."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   195
		pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   196
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   197
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   198
class BaseDocTemplate:
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   199
	"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   200
	First attempt at defining a document template class.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   201
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   202
	The basic idea is simple.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   203
	0)	The document has a list of data associated with it
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   204
		this data should derive from flowables. We'll have
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   205
		special classes like PageBreak, FrameBreak to do things
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   206
		like forcing a page end etc.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   207
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   208
	1)	The document has one or more page templates.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   209
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   210
	2)	Each page template has one or more frames.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   211
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   212
	3)	The document class provides base methods for handling the
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   213
		story events and some reasonable methods for getting the
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   214
		story flowables into the frames.
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   215
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   216
	4)	The document instances can override the base handler routines.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   217
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   218
	Most of the methods for this class are not called directly by the user,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   219
	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
   220
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   221
	EXCEPTION: doctemplate.build(...) must be called for most reasonable uses
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   222
	since it builds a document using the page template.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   223
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   224
	Each document template builds exactly one document into a file specified
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   225
	by the filename argument on initialization.
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   226
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   227
	Possible keyword arguments for the initialization:
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   228
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   229
	pageTemplates: A list of templates.  Must be nonempty.	Names
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   230
	  assigned to the templates are used for referring to them so no two used
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   231
	  templates should have the same name.	For example you might want one template
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   232
	  for a title page, one for a section first page, one for a first page of
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   233
	  a chapter and two more for the interior of a chapter on odd and even pages.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   234
	  If this argument is omitted then at least one pageTemplate should be provided
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   235
	  using the addPageTemplates method before the document is built.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   236
	showBoundary: if set draw a box around the frame boundaries.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   237
	leftMargin:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   238
	rightMargin:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   239
	topMargin:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   240
	bottomMargin:  Margin sizes in points (default 1 inch)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   241
	  These margins may be overridden by the pageTemplates.  They are primarily of interest
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   242
	  for the SimpleDocumentTemplate subclass.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   243
	allowSplitting:  If set flowables (eg, paragraphs) may be split across frames or pages
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   244
	  (default: 1)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   245
	title: Internal title for document (does not automatically display on any page)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   246
	author: Internal author for document (does not automatically display on any page)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   247
	"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   248
	_initArgs = {	'pagesize':defaultPageSize,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   249
					'pageTemplates':[],
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   250
					'showBoundary':0,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   251
					'leftMargin':inch,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   252
					'rightMargin':inch,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   253
					'topMargin':inch,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   254
					'bottomMargin':inch,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   255
					'allowSplitting':1,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   256
					'title':None,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   257
					'author':None,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   258
					'_pageBreakQuick':1}
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   259
	_invalidInitArgs = ()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   260
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   261
	def __init__(self, filename, **kw):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   262
		"""create a document template bound to a filename (see class documentation for keyword arguments)"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   263
		self.filename = filename
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   264
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   265
		for k in self._initArgs.keys():
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   266
			if not kw.has_key(k):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   267
				v = self._initArgs[k]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   268
			else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   269
				if k in self._invalidInitArgs:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   270
					raise ValueError, "Invalid argument %s" % k
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   271
				v = kw[k]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   272
			setattr(self,k,v)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   273
		#print "pagesize is", self.pagesize
310
cbec783cfb81 Documentation changes
rgbecker
parents: 305
diff changeset
   274
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   275
		p = self.pageTemplates
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   276
		self.pageTemplates = []
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   277
		self.addPageTemplates(p)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   278
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   279
		# facility to assist multi-build and cross-referencing.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   280
		# various hooks can put things into here - key is what
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   281
		# you want, value is a page number.  This can then be
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   282
		# passed to indexing flowables.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   283
		self._pageRefs = {}
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   284
		self._indexingFlowables = []
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   285
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   286
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   287
		#callback facility for progress monitoring
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   288
		self._onPage = None
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   289
		self._onProgress = None
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   290
		self._flowableCount = 0  # so we know how far to go
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   291
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   292
		
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   293
		self._calc()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   294
		self.afterInit()
1502
125b52eb0a8e Added callbacks throughout
andy_robinson
parents: 1440
diff changeset
   295
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   296
	def _calc(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   297
		self._rightMargin = self.pagesize[0] - self.rightMargin
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   298
		self._topMargin = self.pagesize[1] - self.topMargin
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   299
		self.width = self._rightMargin - self.leftMargin
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   300
		self.height = self._topMargin - self.bottomMargin
1502
125b52eb0a8e Added callbacks throughout
andy_robinson
parents: 1440
diff changeset
   301
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   302
	def setPageCallBack(self, func):
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   303
		'Simple progress monitor - func(pageNo) called on each new page'
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   304
		self._onPage = func
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   305
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   306
	def setProgressCallBack(self, func):
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   307
		'''Cleverer progress monitor - func(typ, value) called regularly'''
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   308
		self._onProgress = func
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   309
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   310
	def clean_hanging(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   311
		'handle internal postponed actions'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   312
		while len(self._hanging):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   313
			self.handle_flowable(self._hanging)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   314
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   315
	def addPageTemplates(self,pageTemplates):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   316
		'add one or a sequence of pageTemplates'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   317
		if type(pageTemplates) not in (ListType,TupleType):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   318
			pageTemplates = [pageTemplates]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   319
		#this test below fails due to inconsistent imports!
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   320
		#assert filter(lambda x: not isinstance(x,PageTemplate), pageTemplates)==[], "pageTemplates argument error"
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   321
		for t in pageTemplates:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   322
			self.pageTemplates.append(t)
1502
125b52eb0a8e Added callbacks throughout
andy_robinson
parents: 1440
diff changeset
   323
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   324
	def handle_documentBegin(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   325
		'''implement actions at beginning of document'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   326
		self._hanging = [PageBegin]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   327
		self.pageTemplate = self.pageTemplates[0]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   328
		self.page = 0
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   329
		self.beforeDocument()
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents: 249
diff changeset
   330
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   331
	def handle_pageBegin(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   332
		'''Perform actions required at beginning of page.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   333
		shouldn't normally be called directly'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   334
		self.page = self.page + 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   335
		self.pageTemplate.beforeDrawPage(self.canv,self)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   336
		self.pageTemplate.checkPageSize(self.canv,self)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   337
		self.pageTemplate.onPage(self.canv,self)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   338
		for f in self.pageTemplate.frames: f._reset()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   339
		self.beforePage()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   340
		if hasattr(self,'_nextFrameIndex'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   341
			del self._nextFrameIndex
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   342
		self.frame = self.pageTemplate.frames[0]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   343
		self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   344
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   345
	def handle_pageEnd(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   346
		''' show the current page
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   347
			check the next page template
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   348
			hang a page begin
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   349
		'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   350
		self.pageTemplate.afterDrawPage(self.canv, self)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   351
		self.pageTemplate.onPageEnd(self.canv, self)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   352
		self.afterPage()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   353
		self.canv.showPage()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   354
		if hasattr(self,'_nextPageTemplateIndex'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   355
			self.pageTemplate = self.pageTemplates[self._nextPageTemplateIndex]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   356
			del self._nextPageTemplateIndex
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   357
		self._hanging.append(PageBegin)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   358
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   359
	def handle_pageBreak(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   360
		'''some might choose not to end all the frames'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   361
		if self._pageBreakQuick:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   362
			self.handle_pageEnd()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   363
		else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   364
			n = len(self._hanging)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   365
			while len(self._hanging)==n:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   366
				self.handle_frameEnd()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   367
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   368
	def handle_frameBegin(self,resume=0):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   369
		'''What to do at the beginning of a frame'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   370
		f = self.frame
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   371
		if f._atTop:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   372
			if self.showBoundary or self.frame.showBoundary:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   373
				self.frame.drawBoundary(self.canv)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   374
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   375
	def handle_frameEnd(self,resume=0):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   376
		''' Handles the semantics of the end of a frame. This includes the selection of
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   377
			the next frame or if this is the last frame then invoke pageEnd.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   378
		'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   379
		if hasattr(self,'_nextFrameIndex'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   380
			frame = self.pageTemplate.frames[self._nextFrameIndex]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   381
			del self._nextFrameIndex
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   382
			self.handle_frameBegin(resume)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   383
		elif hasattr(self.frame,'lastFrame') or self.frame is self.pageTemplate.frames[-1]:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   384
			self.handle_pageEnd()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   385
			self.frame = None
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   386
		else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   387
			f = self.frame
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   388
			self.frame = self.pageTemplate.frames[self.pageTemplate.frames.index(f) + 1]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   389
			self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   390
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   391
	def handle_nextPageTemplate(self,pt):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   392
		'''On endPage chenge to the page template with name or index pt'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   393
		if type(pt) is StringType:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   394
			for t in self.pageTemplates:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   395
				if t.id == pt:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   396
					self._nextPageTemplateIndex = self.pageTemplates.index(t)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   397
					return
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   398
			raise ValueError, "can't find template('%s')"%pt
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   399
		elif type(pt) is IntType:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   400
			self._nextPageTemplateIndex = pt
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   401
		else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   402
			raise TypeError, "argument pt should be string or integer"
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   403
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   404
	def handle_nextFrame(self,fx):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   405
		'''On endFrame chenge to the frame with name or index fx'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   406
		if type(fx) is StringType:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   407
			for f in self.pageTemplate.frames:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   408
				if f.id == fx:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   409
					self._nextFrameIndex = self.pageTemplate.frames.index(f)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   410
					return
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   411
			raise ValueError, "can't find frame('%s')"%fx
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   412
		elif type(fx) is IntType:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   413
			self._nextFrameIndex = fx
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   414
		else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   415
			raise TypeError, "argument fx should be string or integer"
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   416
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   417
	def handle_currentFrame(self,fx):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   418
		'''chenge to the frame with name or index fx'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   419
		if type(fx) is StringType:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   420
			for f in self.pageTemplate.frames:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   421
				if f.id == fx:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   422
					self._nextFrameIndex = self.pageTemplate.frames.index(f)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   423
					return
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   424
			raise ValueError, "can't find frame('%s')"%fx
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   425
		elif type(fx) is IntType:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   426
			self._nextFrameIndex = fx
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   427
		else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   428
			raise TypeError, "argument fx should be string or integer"
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   429
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   430
	def handle_breakBefore(self, flowables):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   431
		'''preprocessing step to allow pageBreakBefore and frameBreakBefore attributes'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   432
		first = flowables[0]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   433
		# if we insert a page break before, we'll process that, see it again,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   434
		# and go in an infinite loop.  So we need to set a flag on the object
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   435
		# saying 'skip me'.  This should be unset on the next pass
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   436
		if hasattr(first, '_skipMeNextTime'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   437
			delattr(first, '_skipMeNextTime')
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   438
			return
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   439
		# this could all be made much quicker by putting the attributes
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   440
		# in to the flowables with a defult value of 0
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   441
		if hasattr(first,'pageBreakBefore') and first.pageBreakBefore == 1:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   442
			first._skipMeNextTime = 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   443
			first.insert(0, PageBreak())
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   444
			return
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   445
		if hasattr(first,'style') and hasattr(first.style, 'pageBreakBefore') and first.style.pageBreakBefore == 1:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   446
			first._skipMeNextTime = 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   447
			flowables.insert(0, PageBreak())
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   448
			return
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   449
		if hasattr(first,'frameBreakBefore') and first.frameBreakBefore == 1:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   450
			first._skipMeNextTime = 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   451
			flowables.insert(0, FrameBreak())
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   452
			return
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   453
		if hasattr(first,'style') and hasattr(first.style, 'frameBreakBefore') and first.style.frameBreakBefore == 1:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   454
			first._skipMeNextTime = 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   455
			flowables.insert(0, FrameBreak())
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   456
			return
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   457
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   458
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   459
	def handle_keepWithNext(self, flowables):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   460
		"implements keepWithNext"
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   461
		i = 0
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   462
		n = len(flowables)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   463
		while i<n and flowables[i].getKeepWithNext(): i = i + 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   464
		if i:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   465
			i = i + 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   466
			K = KeepTogether(flowables[:i])
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   467
			for f in K._flowables:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   468
				f.keepWithNext = 0
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   469
			del flowables[:i]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   470
			flowables.insert(0,K)
1425
fa9f74f1a701 Experiments with platypus
andy_robinson
parents: 1324
diff changeset
   471
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   472
	def handle_flowable(self,flowables):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   473
		'''try to handle one flowable from the front of list flowables.'''
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   474
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   475
		#allow document a chance to look at, modify or ignore
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   476
		#the object(s) about to be processed
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   477
		self.filterFlowables(flowables)
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   478
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   479
		self.handle_breakBefore(flowables)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   480
		self.handle_keepWithNext(flowables)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   481
		f = flowables[0]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   482
		del flowables[0]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   483
		if f is None:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   484
			return
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   485
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   486
		if isinstance(f,PageBreak):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   487
			self.handle_pageBreak()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   488
			self.afterFlowable(f)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   489
		elif isinstance(f,ActionFlowable):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   490
			f.apply(self)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   491
			self.afterFlowable(f)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   492
		else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   493
			#try to fit it then draw it
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   494
			if self.frame.add(f, self.canv, trySplit=self.allowSplitting):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   495
				self.afterFlowable(f)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   496
			else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   497
				#if isinstance(f, KeepTogether): print 'could not add it to frame'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   498
				if self.allowSplitting:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   499
					# see if this is a splittable thing
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   500
					S = self.frame.split(f,self.canv)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   501
					n = len(S)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   502
				else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   503
					n = 0
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   504
				#if isinstance(f, KeepTogether): print 'n=%d' % n
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   505
				if n:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   506
					if self.frame.add(S[0], self.canv, trySplit=0):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   507
						self.afterFlowable(S[0])
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   508
					else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   509
						print 'n = %d' % n
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   510
						raise "LayoutError", "splitting error on page %d in\n%s" % (self.page,f.identity(30))
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   511
					del S[0]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   512
					for f in xrange(n-1):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   513
						flowables.insert(f,S[f])	# put split flowables back on the list
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   514
				else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   515
					# this must be cleared when they are finally drawn!
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   516
##					if hasattr(f,'postponed'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   517
					if hasattr(f,'_postponed'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   518
						message = "Flowable %s too large on page %d" % (f.identity(30), self.page)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   519
						#show us, it might be handy
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   520
						#HACK = it seems within tables we sometimes
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   521
						#get an empty paragraph that won't fit and this
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   522
						#causes it to fall over.  FIXME FIXME FIXME
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   523
						raise "LayoutError", message
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   524
##					f.postponed = 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   525
					f._postponed = 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   526
					flowables.insert(0,f)			# put the flowable back
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   527
					self.handle_frameEnd()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   528
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   529
	#these are provided so that deriving classes can refer to them
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   530
	_handle_documentBegin = handle_documentBegin
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   531
	_handle_pageBegin = handle_pageBegin
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   532
	_handle_pageEnd = handle_pageEnd
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   533
	_handle_frameBegin = handle_frameBegin
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   534
	_handle_frameEnd = handle_frameEnd
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   535
	_handle_flowable = handle_flowable
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   536
	_handle_nextPageTemplate = handle_nextPageTemplate
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   537
	_handle_currentFrame = handle_currentFrame
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   538
	_handle_nextFrame = handle_nextFrame
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   539
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   540
	def _startBuild(self, filename=None, canvasmaker=canvas.Canvas):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   541
		self._calc()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   542
		self.canv = canvasmaker(filename or self.filename,pagesize=self.pagesize)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   543
		if self._onPage:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   544
			self.canv.setPageCallBack(self._onPage)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   545
		self.handle_documentBegin()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   546
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   547
	def _endBuild(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   548
		if self._hanging!=[] and self._hanging[-1] is PageBegin:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   549
			del self._hanging[-1]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   550
			self.clean_hanging()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   551
		else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   552
			self.clean_hanging()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   553
			self.handle_pageBreak()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   554
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   555
		if getattr(self,'_doSave',1): self.canv.save()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   556
		if self._onPage: self.canv.setPageCallBack(None)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   557
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   558
	def build(self, flowables, filename=None, canvasmaker=canvas.Canvas):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   559
		"""Build the document from a list of flowables.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   560
		   If the filename argument is provided then that filename is used
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   561
		   rather than the one provided upon initialization.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   562
		   If the canvasmaker argument is provided then it will be used
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   563
		   instead of the default.	For example a slideshow might use
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   564
		   an alternate canvas which places 6 slides on a page (by
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   565
		   doing translations, scalings and redefining the page break
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   566
		   operations).
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   567
		"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   568
		#assert filter(lambda x: not isinstance(x,Flowable), flowables)==[], "flowables argument error"
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   569
		flowableCount = len(flowables)
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   570
		if self._onProgress:
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   571
			self._onProgress('STARTED',0)
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   572
			self._onProgress('SIZE_EST', len(flowables))
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   573
		self._startBuild(filename,canvasmaker)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   574
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   575
		while len(flowables):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   576
			self.clean_hanging()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   577
			self.handle_flowable(flowables)
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   578
			if self._onProgress:
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   579
				self._onProgress('PROGRESS',flowableCount - len(flowables))
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   580
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   581
		self._endBuild()
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   582
		if self._onProgress:
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   583
			self._onProgress('FINISHED',0)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   584
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   585
	def _allSatisfied(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   586
		"""Called by multi-build - are all cross-references resolved?"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   587
		allHappy = 1
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   588
		for f in self._indexingFlowables:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   589
			if not f.isSatisfied():
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   590
				allHappy = 0
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   591
				break
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   592
		return allHappy
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   593
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   594
	def notify(self, kind, stuff):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   595
		""""Forward to any listeners"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   596
		for l in self._indexingFlowables:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   597
			l.notify(kind, stuff)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   598
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   599
	def pageRef(self, label):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   600
		"""hook to register a page number"""
1530
1dedd3370a99 rl_config._verbose ==> verbose
rgbecker
parents: 1505
diff changeset
   601
		if verbose: print "pageRef called with label '%s' on page %d" % (
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   602
			label, self.page)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   603
		self._pageRefs[label] = self.page
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   604
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   605
	def multiBuild(self, story,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   606
				   filename=None,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   607
				   canvasmaker=canvas.Canvas,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   608
				   maxPasses = 10):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   609
		"""Makes multiple passes until all indexing flowables
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   610
		are happy."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   611
		self._indexingFlowables = []
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   612
		#scan the story and keep a copy
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   613
		for thing in story:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   614
			if thing.isIndexing():
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   615
				self._indexingFlowables.append(thing)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   616
		#print 'scanned story, found these indexing flowables:\n'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   617
		#print self._indexingFlowables
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   618
		
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   619
		passes = 0
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   620
		while 1:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   621
			passes = passes + 1
1668
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   622
			if self._onProgress:
448a9205be12 Provision for callback progress monitoring in basic doctemplate class
andy_robinson
parents: 1530
diff changeset
   623
				self.onProgress('PASS', passes)
1530
1dedd3370a99 rl_config._verbose ==> verbose
rgbecker
parents: 1505
diff changeset
   624
			if verbose: print 'building pass '+str(passes) + '...',
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   625
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   626
			for fl in self._indexingFlowables:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   627
				fl.beforeBuild()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   628
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   629
			# work with a copy of the story, since it is consumed
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   630
			tempStory = story[:]
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   631
			self.build(tempStory, filename, canvasmaker)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   632
			#self.notify('debug',None)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   633
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   634
			#clean up so multi-build does not go wrong - the frame
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   635
			#packer might have tacked an attribute onto some
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   636
			#paragraphs
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   637
			for elem in story:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   638
##				if hasattr(elem, 'postponed'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   639
##					del elem.postponed
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   640
				if hasattr(elem, '_postponed'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   641
					del elem._postponed
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   642
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   643
			for fl in self._indexingFlowables:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   644
				fl.afterBuild()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   645
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   646
			happy = self._allSatisfied()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   647
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   648
			if happy:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   649
				## print 'OK'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   650
				break
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   651
			## else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   652
				## print 'failed'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   653
			if passes > maxPasses:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   654
				raise IndexError, "Index entries not resolved after %d passes" % maxPasses
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   655
1530
1dedd3370a99 rl_config._verbose ==> verbose
rgbecker
parents: 1505
diff changeset
   656
		if verbose: print 'saved'
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   657
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   658
	#these are pure virtuals override in derived classes
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   659
	#NB these get called at suitable places by the base class
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   660
	#so if you derive and override the handle_xxx methods
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   661
	#it's up to you to ensure that they maintain the needed consistency
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   662
	def afterInit(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   663
		"""This is called after initialisation of the base class."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   664
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   665
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   666
	def beforeDocument(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   667
		"""This is called before any processing is
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   668
		done on the document."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   669
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   670
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   671
	def beforePage(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   672
		"""This is called at the beginning of page
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   673
		processing, and immediately before the
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   674
		beforeDrawPage method of the current page
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   675
		template."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   676
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   677
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   678
	def afterPage(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   679
		"""This is called after page processing, and
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   680
		immediately after the afterDrawPage method
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   681
		of the current page template."""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   682
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   683
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   684
	def filterFlowables(self,flowables):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   685
		'''called to filter flowables at the start of the main handle_flowable method.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   686
		Upon return if flowables[0] has been set to None it is discarded and the main
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   687
		method returns.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   688
		'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   689
		pass
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   690
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   691
	def afterFlowable(self, flowable):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   692
		'''called after a flowable has been rendered'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   693
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   694
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   695
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   696
class SimpleDocTemplate(BaseDocTemplate):
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   697
	"""A special case document template that will handle many simple documents.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   698
	   See documentation for BaseDocTemplate.  No pageTemplates are required
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   699
	   for this special case.	A page templates are inferred from the
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   700
	   margin information and the onFirstPage, onLaterPages arguments to the build method.
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   701
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   702
	   A document which has all pages with the same look except for the first
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   703
	   page may can be built using this special approach.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   704
	"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   705
	_invalidInitArgs = ('pageTemplates',)
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   706
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   707
	def handle_pageBegin(self):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   708
		'''override base method to add a change of page template after the firstpage.
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   709
		'''
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   710
		self._handle_pageBegin()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   711
		self._handle_nextPageTemplate('Later')
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   712
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   713
	def build(self,flowables,onFirstPage=_doNothing, onLaterPages=_doNothing):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   714
		"""build the document using the flowables.	Annotate the first page using the onFirstPage
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   715
			   function and later pages using the onLaterPages function.  The onXXX pages should follow
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   716
			   the signature
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   717
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   718
				  def myOnFirstPage(canvas, document):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   719
					  # do annotations and modify the document
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   720
					  ...
1428
13a13044e9a8 Fixed up keepWithNext so it works
rgbecker
parents: 1425
diff changeset
   721
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   722
			   The functions can do things like draw logos, page numbers,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   723
			   footers, etcetera. They can use external variables to vary
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   724
			   the look (for example providing page numbering or section names).
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   725
		"""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   726
		self._calc()	#in case we changed margins sizes etc
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   727
		frameT = Frame(self.leftMargin, self.bottomMargin, self.width, self.height, id='normal')
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   728
		self.addPageTemplates([PageTemplate(id='First',frames=frameT, onPage=onFirstPage,pagesize=self.pagesize),
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   729
						PageTemplate(id='Later',frames=frameT, onPage=onLaterPages,pagesize=self.pagesize)])
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   730
		if onFirstPage is _doNothing and hasattr(self,'onFirstPage'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   731
			self.pageTemplates[0].beforeDrawPage = self.onFirstPage
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   732
		if onLaterPages is _doNothing and hasattr(self,'onLaterPages'):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   733
			self.pageTemplates[1].beforeDrawPage = self.onLaterPages
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   734
		BaseDocTemplate.build(self,flowables)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   735
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   736
1669
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   737
def progressCB(typ, value):
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   738
	"""Example prototype for progress monitoring.
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   739
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   740
	This aims to provide info about what is going on
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   741
	during a big job.  It should enable, for example, a reasonably
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   742
	smooth progress bar to be drawn.  We design the argument
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   743
	signature to be predictable and conducive to programming in
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   744
	other (type safe) languages.  If set, this will be called
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   745
	repeatedly with pairs of values.  The first is a string
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   746
	indicating the type of call; the second is a numeric value.
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   747
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   748
	typ 'STARTING', value = 0
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   749
	typ 'SIZE_EST', value = numeric estimate of job size
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   750
	typ 'PASS', value = number of this rendering pass
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   751
	typ 'PROGRESS', value = number between 0 and SIZE_EST
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   752
	typ 'PAGE', value = page number of page
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   753
	type 'FINISHED', value = 0
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   754
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   755
	The sequence is
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   756
		STARTING - always called once
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   757
		SIZE_EST - always called once
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   758
		PROGRESS - called often
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   759
		PAGE - called often when page is emitted
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   760
		FINISHED - called when really, really finished
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   761
	
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   762
	some juggling is needed to accurately estimate numbers of
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   763
	pages in pageDrawing mode.
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   764
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   765
	NOTE: the SIZE_EST is a guess.  It is possible that the
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   766
	PROGRESS value may slightly exceed it, or may even step
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   767
	back a little on rare occasions.  The only way to be
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   768
	really accurate would be to do two passes, and I don't
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   769
	want to take that performance hit.
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   770
	"""
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   771
	print 'PROGRESS MONITOR:  %-10s   %d' % (typ, value)
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   772
31cb4c337e0d Andy's progress stuff
rgbecker
parents: 1668
diff changeset
   773
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   774
	##########################################################
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   775
	##
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   776
	##	 testing
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   777
	##
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   778
	##########################################################
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   779
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   780
def randomText():
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   781
	#this may or may not be appropriate in your company
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   782
	from random import randint, choice
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   783
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   784
	RANDOMWORDS = ['strategic','direction','proactive',
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   785
	'reengineering','forecast','resources',
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   786
	'forward-thinking','profit','growth','doubletalk',
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   787
	'venture capital','IPO']
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   788
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   789
	sentences = 5
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   790
	output = ""
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   791
	for sentenceno in range(randint(1,5)):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   792
		output = output + 'Blah'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   793
		for wordno in range(randint(10,25)):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   794
			if randint(0,4)==0:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   795
				word = choice(RANDOMWORDS)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   796
			else:
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   797
				word = 'blah'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   798
			output = output + ' ' +word
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   799
		output = output+'.'
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   800
	return output
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   801
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   802
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   803
if __name__ == '__main__':
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   804
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   805
	def myFirstPage(canvas, doc):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   806
		canvas.saveState()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   807
		canvas.setStrokeColor(red)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   808
		canvas.setLineWidth(5)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   809
		canvas.line(66,72,66,PAGE_HEIGHT-72)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   810
		canvas.setFont('Times-Bold',24)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   811
		canvas.drawString(108, PAGE_HEIGHT-108, "TABLE OF CONTENTS DEMO")
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   812
		canvas.setFont('Times-Roman',12)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   813
		canvas.drawString(4 * inch, 0.75 * inch, "First Page")
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   814
		canvas.restoreState()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   815
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   816
	def myLaterPages(canvas, doc):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   817
		canvas.saveState()
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   818
		canvas.setStrokeColor(red)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   819
		canvas.setLineWidth(5)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   820
		canvas.line(66,72,66,PAGE_HEIGHT-72)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   821
		canvas.setFont('Times-Roman',12)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   822
		canvas.drawString(4 * inch, 0.75 * inch, "Page %d" % doc.page)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   823
		canvas.restoreState()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   824
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   825
	def run():
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   826
		objects_to_draw = []
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   827
		from reportlab.lib.styles import ParagraphStyle
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   828
		#from paragraph import Paragraph
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   829
		from doctemplate import SimpleDocTemplate
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   830
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   831
		#need a style
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   832
		normal = ParagraphStyle('normal')
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   833
		normal.firstLineIndent = 18
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   834
		normal.spaceBefore = 6
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   835
		import random
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   836
		for i in range(15):
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   837
			height = 0.5 + (2*random.random())
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   838
			box = XBox(6 * inch, height * inch, 'Box Number %d' % i)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   839
			objects_to_draw.append(box)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   840
			para = Paragraph(randomText(), normal)
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   841
			objects_to_draw.append(para)
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   842
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   843
		SimpleDocTemplate('doctemplate.pdf').build(objects_to_draw,
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   844
			onFirstPage=myFirstPage,onLaterPages=myLaterPages)
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   845
1505
e45994cb76bb Allow non-save builds
rgbecker
parents: 1502
diff changeset
   846
	run()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   847