PlaybookOverlay class
The playbook's finger and step caption, drawn above the app.
The entry sits in an IgnorePointer, so it never takes a tap meant for
the app, and inside a PlaybookOverlayScope, so finders skip it.
Constructors
- PlaybookOverlay({PlaybookCaption caption = PlaybookCaption.hidden})
-
Creates an overlay showing captions at
caption.
Properties
- caption ↔ PlaybookCaption
-
Where captions are shown.
getter/setter pair
-
countdown
→ ValueNotifier<
int?> -
The seconds left before the run starts, or null when it isn't counting
down.
final
-
finger
→ ValueNotifier<
Offset?> -
Where the finger is, or null before it first moves.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
pressed
→ ValueNotifier<
bool> -
Whether the finger is pressing.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
showFinger
→ ValueNotifier<
bool> -
Whether the finger is drawn. It still moves while hidden.
final
-
text
→ ValueNotifier<
String?> -
The caption text, or null for none.
final
Methods
-
attach(
) → bool - Inserts the overlay into the app's root overlay.
-
bringToFront(
) → void - Moves the overlay above anything inserted since, like a dialog.
-
detach(
) → void - Removes the overlay and releases it.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited