StateObject class

StateOjbect is the default RootStateElement used in Upstate which makes it very easy and quick to create a state with many nested values.

Inheritance
Mixed in types

Constructors

StateObject(Map<String, dynamic> map, {bool elementsShouldNotifyParents = true, StateValueTyping typing = StateValueTyping.dynamicTyping, StateElement converter(dynamic value, StateElement parent), TypeSafety typeSafety = TypeSafety.unsafe})

Properties

converter StateElement Function(dynamic value, StateElement parent)
read / write, override
entries Iterable<MapEntry<String, dynamic>>
The map entries of this.
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
isEmpty bool
Whether there is no key/value pair in the map.
read-only, inherited
isNotEmpty bool
Whether there is at least one key/value pair in the map.
read-only, inherited
keys Iterable<String>
read-only, inherited
length int
The number of key/value pairs in the map.
read-only, inherited
notifications Stream<StateElementNotification>
Returns a stream that can be subscribed to that receives StateElementNotifications upon changes
read-only, inherited
notifyParent bool
read / write, override
parent StateElement
final, inherited
removedFromState bool
Whether a state element has been removed from the state tree
read-only, inherited
rootElement RootStateElement
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
typeSafety TypeSafety
read / write, override
typing StateValueTyping
read / write, override
values Iterable
The values of this. [...]
read-only, inherited

Methods

addAll(Map<String, dynamic> other) → void
Adds all key/value pairs of other to this map. [...]
inherited
addEntries(Iterable<MapEntry<String, dynamic>> newEntries) → void
Adds all key/value pairs of newEntries to this map. [...]
inherited
call<T>(StatePath path) → T
cast<RK, RV>() Map<RK, RV>
Provides a view of this map as having RK keys and RV instances, if necessary. [...]
inherited
clear() → void
inherited
containsKey(Object key) bool
Whether this map contains the given key. [...]
inherited
containsValue(Object value) bool
Whether this map contains the given value. [...]
inherited
forEach(void action(String key, dynamic value)) → void
Applies action to each key/value pair of the map. [...]
inherited
map<K2, V2>(MapEntry<K2, V2> transform(String key, dynamic value)) Map<K2, V2>
Returns a new map where all entries of this map are transformed by the given convert function.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
notifyChange() → void
inherited
notifyRemovedFromState() → void
should be called after a state element is no longer part of the state. This will cause your app to throw an error if you accidentally try to access or modify an element that's no longer in state.
inherited
putIfAbsent(String key, dynamic ifAbsent()) → dynamic
Look up the value of key, or add a new entry if it isn't there. [...]
inherited
remove(dynamic key) → dynamic
inherited
removeWhere(bool test(String key, dynamic value)) → void
Removes all entries of this map that satisfy the given test.
inherited
subscribe(void callback(StateElementNotification notification)) StreamSubscription<StateElementNotification>
Subscripes to notifications and calls the callback upon an event will be depricated. Use notifications instead.
inherited
toJson() String
toPrimitive() Map
Recursively converts all values to primitive values where possible for the purpose of converting the entire state tree to JSON
inherited
toString() String
A string representation of this object. [...]
inherited
unmount() → void
override
update(String key, dynamic update(dynamic value), {dynamic ifAbsent()}) → dynamic
Updates the value for the provided key. [...]
inherited
updateAll(dynamic update(String key, dynamic value)) → void
Updates all values. [...]
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited
operator [](dynamic key) → dynamic
The value for the given key, or null if key is not in the map. [...]
override
operator []=(String key, dynamic value) → void
inherited

Static Methods

fromJson(String json, {bool elementsShouldNotifyParents, StateValueTyping typing = StateValueTyping.dynamicTyping, TypeSafety typeSafety = TypeSafety.unsafe, StateElement converter(dynamic value, StateElement parent)}) StateObject
of<T extends StateWidget>(BuildContext context) StateObject