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