InkSplash class Null safety
A visual reaction on a piece of Material to user input.
A circular ink feature whose origin starts at the input touch point and whose radius expands from zero.
This object is rarely created directly. Instead of creating an ink splash directly, consider using an InkResponse or InkWell widget, which uses gestures (such as tap and long-press) to trigger ink splashes.
See also:
- InkRipple, which is an ink splash feature that expands more aggressively than this class does.
- InkResponse, which uses gestures to trigger ink highlights and ink splashes in the parent Material.
- InkWell, which is a rectangular InkResponse (the most common type of ink response).
- Material, which is the widget on which the ink splash is painted.
- InkHighlight, which is an ink feature that emphasizes a part of a Material.
- Ink, a convenience widget for drawing images and other decorations on Material widgets.
- Inheritance
-
- Object
- InkFeature
- InteractiveInkFeature
- InkSplash
Constructors
- InkSplash({required MaterialInkController controller, required RenderBox referenceBox, required TextDirection textDirection, Offset? position, required Color color, bool containedInkWell = false, RectCallback? rectCallback, BorderRadius? borderRadius, ShapeBorder? customBorder, double? radius, VoidCallback? onRemoved})
- Begin a splash, centered at position relative to referenceBox.
Properties
- color ↔ Color
-
The ink's color.
read / writeinherited
- controller → MaterialInkController
-
The MaterialInkController associated with this InkFeature.
read-onlyinherited
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- 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.
read-onlyinherited
Methods
-
cancel(
) → void -
Called when the user input that triggered this feature's appearance was canceled.
override
-
confirm(
) → void -
Called when the user input that triggered this feature's appearance was confirmed.
override
-
dispose(
) → void -
Free up the resources associated with this ink feature.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
paintFeature(
Canvas canvas, Matrix4 transform) → void -
Override this method to paint the ink feature.
override
-
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.
protected">@protectedinherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- splashFactory → const InteractiveInkFeatureFactory
-
Used to specify this type of ink splash for an InkWell, InkResponse,
material Theme, or ButtonStyle.
_InkSplashFactory()