SplashPageFactory<T extends StandardPage<void> > class
base
This is a special factory class for creating a splash page after app launch, and it is required to collaborate with the functionality of StartupSequence.
- Inheritance
-
- Object
- StandardPageWithResultFactory<
T, void, void> - StandardPageFactory<
T, void> - SplashPageFactory
Constructors
-
SplashPageFactory.new({required T create(void pageData), LocalKey pageKey(void pageData)?, StandardPageInterface<
void, void> pageBuilder(Widget child, String? name, void pageData, LocalKey pageKey, String restorationId, GlobalKey<StandardPageWithResult< standardPageKey, StandardPageWithResultFactory<void, void> >StandardPageWithResult< factoryObject)?, void pageDataWhenNull()?, String? pageName()?, String restorationId(void pageData)?, })void, void> , void, void> - Create a SplashPageFactory
Properties
- create → T Function(void pageData)
-
Creates the
T
page that this factory manages.finalinherited - dataType → Type
-
The data type of this page.
no setterinherited
- dataTypeIsNonNullable → bool
-
Flag indicating that the type of page data set for this page is nullable.
no setterinherited
-
Flag indicating whether to enable analytics for navigation.
finalinherited
- group → String?
-
The group name used to manage multiple pages as part of the same group when they exist.
finalinherited
- groupRoot → bool
-
Flag indicating whether to set this page as the root group if a group name is specified.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- keepHistory → bool
-
Flag indicating whether to stack this page as part of the history or not.
finalinherited
- linkGenerator → String Function(void pageData)?
-
The function to create deep links for this page.
The return value must match the keys (regular expressions) passed to links and their corresponding
R
'pageData' destinations.finalinherited -
The method for transitioning to this page from other pages.
Please refer to StandardPageNavigationMode for navigation modes.
finalinherited
-
pageBuilder
→ StandardPageInterface<
void, void> Function(Widget child, String? name, void pageData, LocalKey pageKey, String restorationId, GlobalKey<StandardPageWithResult< standardPageKey, StandardPageWithResultFactory<void, void> >StandardPageWithResult< factoryObject)?void, void> , void, void> -
A function for creating StandardPageInterface.
finalinherited
- pageDataWhenNull → void Function()?
-
A function to generate a replacement value when the pageData passed during navigation is null.
finalinherited
- pageName → String? Function()?
-
The name of this page.
finalinherited
- pageType → Type
-
The page type of this page.
no setterinherited
- parentPageType → Type?
-
When using nested Navigators, specifies what the parent page Type of this child page should be.
finalinherited
- restorationId → String Function(void pageData)?
-
A function for generating a value to pass to Page.restorationId.
finalinherited
- resultType → Type
-
The result type of this page.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
generateLink(
Object? pageData) → String? -
Returns the deep link generated by this page given
pageData
.inherited -
getPageKey(
Object? pageData) → LocalKey -
Get the key set for this page, as configured for this page.
inherited
-
goWithResult(
void pageData, [ ]) → Future< void> -
Navigate to the StandardPage of type
T
with the option to passpageData
during navigation. An optionalnavigationMode
representing the mode of StandardPageNavigationMode to use during navigation can also be provided.inherited -
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