UsagePanelContainer class

Container which shows/hides a usage panel when a specified key is pressed.

Inheritance

Constructors

UsagePanelContainer({KeyInput toggle = KeyInput.function12, UsageInfo? additionalUsageInfo, bool showDivider = true, bool startOpen = false, Renderable? usageDataSourceOverride, required Renderable child})
Container which shows/hides a usage panel when a specified key is pressed.
const

Properties

additionalUsageInfo → UsageInfo?
Extra usage info to add (e.g. key to open/close panel).
final
child → Renderable
Component to wrap. Uses child's usage info by default.
final
dependency → dynamic
Provider dependency; when it changes this component's state is invalidated.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
key → String?
Key used to differentiate the states of different instances of this component.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showDivider → bool
Show a horizontal divider between the child and the panel when open.
final
startOpen → bool
Whether to open panel by default.
final
stateProvider → dynamic
Reference to this class's state provider. Provide a static final StateProvider of the correct type, using key if relevant.
no setteroverride
toggle → KeyInput
Key to open and close the panel.
final
usageDataSourceOverride → Renderable?
If not null, displays usage data from this source instead of from the child.
final

Methods

build(ProviderContainer container) → Renderable
Return a Renderable which is to be displayed.
override
getSize(ProviderContainer container, Axis axis, int crossSize) → int?
Report this item's intrinsic size, or null if it has none.
inherited
getState(ProviderContainer container) → bool
Read the current state of this component.
inherited
getUsageInfo(ProviderContainer container) → UsageInfo
Return usage info for this renderable, or redirect to its child.
override
keyPressed(ProviderContainer container, KeyInput key) → bool
Handle key presses. Return true if the key was absorbed, or false if another listener further up the tree should handle it.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
render(ProviderContainer container, int width, int height) → AxelMap
Produce an AxelMap of the specified size to be shown on screen.
inherited
setState(ProviderContainer container, bool update(bool)) → void
Update this component's state.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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