HelperOrchestratorState class
State for HelperOrchestrator
Can display an helper as overlay above a child using the current BuildContext and HelperOrchestrator.of
- Inheritance
-
- Object
- State<
HelperOrchestrator> - HelperOrchestratorState
Constructors
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
keys
→ Map<
String, Key> -
final
- 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 → HelperOrchestrator
-
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.
override
-
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.
override
-
didUpdateWidget(
covariant HelperOrchestrator oldWidget) → void -
Called whenever the widget configuration changes.
inherited
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
inherited
-
findAnchor(
String anchorKeyId, {HelperAlignment? align, bool isInModal = false}) → Future< Anchor?> - Returns an Anchor wich contains position, size and rect of the widget containing the key.
-
generateKey(
String key) → Key -
generate a
key
that will be registered within HelperOrchestrator this keyId is associated with the key and can be found again using getAnchorKey The key will be used to find the element position when requesting showAnchoredHelper -
getAnchorKey(
String keyId) → Key - Returns the Key from the KeyId if found. this throws if not found.
-
hideHelper(
) → void - Hide the current overlayed helper this do nothing if there is no helper overlayed.
-
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
-
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
-
showAnchoredHelper(
String anchorKeyId, AnchoredHelper helper, {HelperAlignment? align, bool isInModal = false}) → Future - This shows an AnchoredHelper above your page as overlay
-
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