PlatformInkWell class

A rectangular area of a that responds to touch.

Inheritance

Constructors

PlatformInkWell({Key? key, Widget? child, GestureTapCallback? onTap, GestureTapDownCallback? onTapDown, GestureTapCallback? onTapCancel, GestureTapCallback? onDoubleTap, GestureLongPressCallback? onLongPress, ValueChanged<bool>? onHighlightChanged, ValueChanged<bool>? onHover, MouseCursor? mouseCursor, bool containedInkWell = false, BoxShape highlightShape = BoxShape.circle, double? radius, BorderRadius? borderRadius, ShapeBorder? customBorder, Color? focusColor, Color? hoverColor, Color? pressColor, Color? highlightColor, MaterialStateProperty<Color?>? overlayColor, Color? splashColor, InteractiveInkFeatureFactory? splashFactory, bool enableFeedback = true, bool excludeFromSemantics = false, FocusNode? focusNode, bool canRequestFocus = true, ValueChanged<bool>? onFocusChange, bool autofocus = false})
const

Properties

autofocus → bool
True if this widget will be selected as the initial focus when no other node in its scope is currently focused.
final
borderRadius → BorderRadius?
The clipping radius of the containing rect. This is effective only if customBorder is null.
final
canRequestFocus → bool
If true, this widget may request the primary focus.
final
child → Widget?
The widget below this widget in the tree.
final
containedInkWell → bool
Whether this ink response should be clipped its bounds.
final
customBorder → ShapeBorder?
The custom clip border which overrides borderRadius.
final
enableFeedback → bool
Whether detected gestures should provide acoustic and/or haptic feedback.
final
excludeFromSemantics → bool
Whether to exclude the gestures introduced by this widget from the semantics tree.
final
focusColor → Color?
The color of the ink response when the parent widget is focused. If this property is null then the focus color of the theme, ThemeData.focusColor, will be used.
final
focusNode → FocusNode?
An optional focus node to use as the focus node for this widget.
final
hashCode → int
The hash code for this object.
no setterinherited
highlightColor → Color?
The highlight color of the ink response when pressed. If this property is null then the highlight color of the theme, ThemeData.highlightColor, will be used.
final
highlightShape → BoxShape
The shape (e.g., circle, rectangle) to use for the highlight drawn around this part of the material when pressed, hovered over, or focused.
final
hoverColor → Color?
The color of the ink response when a pointer is hovering over it. If this property is null then the hover color of the theme, ThemeData.hoverColor, will be used.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mouseCursor → MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the widget.
final
onDoubleTap → GestureTapCallback?
Called when the user double taps this part of the material.
final
onFocusChange → ValueChanged<bool>?
Handler called when the focus changes.
final
onHighlightChanged → ValueChanged<bool>?
Called when this part of the material either becomes highlighted or stops being highlighted.
final
onHover → ValueChanged<bool>?
Called when a pointer enters or exits the ink response area.
final
onLongPress → GestureLongPressCallback?
Called when the user long-presses on this part of the material.
final
onTap → GestureTapCallback?
Called when the user taps this part of the material.
final
onTapCancel → GestureTapCallback?
Called when the user cancels a tap that was started on this part of the material.
final
onTapDown → GestureTapDownCallback?
Called when the user taps down this part of the material.
final
overlayColor → MaterialStateProperty<Color?>?
Defines the ink response focus, hover, and splash colors.
final
pressColor → Color?
The color of the ink response when the parent widget is pressed.
final
radius → double?
The radius of the ink splash.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
splashColor → Color?
The splash color of the ink response. If this property is null then the splash color of the theme, ThemeData.splashColor, will be used.
final
splashFactory → InteractiveInkFeatureFactory?
Defines the appearance of the splash.
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
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}) → 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