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({required T create(void pageData), LocalKey pageKey(void pageData)?, StandardPageBuilder<void, void>? pageBuilder, void pageDataWhenNull()?, String? pageName()?, String restorationId(void pageData)?, bool enableNavigationAnalytics = true})

Create a SplashPageFactory

const

Properties

activeFirstNestedPage → bool

Flag indicating whether the first page in nestedPageFactories should always be stacked as the first page of the nested Navigator.

no setter, inherited

anyNavigator → bool

Add to the deepest navigator when there are multiple nested navigators.

no setter, inherited

anyNestedPageFactories → List<StandardPageWithResultFactory<StandardPageWithResult<Object?, Object?>, Object?, Object?>>

The list of nested pages that can be used in any nested Navigator.

no setter, inherited

childPageFactories → List<StandardChildPageWithResultFactory<StandardPageWithResult<Object?, Object?>, Object?, Object?, Object?>>

The list of child pages that can be navigated to from this page.

final, inherited

create → T Function(void pageData)

Creates the T page that this factory manages.

final, inherited

dataType → Type

The data type of this page.

no setter, inherited

dataTypeIsNonNullable → bool

Flag indicating that the type of page data set for this page is nullable.

no setter, inherited

enableNavigationAnalytics → bool

Flag indicating whether to enable analytics for navigation.

final, inherited

group → String?

The group name used to manage multiple pages as part of the same group when they exist.

final, inherited

groupRoot → bool

Flag indicating whether to set this page as the root group if a group name is specified.

final, inherited

hasChildPages → bool

Flag indicating whether there are child pages that can be navigated to from this page.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasNestedPages → bool

Flag indicating whether there are nested pages.

no setter, inherited

keepHistory → bool

Flag indicating whether to stack this page as part of the history or not.

final, inherited

linkGenerator → String Function(void pageData)?

The function to create deep links for this page.

final, inherited

navigationMode → StandardPageNavigationMode

The method for transitioning to this page from other pages. Please refer to StandardPageNavigationMode for navigation modes.

final, inherited

navigatorPageFactory → StandardPageWithResultFactory<StandardPageWithResult<Object?, Object?>, Object?, Object?>?

The navigator page factory of this page, if any.

no setter, inherited

nestedPageFactories → List<StandardPageWithResultFactory<StandardPageWithResult<Object?, Object?>, Object?, Object?>>

The list of nested pages when using nested Navigators.

no setter, inherited

pageBuilder → StandardPageBuilder<void, void>?

A function for creating StandardPageInterface.

final, inherited

pageDataWhenNull → void Function()?

A function to generate a replacement value when the pageData passed during navigation is null.

final, inherited

pageName → String? Function()?

The name of this page.

final, inherited

pageType → Type

The page type of this page.

no setter, inherited

parentPageFactory → StandardPageWithResultFactory<StandardPageWithResult<Object?, Object?>, Object?, Object?>?

The parent page factory of this page, if any.

no setter, inherited

restorationId → String Function(void pageData)?

A function for generating a value to pass to Page.restorationId.

final, inherited

resultType → Type

The result type of this page.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createParentPageData(void pageData) → Object?

When using child pages, specifies how to create the parent page data from the page data of this page.

inherited

generateLink(Object? pageData) → String?

Returns the deep link generated by this page for the given pageData.

inherited

getPageKey(Object? pageData) → LocalKey

Get the key set for this page, as configured for this page.

inherited

goWithResult(void pageData, [StandardPageNavigationMode? navigationMode, bool pushParentPage = false]) → Future<void>

Navigate to the StandardPage of type T with the option to pass pageData during navigation. An optional navigationMode representing the mode of StandardPageNavigationMode to use during navigation can also be provided. pushParentPage indicates whether to push the parent page when navigating to a child page. default is false.

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