SignDocumentPage class - sign_document_page library

Constructors

SignDocumentPage.new({Key? key, required File file, ValueChanged<Exception>? onError, ValueChanged<File>? onSignedDocument, ValueChanged<String>? onCancelled, ValueChanged<Image>? onSign, ValueChanged<int>? onPageChanged, ValueChanged<List<SignaturePlacement>>? onPlacementsChanged, ValueChanged<bool>? onSignatureModeChanged, Widget pageIndicatorBuilder(BuildContext, int, int)?, Widget loadingIndicatorBuilder(BuildContext)?, Widget errorWidgetBuilder(BuildContext, Exception)?, String uploadButtonMessage = 'Upload PDF', String nextButtonMessage = 'Next', String prevButtonMessage = 'Previous', String addSignatureMessage = 'Add Signature', Color primaryColor = const Color(0xFF2A6BCC), Color backgroundColor = const Color(0xFFF5F7F9), Color signatureColor = Colors.black, double minSignatureScale = 0.2, double maxSignatureScale = 3.0, bool enableMultipleSignatures = true, bool enableSignatureDeletion = true, bool enableSignatureResizing = true, bool enableSignatureRotation = false, bool showPageNavigation = true, bool showSignatureCount = false}): const

Properties

addSignatureMessage → String: Text for the add signature button.
final
backgroundColor → Color: Background color of the page.
final
enableMultipleSignatures → bool: Whether multiple signatures are allowed.
final
enableSignatureDeletion → bool: Whether signatures can be deleted.
final
enableSignatureResizing → bool: Whether signatures can be resized.
final
enableSignatureRotation → bool: Whether signatures can be rotated.
final
errorWidgetBuilder → Widget Function(BuildContext, Exception)?: Custom builder for the error widget.
final
file → File: The PDF file to be signed.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
loadingIndicatorBuilder → Widget Function(BuildContext)?: Custom builder for the loading indicator widget.
final
maxSignatureScale → double: Maximum scale for signature resizing.
final
minSignatureScale → double: Minimum scale for signature resizing.
final
nextButtonMessage → String: Text for the next page button.
final
onCancelled → ValueChanged<String>?: Callback triggered when the signing process is cancelled.
final
onError → ValueChanged<Exception>?: Callback triggered when an error occurs.
final
onPageChanged → ValueChanged<int>?: Callback triggered when the page changes.
final
onPlacementsChanged → ValueChanged<List<SignaturePlacement>>?: Callback triggered when signature placements change.
final
onSign → ValueChanged<Image>?: Callback triggered when a signature is created.
final
onSignatureModeChanged → ValueChanged<bool>?: Callback triggered when signature mode is toggled.
final
onSignedDocument → ValueChanged<File>?: Callback triggered when the document is successfully signed.
final
pageIndicatorBuilder → Widget Function(BuildContext, int, int)?: Custom builder for the page indicator widget.
final
prevButtonMessage → String: Text for the previous page button.
final
primaryColor → Color: Primary color for buttons and UI elements.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
showPageNavigation → bool: Whether page navigation controls are shown.
final
showSignatureCount → bool: Whether the signature count is displayed.
final
signatureColor → Color: Color of the signature.
final
uploadButtonMessage → String: Text for the upload button.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SignDocumentPage>: Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String: A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String: Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String: Returns a one-line detailed description of the object.
inherited
toStringShort() → String: A short, textual description of this widget.
inherited

Operators

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