widget_wrapper.dart
7.32 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
/*
* 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:flutter/widgets.dart';
import 'package:pdf/pdf.dart';
import 'package:pdf/widgets.dart' as pw;
/// ImageProvider that draws a Flutter Widget on a PDF document
class WidgetWrapper extends pw.ImageProvider {
WidgetWrapper._(
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 WidgetWrapper.fromKey(key: rb);
///
/// pdf.addPage(
/// pw.Page(
/// build: (context) {
/// return pw.Center(
/// child: pw.Image(image),
/// );
/// },
/// ),
/// );
///
/// return pdf.save();
/// }
/// ```
static Future<WidgetWrapper> fromKey({
required GlobalKey key,
int? width,
int? height,
double pixelRatio = 1.0,
PdfImageOrientation? orientation,
double? dpi,
}) async {
assert(pixelRatio > 0);
final wrappedWidget =
key.currentContext!.findRenderObject() as RenderRepaintBoundary;
final image = await wrappedWidget.toImage(pixelRatio: pixelRatio);
final byteData = await image.toByteData(format: ui.ImageByteFormat.rawRgba);
if (byteData == null) {
return WidgetWrapper._(
Uint8List(0),
0,
0,
PdfImageOrientation.topLeft,
dpi,
);
}
final imageData = byteData.buffer.asUint8List();
return WidgetWrapper._(
imageData,
image.width,
image.height,
orientation ?? PdfImageOrientation.topLeft,
dpi,
);
}
/// Wrap a Flutter Widget to an ImageProvider.
///
/// ```
/// final wrapped = await WidgetWrapper.fromWidget(
/// widget: Container(
/// color: Colors.white,
/// child: Text(
/// 'Hello world !',
/// style: TextStyle(color: Colors.amber),
/// ),
/// ),
/// constraints: BoxConstraints(maxWidth: 100, maxHeight: 400),
/// pixelRatio: 3,
/// );
///
/// pdf.addPage(
/// pw.Page(
/// pageFormat: format,
/// build: (context) {
/// return pw.Image(wrapped, width: 100);
/// },
/// ),
/// );
/// ```
static Future<WidgetWrapper> fromWidget({
required Widget widget,
required BoxConstraints constraints,
double pixelRatio = 1.0,
PdfImageOrientation? orientation,
double? dpi,
}) async {
assert(pixelRatio > 0);
if (!constraints.hasBoundedHeight || !constraints.hasBoundedHeight) {
throw Exception(
'Unable to convert an unbounded widget. Add maxWidth and maxHeight to the constraints.');
}
widget = ConstrainedBox(
constraints: constraints,
child: widget,
);
final _properties = DiagnosticPropertiesBuilder();
widget.debugFillProperties(_properties);
if (_properties.properties.isEmpty) {
throw ErrorDescription('Unable to get the widget properties');
}
final _constraints = _properties.properties
.whereType<DiagnosticsProperty<BoxConstraints>>()
.first
.value;
if (_constraints == null ||
!_constraints.hasBoundedWidth ||
!_constraints.hasBoundedWidth) {
throw Exception('Unable to convert an unbounded widget.');
}
final _repaintBoundary = RenderRepaintBoundary();
final renderView = RenderView(
child: RenderPositionedBox(
alignment: Alignment.center, child: _repaintBoundary),
configuration: ViewConfiguration(
size: Size(_constraints.maxWidth, _constraints.maxHeight),
devicePixelRatio: ui.window.devicePixelRatio),
window: ui.window,
);
final pipelineOwner = PipelineOwner()..rootNode = renderView;
renderView.prepareInitialFrame();
final buildOwner = BuildOwner(focusManager: FocusManager());
final _rootElement = RenderObjectToWidgetAdapter<RenderBox>(
container: _repaintBoundary,
child: Directionality(
textDirection: TextDirection.ltr,
child: IntrinsicHeight(child: IntrinsicWidth(child: widget)),
),
).attachToRenderTree(buildOwner);
buildOwner
..buildScope(_rootElement)
..finalizeTree();
pipelineOwner
..flushLayout()
..flushCompositingBits()
..flushPaint();
final image = await _repaintBoundary.toImage(pixelRatio: pixelRatio);
final bytes = await image.toByteData(format: ui.ImageByteFormat.rawRgba);
if (bytes == null) {
throw Exception('Unable to read image data');
}
return WidgetWrapper._(
bytes.buffer.asUint8List(),
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,
);
}
}
/// ImageProvider that draws a Flutter Widget on a PDF document
@Deprecated('Use WidgetWrapper instead')
class WidgetWraper extends WidgetWrapper {
WidgetWraper._(
Uint8List bytes,
int width,
int height,
PdfImageOrientation orientation,
double? dpi,
) : super._(bytes, width, height, orientation, dpi);
/// Wrap a Flutter Widget identified by a GlobalKey to an ImageProvider.
@Deprecated('Use WidgetWrapper.fromKey instead')
static Future<WidgetWrapper> fromKey({
required GlobalKey key,
int? width,
int? height,
double pixelRatio = 1.0,
PdfImageOrientation? orientation,
double? dpi,
}) {
return WidgetWrapper.fromKey(
key: key,
width: width,
pixelRatio: pixelRatio,
orientation: orientation,
dpi: dpi,
);
}
/// Wrap a Flutter Widget to an ImageProvider.
@Deprecated('Use WidgetWrapper.fromWidget instead')
static Future<WidgetWrapper> fromWidget({
required Widget widget,
required BoxConstraints constraints,
double pixelRatio = 1.0,
PdfImageOrientation? orientation,
double? dpi,
}) {
return WidgetWrapper.fromWidget(
widget: widget,
constraints: constraints,
pixelRatio: pixelRatio,
orientation: orientation,
dpi: dpi,
);
}
}