multi_page.dart
9.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
/*
* Copyright (C) 2017, David PHAM-VAN <dev.nfet.net@gmail.com>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// ignore_for_file: omit_local_variable_types
part of widget;
class WidgetContext {}
abstract class SpanningWidget extends Widget {
bool get canSpan => false;
@protected
WidgetContext saveContext();
@protected
void restoreContext(WidgetContext context);
}
class NewPage extends Widget {
@override
void layout(Context context, BoxConstraints constraints,
{bool parentUsesSize = false}) {
box = PdfRect.zero;
}
}
class _MultiPageInstance {
const _MultiPageInstance(
{@required this.context,
@required this.constraints,
@required this.fullConstraints,
@required this.offsetStart});
final Context context;
final BoxConstraints constraints;
final BoxConstraints fullConstraints;
final double offsetStart;
}
class MultiPage extends Page {
MultiPage(
{PageTheme pageTheme,
PdfPageFormat pageFormat,
BuildListCallback build,
this.crossAxisAlignment = CrossAxisAlignment.start,
this.header,
this.footer,
Theme theme,
this.maxPages = 20,
PageOrientation orientation,
EdgeInsets margin})
: _buildList = build,
assert(maxPages != null && maxPages > 0),
super(
pageTheme: pageTheme,
pageFormat: pageFormat,
margin: margin,
theme: theme,
orientation: orientation);
final BuildListCallback _buildList;
final CrossAxisAlignment crossAxisAlignment;
final BuildCallback header;
final BuildCallback footer;
final List<_MultiPageInstance> _pages = <_MultiPageInstance>[];
final int maxPages;
void _paintChild(
Context context, Widget child, double x, double y, double pageHeight) {
if (mustRotate) {
final EdgeInsets _margin = margin;
context.canvas
..saveContext()
..setTransform(Matrix4.identity()
..rotateZ(-math.pi / 2)
..translate(
x - pageHeight + _margin.top - _margin.left,
y + _margin.left - _margin.bottom,
));
child.paint(context);
context.canvas.restoreContext();
} else {
child.box = PdfRect(x, y, child.box.width, child.box.height);
child.paint(context);
}
}
@override
void generate(Document document) {
if (_buildList == null) {
return;
}
assert(pageFormat.width > 0 && pageFormat.width < double.infinity);
assert(pageFormat.height > 0 && pageFormat.height < double.infinity);
final EdgeInsets _margin = margin;
final bool _mustRotate = mustRotate;
final double pageHeight =
_mustRotate ? pageFormat.width : pageFormat.height;
final double pageHeightMargin =
_mustRotate ? _margin.horizontal : _margin.vertical;
final BoxConstraints constraints = BoxConstraints(
maxWidth: _mustRotate
? (pageFormat.height - _margin.vertical)
: (pageFormat.width - _margin.horizontal));
final BoxConstraints fullConstraints = mustRotate
? BoxConstraints(
maxWidth: pageFormat.height - _margin.vertical,
maxHeight: pageFormat.width - _margin.horizontal)
: BoxConstraints(
maxWidth: pageFormat.width - _margin.horizontal,
maxHeight: pageFormat.height - _margin.vertical);
final Theme calculatedTheme = theme ?? document.theme ?? Theme.base();
Context context;
double offsetEnd;
double offsetStart;
int index = 0;
int sameCount = 0;
final Context baseContext =
Context(document: document.document).inheritFrom(calculatedTheme);
final List<Widget> children = _buildList(baseContext);
WidgetContext widgetContext;
while (index < children.length) {
final Widget child = children[index];
assert(() {
// Detect too big widgets
if (sameCount++ > maxPages) {
throw Exception(
'This widget created more than $maxPages pages. This may be an issue in the widget or the document.');
}
return true;
}());
// Create a new page if we don't already have one
if (context == null || child is NewPage) {
final PdfPage pdfPage =
PdfPage(document.document, pageFormat: pageFormat);
context =
baseContext.copyWith(page: pdfPage, canvas: pdfPage.getGraphics());
assert(() {
if (Document.debug) {
debugPaint(context);
}
return true;
}());
if (pageTheme.buildBackground != null) {
final Widget child = pageTheme.buildBackground(context);
if (child != null) {
child.layout(context, fullConstraints, parentUsesSize: false);
assert(child.box != null);
_paintChild(context, child, _margin.left, _margin.bottom,
pageFormat.height);
}
}
offsetStart = pageHeight -
(_mustRotate ? pageHeightMargin - margin.bottom : _margin.top);
offsetEnd =
_mustRotate ? pageHeightMargin - _margin.left : _margin.bottom;
_pages.add(_MultiPageInstance(
context: context,
constraints: constraints,
fullConstraints: fullConstraints,
offsetStart: offsetStart,
));
if (header != null) {
final Widget headerWidget = header(context);
if (headerWidget != null) {
headerWidget.layout(context, constraints, parentUsesSize: false);
assert(headerWidget.box != null);
offsetStart -= headerWidget.box.height;
}
}
if (footer != null) {
final Widget footerWidget = footer(context);
if (footerWidget != null) {
footerWidget.layout(context, constraints, parentUsesSize: false);
assert(footerWidget.box != null);
offsetEnd += footerWidget.box.height;
}
}
}
// If we are processing a multi-page widget, we restore its context
if (widgetContext != null && child is SpanningWidget) {
child.restoreContext(widgetContext);
widgetContext = null;
}
child.layout(context, constraints, parentUsesSize: false);
assert(child.box != null);
// What to do if the widget is too big for the page?
if (offsetStart - child.box.height < offsetEnd) {
// If it is not a multi-page widget and its height
// is smaller than a full new page, we schedule a new page creation
if (child.box.height <= pageHeight - pageHeightMargin &&
!(child is SpanningWidget)) {
context = null;
continue;
}
// Else we crash if the widget is too big and cannot be splitted
if (!(child is SpanningWidget)) {
throw Exception(
'Widget won\'t fit into the page as its height (${child.box.height}) '
'exceed a page height (${pageHeight - pageHeightMargin}). '
'You probably need a SpanningWidget or use a single page layout');
}
final SpanningWidget span = child;
child.layout(
context, constraints.copyWith(maxHeight: offsetStart - offsetEnd),
parentUsesSize: false);
assert(child.box != null);
_paintChild(context, child, _margin.left,
offsetStart - child.box.height, pageFormat.height);
// Has it finished spanning?
if (span.canSpan) {
widgetContext = span.saveContext();
} else {
sameCount = 0;
index++;
}
// Schedule a new page
context = null;
continue;
}
_paintChild(context, child, _margin.left, offsetStart - child.box.height,
pageFormat.height);
offsetStart -= child.box.height;
sameCount = 0;
index++;
}
}
@override
void postProcess(Document document) {
final EdgeInsets _margin = margin;
for (_MultiPageInstance page in _pages) {
if (header != null) {
final Widget headerWidget = header(page.context);
if (headerWidget != null) {
headerWidget.layout(page.context, page.constraints,
parentUsesSize: false);
assert(headerWidget.box != null);
_paintChild(page.context, headerWidget, _margin.left,
page.offsetStart - headerWidget.box.height, pageFormat.height);
}
}
if (footer != null) {
final Widget footerWidget = footer(page.context);
if (footerWidget != null) {
footerWidget.layout(page.context, page.constraints,
parentUsesSize: false);
assert(footerWidget.box != null);
_paintChild(page.context, footerWidget, _margin.left, _margin.bottom,
pageFormat.height);
}
}
if (pageTheme.buildForeground != null) {
final Widget child = pageTheme.buildForeground(page.context);
if (child != null) {
child.layout(page.context, page.fullConstraints,
parentUsesSize: false);
assert(child.box != null);
_paintChild(page.context, child, _margin.left, _margin.bottom,
pageFormat.height);
}
}
}
}
}