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