ImageToo class
A StatefulWidget that renders an image according to a swath of optional properties. Several constructors are provided for painting an image from a variety of sources.
Abstracts the rendering of a dart:ui
Image
by returning a configured
RawImageToo
(which creates a RenderImageToo
RenderBox
).
All of these image widgets support an expanded concept of ImageRepeat
defined as Repeat. Thus this ImageToo
can render an image smaller than
its bounds by mirror-tiling with Repeat.mirror as well as the expected
values such as Repeat.noRepeat, Repeat.repeat, etc.
This is the core difference between an Image and an ImageToo.
Construct a const
new ImageToo
with an ImageProvider as the image
property.
new ImageToo.network
demands a String
representing the URL path to a
network hosted image.
new ImageToo.file
demands a File representing the image on the
local disk.
new ImageToo.asset
demands a String
and optional AssetBundle
describing the image as an asset included with a package.
new ImageToo.memory
constructs an image from a Uint8List of bytes.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- ImageToo
- Implementers
Constructors
-
ImageToo({Key? key, required ImageProvider<
Object> image, double? width, double? height, BoxFit? fit, AlignmentGeometry alignment = Alignment.center, Repeat repeat = Repeat.noRepeat, Offset mirrorOffset = Offset.zero, Color? color, BlendMode? colorBlendMode, Rect? centerSlice, bool matchTextDirection = false, bool gaplessPlayback = false, bool isAntiAlias = false, FilterQuality filterQuality = FilterQuality.low, String? semanticLabel, bool excludeFromSemantics = false, ImageFrameBuilder? frameBuilder, ImageLoadingBuilder? loadingBuilder, ImageErrorWidgetBuilder? errorBuilder}) -
A StatefulWidget that renders its required image field, an ImageProvider,
according to the other optional properties.const - ImageToo.asset(String name, {Key? key, AssetBundle? bundle, double? width, double? height, BoxFit? fit, double? scale, AlignmentGeometry alignment = Alignment.center, Repeat repeat = Repeat.noRepeat, Offset mirrorOffset = Offset.zero, Color? color, BlendMode? colorBlendMode, Rect? centerSlice, bool matchTextDirection = false, bool gaplessPlayback = false, bool isAntiAlias = false, FilterQuality filterQuality = FilterQuality.low, String? semanticLabel, bool excludeFromSemantics = false, String? package, int? cacheWidth, int? cacheHeight, ImageFrameBuilder? frameBuilder, ImageErrorWidgetBuilder? errorBuilder})
-
A StatefulWidget that renders an image from an optional
bundle
AssetBundle that is defined byname
, the requiredString
at the front of this constructor. - ImageToo.file(File file, {Key? key, double? width, double? height, BoxFit? fit, double scale = 1.0, AlignmentGeometry alignment = Alignment.center, Repeat repeat = Repeat.noRepeat, Offset mirrorOffset = Offset.zero, Color? color, BlendMode? colorBlendMode, Rect? centerSlice, bool matchTextDirection = false, bool gaplessPlayback = false, bool isAntiAlias = false, FilterQuality filterQuality = FilterQuality.low, String? semanticLabel, bool excludeFromSemantics = false, int? cacheWidth, int? cacheHeight, ImageFrameBuilder? frameBuilder, ImageErrorWidgetBuilder? errorBuilder})
- A StatefulWidget that renders an image from a File, the required value at the front of this constructor.
- ImageToo.memory(Uint8List bytes, {Key? key, double? width, double? height, BoxFit? fit, double scale = 1.0, AlignmentGeometry alignment = Alignment.center, Repeat repeat = Repeat.noRepeat, Offset mirrorOffset = Offset.zero, Color? color, BlendMode? colorBlendMode, Rect? centerSlice, bool matchTextDirection = false, bool gaplessPlayback = false, bool isAntiAlias = false, FilterQuality filterQuality = FilterQuality.low, String? semanticLabel, bool excludeFromSemantics = false, int? cacheWidth, int? cacheHeight, ImageFrameBuilder? frameBuilder, ImageErrorWidgetBuilder? errorBuilder})
-
A StatefulWidget that renders an image based on a list of data
bytes
representing that image in memory, the required Uint8List at the front of this constructor. -
ImageToo.network(String src, {Key? key, double? width, double? height, BoxFit? fit, double scale = 1.0, AlignmentGeometry alignment = Alignment.center, Repeat repeat = Repeat.noRepeat, Offset mirrorOffset = Offset.zero, Color? color, BlendMode? colorBlendMode, Rect? centerSlice, bool matchTextDirection = false, bool gaplessPlayback = false, FilterQuality filterQuality = FilterQuality.low, bool isAntiAlias = false, String? semanticLabel, bool excludeFromSemantics = false, Map<
String, String> ? headers, int? cacheWidth, int? cacheHeight, ImageFrameBuilder? frameBuilder, ImageLoadingBuilder? loadingBuilder, ImageErrorWidgetBuilder? errorBuilder}) -
A StatefulWidget that renders an image from a web server defined by the
URL
src
,
the requiredString
at the front of this constructor.
Properties
- alignment → AlignmentGeometry
-
How to align the image within its bounds.
final
- centerSlice → Rect?
-
The center slice for a nine-patch image.
final
- color → Color?
-
If non-
null
, this color is blended with each image pixel using colorBlendMode.final - colorBlendMode → BlendMode?
-
Used to combine color with this image.
final
- errorBuilder → ImageErrorWidgetBuilder?
-
A builder function that is called if an error occurs during image loading.
final
- excludeFromSemantics → bool
-
Whether to exclude this image from semantics.
final
- filterQuality → FilterQuality
-
The rendering quality of the image.
final
- fit → BoxFit?
-
How to inscribe the image into the space allocated during layout.
final
- frameBuilder → ImageFrameBuilder?
-
A builder function responsible for creating the widget that represents
this image.
final
- gaplessPlayback → bool
-
Whether to continue showing the old image (true), or briefly show nothing
(false), when the image provider changes. The default value is false.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- height → double?
-
If non-
null
, require the image to have this height.final -
image
→ ImageProvider<
Object> -
The image to display.
final
- isAntiAlias → bool
-
Whether to paint the image with anti-aliasing.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loadingBuilder → ImageLoadingBuilder?
-
A builder that specifies the widget to display to the user while an image
is still loading.
final
- matchTextDirection → bool
-
Whether to paint the image in the direction of the TextDirection.
final
- mirrorOffset → Offset
-
Only applicable if repeat is Repeat.mirror, Repeat.mirrorX, or
Repeat.mirrorY. Default is Offset.zero.
final
- repeat → Repeat
-
How to paint any portions of the layout bounds not covered by the image.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
A Semantic description of the image.
final
- width → double?
-
If non-
null
, require the image to have this width.final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _ImageTooState -
Creates the mutable state for this widget at a given location in the tree.
override
-
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.
override
-
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