ScreenLock class
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ScreenLock
Constructors
-
ScreenLock({Key? key, required String correctString, Widget title = const HeadingTitle(text: 'Please enter passcode.'), Widget confirmTitle = const HeadingTitle(text: 'Please enter confirm passcode.'), ScreenLockConfig screenLockConfig = const ScreenLockConfig(), SecretsConfig secretsConfig = const SecretsConfig(), InputButtonConfig inputButtonConfig = const InputButtonConfig(), bool canCancel = true, bool confirmation = false, int digits = 4, void didUnlocked()?, void didConfirmed(String matchedText)?, void didError(int retries)?, int maxRetries = 0, Duration retryDelay = Duration.zero, Widget? delayChild, void didMaxRetries(int retries)?, Future<
void> customizedButtonTap()?, Widget? customizedButtonChild, Widget? cancelButton, Widget? deleteButton, InputController? inputController, bool withBlur = true, SecretsBuilderCallback? secretsBuilder}) -
const
Properties
- canCancel → bool
-
You can cancel and close the ScreenLock.
final
- cancelButton → Widget?
-
Cancel button widget.
final
- confirmation → bool
-
Make sure the first and second inputs are the same.
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
→ (Future<
void> Function()?) -
Tapped for left side lower button.
final
- delayChild → Widget?
-
Specify the widget during input invalidation by retry delay.
final
- deleteButton → Widget?
-
delete button widget.
final
- didConfirmed → (void Function(String matchedText)?)
-
Called when the first and second inputs match during confirmation.
final
- didError → (void Function(int retries)?)
-
Called if the value does not match the correctString.
final
- didMaxRetries → (void Function(int retries)?)
-
Events that have reached the maximum number of attempts.
final
- didUnlocked → (void Function()?)
-
Called if the value matches the correctString.
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
- inputButtonConfig → InputButtonConfig
-
Configurations of InputButton.
final
- inputController → InputController?
-
Control inputs externally.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- maxRetries → int
-
0is unlimited. For example, if it is set to 1, didMaxRetries will be called on the first failure.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
- withBlur → bool
-
Blur the background.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _ScreenLockState -
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