dispose method Null safety

  1. @override
void dispose()
override

Called when this object is removed from the tree permanently.

The framework calls this method when this State object will never build again. After the framework calls dispose, the State object is considered unmounted and the mounted property is false. It is an error to call setState at this point. This stage of the lifecycle is terminal: there is no way to remount a State object that has been disposed.

Subclasses should override this method to release any resources retained by this object (e.g., stop any active animations).

If a State's build method depends on an object that can itself change state, for example a ChangeNotifier or Stream, or some other object to which one can subscribe to receive notifications, then be sure to subscribe and unsubscribe properly in initState, didUpdateWidget, and dispose:

  • In initState, subscribe to the object.
  • In didUpdateWidget unsubscribe from the old object and subscribe to the new one if the updated widget configuration requires replacing the object.
  • In dispose, unsubscribe from the object.

Implementations of this method should end with a call to the inherited method, as in super.dispose().

See also:

Implementation

@override
void dispose() {
  super.dispose();

  if (!_isTopmostAutofillGroup || widget.onDisposeAction == null) {
    return;
  }
  switch (widget.onDisposeAction) {
    case AutofillContextAction.cancel:
      TextInput.finishAutofillContext(shouldSave: false);
      break;
    case AutofillContextAction.commit:
      TextInput.finishAutofillContext();
      break;
  }
}