RestorableEnum<T extends Enum> class

A RestorableProperty that knows how to store and restore an Enum type.

The current value of this property is stored in the restoration data. During state restoration the property is restored to the value it had when the restoration data it is getting restored from was collected.

If no restoration data is available, value is initialized to the defaultValue given in the constructor.

The values are serialized using the name of the enum, obtained using the EnumName.name extension accessor.

The represented value is accessible via the value getter.

See also:

  • RestorableEnumN, a class similar to this one that knows how to store and restore nullable Enum types.
Inheritance

Constructors

RestorableEnum(T defaultValue, {required Iterable<T> values})
Creates a RestorableEnum.

Properties

enabled → bool
Whether the object currently returned by toPrimitives should be included in the restoration state.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
isRegistered → bool
Whether this property is currently registered with a RestorationMixin.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → State<StatefulWidget>
The State object that this property is registered with.
no setterinherited
value ↔ T
The current value stored in this property.
getter/setter pairinherited-getteroverride-setter
values ↔ Set<T>
The set of values that this RestorableEnum may represent.
getter/setter pair

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
createDefaultValue() → T
Called by the RestorationMixin if no restoration data is available to restore the value of the property from to obtain the default value for the property.
override
didUpdateValue(T? oldValue) → void
Called whenever a new value is assigned to value.
override
dispose() → void
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
inherited
fromPrimitives(Object? data) → T
Called by the RestorationMixin to convert the data previously retrieved from toPrimitives back into an object of type T that this property should wrap.
override
initWithValue(T value) → void
Called by the RestorationMixin with the value returned by either createDefaultValue or fromPrimitives to set the value that this property currently wraps.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
toPrimitives() → Object
Called by the RestorationMixin to retrieve the information that this property wants to store in the restoration data.
override
toString() → String
A string representation of this object.
inherited

Operators

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