A widget that paints a Decoration either before or after its child paints.

Container insets its child by the widths of the borders; this widget does not.

Commonly used with BoxDecoration.

Sample code

This sample shows a radial gradient that draws a moon on a night sky:

new DecoratedBox(
  decoration: new BoxDecoration(
    gradient: new RadialGradient(
      center: const FractionalOffset(0.25, 0.3),
      radius: 0.15,
      colors: <Color>[
        const Color(0xFFEEEEEE),
        const Color(0xFF111133),
      ],
      stops: <double>[0.9, 1.0],
    ),
  ),
),

See also:

Inheritance

Constructors

DecoratedBox({Key key, Decoration decoration, DecorationPosition position: DecorationPosition.background, Widget child })

Creates a widget that paints a Decoration.

const

Properties

decoration Decoration

What decoration to paint.

final
position DecorationPosition

Whether to paint the box decoration behind or in front of the child.

final
child Widget

The widget below this widget in the tree.

final, inherited
hashCode int

The hash code for this object.

read-only, inherited
key Key

Controls how one widget replaces another widget in the tree.

final, inherited
runtimeType Type

A representation of the runtime type of the object.

read-only, inherited

Methods

createRenderObject(BuildContext context) RenderDecoratedBox

Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.

debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

updateRenderObject(BuildContext context, RenderDecoratedBox renderObject) → void

Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject.

createElement() SingleChildRenderObjectElement

RenderObjectWidgets always inflate to a RenderObjectElement subclass.

inherited
didUnmountRenderObject(RenderObject, renderObject) → void

A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.

@protected, inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() String

Returns a string representation of this object.

inherited
toStringShort() String

A short, textual description of this widget.

inherited

Operators

operator ==(other) bool

The equality operator.

inherited