pdf_preview.dart
11.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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
import 'dart:math';
import 'dart:typed_data';
import 'package:flutter/material.dart';
import 'package:pdf/pdf.dart';
import 'package:pdf/widgets.dart' as pw;
import 'callback.dart';
import 'printing.dart';
import 'printing_info.dart';
import 'raster.dart';
/// Flutter widget that uses the rasterized pdf pages to display a document.
class PdfPreview extends StatefulWidget {
/// Show a pdf document built on demand
const PdfPreview({
Key key,
@required this.build,
this.initialPageFormat,
this.allowPrinting = true,
this.allowSharing = true,
this.maxPageWidth,
this.canChangePageFormat = true,
this.actions,
this.pageFormats,
this.onError,
this.onPrinted,
this.onShared,
this.scrollViewDecoration,
this.pdfPreviewPageDecoration,
this.pdfFileName,
this.useActions = true,
}) : super(key: key);
/// Called when a pdf document is needed
final LayoutCallback build;
/// Pdf page format asked for the first display
final PdfPageFormat initialPageFormat;
/// Add a button to print the pdf document
final bool allowPrinting;
/// Add a button to share the pdf document
final bool allowSharing;
/// Allow disable actions
final bool useActions;
/// Maximum width of the pdf document on screen
final double maxPageWidth;
/// Add a drop-down menu to choose the page format
final bool canChangePageFormat;
/// Additionnal actions to add to the widget
final List<PdfPreviewAction> actions;
/// List of page formats the user can choose
final Map<String, PdfPageFormat> pageFormats;
/// Called if an error creating the Pdf occured
final Widget Function(BuildContext context) onError;
/// Called if the user prints the pdf document
final void Function(BuildContext context) onPrinted;
/// Called if the user shares the pdf document
final void Function(BuildContext context) onShared;
/// Decoration of scrollView
final Decoration scrollViewDecoration;
/// Decoration of _PdfPreviewPage
final Decoration pdfPreviewPageDecoration;
/// Name of the PDF when sharing. It must include the extension.
final String pdfFileName;
@override
_PdfPreviewState createState() => _PdfPreviewState();
}
class _PdfPreviewState extends State<PdfPreview> {
final GlobalKey<State<StatefulWidget>> shareWidget = GlobalKey();
final GlobalKey<State<StatefulWidget>> listView = GlobalKey();
final List<_PdfPreviewPage> pages = <_PdfPreviewPage>[];
PdfPageFormat pageFormat;
PrintingInfo info = PrintingInfo.unavailable;
bool infoLoaded = false;
double dpi = 10;
Object error;
static const Map<String, PdfPageFormat> defaultPageFormats =
<String, PdfPageFormat>{
'A4': PdfPageFormat.a4,
'Letter': PdfPageFormat.letter,
};
Future<void> _raster() async {
Uint8List _doc;
if (!info.canRaster) {
return;
}
try {
_doc = await widget.build(pageFormat);
} catch (e) {
error = e;
return;
}
if (error != null) {
setState(() {
error = null;
});
}
var pageNum = 0;
await for (final PdfRaster page in Printing.raster(_doc, dpi: dpi)) {
if (!mounted) {
return;
}
setState(() {
if (pages.length <= pageNum) {
pages.add(_PdfPreviewPage(
page: page,
pdfPreviewPageDecoration: widget.pdfPreviewPageDecoration,
));
} else {
pages[pageNum] = _PdfPreviewPage(
page: page,
pdfPreviewPageDecoration: widget.pdfPreviewPageDecoration,
);
}
});
pageNum++;
}
pages.removeRange(pageNum, pages.length);
}
@override
void initState() {
final locale =
WidgetsBinding.instance.window.locale ?? const Locale('en', 'US');
final cc = locale.countryCode;
if (cc == 'US' || cc == 'CA' || cc == 'MX') {
pageFormat = widget.initialPageFormat ?? PdfPageFormat.letter;
} else {
pageFormat = widget.initialPageFormat ?? PdfPageFormat.a4;
}
super.initState();
}
@override
void reassemble() {
_raster();
super.reassemble();
}
@override
void didUpdateWidget(covariant PdfPreview oldWidget) {
if (oldWidget.build != widget.build) {
pages.clear();
_raster();
}
super.didUpdateWidget(oldWidget);
}
@override
void didChangeDependencies() {
if (!infoLoaded) {
Printing.info().then((PrintingInfo _info) {
setState(() {
infoLoaded = true;
info = _info;
_raster();
});
});
}
final mq = MediaQuery.of(context);
dpi = (min(mq.size.width - 16, widget.maxPageWidth ?? double.infinity)) *
mq.devicePixelRatio /
pageFormat.width *
72;
_raster();
super.didChangeDependencies();
}
Widget _showError() {
if (widget.onError != null) {
return widget.onError(context);
}
return const Center(
child: Text(
'Unable to display the document',
style: TextStyle(
fontSize: 20,
),
),
);
}
Widget _createPreview() {
if (error != null) {
var content = _showError();
assert(() {
print(error);
content = ErrorWidget(error);
return true;
}());
return content;
}
if (!info.canRaster) {
return _showError();
}
if (pages.isEmpty) {
return const Center(child: CircularProgressIndicator());
}
return Scrollbar(
child: ListView.builder(
itemCount: pages.length,
itemBuilder: (BuildContext context, int index) => pages[index],
),
);
}
@override
Widget build(BuildContext context) {
final theme = Theme.of(context);
final Widget scrollView = Container(
decoration: widget.scrollViewDecoration ??
BoxDecoration(
gradient: LinearGradient(
colors: <Color>[Colors.grey.shade400, Colors.grey.shade200],
begin: Alignment.topCenter,
end: Alignment.bottomCenter,
),
),
width: double.infinity,
alignment: Alignment.center,
child: Container(
constraints: widget.maxPageWidth != null
? BoxConstraints(maxWidth: widget.maxPageWidth)
: null,
child: _createPreview(),
),
);
final actions = <Widget>[];
if (widget.allowPrinting && info.canPrint) {
actions.add(
IconButton(
icon: const Icon(Icons.print),
color: theme.accentIconTheme.color,
onPressed: _print,
),
);
}
if (widget.allowSharing && info.canShare) {
actions.add(
IconButton(
key: shareWidget,
icon: const Icon(Icons.share),
color: theme.accentIconTheme.color,
onPressed: _share,
),
);
}
if (widget.canChangePageFormat) {
final _pageFormats = widget.pageFormats ?? defaultPageFormats;
final keys = _pageFormats.keys.toList();
actions.add(
DropdownButton<PdfPageFormat>(
dropdownColor: theme.primaryColor,
icon: Icon(
Icons.arrow_drop_down,
color: theme.accentIconTheme.color,
),
value: pageFormat,
items: List<DropdownMenuItem<PdfPageFormat>>.generate(
_pageFormats.length,
(int index) {
final key = keys[index];
final val = _pageFormats[key];
return DropdownMenuItem<PdfPageFormat>(
child: Text(key,
style: TextStyle(color: theme.accentIconTheme.color)),
value: val,
);
},
),
onChanged: (PdfPageFormat _pageFormat) {
setState(() {
pageFormat = _pageFormat;
_raster();
});
},
),
);
}
if (widget.actions != null) {
for (final action in widget.actions) {
actions.add(
IconButton(
icon: action.icon,
color: theme.accentIconTheme.color,
onPressed: action.onPressed == null
? null
: () => action.onPressed(
context,
widget.build,
pageFormat,
),
),
);
}
}
assert(() {
if (actions.isNotEmpty) {
actions.add(
Switch(
activeColor: Colors.red,
value: pw.Document.debug,
onChanged: (bool value) {
setState(
() {
pw.Document.debug = value;
_raster();
},
);
},
),
);
}
return true;
}());
return Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
Expanded(child: scrollView),
if (actions.isNotEmpty && widget.useActions)
Material(
elevation: 4,
color: theme.primaryColor,
child: SafeArea(
child: Row(
mainAxisAlignment: MainAxisAlignment.spaceAround,
children: actions,
),
),
)
],
);
}
Future<void> _print() async {
final result = await Printing.layoutPdf(
onLayout: widget.build,
name: widget.pdfFileName ?? 'Document',
format: pageFormat,
);
if (result && widget.onPrinted != null) {
widget.onPrinted(context);
}
}
Future<void> _share() async {
// Calculate the widget center for iPad sharing popup position
final RenderBox referenceBox =
shareWidget.currentContext.findRenderObject();
final topLeft =
referenceBox.localToGlobal(referenceBox.paintBounds.topLeft);
final bottomRight =
referenceBox.localToGlobal(referenceBox.paintBounds.bottomRight);
final bounds = Rect.fromPoints(topLeft, bottomRight);
final bytes = await widget.build(pageFormat);
final result = await Printing.sharePdf(
bytes: bytes,
bounds: bounds,
filename: widget.pdfFileName ?? 'document.pdf',
);
if (result && widget.onShared != null) {
widget.onShared(context);
}
}
}
class _PdfPreviewPage extends StatelessWidget {
const _PdfPreviewPage({
Key key,
this.page,
this.pdfPreviewPageDecoration,
}) : super(key: key);
final PdfRaster page;
final Decoration pdfPreviewPageDecoration;
@override
Widget build(BuildContext context) {
final im = PdfRasterImage(page);
return Container(
margin: const EdgeInsets.only(
left: 8,
top: 8,
right: 8,
bottom: 12,
),
decoration: pdfPreviewPageDecoration ??
const BoxDecoration(
color: Colors.white,
boxShadow: <BoxShadow>[
BoxShadow(
offset: Offset(0, 3),
blurRadius: 5,
color: Color(0xFF000000),
),
],
),
child: AspectRatio(
aspectRatio: page.width / page.height,
child: Image(
image: im,
fit: BoxFit.cover,
),
),
);
}
}
/// Action callback
typedef OnPdfPreviewActionPressed = void Function(
BuildContext context,
LayoutCallback build,
PdfPageFormat pageFormat,
);
/// Action to add the the [PdfPreview] widget
class PdfPreviewAction {
/// Represents an icon to add to [PdfPreview]
const PdfPreviewAction({
@required this.icon,
@required this.onPressed,
}) : assert(icon != null);
/// The icon to display
final Icon icon;
/// The callback called when the user tap on the icon
final OnPdfPreviewActionPressed onPressed;
}