TickerMode class
Enables or disables tickers (and thus animation controllers) in the widget subtree.
This only works if AnimationController objects are created using widget-aware ticker providers. For example, using a TickerProviderStateMixin or a SingleTickerProviderStateMixin.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- TickerMode
Constructors
- TickerMode({Key? key, required bool enabled, required Widget child, bool forceFrames = false})
-
Creates a widget that enables or disables tickers and optionally forces frames.
const
Properties
- child → Widget
-
The widget below this widget in the tree.
final
- enabled → bool
-
The requested ticker mode for this subtree.
final
- forceFrames → bool
-
If true, tickers in this subtree will force frames even if
frames would normally not be scheduled (e.g. even if the
device's screen is turned off).
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< TickerMode> -
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.
inherited
-
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, int wrapWidth = 65}) → 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
Static Methods
-
getNotifier(
BuildContext context) → ValueListenable< bool> -
Obtains a ValueListenable from the TickerMode surrounding the
context, which indicates whether tickers are enabled in the given subtree. -
getValuesNotifier(
BuildContext context) → ValueListenable< TickerModeData> -
Obtains a ValueListenable from the TickerMode surrounding the
context, which indicates whether tickers are enabled in the given subtree. -
merge(
{Key? key, bool? enabled, bool? forceFrames, required Widget child}) → Widget - Creates a TickerMode that overrides the ambient ticker mode values.
-
of(
BuildContext context) → bool - Whether tickers in the given subtree should be enabled or disabled.
-
valuesOf(
BuildContext context) → TickerModeData - Returns the requested ticker mode values for this subtree and establishes a dependency on the ancestor TickerMode, if any.