reportlab/platypus/doctemplate.py
author rgbecker
Tue, 16 May 2000 14:28:55 +0000
changeset 218 274db2129c04
parent 214 be55cfb3e54f
child 221 3d71b66b14c6
permissions -rw-r--r--
Fixes/Changes to get testplatypus to work with new framework
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     1
###############################################################################
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     2
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     3
#	ReportLab Public License Version 1.0
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     4
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     5
#   Except for the change of names the spirit and intention of this
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     6
#   license is the same as that of Python
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     7
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     8
#	(C) Copyright ReportLab Inc. 1998-2000.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
     9
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    10
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    11
# All Rights Reserved
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    12
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    13
# Permission to use, copy, modify, and distribute this software and its
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    14
# documentation for any purpose and without fee is hereby granted, provided
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    15
# that the above copyright notice appear in all copies and that both that
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    16
# copyright notice and this permission notice appear in supporting
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    17
# documentation, and that the name of ReportLab not be used
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    18
# in advertising or publicity pertaining to distribution of the software
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    19
# without specific, written prior permission. 
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    20
# 
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    21
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    22
# Disclaimer
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    23
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    24
# ReportLab Inc. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    25
# SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    26
# IN NO EVENT SHALL ReportLab BE LIABLE FOR ANY SPECIAL, INDIRECT
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    27
# OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    28
# OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    29
# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    30
# PERFORMANCE OF THIS SOFTWARE. 
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    31
#
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    32
###############################################################################
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    33
#	$Log: doctemplate.py,v $
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    34
#	Revision 1.7  2000/05/16 14:28:55  rgbecker
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    35
#	Fixes/Changes to get testplatypus to work with new framework
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    36
#
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
    37
#	Revision 1.6  2000/05/15 15:07:32  rgbecker
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
    38
#	Added drawPage
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    39
#	
206
8c0649978a61 fix typo in import
rgbecker
parents: 204
diff changeset
    40
#	Revision 1.5  2000/05/13 08:33:53  rgbecker
8c0649978a61 fix typo in import
rgbecker
parents: 204
diff changeset
    41
#	fix typo in import
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
    42
#	
204
b19c3cae893a _donothing explicit import
rgbecker
parents: 200
diff changeset
    43
#	Revision 1.4  2000/05/12 16:21:02  rgbecker
b19c3cae893a _donothing explicit import
rgbecker
parents: 200
diff changeset
    44
#	_donothing explicit import
206
8c0649978a61 fix typo in import
rgbecker
parents: 204
diff changeset
    45
#	
200
74da573e661f Handle splitting error in build
rgbecker
parents: 199
diff changeset
    46
#	Revision 1.3  2000/05/12 14:53:38  rgbecker
74da573e661f Handle splitting error in build
rgbecker
parents: 199
diff changeset
    47
#	Handle splitting error in build
204
b19c3cae893a _donothing explicit import
rgbecker
parents: 200
diff changeset
    48
#	
199
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    49
#	Revision 1.2  2000/05/12 14:45:31  rgbecker
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    50
#	Single actions only in ActionFlowables
200
74da573e661f Handle splitting error in build
rgbecker
parents: 199
diff changeset
    51
#	
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    52
#	Revision 1.1  2000/05/12 12:53:33  rgbecker
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    53
#	Initial try at a document template class
199
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    54
#	
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    55
__version__=''' $Id: doctemplate.py,v 1.7 2000/05/16 14:28:55 rgbecker Exp $ '''
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    56
__doc__="""
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    57
More complicated Document model
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    58
"""
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    59
from layout import *
206
8c0649978a61 fix typo in import
rgbecker
parents: 204
diff changeset
    60
from layout import _doNothing
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    61
from types import *
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    62
import sys
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    63
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    64
class ActionFlowable(Flowable):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    65
	'''This Flowable is never drawn, it can be used for data driven controls'''
199
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    66
	def __init__(self,action=[]):
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    67
		if type(action) not in (ListType, TupleType):
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    68
			action = (action,)
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    69
		self.action = action
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    70
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    71
	def wrap(self, availWidth, availHeight):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    72
		raise NotImplementedError
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    73
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    74
	def draw(self):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    75
		raise NotImplementedError
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    76
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    77
	def apply(self,doc):
199
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    78
		action = self.action[0]
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    79
		args = tuple(self.action[1:])
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    80
		try:
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    81
			apply(getattr(doc,'handle_'+action), args)
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    82
		except AttributeError:
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    83
			raise NotImplementedError, "Can't handle ActionFlowable(%s)" % action
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    84
		except:
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    85
			t, v, None = sys.exc_info()
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    86
			raise t, "%s\n   handle_%s args=%s"%(v,action,args)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    87
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    88
	def __call__(self):
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    89
		return self
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    90
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
    91
FrameBreak = ActionFlowable('frameEnd')
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    92
PageBegin = ActionFlowable('pageBegin')
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    93
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    94
class NextPageTemplate(ActionFlowable):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    95
	def __init__(self,pt):
199
7de4e498ce32 Single actions only in ActionFlowables
rgbecker
parents: 197
diff changeset
    96
		ActionFlowable.__init__(self,('nextPageTemplate',pt))
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    97
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    98
class PageTemplate:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
    99
	"""
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   100
	essentially a list of BasicFrames and an onPage routine to call at the start
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   101
	of a page when this is selected.
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   102
	derived classes can also implement drawPage if they want
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   103
	"""
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   104
	def __init__(self,id=None,frames=[],onPage=None):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   105
		if type(frames) not in (ListType,TupleType): frames = [frames]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   106
		assert filter(lambda x: not isinstance(x,BasicFrame), frames)==[], "frames argument error"
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   107
		self.id = id
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   108
		self.frames = frames
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   109
		self.onPage = onPage or _doNothing
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   110
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   111
	def drawPage(self,canv,doc):
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   112
		'''	Override this if you want additional functionality or prefer a class
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   113
			based page routine
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   114
		'''
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   115
		pass
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   116
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   117
class BaseDocTemplate:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   118
	"""
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   119
	First attempt at defining a document template class.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   120
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   121
	The basic idea is simple.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   122
	0)	The document has a list of data associated with it
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   123
		this data should derive from flowables. We'll have
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   124
		special classes like PageBreak, FrameBreak to do things
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   125
		like forcing a page end etc.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   126
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   127
	1)	The document has one or more page templates.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   128
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   129
	2)	Each page template has one or more frames.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   130
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   131
	3)	The document class provides base methods for handling the
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   132
		story events and some reasonable methods for getting the
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   133
		story flowables into the frames.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   134
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   135
	4)	The document instances can override the base handler routines.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   136
	"""
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   137
	def __init__(self, filename, pagesize=DEFAULT_PAGE_SIZE, pageTemplates=[], showBoundary=0,
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   138
				leftMargin=inch, rightMargin=inch, topMargin=inch, bottomMargin=inch,
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   139
				allowSplitting=1):
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   140
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   141
		self.pageTemplates = []
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   142
		self.addPageTemplates(pageTemplates)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   143
		self.filename = filename
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   144
		self.showBoundary = showBoundary
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   145
		self.leftMargin =  leftMargin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   146
		self.bottomMargin = bottomMargin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   147
		self.rightMargin = pagesize[0] - rightMargin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   148
		self.topMargin = pagesize[1] - topMargin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   149
		self.width = self.rightMargin - self.leftMargin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   150
		self.height = self.topMargin - self.bottomMargin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   151
		self.pagesize = pagesize
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   152
		self.allowSplitting = allowSplitting
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   153
		self._pageBreakQuick = 1
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   154
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   155
	def clean_hanging(self):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   156
		while len(self._hanging):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   157
			self.handle_flowable(self._hanging)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   158
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   159
	def addPageTemplates(self,pageTemplates):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   160
		if type(pageTemplates) not in (ListType,TupleType):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   161
			pageTemplates = [pageTemplates]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   162
		assert filter(lambda x: not isinstance(x,PageTemplate), pageTemplates)==[], "pageTemplates argument error"
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   163
		for t in pageTemplates:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   164
			self.pageTemplates.append(t)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   165
			
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   166
	def handle_documentBegin(self):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   167
		self._hanging = [PageBegin]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   168
		self.pageTemplate = self.pageTemplates[0]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   169
		self.page = 0
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   170
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   171
	def handle_pageBegin(self):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   172
		'''shouldn't normally be called directly'''
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   173
		self.page = self.page + 1
214
be55cfb3e54f Added drawPage
rgbecker
parents: 206
diff changeset
   174
		self.pageTemplate.drawPage(self.canv,self)
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   175
		self.pageTemplate.onPage(self.canv,self)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   176
		if hasattr(self,'_nextFrameIndex'):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   177
			del self._nextFrameIndex
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   178
		self.frame = self.pageTemplate.frames[0]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   179
		self.handle_frameBegin()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   180
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   181
	def handle_pageEnd(self):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   182
		'''	show the current page
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   183
			check the next page template
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   184
			hang a page begin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   185
		'''
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   186
		self.canv.showPage()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   187
		if hasattr(self,'_nextPageTemplateIndex'):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   188
			self.pageTemplate = self.pageTemplates[self._nextPageTemplateIndex]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   189
			del self._nextPageTemplateIndex
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   190
		self._hanging.append(PageBegin)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   191
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   192
	def handle_pageBreak(self):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   193
		'''some might choose not to end all the frames'''
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   194
		if self._pageBreakQuick:
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   195
			self.handle_pageEnd()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   196
		else:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   197
			n = len(self._hanging)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   198
			while len(self._hanging)==n:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   199
				self.handle_frameEnd()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   200
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   201
	def handle_frameBegin(self,*args):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   202
		self.frame._reset()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   203
		if self.showBoundary or self.frame.showBoundary:
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   204
			self.canv.rect(
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   205
						self.frame.x1,
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   206
						self.frame.y1,
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   207
						self.frame.x2 - self.frame.x1,
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   208
						self.frame.y2 - self.frame.y1
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   209
						)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   210
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   211
	def handle_frameEnd(self):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   212
		'''	Handles the semantics of the end of a frame. This includes the selection of
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   213
			the next frame or if this is the last frame then invoke pageEnd.
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   214
		'''
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   215
		if hasattr(self,'_nextFrameIndex'):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   216
			frame = self.pageTemplate.frames[self._nextFrameIndex]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   217
			del self._nextFrameIndex
204
b19c3cae893a _donothing explicit import
rgbecker
parents: 200
diff changeset
   218
			self.handle_frameBegin()
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   219
		elif hasattr(self.frame,'lastFrame') or self.frame is self.pageTemplate.frames[-1]:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   220
			self.handle_pageEnd()
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   221
			self.frame = None
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   222
		else:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   223
			f = self.frame
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   224
			self.frame = self.pageTemplate.frames[self.pageTemplate.frames.index(f) + 1]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   225
			self.handle_frameBegin()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   226
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   227
	def handle_nextPageTemplate(self,pt):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   228
		'''On endPage chenge to the page template with name or index pt'''
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   229
		if type(pt) is StringType:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   230
			for t in self.pageTemplates:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   231
				if t.id == pt:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   232
					self._nextPageTemplateIndex = self.pageTemplates.index(t)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   233
					return
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   234
			raise ValueError, "can't find template('%s')"%pt
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   235
		elif type(pt) is IntType:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   236
			self._nextPageTemplateIndex = pt
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   237
		else:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   238
			raise TypeError, "argument pt should be string or integer"
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   239
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   240
	def handle_nextFrame(self,fx):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   241
		'''On endFrame chenge to the frame with name or index fx'''
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   242
		if type(fx) is StringType:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   243
			for f in self.pageTemplate.frames:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   244
				if f.id == fx:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   245
					self._nextFrameIndex = self.pageTemplate.frames.index(f)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   246
					return
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   247
			raise ValueError, "can't find frame('%s')"%fx
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   248
		elif type(fx) is IntType:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   249
			self._nextFrameIndex = fx
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   250
		else:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   251
			raise TypeError, "argument fx should be string or integer"
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   252
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   253
	def handle_currentFrame(self,fx):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   254
		'''chenge to the frame with name or index fx'''
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   255
		if type(fx) is StringType:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   256
			for f in self.pageTemplate.frames:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   257
				if f.id == fx:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   258
					self._nextFrameIndex = self.pageTemplate.frames.index(f)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   259
					return
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   260
			raise ValueError, "can't find frame('%s')"%fx
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   261
		elif type(fx) is IntType:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   262
			self._nextFrameIndex = fx
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   263
		else:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   264
			raise TypeError, "argument fx should be string or integer"
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   265
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   266
	def handle_flowable(self,flowables):
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   267
		'''try to handle one flowable from the front of list flowables.'''
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   268
		f = flowables[0]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   269
		del flowables[0]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   270
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   271
		if isinstance(f,PageBreak):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   272
			self.handle_pageBreak()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   273
		elif isinstance(f,ActionFlowable):
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   274
			f.apply(self)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   275
		else:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   276
			#general case we have to do something
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   277
			if not self.frame.add(f, self.canv, trySplit=self.allowSplitting):
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   278
				if self.allowSplitting:
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   279
					# see if this is a splittable thing
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   280
					S = self.frame.split(f)
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   281
					n = len(S)
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   282
				else:
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   283
					n = 0
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   284
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   285
				if n:
200
74da573e661f Handle splitting error in build
rgbecker
parents: 199
diff changeset
   286
					if not self.frame.add(S[0], self.canv, trySplit=0):
74da573e661f Handle splitting error in build
rgbecker
parents: 199
diff changeset
   287
						raise "LayoutError", "splitting error"
74da573e661f Handle splitting error in build
rgbecker
parents: 199
diff changeset
   288
					del S[0]
74da573e661f Handle splitting error in build
rgbecker
parents: 199
diff changeset
   289
					for f in xrange(n-1):
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   290
						flowables.insert(f,S[f])	# put split flowables back on the list
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   291
				else:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   292
					flowables.insert(0,f)			# put the flowable back
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   293
					self.handle_frameEnd()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   294
204
b19c3cae893a _donothing explicit import
rgbecker
parents: 200
diff changeset
   295
	#these are provided so that deriving classes can refer to them
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   296
	_handle_documentBegin = handle_documentBegin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   297
	_handle_pageBegin = handle_pageBegin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   298
	_handle_pageEnd = handle_pageEnd
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   299
	_handle_frameBegin = handle_frameBegin
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   300
	_handle_frameEnd = handle_frameEnd
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   301
	_handle_flowable = handle_flowable
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   302
	_handle_nextPageTemplate = handle_nextPageTemplate
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   303
	_handle_currentFrame = handle_currentFrame
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   304
	_handle_nextFrame = handle_nextFrame
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   305
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   306
	def _startBuild(self):
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   307
		self.canv = canvas.Canvas(self.filename)
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   308
		self.handle_documentBegin()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   309
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   310
	def _endBuild(self):
197
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   311
		if self._hanging!=[] and self._hanging[-1] is PageBegin:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   312
			del self._hanging[-1]
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   313
			self.clean_hanging()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   314
		else:
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   315
			self.clean_hanging()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   316
			self.handle_pageBreak()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   317
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   318
		self.canv.save()
b8ca098f5ec7 Initial try at a document template class
rgbecker
parents:
diff changeset
   319
		del self.frame, self.pageTemplate
218
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   320
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   321
	def build(self, flowables):
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   322
		assert filter(lambda x: not isinstance(x,Flowable), flowables)==[], "flowables argument error"
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   323
		self._startBuild()
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   324
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   325
		while len(flowables):
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   326
			self.clean_hanging()
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   327
			self.handle_flowable(flowables)
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   328
274db2129c04 Fixes/Changes to get testplatypus to work with new framework
rgbecker
parents: 214
diff changeset
   329
		self._endBuild()