HistoryManager | Swim Toolkit

Type parameters

C: Controller = Controller

Hierarchy

ControllerManager<C>
- HistoryManager

Index

Constructors

constructor

Properties

Accessors

historyUri

Methods

Constructors

constructor

new HistoryManager<C>(): HistoryManager<C>

Overrides ControllerManager.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:7
Type parameters
- C: Controller<C> = Controller
Returns HistoryManager<C>

Properties

Readonly controllerManagerObservers

controllerManagerObservers: readonly HistoryManagerObserver<Controller, HistoryManager<Controller>>[]

Readonly historyState

historyState: HistoryState

Readonly rootControllers

rootControllers: readonly C[]

Accessors

historyUri

get historyUri(): Uri

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:9
Returns Uri

Methods

addControllerManagerObserver

addControllerManagerObserver(controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void

Inherited from ControllerManager.addControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:6
Parameters
- controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
Returns void

Protected attachEvents

attachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:25
Returns void

Protected detachEvents

detachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:26
Returns void

Protected didAddControllerManagerObserver

didAddControllerManagerObserver(controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void

Inherited from ControllerManager.didAddControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:9
Parameters
- controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
Returns void

Protected didAttach

didAttach(): void

Inherited from ControllerManager.didAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:19
Returns void

Protected didDetach

didDetach(): void

Inherited from ControllerManager.didDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:22
Returns void

Protected didInsertRootController

didInsertRootController(rootController: C): void

Inherited from ControllerManager.didInsertRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:27
Parameters
- rootController: C
Returns void

Protected didObserve

didObserve<T>(callback: (controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>) => void | T): undefined | T

Inherited from ControllerManager.didObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:15
Type parameters
- T
Parameters
- callback: (controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>) => void | T
  - - (controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void | T
    - Parameters
      - controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
      Returns void | T
Returns undefined | T

Protected didPopHistory

didPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:21
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected didPushHistory

didPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:13
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected didRemoveControllerManagerObserver

didRemoveControllerManagerObserver(controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void

Inherited from ControllerManager.didRemoveControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:13
Parameters
- controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
Returns void

Protected didRemoveRootController

didRemoveRootController(rootController: C): void

Inherited from ControllerManager.didRemoveRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:31
Parameters
- rootController: C
Returns void

Protected didReplaceHistory

didReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:17
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

insertRootController

insertRootController(rootController: C): void

Inherited from ControllerManager.insertRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:24
Parameters
- rootController: C
Returns void

isAttached

isAttached(): boolean

Inherited from ControllerManager.isAttached
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:16
Returns boolean

Protected onAddControllerManagerObserver

onAddControllerManagerObserver(controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void

Inherited from ControllerManager.onAddControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:8
Parameters
- controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
Returns void

Protected onAttach

onAttach(): void

Overrides ControllerManager.onAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:23
Returns void

Protected onDetach

onDetach(): void

Overrides ControllerManager.onDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:24
Returns void

Protected onInsertRootController

onInsertRootController(rootController: C): void

Inherited from ControllerManager.onInsertRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:26
Parameters
- rootController: C
Returns void

Protected onPopHistory

onPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:20
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected onPushHistory

onPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:12
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected onRemoveControllerManagerObserver

onRemoveControllerManagerObserver(controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void

Inherited from ControllerManager.onRemoveControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:12
Parameters
- controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
Returns void

Protected onRemoveRootController

onRemoveRootController(rootController: C): void

Inherited from ControllerManager.onRemoveRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:30
Parameters
- rootController: C
Returns void

Protected onReplaceHistory

onReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:16
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

popHistory

popHistory(event: PopStateEvent): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:18
Parameters
- event: PopStateEvent
Returns void

pushHistory

pushHistory(deltaState: HistoryStateInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:10
Parameters
- deltaState: HistoryStateInit
Returns void

removeControllerManagerObserver

removeControllerManagerObserver(controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void

Inherited from ControllerManager.removeControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:10
Parameters
- controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
Returns void

removeRootController

removeRootController(rootController: C): void

Inherited from ControllerManager.removeRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:28
Parameters
- rootController: C
Returns void

replaceHistory

replaceHistory(deltaState: HistoryStateInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:14
Parameters
- deltaState: HistoryStateInit
Returns void

Protected willAddControllerManagerObserver

willAddControllerManagerObserver(controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void

Inherited from ControllerManager.willAddControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:7
Parameters
- controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
Returns void

Protected willAttach

willAttach(): void

Inherited from ControllerManager.willAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:17
Returns void

Protected willDetach

willDetach(): void

Inherited from ControllerManager.willDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:20
Returns void

Protected willInsertRootController

willInsertRootController(rootController: C): void

Inherited from ControllerManager.willInsertRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:25
Parameters
- rootController: C
Returns void

Protected willObserve

willObserve<T>(callback: (controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>) => void | T): undefined | T

Inherited from ControllerManager.willObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:14
Type parameters
- T
Parameters
- callback: (controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>) => void | T
  - - (controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void | T
    - Parameters
      - controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
      Returns void | T
Returns undefined | T

Protected willPopHistory

willPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:19
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected willPushHistory

willPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:11
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected willRemoveControllerManagerObserver

willRemoveControllerManagerObserver(controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>): void

Inherited from ControllerManager.willRemoveControllerManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:11
Parameters
- controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>
Returns void

Protected willRemoveRootController

willRemoveRootController(rootController: C): void

Inherited from ControllerManager.willRemoveRootController
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/manager/ControllerManager.d.ts:29
Parameters
- rootController: C
Returns void

Protected willReplaceHistory

willReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:15
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Static global

global<C>(): HistoryManager<C>

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryManager.d.ts:27
Type parameters
- C: Controller<C>
Returns HistoryManager<C>

Type parameters

C: Controller = Controller

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

C: Controller<C> = Controller

Returns HistoryManager<C>

Properties

Readonly controllerManagerObservers

Readonly historyState

Readonly rootControllers

Accessors

historyUri

Returns Uri

Methods

addControllerManagerObserver

Parameters

controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>

Returns void

Protected attachEvents

Returns void

Protected detachEvents

Returns void

Protected didAddControllerManagerObserver

Parameters

controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>

Returns void

Protected didAttach

Returns void

Protected didDetach

Returns void

Protected didInsertRootController

Parameters

rootController: C

Returns void

Protected didObserve

Type parameters

T

Parameters

callback: (controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>) => void | T

Parameters

controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>

Returns void | T

Returns undefined | T

Protected didPopHistory

Parameters

newState: HistoryState

oldState: HistoryState

Returns void

Protected didPushHistory

Parameters

newState: HistoryState

oldState: HistoryState

Returns void

Protected didRemoveControllerManagerObserver

Parameters

controllerManagerObserver: HistoryManagerObserver<Controller, HistoryManager<Controller>>

Returns void

Protected didRemoveRootController

Parameters

rootController: C

Returns void

Protected didReplaceHistory

Parameters

newState: HistoryState

oldState: HistoryState

Returns void

insertRootController

Parameters

rootController: C

Returns void

isAttached

Returns boolean

Protected onAddControllerManagerObserver