Abstract Class: AbstractPageManager
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:52
Page manager for controller.
Extends
Extended by
Constructors
Constructor
new AbstractPageManager(
pageFactory,pageRenderer,pageStateManager,pageHandlerRegistry,dispatcher):AbstractPageManager
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:95
Initializes the page manager.
Parameters
pageFactory
Factory used by the page manager to create instances of the controller for the current route, and decorate the controllers and page state managers.
pageRenderer
The current renderer of the page.
pageStateManager
The current page state manager.
pageHandlerRegistry
Instance of HandlerRegistry that holds a list of pre-manage and post-manage handlers.
dispatcher
Returns
AbstractPageManager
Overrides
Properties
_dispatcher
protected_dispatcher:Dispatcher
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:81
_managedPage
protected_managedPage:ManagedPage
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:68
Details of the currently managed page.
_pageFactory
protected_pageFactory:PageFactory
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:63
Factory used by the page manager to create instances of the controller for the current route, and decorate the controllers and page state managers.
_pageHandlerRegistry
protected_pageHandlerRegistry:PageHandlerRegistry
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:80
A registry that holds a list of pre-manage and post-manage handlers.
_pageRenderer
protected_pageRenderer:PageRenderer
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:72
The current renderer of the page.
_pageStateManager
protected_pageStateManager:PageStateManager
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:76
The current page state manager.
_previousManagedPage
protected_previousManagedPage:ManagedPage
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:57
Snapshot of the previously managed page before it was replaced with a new one
Methods
_activateController()
protected_activateController():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:550
Activate managed instance of controller.
Returns
Promise<void>
_activateExtensions()
protected_activateExtensions():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:564
Activate extensions for managed instance of controller.
Returns
Promise<void>
_activatePageSource()
protected_activatePageSource():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:530
Activate page source so call activate method on controller and his extensions.
Returns
Promise<void>
_clearComponentState()
_clearComponentState(
options):void
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:754
The method clear state on current rendered component to DOM.
Parameters
options
The current route options.
Returns
void
_constructManagedPageValue()
protected_constructManagedPageValue(controller,view,route,options,params,controllerInstance,decoratedController,viewInstance):ManagedPage
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:246
Parameters
controller
view
unknown
route
AbstractRoute<string | RoutePathExpression>
options
params
controllerInstance
decoratedController
viewInstance
unknown
Returns
_deactivateController()
protected_deactivateController():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:692
Deactivate last managed instance of controller only If controller was activated.
Returns
Promise<void>
_deactivateExtensions()
protected_deactivateExtensions():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:703
Deactivate extensions for last managed instance of controller only if they were activated.
Returns
Promise<void>
_deactivatePageSource()
protected_deactivatePageSource():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:678
Deactivate page source so call deactivate method on controller and his extensions.
Returns
Promise<void>
_destroyController()
protected_destroyController():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:727
Destroy last managed instance of controller.
Returns
Promise<void>
_destroyExtensions()
protected_destroyExtensions():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:740
Destroy extensions for last managed instance of controller.
Returns
Promise<void>
_destroyPageSource()
protected_destroyPageSource():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:715
Destroy page source so call destroy method on controller and his extensions.
Returns
Promise<void>
_getInitialManagedPage()
protected_getInitialManagedPage():ManagedPage
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:303
Clear value from managed page.
Returns
_getLoadedControllerState()
protected_getLoadedControllerState():Promise<{ }>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:486
Load controller state from managed instance of controller.
Returns
Promise<{ }>
_getLoadedExtensionsState()
protected_getLoadedExtensionsState(controllerState?):Promise<UnknownParameters>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:502
Load extensions state from managed instance of controller.
Parameters
controllerState?
Returns
Promise<UnknownParameters>
_getUpdatedControllerState()
protected_getUpdatedControllerState(): { } |Promise<{ }>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:622
Return updated controller state for current page controller.
Returns
{ } | Promise<{ }>
_getUpdatedExtensionsState()
protected_getUpdatedExtensionsState(controllerState?):Promise<UnknownParameters>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:638
Return updated extensions state for current page controller.
Parameters
controllerState?
Returns
Promise<UnknownParameters>
_hasOnlyUpdate()
protected_hasOnlyUpdate(controller,view,options):boolean
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:770
Return true if manager has to update last managed controller and view.
Parameters
controller
view
unknown
options
Returns
boolean
_initController()
protected_initController():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:399
Initializes managed instance of controller with the provided parameters.
Returns
Promise<void>
_initExtensions()
protected_initExtensions():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:414
Initialize extensions for managed instance of controller with the provided parameters.
Returns
Promise<void>
_initPageSource()
protected_initPageSource():Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:384
Initialize page source so call init method on controller and his extensions.
Returns
Promise<void>
_loadPageSource()
protected_loadPageSource():Promise<void|PageData>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:444
Load page source so call load method on controller and his extensions. Merge loaded state and render it.
Returns
Promise<void | PageData>
_runPostManageHandlers()
protected_runPostManageHandlers(previousManagedPage,action):Promise<unknown>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:810
Parameters
previousManagedPage
action
Returns
Promise<unknown>
_runPreManageHandlers()
protected_runPreManageHandlers(actualManagedPage,action):Promise<unknown>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:789
Parameters
actualManagedPage
action
Returns
Promise<unknown>
_setRestrictedPageStateManager()
_setRestrictedPageStateManager(
extension,extensionState):void
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:343
Set page state manager to extension which has restricted rights to set global state.
Parameters
extension
extensionState
Returns
void
_storeManagedPageSnapshot()
protected_storeManagedPageSnapshot():void
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:282
Creates a cloned version of currently managed page and stores it in a helper property. Snapshot is used in manager handlers to easily determine differences between the current and the previous state.
Returns
void
_stripManagedPageValueForPublic()
protected_stripManagedPageValueForPublic(value):object
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:333
Removes properties we do not want to propagate outside of the page manager
Parameters
value
The managed page object to strip down
Returns
object
controller
controller:
RouteController
options
options:
RouteOptions
params
params:
RouteParams
route
route:
AbstractRoute<string|RoutePathExpression>
view
view:
unknown
_switchToPageStateManager()
protected_switchToPageStateManager():void
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:431
Iterates over extensions of current controller and switches each one to pageStateManager and clears their partial state.
Returns
void
_switchToPageStateManagerAfterLoaded()
_switchToPageStateManagerAfterLoaded(
extension,extensionState):void
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:364
For defined extension switches to pageStageManager and clears partial state after extension state is loaded.
Parameters
extension
extensionState
Returns
void
_updatePageSource()
protected_updatePageSource():Promise<void|PageData>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:581
Update page source so call update method on controller and his extensions. Merge updated state and render it.
Returns
Promise<void | PageData>
destroy()
destroy():
Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:233
Finalization callback, called when the page manager is being discarded. This usually happens when the page is hot-reloaded at the client side.
Returns
Promise<void>
Overrides
getViewController()
protectedgetViewController(route):Promise<{controller:RouteController;view:RouteView; }>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:834
Parameters
route
AbstractRoute<string | RoutePathExpression>
Returns
Promise<{ controller: RouteController; view: RouteView; }>
init()
init():
void
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:114
Initializes the page manager.
Returns
void
Overrides
manage()
manage(
__namedParameters):Promise<void|PageData>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:133
Starts to manage the provided controller and its view. The manager stops the management of any previously managed controller and view.
The controller and view will be initialized and rendered either into the UI (at the client-side) or to the response to send to the client (at the server-side).
Parameters
__namedParameters
Returns
Promise<void | PageData>
A promise that will resolve to information about the rendered page.
The status will contain the HTTP status code to send to the
client (at the server side) or determine the type of error page
to navigate to (at the client side).
Overrides
postManage()
postManage():
void
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:222
Called by router after currently managed route is resolved.
Returns
void
Overrides
preManage()
preManage():
Promise<void>
Defined in: packages/core/src/page/manager/AbstractPageManager.ts:123
Pre manage handler, should be called and awaited before tryint to handle new route handler. This pre manage takes care of canceling any currently executed route handlers and returns promise which is resolved when previous page finished loading (even if it got canceled).
Returns
Promise<void>