widget_wrapper.dart
2.91 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
/*
* 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.
*/
import 'dart:async';
import 'dart:typed_data';
import 'dart:ui' as ui;
import 'package:flutter/material.dart';
import 'package:flutter/rendering.dart';
import 'package:pdf/pdf.dart';
import 'package:pdf/widgets.dart' as pw;
/// ImageProvider that draws a Flutter Widget on a PDF document
class WidgetWraper extends pw.ImageProvider {
WidgetWraper._(
this.bytes,
int width,
int height,
PdfImageOrientation orientation,
double? dpi,
) : super(width, height, orientation, dpi);
/// Wrap a Flutter Widget identified by a GlobalKey to an ImageProvider.
///
/// Use it with a RepaintBoundary:
/// ```
/// final rb = GlobalKey();
///
/// @override
/// Widget build(BuildContext context) {
/// return RepaintBoundary(
/// key: rb,
/// child: FlutterLogo()
/// );
/// }
///
/// Future<Uint8List> _generatePdf(PdfPageFormat format) async {
/// final pdf = pw.Document();
///
/// final image = await WidgetWraper.fromKey(key: rb);
///
/// pdf.addPage(
/// pw.Page(
/// build: (context) {
/// return pw.Center(
/// child: pw.Image(image),
/// );
/// },
/// ),
/// );
///
/// return pdf.save();
/// }
/// ```
static Future<WidgetWraper> fromKey({
required GlobalKey key,
int? width,
int? height,
double pixelRatio = 1.0,
PdfImageOrientation? orientation,
double? dpi,
}) async {
assert(pixelRatio > 0);
final wrappedWidget =
// ignore: avoid_as
key.currentContext!.findRenderObject() as RenderRepaintBoundary;
final image = await wrappedWidget.toImage(pixelRatio: pixelRatio);
final byteData = await (image.toByteData(format: ui.ImageByteFormat.rawRgba)
// ignore: avoid_as
as FutureOr<ByteData>);
final imageData = byteData.buffer.asUint8List();
return WidgetWraper._(
imageData,
image.width,
image.height,
orientation ?? PdfImageOrientation.topLeft,
dpi,
);
}
/// The image data
final Uint8List bytes;
@override
PdfImage buildImage(pw.Context context, {int? width, int? height}) {
return PdfImage(
context.document,
image: bytes,
width: width ?? this.width!,
height: height ?? this.height!,
orientation: orientation,
);
}
}