NavPagesState class
The state class for NavPages.
This class manages the navigation state, including the current page, navigation history, and button interactions.
Constructors
Properties
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
- direction → NavPagesDirection
-
Returns the NavPagesDirection for the navigation pages.
no setter
-
Returns the bool footer fullscreen state for the navigation pages.
no setter
- fullscreen → bool
-
Returns the boolfullscreen state for the navigation pages..
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- headerFullscreen → bool
-
Returns the bool header fullscreen state for the navigation pages.
no setter
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- position → NavPagesRailPosition
-
Returns the NavPagesRailPosition for the navigation pages.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showActionSelectedIndex → bool
-
Returns the bool action selected index state for the navigation pages.
no setter
- showSecondaryActionSelectedIndex → bool
-
Returns the bool secondary action selected index state for the navigation pages.
no setter
- widget → NavPages
-
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
-
canPop(
) → bool - Returns whether the navigation stack can be popped.
-
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.
inherited
-
didUpdateWidget(
covariant NavPages oldWidget) → void -
Called whenever the widget configuration changes.
inherited
-
disableActionSelectedIndex(
) → void - Disables the action selected index.
- Disables the footer fullscreen mode.
-
disableHeaderFullscreen(
) → void - Disables the header fullscreen mode.
-
disableSecondaryActionSelectedIndex(
) → void - Disables the secondary action selected index.
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
inherited
-
enableActionSelectedIndex(
) → void - Enables the action selected index.
- Enables the footer fullscreen mode.
-
enableHeaderFullscreen(
) → void - Enables the header fullscreen mode.
-
enableSecondaryActionSelectedIndex(
) → void - Enables the secondary action selected index.
-
enterFullscreen(
) → void - Enters the fullscreen mode.
-
exitFullscreen(
) → void - Exits the fullscreen mode.
-
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
-
pop(
) → void - Pops the current page from the navigation stack.
-
push(
Widget page, {bool fullscreen = false}) → void - Pushes a new page onto the navigation stack.
-
pushReplacement(
Widget page, {bool fullscreen = false}) → void - Replaces the current page with a new page.
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
setActions(
List< NrButtonWidget> actions) → void - Sets the actions for the navigation rail.
-
setButtons(
List< NrButtonWidget> buttons) → void - Sets the buttons for the navigation rail.
-
setDirection(
NavPagesDirection direction) → void - Sets the direction for the navigation pages.
-
setPosition(
NavPagesRailPosition position) → void - Sets the position for the navigation pages.
-
setSecondaryActions(
List< NrButtonWidget> actions) → void - Sets the secondary actions for the navigation rail.
-
setState(
VoidCallback fn) → void -
Notify the framework that the internal state of this object has changed.
inherited
-
toDiagnosticsNode(
{String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode -
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toggleActionSelectedIndex(
) → void - Toggles the action selected index.
- Toggles the footer fullscreen mode.
-
toggleFullscreen(
) → void - Toggles the fullscreen mode.
-
toggleHeaderFullscreen(
) → void - Toggles the header fullscreen mode.
-
toggleSecondaryActionSelectedIndex(
) → void - Toggles the secondary action selected index.
-
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