ScreenLock class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ScreenLock
Constructors
-
ScreenLock({Key? key, required String correctString, required VoidCallback onUnlocked, VoidCallback? onOpened, ValidationCallback? onValidate, VoidCallback? onCancelled, ValueChanged<
int> ? onError, ValueChanged<int> ? onMaxRetries, int maxRetries = 0, Duration retryDelay = Duration.zero, Widget? title, ScreenLockConfig? screenLockConfig, SecretsConfig? secretsConfig, KeyPadConfig? keyPadConfig, DelayBuilderCallback? delayBuilder, Widget? customizedButtonChild, VoidCallback? customizedButtonTap, Widget? cancelButton, Widget? deleteButton, InputController? inputController, SecretsBuilderCallback? secretsBuilder, bool useBlur = true, bool useLandscape = true}) -
Animated ScreenLock
const
-
ScreenLock.create({Key? key, required ValueChanged<
String> onConfirmed, VoidCallback? onOpened, ValidationCallback? onValidate, VoidCallback? onCancelled, ValueChanged<int> ? onError, ValueChanged<int> ? onMaxRetries, int maxRetries = 0, int digits = 4, Duration retryDelay = Duration.zero, Widget? title, Widget? confirmTitle, ScreenLockConfig? screenLockConfig, SecretsConfig? secretsConfig, KeyPadConfig? keyPadConfig, DelayBuilderCallback? delayBuilder, Widget? customizedButtonChild, VoidCallback? customizedButtonTap, Widget? cancelButton, Widget? deleteButton, InputController? inputController, SecretsBuilderCallback? secretsBuilder, bool useBlur = true, bool useLandscape = true}) -
Animated ScreenLock
const
Properties
- cancelButton → Widget?
-
Cancel button widget.
final
- confirmTitle → Widget?
-
Heading confirm title for ScreenLock.
final
- correctString → String?
-
Input correct string.
final
- customizedButtonChild → Widget?
-
Child for bottom left side button.
final
- customizedButtonTap → VoidCallback?
-
Tapped for left side lower button.
final
- delayBuilder → DelayBuilderCallback?
-
Specify the widget during input invalidation by retry delay.
final
- deleteButton → Widget?
-
delete button widget.
final
- digits → int
-
Set the maximum number of characters to enter when confirmation is true.
final
-
Footer widget.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- inputController → InputController?
-
Control inputs externally.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- keyPadConfig → KeyPadConfig?
-
Configurations of
KeyPad.final - maxRetries → int
-
0is unlimited. For example, if it is set to 1, didMaxRetries will be called on the first failure.final - onCancelled → VoidCallback?
-
Called when the user cancels.
final
-
onConfirmed
→ ValueChanged<
String> ? -
Called when the first and second inputs match during confirmation.
final
-
onError
→ ValueChanged<
int> ? -
Called if the value does not match the correctString.
final
-
onMaxRetries
→ ValueChanged<
int> ? -
Events that have reached the maximum number of attempts.
final
- onOpened → VoidCallback?
-
Called when the screen is shown the first time.
final
- onUnlocked → VoidCallback?
-
Called if the value matches the correctString.
final
- onValidate → ValidationCallback?
-
Callback to validate input values filled in digits.
final
- retryDelay → Duration
-
Delay until we can retry.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- screenLockConfig → ScreenLockConfig?
-
Configurations of ScreenLock.
final
- secretsBuilder → SecretsBuilderCallback?
-
Custom secrets animation widget builder.
final
- secretsConfig → SecretsConfig
-
Configurations of Secrets.
final
- title → Widget
-
Heading title for ScreenLock.
final
- useBlur → bool
-
Blur the background.
final
- useLandscape → bool
-
Use a landscape orientation when sufficient width is available.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< ScreenLock> -
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}) → 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