Decoration class Null safety
A description of a box decoration (a decoration applied to a Rect).
This class presents the abstract interface for all decorations. See BoxDecoration for a concrete example.
To actually paint a Decoration, use the createBoxPainter method to obtain a BoxPainter. Decoration objects can be shared between boxes; BoxPainter objects can cache resources to make painting on a particular surface faster.
- Mixed in types
- Implementers
- Annotations
Constructors
- Decoration()
-
Abstract const constructor. This constructor enables subclasses to provide
const constructors so that they can be used in const expressions.
const
Properties
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- isComplex → bool
-
Whether this decoration is complex enough to benefit from caching its painting.
read-only
- padding → EdgeInsetsGeometry?
-
Returns the insets to apply when using this decoration on a box
that has contents, so that the contents do not overlap the edges
of the decoration. For example, if the decoration draws a frame
around its edge, the padding would return the distance by which
to inset the children so as to not overlap the frame.
read-only
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
createBoxPainter(
[VoidCallback onChanged]) → BoxPainter -
Returns a BoxPainter that will paint this decoration.
factory">@factory
-
debugAssertIsValid(
) → bool - In debug mode, throws an exception if the object is not in a valid configuration. Otherwise, returns true.
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void - Add additional properties associated with the node.
-
getClipPath(
Rect rect, TextDirection textDirection) → Path - Returns a closed Path that describes the outer edge of this decoration.
-
hitTest(
Size size, Offset position, {TextDirection? textDirection}) → bool - Tests whether the given point, on a rectangle of a given size, would be considered to hit the decoration or not. For example, if the decoration only draws a circle, this function might return true if the point was inside the circle and false otherwise.
-
lerpFrom(
Decoration? a, double t) → Decoration? -
Linearly interpolates from another Decoration (which may be of a
different class) to
this
.protected">@protected -
lerpTo(
Decoration? b, double t) → Decoration? -
Linearly interpolates from
this
to another Decoration (which may be of a different class).protected">@protected -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent 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
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
lerp(
Decoration? a, Decoration? b, double t) → Decoration? - Linearly interpolates between two Decorations.