VoDashboardController class

The panes of a VoDashboard and which one is showing.

VoDashboard creates one for itself. Pass your own to drive it from outside the dashboard, for example to sync the current pane with the URL; you then own it and must dispose it.

History holds each pane once, most recent last: going to a pane that is already in it moves it to the end, so back returns to the previously visited pane rather than replaying every switch.

Inheritance

Constructors

VoDashboardController()

Properties

canGoBack → bool
no setter
currentKey → String?
no setter
currentPane → VoDashboardPane?
no setter
dockPanes → List<VoDashboardPane>
no setter
drawerPanes → List<VoDashboardPane>
no setter
endDrawerPanes → List<VoDashboardPane>
no setter
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
history → List<String>
no setter
panes → Map<String, VoDashboardPane>
Panes that can be shown, by key. A key used in more than one list resolves to the first pane with a builder.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
back() → bool
Returns to the previously visited pane. Returns false if there is none.
dispose() → void
Discards any resources used by the object.
inherited
goTo(String key) → bool
Shows the pane with key. Returns false if there is no such pane or it is already showing.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
paneByKey(String key) → VoDashboardPane?
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setPanes({required List<VoDashboardPane> dockPanes, required List<VoDashboardPane> drawerPanes, required List<VoDashboardPane> endDrawerPanes, required String initialPaneKey}) → void
Replaces the pane lists. VoDashboard calls this on every build, so listeners are not notified; the dashboard is rebuilding anyway.
toString() → String
A string representation of this object.
inherited

Operators

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