InteractiveInkFeature class abstract
An ink feature that displays a color "splash" in response to a user gesture that can be confirmed or canceled.
Subclasses call confirm when an input gesture is recognized. For example a press event might trigger an ink feature that's confirmed when the corresponding up event is seen.
Subclasses call cancel when an input gesture is aborted before it is recognized. For example a press event might trigger an ink feature that's canceled when the pointer is dragged out of the reference box.
The InkWell and InkResponse widgets generate instances of this class.
- Inheritance
-
- Object
- InkFeature
- InteractiveInkFeature
- Implementers
Constructors
- InteractiveInkFeature({required MaterialInkController controller, required RenderBox referenceBox, required Color color, ShapeBorder? customBorder, VoidCallback? onRemoved})
- Creates an InteractiveInkFeature.
Properties
- color ↔ Color
-
The ink's color.
getter/setter pair
- controller → MaterialInkController
-
The MaterialInkController associated with this InkFeature.
no setterinherited
- customBorder ↔ ShapeBorder?
-
The ink's optional custom border.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- onRemoved → VoidCallback?
-
Called when the ink feature is no longer visible on the material.
finalinherited
- referenceBox → RenderBox
-
The render box whose visual position defines the frame of reference for this ink feature.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancel(
) → void - Called when the user input that triggered this feature's appearance was canceled.
-
confirm(
) → void - Called when the user input that triggered this feature's appearance was confirmed.
-
dispose(
) → void -
Free up the resources associated with this ink feature.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
paintFeature(
Canvas canvas, Matrix4 transform) → void -
Override this method to paint the ink feature.
inherited
-
paintInkCircle(
{required Canvas canvas, required Matrix4 transform, required Paint paint, required Offset center, required double radius, TextDirection? textDirection, ShapeBorder? customBorder, BorderRadius borderRadius = BorderRadius.zero, RectCallback? clipCallback}) → void - Draws an ink splash or ink ripple on the passed in Canvas.
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited