PinInputScope class

InheritedWidget providing PIN state to descendant cells.

This allows custom cell implementations to access the current PIN state without needing to pass data through every widget in the tree.

Inheritance

Constructors

PinInputScope({Key? key, required List<PinCellData> cells, required bool obscureText, required String obscuringCharacter, required bool hasFocus, required VoidCallback requestFocus, required Widget child})
const

Properties

cells List<PinCellData>
List of cell data for each PIN position.
final
child Widget
The widget below this widget in the tree.
finalinherited
hasFocus bool
Whether the PIN field has focus.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
obscureText bool
Whether text should be obscured.
final
obscuringCharacter String
Character used to obscure text.
final
requestFocus VoidCallback
Callback to request focus on the PIN field.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() InheritedElement
Inflates this configuration to a concrete instance.
inherited
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
updateShouldNotify(covariant PinInputScope oldWidget) bool
Whether the framework should notify widgets that inherit from this widget.
override

Operators

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

Static Methods

maybeOf(BuildContext context) PinInputScope?
Gets the PinInputScope from the widget tree, or null if not found.
of(BuildContext context) PinInputScope
Gets the PinInputScope from the widget tree.