reportlab/platypus/doctemplate.py
author aaron_watters
Thu, 20 Sep 2001 16:02:38 +0000
changeset 1222 e52d533376bc
parent 1131 069fea8037dc
child 1267 118eabbf5ba4
permissions -rw-r--r--
platypus bug where platypus would mess up the pagesize of the canvas fixed.
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
1222
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
     4
#$Header: /tmp/reportlab/reportlab/platypus/doctemplate.py,v 1.43 2001/09/20 16:02:38 aaron_watters Exp $
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
     5
1222
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
     6
__version__=''' $Id: doctemplate.py,v 1.43 2001/09/20 16:02:38 aaron_watters 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
550
1fcf530ec15b Better error message
rgbecker
parents: 512
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
1131
069fea8037dc Added _verbose control
rgbecker
parents: 1103
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):
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    43
	"Dummy callback for onPage"
1fcf530ec15b Better error message
rgbecker
parents: 512
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
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    47
class IndexingFlowable0(Flowable):
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    48
	"""Abstract interface definition for flowables which might
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    49
	hold references to other pages or themselves be targets
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    50
	of cross-references.  XRefStart, XRefDest, Table of Contents,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    51
	Indexes etc."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    52
	def isIndexing(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    53
		return 1
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    54
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    55
	def isSatisfied(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    56
		return 1
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    57
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    58
	def notify(self, kind, stuff):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    59
		"""This will be called by the framework wherever 'stuff' happens.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    60
		'kind' will be a value that can be used to decide whether to
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    61
		pay attention or not."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    62
		pass
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
    63
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    64
	def beforeBuild(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    65
		"""Called by multiBuild before it starts; use this to clear
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    66
		old contents"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    67
		pass
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    68
	
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    69
	def afterBuild(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    70
		"""Called after build ends but before isSatisfied"""
1fcf530ec15b Better error message
rgbecker
parents: 512
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):
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    75
	'''This Flowable is never drawn, it can be used for data driven controls
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    76
	   For example to change a page template (from one column to two, for example)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    77
	   use NextPageTemplate which creates an ActionFlowable.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    78
	'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    79
	def __init__(self,action=[]):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    80
		if type(action) not in (ListType, TupleType):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    81
			action = (action,)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    82
		self.action = action
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    83
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    84
	def wrap(self, availWidth, availHeight):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    85
		'''Should never be called.'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    86
		raise NotImplementedError
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    87
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    88
	def draw(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    89
		'''Should never be called.'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    90
		raise NotImplementedError
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    91
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    92
	def apply(self,doc):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    93
		'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    94
		This is called by the doc.build processing to allow the instance to
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    95
		implement its behaviour
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    96
		'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    97
		action = self.action[0]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    98
		args = tuple(self.action[1:])
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
    99
		arn = 'handle_'+action
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   100
		try:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   101
			apply(getattr(doc,arn), args)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   102
		except AttributeError, aerr:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   103
			if aerr.args[0]==arn:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   104
				raise NotImplementedError, "Can't handle ActionFlowable(%s)" % action
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   105
			else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   106
				raise
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   107
		except "bogus":
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   108
			t, v, None = sys.exc_info()
1fcf530ec15b Better error message
rgbecker
parents: 512
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
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   111
	def __call__(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   112
		return self
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   113
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   114
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   115
FrameBreak = ActionFlowable('frameEnd')
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   116
PageBegin = ActionFlowable('pageBegin')
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   117
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   118
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   119
class NextPageTemplate(ActionFlowable):
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   120
	"""When you get to the next page, use the template specified (change to two column, for example)  """
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   121
	def __init__(self,pt):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   122
		ActionFlowable.__init__(self,('nextPageTemplate',pt))
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   123
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   124
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   125
class PageTemplate:
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   126
	"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   127
	essentially a list of Frames and an onPage routine to call at the start
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   128
	of a page when this is selected. onPageEnd gets called at the end.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   129
	derived classes can also implement beforeDrawPage and afterDrawPage if they want
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   130
	"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   131
	def __init__(self,id=None,frames=[],onPage=_doNothing, onPageEnd=_doNothing,
684
2a43c747527a Changed things to use config.py for defaults
rgbecker
parents: 681
diff changeset
   132
				 pagesize=defaultPageSize):
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   133
		if type(frames) not in (ListType,TupleType): frames = [frames]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   134
		assert filter(lambda x: not isinstance(x,Frame), frames)==[], "frames argument error"
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   135
		self.id = id
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   136
		self.frames = frames
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   137
		self.onPage = onPage
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   138
		self.onPageEnd = onPageEnd
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   139
		self.pagesize = pagesize
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   140
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   141
	def beforeDrawPage(self,canv,doc):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   142
		"""Override this if you want additional functionality or prefer
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   143
		a class based page routine.  Called before any flowables for
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   144
		this page are processed."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   145
		pass
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   146
936
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   147
	def checkPageSize(self,canv,doc):
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   148
		'''This gets called by the template framework'''
1222
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   149
		#print "self.pagesize, canv._pagesize, doc.pagesize",(self.pagesize, canv._pagesize, doc.pagesize)
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   150
		### NEVER EVER EVER COMPARE FLOATS FOR EQUALITY
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   151
		cp = None
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   152
		dp = None
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   153
		sp = None
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   154
		if canv._pagesize: cp = map(int, canv._pagesize)
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   155
		if self.pagesize: sp = map(int, self.pagesize)
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   156
		if doc.pagesize: dp = map(int, doc.pagesize)
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   157
		if cp != dp:
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   158
			if sp:
936
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   159
				canv.setPageSize(self.pagesize)
1222
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   160
			elif cp != dp:
936
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   161
				canv.setPageSize(doc.pagesize)
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   162
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   163
	def afterDrawPage(self, canv, doc):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   164
		"""This is called after the last flowable for the page has
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   165
		been processed.  You might use this if the page header or
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   166
		footer needed knowledge of what flowables were drawn on
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   167
		this page."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   168
		pass
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   169
		
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   170
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   171
class BaseDocTemplate:
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   172
	"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   173
	First attempt at defining a document template class.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   174
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   175
	The basic idea is simple.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   176
	0)	The document has a list of data associated with it
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   177
		this data should derive from flowables. We'll have
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   178
		special classes like PageBreak, FrameBreak to do things
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   179
		like forcing a page end etc.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   180
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   181
	1)	The document has one or more page templates.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   182
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   183
	2)	Each page template has one or more frames.
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   184
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   185
	3)	The document class provides base methods for handling the
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   186
		story events and some reasonable methods for getting the
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   187
		story flowables into the frames.
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   188
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   189
	4)	The document instances can override the base handler routines.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   190
	
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   191
	Most of the methods for this class are not called directly by the user,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   192
	but in some advanced usages they may need to be overridden via subclassing.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   193
	
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   194
	EXCEPTION: doctemplate.build(...) must be called for most reasonable uses
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   195
	since it builds a document using the page template.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   196
	
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   197
	Each document template builds exactly one document into a file specified
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   198
	by the filename argument on initialization.
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   199
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   200
	Possible keyword arguments for the initialization:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   201
	
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   202
	pageTemplates: A list of templates.  Must be nonempty.	Names
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   203
	  assigned to the templates are used for referring to them so no two used
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   204
	  templates should have the same name.	For example you might want one template
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   205
	  for a title page, one for a section first page, one for a first page of
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   206
	  a chapter and two more for the interior of a chapter on odd and even pages.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   207
	  If this argument is omitted then at least one pageTemplate should be provided
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   208
	  using the addPageTemplates method before the document is built.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   209
	showBoundary: if set draw a box around the frame boundaries.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   210
	leftMargin:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   211
	rightMargin:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   212
	topMargin:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   213
	bottomMargin:  Margin sizes in points (default 1 inch)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   214
	  These margins may be overridden by the pageTemplates.  They are primarily of interest
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   215
	  for the SimpleDocumentTemplate subclass.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   216
	allowSplitting:  If set flowables (eg, paragraphs) may be split across frames or pages
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   217
	  (default: 1)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   218
	title: Internal title for document (does not automatically display on any page)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   219
	author: Internal author for document (does not automatically display on any page)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   220
	"""
684
2a43c747527a Changed things to use config.py for defaults
rgbecker
parents: 681
diff changeset
   221
	_initArgs = {	'pagesize':defaultPageSize,
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   222
					'pageTemplates':[],
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   223
					'showBoundary':0,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   224
					'leftMargin':inch,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   225
					'rightMargin':inch,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   226
					'topMargin':inch,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   227
					'bottomMargin':inch,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   228
					'allowSplitting':1,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   229
					'title':None,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   230
					'author':None,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   231
					'_pageBreakQuick':1}
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   232
	_invalidInitArgs = ()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   233
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   234
	def __init__(self, filename, **kw):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   235
		"""create a document template bound to a filename (see class documentation for keyword arguments)"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   236
		self.filename = filename
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   237
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   238
		for k in self._initArgs.keys():
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   239
			if not kw.has_key(k):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   240
				v = self._initArgs[k]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   241
			else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   242
				if k in self._invalidInitArgs:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   243
					raise ValueError, "Invalid argument %s" % k
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   244
				v = kw[k]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   245
			setattr(self,k,v)
1222
e52d533376bc platypus bug where platypus would mess up the pagesize of the canvas fixed.
aaron_watters
parents: 1131
diff changeset
   246
		#print "pagesize is", self.pagesize
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   247
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   248
		p = self.pageTemplates
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   249
		self.pageTemplates = []
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   250
		self.addPageTemplates(p)
310
cbec783cfb81 Documentation changes
rgbecker
parents: 305
diff changeset
   251
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   252
		# facility to assist multi-build and cross-referencing.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   253
		# various hooks can put things into here - key is what
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   254
		# you want, value is a page number.  This can then be
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   255
		# passed to indexing flowables.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   256
		self._pageRefs = {}
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   257
		self._indexingFlowables = []
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   258
		
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   259
		self._calc()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   260
		self.afterInit()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   261
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   262
	def _calc(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   263
		self._rightMargin = self.pagesize[0] - self.rightMargin
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   264
		self._topMargin = self.pagesize[1] - self.topMargin
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   265
		self.width = self._rightMargin - self.leftMargin
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   266
		self.height = self._topMargin - self.bottomMargin
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   267
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   268
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   269
	def clean_hanging(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   270
		'handle internal postponed actions'
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   271
		while len(self._hanging):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   272
			self.handle_flowable(self._hanging)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   273
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   274
	def addPageTemplates(self,pageTemplates):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   275
		'add one or a sequence of pageTemplates'
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   276
		if type(pageTemplates) not in (ListType,TupleType):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   277
			pageTemplates = [pageTemplates]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   278
		#this test below fails due to inconsistent imports!
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   279
		#assert filter(lambda x: not isinstance(x,PageTemplate), pageTemplates)==[], "pageTemplates argument error"
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   280
		for t in pageTemplates:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   281
			self.pageTemplates.append(t)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   282
			
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   283
	def handle_documentBegin(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   284
		'''implement actions at beginning of document'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   285
		self._hanging = [PageBegin]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   286
		self.pageTemplate = self.pageTemplates[0]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   287
		self.page = 0
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   288
		self.beforeDocument()
253
cfcf8d555a2c Platypus re-organisation
rgbecker
parents: 249
diff changeset
   289
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   290
	def handle_pageBegin(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   291
		'''Perform actions required at beginning of page.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   292
		shouldn't normally be called directly'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   293
		self.page = self.page + 1
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   294
		self.pageTemplate.beforeDrawPage(self.canv,self)
936
bd83a2a40227 Dynamic page sizes
rgbecker
parents: 724
diff changeset
   295
		self.pageTemplate.checkPageSize(self.canv,self)
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   296
		self.pageTemplate.onPage(self.canv,self)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   297
		self.beforePage()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   298
		if hasattr(self,'_nextFrameIndex'):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   299
			del self._nextFrameIndex
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   300
		self.frame = self.pageTemplate.frames[0]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   301
		self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   302
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   303
	def handle_pageEnd(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   304
		''' show the current page
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   305
			check the next page template
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   306
			hang a page begin
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   307
		'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   308
		self.pageTemplate.afterDrawPage(self.canv, self)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   309
		self.pageTemplate.onPageEnd(self.canv, self)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   310
		self.afterPage()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   311
		self.canv.showPage()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   312
		if hasattr(self,'_nextPageTemplateIndex'):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   313
			self.pageTemplate = self.pageTemplates[self._nextPageTemplateIndex]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   314
			del self._nextPageTemplateIndex
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   315
		self._hanging.append(PageBegin)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   316
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   317
	def handle_pageBreak(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   318
		'''some might choose not to end all the frames'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   319
		if self._pageBreakQuick:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   320
			self.handle_pageEnd()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   321
		else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   322
			n = len(self._hanging)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   323
			while len(self._hanging)==n:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   324
				self.handle_frameEnd()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   325
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   326
	def handle_frameBegin(self,*args):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   327
		'''What to do at the beginning of a page'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   328
		self.frame._reset()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   329
		if self.showBoundary or self.frame.showBoundary:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   330
			self.frame.drawBoundary(self.canv)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   331
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   332
	def handle_frameEnd(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   333
		''' Handles the semantics of the end of a frame. This includes the selection of
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   334
			the next frame or if this is the last frame then invoke pageEnd.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   335
		'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   336
		if hasattr(self,'_nextFrameIndex'):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   337
			frame = self.pageTemplate.frames[self._nextFrameIndex]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   338
			del self._nextFrameIndex
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   339
			self.handle_frameBegin()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   340
		elif hasattr(self.frame,'lastFrame') or self.frame is self.pageTemplate.frames[-1]:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   341
			self.handle_pageEnd()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   342
			self.frame = None
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   343
		else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   344
			f = self.frame
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   345
			self.frame = self.pageTemplate.frames[self.pageTemplate.frames.index(f) + 1]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   346
			self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   347
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   348
	def handle_nextPageTemplate(self,pt):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   349
		'''On endPage chenge to the page template with name or index pt'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   350
		if type(pt) is StringType:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   351
			for t in self.pageTemplates:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   352
				if t.id == pt:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   353
					self._nextPageTemplateIndex = self.pageTemplates.index(t)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   354
					return
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   355
			raise ValueError, "can't find template('%s')"%pt
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   356
		elif type(pt) is IntType:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   357
			self._nextPageTemplateIndex = pt
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   358
		else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   359
			raise TypeError, "argument pt should be string or integer"
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   360
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   361
	def handle_nextFrame(self,fx):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   362
		'''On endFrame chenge to the frame with name or index fx'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   363
		if type(fx) is StringType:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   364
			for f in self.pageTemplate.frames:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   365
				if f.id == fx:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   366
					self._nextFrameIndex = self.pageTemplate.frames.index(f)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   367
					return
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   368
			raise ValueError, "can't find frame('%s')"%fx
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   369
		elif type(fx) is IntType:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   370
			self._nextFrameIndex = fx
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   371
		else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   372
			raise TypeError, "argument fx should be string or integer"
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   373
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   374
	def handle_currentFrame(self,fx):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   375
		'''chenge to the frame with name or index fx'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   376
		if type(fx) is StringType:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   377
			for f in self.pageTemplate.frames:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   378
				if f.id == fx:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   379
					self._nextFrameIndex = self.pageTemplate.frames.index(f)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   380
					return
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   381
			raise ValueError, "can't find frame('%s')"%fx
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   382
		elif type(fx) is IntType:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   383
			self._nextFrameIndex = fx
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   384
		else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   385
			raise TypeError, "argument fx should be string or integer"
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   386
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   387
	def handle_flowable(self,flowables):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   388
		'''try to handle one flowable from the front of list flowables.'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   389
		
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   390
		#allow document a chance to look at, modify or ignore
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   391
		#the object(s) about to be processed
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   392
		self.filterFlowables(flowables)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   393
		f = flowables[0]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   394
		del flowables[0]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   395
		if f is None:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   396
			return
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   397
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   398
		if isinstance(f,PageBreak):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   399
			self.handle_pageBreak()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   400
			self.afterFlowable(f)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   401
		elif isinstance(f,ActionFlowable):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   402
			f.apply(self)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   403
			self.afterFlowable(f)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   404
		else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   405
			#general case we have to do something
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   406
			if self.frame.add(f, self.canv, trySplit=self.allowSplitting):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   407
				self.afterFlowable(f)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   408
			else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   409
				if self.allowSplitting:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   410
					# see if this is a splittable thing
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   411
					S = self.frame.split(f,self.canv)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   412
					n = len(S)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   413
				else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   414
					n = 0
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   415
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   416
				if n:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   417
					if self.frame.add(S[0], self.canv, trySplit=0):
551
21b8a2cb8c8b Hack to fix Dinu's problem
rgbecker
parents: 550
diff changeset
   418
						self.afterFlowable(S[0])
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   419
					else:
1103
857af510186d Added identity method to Flowables
rgbecker
parents: 936
diff changeset
   420
						raise "LayoutError", "splitting error on page %d in\n%s" % (self.page,f.identity(30))
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   421
					del S[0]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   422
					for f in xrange(n-1):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   423
						flowables.insert(f,S[f])	# put split flowables back on the list
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   424
				else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   425
					# this must be cleared when they are finally drawn!
698
864265047890 Changed attribute postponed to _postponed in doctemplate.py.
dinu_gherman
parents: 684
diff changeset
   426
##					if hasattr(f,'postponed'):
864265047890 Changed attribute postponed to _postponed in doctemplate.py.
dinu_gherman
parents: 684
diff changeset
   427
					if hasattr(f,'_postponed'):
1103
857af510186d Added identity method to Flowables
rgbecker
parents: 936
diff changeset
   428
						message = "Flowable %s too large on page %d" % (f.identity(30), self.page)
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   429
						#show us, it might be handy
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   430
						#HACK = it seems within tables we sometimes
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   431
						#get an empty paragraph that won't fit and this
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   432
						#causes it to fall over.  FIXME FIXME FIXME
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   433
						raise "LayoutError", message
698
864265047890 Changed attribute postponed to _postponed in doctemplate.py.
dinu_gherman
parents: 684
diff changeset
   434
##					f.postponed = 1
864265047890 Changed attribute postponed to _postponed in doctemplate.py.
dinu_gherman
parents: 684
diff changeset
   435
					f._postponed = 1
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   436
					flowables.insert(0,f)			# put the flowable back
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   437
					self.handle_frameEnd()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   438
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   439
	#these are provided so that deriving classes can refer to them
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   440
	_handle_documentBegin = handle_documentBegin
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   441
	_handle_pageBegin = handle_pageBegin
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   442
	_handle_pageEnd = handle_pageEnd
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   443
	_handle_frameBegin = handle_frameBegin
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   444
	_handle_frameEnd = handle_frameEnd
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   445
	_handle_flowable = handle_flowable
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   446
	_handle_nextPageTemplate = handle_nextPageTemplate
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   447
	_handle_currentFrame = handle_currentFrame
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   448
	_handle_nextFrame = handle_nextFrame
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   449
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   450
	def _startBuild(self, filename=None, canvasmaker=canvas.Canvas):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   451
		self._calc()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   452
		self.canv = canvasmaker(filename or self.filename,pagesize=self.pagesize)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   453
		self.handle_documentBegin()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   454
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   455
	def _endBuild(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   456
		if self._hanging!=[] and self._hanging[-1] is PageBegin:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   457
			del self._hanging[-1]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   458
			self.clean_hanging()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   459
		else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   460
			self.clean_hanging()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   461
			self.handle_pageBreak()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   462
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   463
		self.canv.save()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   464
		#AR - hack - for some reason a document did not
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   465
		#have these:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   466
		#if hasattr(self, 'frame'): del self.frame
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   467
		#if hasattr(self, 'pageTemplate'): del self.pageTemplate
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   468
		#del self.frame, self.pageTemplate
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   469
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   470
	def build(self, flowables, filename=None, canvasmaker=canvas.Canvas):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   471
		"""Build the document from a list of flowables.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   472
		   If the filename argument is provided then that filename is used
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   473
		   rather than the one provided upon initialization.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   474
		   If the canvasmaker argument is provided then it will be used
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   475
		   instead of the default.	For example a slideshow might use
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   476
		   an alternate canvas which places 6 slides on a page (by
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   477
		   doing translations, scalings and redefining the page break
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   478
		   operations).
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   479
		"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   480
		#assert filter(lambda x: not isinstance(x,Flowable), flowables)==[], "flowables argument error"
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   481
		self._startBuild(filename,canvasmaker)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   482
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   483
		while len(flowables):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   484
			self.clean_hanging()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   485
			self.handle_flowable(flowables)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   486
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   487
		self._endBuild()
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   488
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   489
	def _allSatisfied0(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   490
		"""Called by multi-build - are all cross-references resolved?"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   491
		allHappy = 1
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   492
		for f in self._indexingFlowables:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   493
			if not f.isSatisfied():
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   494
				allHappy = 0
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   495
				break
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   496
		return allHappy    
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   497
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   498
	def notify0(self, kind, stuff):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   499
		""""Forward to any listeners"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   500
		for l in self._indexingFlowables:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   501
			l.notify(kind, stuff)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   502
			
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   503
	def pageRef0(self, label):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   504
		"""hook to register a page number"""
1131
069fea8037dc Added _verbose control
rgbecker
parents: 1103
diff changeset
   505
		if _verbose: print "pageRef called with label '%s' on page %d" % (
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   506
			label, self.page)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   507
		self._pageRefs[label] = self.page
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   508
		
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   509
	def multiBuild0(self, story,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   510
				   filename=None,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   511
				   canvasmaker=canvas.Canvas,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   512
				   maxPasses = 10):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   513
		"""Makes multiple passes until all indexing flowables
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   514
		are happy."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   515
		self._indexingFlowables = []
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   516
		#scan the story and keep a copy
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   517
		for thing in story:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   518
			if thing.isIndexing():
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   519
				self._indexingFlowables.append(thing)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   520
		#print 'scanned story, found these indexing flowables:\n'
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   521
		#print self._indexingFlowables
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   522
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   523
		passes = 0
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   524
		while 1:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   525
			passes = passes + 1
1131
069fea8037dc Added _verbose control
rgbecker
parents: 1103
diff changeset
   526
			if _verbose: print 'building pass '+str(passes) + '...',
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   527
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   528
			for fl in self._indexingFlowables:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   529
				fl.beforeBuild()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   530
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   531
			# work with a copy of the story, since it is consumed
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   532
			tempStory = story[:]
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   533
			self.build(tempStory, filename, canvasmaker)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   534
			#self.notify0('debug',None)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   535
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   536
			#clean up so multi-build does not go wrong - the frame
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   537
			#packer might have tacked an attribute onto some
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   538
			#paragraphs
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   539
			for elem in story:
698
864265047890 Changed attribute postponed to _postponed in doctemplate.py.
dinu_gherman
parents: 684
diff changeset
   540
##				if hasattr(elem, 'postponed'):
864265047890 Changed attribute postponed to _postponed in doctemplate.py.
dinu_gherman
parents: 684
diff changeset
   541
##					del elem.postponed
864265047890 Changed attribute postponed to _postponed in doctemplate.py.
dinu_gherman
parents: 684
diff changeset
   542
				if hasattr(elem, '_postponed'):
864265047890 Changed attribute postponed to _postponed in doctemplate.py.
dinu_gherman
parents: 684
diff changeset
   543
					del elem._postponed
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   544
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   545
			for fl in self._indexingFlowables:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   546
				fl.afterBuild()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   547
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   548
			happy = self._allSatisfied0()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   549
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   550
			if happy:
618
d9159ec67dbd Commented some disturbing print statements.
dinu_gherman
parents: 565
diff changeset
   551
				## print 'OK'
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   552
				break
618
d9159ec67dbd Commented some disturbing print statements.
dinu_gherman
parents: 565
diff changeset
   553
			## else:
d9159ec67dbd Commented some disturbing print statements.
dinu_gherman
parents: 565
diff changeset
   554
				## print 'failed'
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   555
			if passes > maxPasses:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   556
				raise IndexError, "Index entries not resolved after %d passes" % maxPasses
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   557
		
1131
069fea8037dc Added _verbose control
rgbecker
parents: 1103
diff changeset
   558
		if _verbose: print 'saved'
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   559
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   560
	#these are pure virtuals override in derived classes
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   561
	#NB these get called at suitable places by the base class
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   562
	#so if you derive and override the handle_xxx methods
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   563
	#it's up to you to ensure that they maintain the needed consistency
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   564
	def afterInit(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   565
		"""This is called after initialisation of the base class."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   566
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   567
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   568
	def beforeDocument(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   569
		"""This is called before any processing is
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   570
		done on the document."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   571
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   572
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   573
	def beforePage(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   574
		"""This is called at the beginning of page
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   575
		processing, and immediately before the
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   576
		beforeDrawPage method of the current page
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   577
		template."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   578
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   579
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   580
	def afterPage(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   581
		"""This is called after page processing, and
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   582
		immediately after the afterDrawPage method
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   583
		of the current page template."""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   584
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   585
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   586
	def filterFlowables(self,flowables):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   587
		'''called to filter flowables at the start of the main handle_flowable method.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   588
		Upon return if flowables[0] has been set to None it is discarded and the main
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   589
		method returns.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   590
		'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   591
		pass
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   592
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   593
	def afterFlowable(self, flowable):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   594
		'''called after a flowable has been rendered'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   595
		pass
284
eabeb5f4e851 Added UserDocTemplate class, and paragraph.getPlainText()
andy_robinson
parents: 279
diff changeset
   596
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   597
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   598
class SimpleDocTemplate(BaseDocTemplate):
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   599
	"""A special case document template that will handle many simple documents.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   600
	   See documentation for BaseDocTemplate.  No pageTemplates are required 
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   601
	   for this special case.	A page templates are inferred from the
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   602
	   margin information and the onFirstPage, onLaterPages arguments to the build method.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   603
	   
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   604
	   A document which has all pages with the same look except for the first
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   605
	   page may can be built using this special approach.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   606
	"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   607
	_invalidInitArgs = ('pageTemplates',)
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   608
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   609
	def handle_pageBegin(self):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   610
		'''override base method to add a change of page template after the firstpage.
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   611
		'''
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   612
		self._handle_pageBegin()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   613
		self._handle_nextPageTemplate('Later')
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   614
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   615
	def build(self,flowables,onFirstPage=_doNothing, onLaterPages=_doNothing):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   616
		"""build the document using the flowables.	Annotate the first page using the onFirstPage
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   617
			   function and later pages using the onLaterPages function.  The onXXX pages should follow
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   618
			   the signature
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   619
			   
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   620
				  def myOnFirstPage(canvas, document):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   621
					  # do annotations and modify the document
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   622
					  ...
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   623
					  
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   624
			   The functions can do things like draw logos, page numbers,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   625
			   footers, etcetera. They can use external variables to vary
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   626
			   the look (for example providing page numbering or section names).
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   627
		"""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   628
		self._calc()	#in case we changed margins sizes etc
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   629
		frameT = Frame(self.leftMargin, self.bottomMargin, self.width, self.height, id='normal')
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   630
		self.addPageTemplates([PageTemplate(id='First',frames=frameT, onPage=onFirstPage),
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   631
						PageTemplate(id='Later',frames=frameT, onPage=onLaterPages)])
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   632
		if onFirstPage is _doNothing and hasattr(self,'onFirstPage'):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   633
			self.pageTemplates[0].beforeDrawPage = self.onFirstPage
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   634
		if onLaterPages is _doNothing and hasattr(self,'onLaterPages'):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   635
			self.pageTemplates[1].beforeDrawPage = self.onLaterPages
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   636
		BaseDocTemplate.build(self,flowables)
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   637
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   638
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   639
	##########################################################
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   640
	##
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   641
	##	 testing
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   642
	##
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   643
	##########################################################
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   644
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   645
def randomText():
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   646
	#this may or may not be appropriate in your company
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   647
	from random import randint, choice
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   648
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   649
	RANDOMWORDS = ['strategic','direction','proactive',
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   650
	'reengineering','forecast','resources',
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   651
	'forward-thinking','profit','growth','doubletalk',
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   652
	'venture capital','IPO']
512
c12ae96634d5 Added working table of contents framework
andy_robinson
parents: 500
diff changeset
   653
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   654
	sentences = 5
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   655
	output = ""
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   656
	for sentenceno in range(randint(1,5)):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   657
		output = output + 'Blah'
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   658
		for wordno in range(randint(10,25)):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   659
			if randint(0,4)==0:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   660
				word = choice(RANDOMWORDS)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   661
			else:
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   662
				word = 'blah'
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   663
			output = output + ' ' +word
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   664
		output = output+'.'
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   665
	return output
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   666
565
179927300074 Minor changes.
dinu_gherman
parents: 551
diff changeset
   667
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   668
if __name__ == '__main__':
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   669
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   670
	def myFirstPage(canvas, doc):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   671
		canvas.saveState()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   672
		canvas.setStrokeColor(red)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   673
		canvas.setLineWidth(5)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   674
		canvas.line(66,72,66,PAGE_HEIGHT-72)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   675
		canvas.setFont('Times-Bold',24)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   676
		canvas.drawString(108, PAGE_HEIGHT-108, "TABLE OF CONTENTS DEMO")
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   677
		canvas.setFont('Times-Roman',12)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   678
		canvas.drawString(4 * inch, 0.75 * inch, "First Page")
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   679
		canvas.restoreState()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   680
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   681
	def myLaterPages(canvas, doc):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   682
		canvas.saveState()
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   683
		canvas.setStrokeColor(red)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   684
		canvas.setLineWidth(5)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   685
		canvas.line(66,72,66,PAGE_HEIGHT-72)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   686
		canvas.setFont('Times-Roman',12)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   687
		canvas.drawString(4 * inch, 0.75 * inch, "Page %d" % doc.page)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   688
		canvas.restoreState()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   689
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   690
	def run():
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   691
		objects_to_draw = []
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   692
		from reportlab.lib.styles import ParagraphStyle
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   693
		#from paragraph import Paragraph
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   694
		from doctemplate import SimpleDocTemplate
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   695
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   696
		#need a style
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   697
		normal = ParagraphStyle('normal')
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   698
		normal.firstLineIndent = 18
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   699
		normal.spaceBefore = 6
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   700
		import random
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   701
		for i in range(15):
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   702
			height = 0.5 + (2*random.random())
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   703
			box = XBox(6 * inch, height * inch, 'Box Number %d' % i)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   704
			objects_to_draw.append(box)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   705
			para = Paragraph(randomText(), normal)
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   706
			objects_to_draw.append(para)
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   707
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   708
		SimpleDocTemplate('doctemplate.pdf').build(objects_to_draw,
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   709
			onFirstPage=myFirstPage,onLaterPages=myLaterPages)
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   710
550
1fcf530ec15b Better error message
rgbecker
parents: 512
diff changeset
   711
	run()
221
3d71b66b14c6 Changes related to removal of SimpleFlowDocument
rgbecker
parents: 218
diff changeset
   712