CaptureBoxController class

CaptureBoxController can be attached to a CaptureBox Widget, allowing to perform conversions with rendering outputs. It also allows saving the resulting byte lists into user-defined directories.

Available extensions

Constructors

CaptureBoxController()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

getJpg({int quality = 100}) → Future<Uint8List?>
This method outputs a nullable Uint8List representing the Widget wrapped by CaptureBox in the form of a JPG mime type.
getPdf({PdfPageMode pageMode = PdfPageMode.thumbs, bool compress = false, PdfVersion pdfVersion = PdfVersion.pdf_1_5, PdfPageFormat pageFormat = PdfPageFormat.undefined, PageOrientation? pageOrientation, String? title, String? author, String? creator, String? subject, String? keywords, String? producer}) → Future<Uint8List?>

Available on CaptureBoxController, provided by the CaptureBoxControllerPdf extension

This method outputs a nullable Uint8List representing the Widget wrapped by CaptureBox in the form of a PDF mime type.
getPng() → Future<Uint8List?>
This method outputs a nullable Uint8List representing the Widget wrapped by CaptureBox in the form of a PNG mime type.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
printPdf({required String fileName, PdfPageMode pageMode = PdfPageMode.thumbs, bool compress = false, PdfVersion pdfVersion = PdfVersion.pdf_1_5, PdfPageFormat pageFormat = PdfPageFormat.undefined, PageOrientation? pageOrientation, String? title, String? author, String? creator, String? subject, String? keywords, String? producer}) → Future<void>

Available on CaptureBoxController, provided by the CaptureBoxControllerPdf extension

This method takes the binary data obtained from a widget rendering task and renders it into a printing layout.
saveBytes({required Uint8List byteList, required String fileName, required String fileExtension, SaveMode saveMode = SaveMode.filePicker, String filePickerTitle = ""}) → void
This method takes in a Uint8List and, based on the directive passed to saveMode, it saves the binary data into a file.
saveJpg({required String fileName, int quality = 100, SaveMode saveMode = SaveMode.filePicker, String filePickerTitle = ""}) → Future<void>
This method saves into a JPG file the binary data obtained from a widget rendering task, based on the directive passed to saveMode.
savePdf({required String fileName, SaveMode saveMode = SaveMode.filePicker, String filePickerTitle = "", PdfPageMode pageMode = PdfPageMode.thumbs, bool compress = false, PdfVersion pdfVersion = PdfVersion.pdf_1_5, PdfPageFormat pageFormat = PdfPageFormat.undefined, PageOrientation? pageOrientation, String? title, String? author, String? creator, String? subject, String? keywords, String? producer}) → Future<void>

Available on CaptureBoxController, provided by the CaptureBoxControllerPdf extension

This method saves into a PDF file the binary data obtained from a widget rendering task, based on the directive passed to saveMode.
savePng({required String fileName, SaveMode saveMode = SaveMode.filePicker, String filePickerTitle = ""}) → Future<void>
This method saves into a PNG file the binary data obtained from a widget rendering task, based on the directive passed to saveMode.
toString() → String
A string representation of this object.
inherited
tryPrintPdf({required String fileName, PdfPageMode pageMode = PdfPageMode.thumbs, bool compress = false, PdfVersion pdfVersion = PdfVersion.pdf_1_5, PdfPageFormat pageFormat = PdfPageFormat.undefined, PageOrientation? pageOrientation, String? title, String? author, String? creator, String? subject, String? keywords, String? producer, void onError()?}) → Future<void>

Available on CaptureBoxController, provided by the CaptureBoxControllerPdf extension

This method takes the binary data obtained from a widget rendering task and renders it into a printing layout.
trySaveJpg({required String fileName, int quality = 100, SaveMode saveMode = SaveMode.filePicker, String filePickerTitle = "", void onError()?}) → Future<void>
This method saves into a JPG file the binary data obtained from a widget rendering task, based on the directive passed to saveMode.
trySavePdf({required String fileName, SaveMode saveMode = SaveMode.filePicker, String filePickerTitle = "", PdfPageMode pageMode = PdfPageMode.thumbs, bool compress = false, PdfVersion pdfVersion = PdfVersion.pdf_1_5, PdfPageFormat pageFormat = PdfPageFormat.undefined, PageOrientation? pageOrientation, String? title, String? author, String? creator, String? subject, String? keywords, String? producer, void onError()?}) → Future<void>

Available on CaptureBoxController, provided by the CaptureBoxControllerPdf extension

This method saves into a PDF file the binary data obtained from a widget rendering task, based on the directive passed to saveMode.
trySavePng({required String fileName, SaveMode saveMode = SaveMode.filePicker, String filePickerTitle = "", void onError()?}) → Future<void>
This method saves into a PNG file the binary data obtained from a widget rendering task, based on the directive passed to saveMode.

Operators

operator ==(Object other) → bool
The equality operator.
inherited