TimezoneObserverMixin<T extends StatefulWidget> mixin

A mixin for StatefulWidgets to automatically manage listening to system timezone changes.

This mixin handles:

  1. Fetches the initial timezone in initState.
  2. Subscribes to the FlutterTimezoneObserver.onTimezoneChanged stream.
  3. Safely cancels the stream subscription in dispose.
  4. Provides a hook onTimezoneChanged for the State to react to updates.

Note: This mixin does not re-fetch the timezone when the app resumes from the background.

For a more robust solution that also handles app lifecycle events, consider using AppLifecycleAwareTimezoneObserverMixin.

Superclass constraints

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
currentZone → String?
The most recently received timezone name.
no setter
hashCode → int
The hash code for this object.
no setterinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
widget → T
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant T oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
override
initState() → void
Called when this object is inserted into the tree.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTimezoneChanged(String newZone) → void
A hook for the State to implement.
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
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.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited