GuardShowPage class
A specific single-page BeamLocation for BeamGuard.showPage
- Inheritance
-
- Object
- ChangeNotifier
- BeamLocation<
BeamState> - GuardShowPage
Constructors
- GuardShowPage(RouteInformation routeInformation, BeamPage beamPage)
-
Creates a GuardShowPage BeamLocation with
RouteInformation(location: path)
as its state.
Properties
- beamPage → BeamPage
-
A single page to show in stack.
final
- beamParameters → BeamParameters
-
Beam parameters used to beam to the current state.
no setterinherited
- data ↔ Object?
-
An arbitrary data to be stored in this.
This will persist while navigating within this BeamLocation.
getter/setter pairinherited
-
guards
→ List<
BeamGuard> -
Guards that will be executing BeamGuard.check when this gets beamed to.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasListeners → bool
-
Whether any listeners are currently registered.
no setterinherited
-
history
↔ List<
HistoryElement> -
The history of beaming for this.
getter/setter pairinherited
- isCurrent → bool
-
Whether this BeamLocation is currently in use by BeamerDelegate.
no setterinherited
- mounted → bool
-
Whether buildInit was called.
no setterinherited
-
pathPatterns
→ List<
String> -
Represents the "form" of URI paths supported by this BeamLocation.
no setteroverride
- routeInformation → RouteInformation
-
RouteInformation to show in URL
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- state ↔ BeamState
-
A state of this BeamLocation.
getter/setter pairinherited
- strictPathPatterns → bool
-
Whether pathPatterns are strictly matched agains incoming URI.
no setterinherited
- transitionDelegate → TransitionDelegate?
-
A transition delegate to be used by Navigator.
no setterinherited
Methods
-
addListener(
VoidCallback listener) → void -
Register a closure to be called when the object changes.
inherited
-
addToHistory(
RouteInformation routeInformation, [BeamParameters beamParameters = const BeamParameters(), bool tryPopping = true]) → void -
Adds another HistoryElement to history list.
The history element is created from given state and
beamParameters
.inherited -
builder(
BuildContext context, ) → Widget -
Gives the ability to wrap the
navigator
.inherited -
buildInit(
BuildContext context) → void -
Initialize custom bindings for this BeamLocation using BuildContext.
Similar to builder, but is not tied to Widget tree.
inherited
-
buildPages(
BuildContext context, BeamState state) → List< BeamPage> -
Creates and returns the list of pages to be built by the Navigator
when this BeamLocation is beamed to or internally inferred.
override
-
canHandle(
Uri uri) → bool -
Can this handle the
uri
based on its pathPatterns.inherited -
create(
[RouteInformation? routeInformation, BeamParameters? beamParameters, bool tryPoppingHistory = true]) → void -
Creates the state and adds the
routeInformation
to history. This is called only once during the lifetime of BeamLocation.inherited -
createState(
RouteInformation routeInformation) → BeamState -
How to create state from RouteInformation given by
BeamerDelegate and passed via BeamerDelegate.locationBuilder.
inherited
-
dispose(
) → void -
Discards any resources used by the object. After this is called, the
object is not in a usable state and should be discarded (calls to
addListener will throw after the object is disposed).
inherited
-
disposeState(
) → void -
How to release any resources used by state.
inherited
-
initState(
) → void -
What to do on state initialization.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
notifyListeners(
) → void -
Call all the registered listeners.
inherited
-
onUpdate(
) → void -
Called after initState and on each update,
i.e. whenever we navigate with this BeamLocation.
inherited
-
removeFirstFromHistory(
) → HistoryElement? -
Removes the last HistoryElement from history and returns it.
inherited
-
removeLastFromHistory(
) → HistoryElement? -
Removes the last HistoryElement from history and returns it.
inherited
-
removeListener(
VoidCallback listener) → void -
Remove a previously registered closure from the list of closures that are
notified when the object changes.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
update(
[BeamState copy(BeamState)?, RouteInformation? routeInformation, BeamParameters? beamParameters, bool rebuild = true, bool tryPoppingHistory = true]) → void -
Updates the state and history, depending on inputs.
inherited
-
updateState(
RouteInformation routeInformation) → void -
Updates the state upon receiving new RouteInformation, which usually
happens after BeamerDelegate.setNewRoutePath.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited