PdfDocumentRefCustom class
A PdfDocumentRef that loads the document from custom source.
- Inheritance
-
- Object
- PdfDocumentRef
- PdfDocumentRefCustom
- Mixed in types
Constructors
-
PdfDocumentRefCustom({required int fileSize, required FutureOr<
int> read(Uint8List buffer, int position, int size), required String sourceName, PdfPasswordProvider? passwordProvider, bool firstAttemptByEmptyPassword = true, bool autoDispose = true, int? maxSizeToCacheOnMemory, void onDispose()?}) -
const
Properties
- autoDispose → bool
-
Whether to dispose the document on reference dispose or not.
finalinherited
- fileSize → int
-
final
- firstAttemptByEmptyPassword → bool
-
firstAttemptByEmptyPassword is used to determine whether the first attempt to open the PDF is by empty password
or not. For more info, see PdfPasswordProvider.
final
- hashCode → int
-
Classes that extends PdfDocumentRef should override this function.
no setteroverride
- maxSizeToCacheOnMemory → int?
-
final
- onDispose → (void Function()?)
-
final
- passwordProvider → PdfPasswordProvider?
-
passwordProvider is used to provide password for encrypted PDF. See PdfPasswordProvider for more info.
final
-
read
→ FutureOr<
int> Function(Uint8List buffer, int position, int size) -
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sourceName → String
-
Source name to identify the reference.
final
Methods
-
loadDocument(
PdfDocumentLoaderProgressCallback progressCallback, PdfDocumentLoaderReportCallback reportCallback) → Future< PdfDocument> -
Use resolveListenable/PdfDocumentListenable.document instead to load the shared PdfDocument.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
resolveListenable(
) → PdfDocumentListenable -
Resolve the PdfDocumentListenable for this reference.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
Classes that extends PdfDocumentRef should override this function to compare the equality by sourceName
or such.
override