printing.dart
9.52 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
/*
* 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.
*/
part of printing;
typedef LayoutCallback = FutureOr<List<int>> Function(PdfPageFormat format);
mixin Printing {
static const MethodChannel _channel = MethodChannel('net.nfet.printing');
static final Map<int, _PrintJob> _printJobs = <int, _PrintJob>{};
static int _jobIndex = 0;
/// Callbacks from platform plugins
static Future<dynamic> _handleMethod(MethodCall call) async {
switch (call.method) {
case 'onLayout':
final _PrintJob job = _printJobs[call.arguments['job']];
try {
final PdfPageFormat format = PdfPageFormat(
call.arguments['width'],
call.arguments['height'],
marginLeft: call.arguments['marginLeft'],
marginTop: call.arguments['marginTop'],
marginRight: call.arguments['marginRight'],
marginBottom: call.arguments['marginBottom'],
);
final List<int> bytes = await job.onLayout(format);
if (bytes == null) {
return false;
}
return Uint8List.fromList(bytes);
} catch (e) {
print('Unable to print: $e');
return false;
}
break;
case 'onCompleted':
final bool completed = call.arguments['completed'];
final String error = call.arguments['error'];
final _PrintJob job = _printJobs[call.arguments['job']];
if (completed == false && error != null) {
job.onCompleted.completeError(error);
} else {
job.onCompleted.complete(completed);
}
break;
case 'onHtmlRendered':
final _PrintJob job = _printJobs[call.arguments['job']];
job.onHtmlRendered.complete(call.arguments['doc']);
break;
case 'onHtmlError':
final _PrintJob job = _printJobs[call.arguments['job']];
job.onHtmlRendered.completeError(call.arguments['error']);
break;
case 'onPageRasterized':
final _PrintJob job = _printJobs[call.arguments['job']];
final PdfRaster raster = PdfRaster._(
call.arguments['width'],
call.arguments['height'],
call.arguments['image'],
);
job.onPageRasterized.add(raster);
break;
case 'onPageRasterEnd':
final _PrintJob job = _printJobs[call.arguments['job']];
job.onPageRasterized.close();
_printJobs.remove(job.index);
break;
}
}
static _PrintJob _newPrintJob(_PrintJob job) {
job.index = _jobIndex++;
_printJobs[job.index] = job;
return job;
}
/// Prints a Pdf document to a local printer using the platform UI
/// the Pdf document is re-built in a [LayoutCallback] each time the
/// user changes a setting like the page format or orientation.
///
/// returns a future with a `bool` set to true if the document is printed
/// and false if it is canceled.
/// throws an exception in case of error
static Future<bool> layoutPdf({
@required LayoutCallback onLayout,
String name = 'Document',
PdfPageFormat format = PdfPageFormat.standard,
}) async {
_channel.setMethodCallHandler(_handleMethod);
final _PrintJob job = _newPrintJob(_PrintJob(
onCompleted: Completer<bool>(),
onLayout: onLayout,
));
final Map<String, dynamic> params = <String, dynamic>{
'name': name,
'job': job.index,
'width': format.width,
'height': format.height,
'marginLeft': format.marginLeft,
'marginTop': format.marginTop,
'marginRight': format.marginRight,
'marginBottom': format.marginBottom,
};
await _channel.invokeMethod<int>('printPdf', params);
bool result = false;
try {
result = await job.onCompleted.future;
} catch (e) {
print('Document not printed: $e');
}
_printJobs.remove(job.index);
return result;
}
static Future<Map<dynamic, dynamic>> printingInfo() async {
return await _channel.invokeMethod<Map<dynamic, dynamic>>(
'printingInfo',
<String, dynamic>{},
);
}
/// Opens the native printer picker interface, and returns the URL of the selected printer.
static Future<Printer> pickPrinter({Rect bounds}) async {
_channel.setMethodCallHandler(_handleMethod);
bounds ??= Rect.fromCircle(center: Offset.zero, radius: 10);
final Map<String, dynamic> params = <String, dynamic>{
'x': bounds.left,
'y': bounds.top,
'w': bounds.width,
'h': bounds.height,
};
final Map<dynamic, dynamic> printer = await _channel
.invokeMethod<Map<dynamic, dynamic>>('pickPrinter', params);
if (printer == null) {
return null;
}
return Printer(
url: printer['url'],
name: printer['name'],
model: printer['model'],
location: printer['location'],
);
}
/// Prints a Pdf document to a specific local printer with no UI
///
/// returns a future with a `bool` set to true if the document is printed
/// and false if it is canceled.
/// throws an exception in case of error
static Future<bool> directPrintPdf({
@required Printer printer,
@required LayoutCallback onLayout,
String name = 'Document',
PdfPageFormat format = PdfPageFormat.standard,
}) async {
if (printer == null) {
return false;
}
_channel.setMethodCallHandler(_handleMethod);
final _PrintJob job = _newPrintJob(_PrintJob(
onCompleted: Completer<bool>(),
));
final List<int> bytes = await onLayout(format);
if (bytes == null) {
return false;
}
final Map<String, dynamic> params = <String, dynamic>{
'name': name,
'printer': printer.url,
'doc': Uint8List.fromList(bytes),
'job': job.index,
};
await _channel.invokeMethod<int>('directPrintPdf', params);
final bool result = await job.onCompleted.future;
_printJobs.remove(job.index);
return result;
}
/// Prints a [PdfDocument] or a pdf stream to a local printer using the platform UI
@Deprecated('use Printing.layoutPdf(onLayout: (_) => document.save());')
static Future<void> printPdf({
@Deprecated('use bytes with document.save()') PdfDocument document,
List<int> bytes,
}) async {
assert(document != null || bytes != null);
assert(!(document == null && bytes == null));
layoutPdf(
onLayout: (PdfPageFormat format) =>
document != null ? document.save() : bytes);
}
/// Displays a platform popup to share the Pdf document to another application
static Future<void> sharePdf({
@Deprecated('use bytes with document.save()') PdfDocument document,
List<int> bytes,
String filename = 'document.pdf',
Rect bounds,
}) async {
assert(document != null || bytes != null);
assert(!(document == null && bytes == null));
assert(filename != null);
if (document != null) {
bytes = document.save();
}
bounds ??= Rect.fromCircle(center: Offset.zero, radius: 10);
final Map<String, dynamic> params = <String, dynamic>{
'doc': Uint8List.fromList(bytes),
'name': filename,
'x': bounds.left,
'y': bounds.top,
'w': bounds.width,
'h': bounds.height,
};
return await _channel.invokeMethod('sharePdf', params);
}
/// Convert an html document to a pdf data
static Future<List<int>> convertHtml(
{@required String html,
String baseUrl,
PdfPageFormat format = PdfPageFormat.a4}) async {
_channel.setMethodCallHandler(_handleMethod);
final _PrintJob job = _newPrintJob(_PrintJob(
onHtmlRendered: Completer<List<int>>(),
));
final Map<String, dynamic> params = <String, dynamic>{
'html': html,
'baseUrl': baseUrl,
'width': format.width,
'height': format.height,
'marginLeft': format.marginLeft,
'marginTop': format.marginTop,
'marginRight': format.marginRight,
'marginBottom': format.marginBottom,
'job': job.index,
};
await _channel.invokeMethod<void>('convertHtml', params);
final List<int> result = await job.onHtmlRendered.future;
_printJobs.remove(job.index);
return result;
}
static Future<PrintingInfo> info() async {
_channel.setMethodCallHandler(_handleMethod);
Map<dynamic, dynamic> result;
try {
result = await _channel.invokeMethod(
'printingInfo',
<String, dynamic>{},
);
} catch (e) {
print('Error getting printing info: $e');
return PrintingInfo.unavailable;
}
return PrintingInfo.fromMap(result);
}
static Stream<PdfRaster> raster(
List<int> document, {
List<int> pages,
double dpi = PdfPageFormat.inch,
}) {
_channel.setMethodCallHandler(_handleMethod);
final _PrintJob job = _newPrintJob(_PrintJob(
onPageRasterized: StreamController<PdfRaster>(),
));
final Map<String, dynamic> params = <String, dynamic>{
'doc': Uint8List.fromList(document),
'pages': pages,
'scale': dpi / PdfPageFormat.inch,
'job': job.index,
};
_channel.invokeMethod<void>('rasterPdf', params);
return job.onPageRasterized.stream;
}
}