PageIterator<T> Class

Defines the wizard's page sequence.

Declaration

class PageIterator<T = any> extends Utils.Disposable

Type Parameters

Name Description
T

The type.

Remarks

Use this class to change the page count and/or sequence. For instance, you can remove a specific wizard page or register a new page.

constructor(pageFactory, stateManager)

Initializes a new instance of the FullscreenDataSourceWizardPageIterator<T> class with the specified settings.

Declaration

constructor(pageFactory: PageFactory, stateManager: StateManager, _onResetPage?: (page: _WrappedWizardPage) => void)

Parameters

Name Type Description
pageFactory PageFactory

The page factory.

stateManager StateManager

The state manager.

_onResetPage (page: _WrappedWizardPage) => void

A callback that handles page reset.

Properties

pageFactory Property

Specifies the page factory.

Declaration

pageFactory: PageFactory

Property Value

Type Description
PageFactory

The page factory.

stateManager Property

Specifies the state manager.

Declaration

stateManager: StateManager

Property Value

Type Description
StateManager

The sate manager.

Methods

dispose Method

Disposes the page iterator.

Declaration

dispose(): void

getNextPageId Method

Returns the next page's ID.

Declaration

getNextPageId(pageId?: string): string

Parameters

Name Type Description
pageId string

The current page's ID.

Returns

Type Description
string

The next page's ID.

Remarks

Use this method to change the page count and/or sequence. For instance, you can remove a specific wizard page or register a new page.