dispose method

@override @mustCallSuper void dispose()

The framework calls this method when this StateX object will never build again and will be disposed of with garbage collection.

Implementation

@override
@mustCallSuper
void dispose() {
  /// The State object's lifecycle is terminated.
  /// **IMPORTANT** You will not know when this will run
  /// It's to the Flutter engines discretion. deactivate() is more reliable.
  /// Subclasses should override deactivate() method instead
  /// to release any resources  (e.g., stop any active animations).

  /// Users may have explicitly call this.
  if (_disposed || !_deactivated) {
    assert(() {
      debugPrint('StateX: dispose() already called in $this');
      return true;
    }());
    return;
  }

  /// Indicate this State object is terminated.
  _disposed = true;

  // No 'setState()' functions are allowed to fully function at this point.
  _setStateAllowed = false;

  /// Call its controllers' dispose() functions
  for (final con in controllerList) {
    con.dispose();
  }

  // Remove any 'StateXController' reference
  _controller = null;

  // In some cases, the setState() will be called again! gp
  _setStateAllowed = true;

  // In some cases, if then reinserted back in another part of the tree
  // the build is called, and so setState() is not necessary.
  _setStateRequested = false;

  assert(() {
    if (_printEvents) {
      debugPrint('============ Event: dispose() in $this');
    }
    return true;
  }());

  // Special case: Test if already disposed
  // _element is assigned null AFTER a dispose() call;
  if (mounted) {
    super.dispose();
  } else {
    assert(() {
      debugPrint('StateX: Not mounted so dispose() not called in $this');
      return true;
    }());
  }
}