SelectionManager | Swim Toolkit

Type parameters

M: Model = Model

Hierarchy

ModelManager<M>
- SelectionManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SelectionManager<M>(): SelectionManager<M>

Overrides ModelManager.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:8
Type parameters
- M: Model<M> = Model
Returns SelectionManager<M>

Properties

Readonly modelManagerObservers

modelManagerObservers: readonly SelectionManagerObserver<Model, SelectionManager<Model>>[]

Readonly rootModels

rootModels: readonly M[]

Readonly selections

selections: readonly Model[]

Methods

addModelManagerObserver

addModelManagerObserver(modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void

Inherited from ModelManager.addModelManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:6
Parameters
- modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
Returns void

Protected didAddModelManagerObserver

didAddModelManagerObserver(modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void

Inherited from ModelManager.didAddModelManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:9
Parameters
- modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
Returns void

Protected didAttach

didAttach(): void

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

Protected didDetach

didDetach(): void

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

Protected didInsertRootModel

didInsertRootModel(rootModel: M): void

Inherited from ModelManager.didInsertRootModel
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:27
Parameters
- rootModel: M
Returns void

Protected didObserve

didObserve<T>(callback: (modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>) => void | T): undefined | T

Inherited from ModelManager.didObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:15
Type parameters
- T
Parameters
- callback: (modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>) => void | T
  - - (modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void | T
    - Parameters
      - modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
      Returns void | T
Returns undefined | T

Protected didRemoveModelManagerObserver

didRemoveModelManagerObserver(modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void

Inherited from ModelManager.didRemoveModelManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:13
Parameters
- modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
Returns void

Protected didRemoveRootModel

didRemoveRootModel(rootModel: M): void

Inherited from ModelManager.didRemoveRootModel
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:31
Parameters
- rootModel: M
Returns void

Protected didSelect

didSelect(model: Model, index: number, options: null | SelectionOptions): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:14
Parameters
- model: Model
- index: number
- options: null | SelectionOptions
Returns void

Protected didUnselect

didUnselect(model: Model): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:18
Parameters
- model: Model
Returns void

insertRootModel

insertRootModel(rootModel: M): void

Inherited from ModelManager.insertRootModel
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:24
Parameters
- rootModel: M
Returns void

isAttached

isAttached(): boolean

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

isSelected

isSelected(model: Model): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:10
Parameters
- model: Model
Returns boolean

Protected onAddModelManagerObserver

onAddModelManagerObserver(modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void

Inherited from ModelManager.onAddModelManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:8
Parameters
- modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
Returns void

Protected onAttach

onAttach(): void

Inherited from ModelManager.onAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:18
Returns void

Protected onDetach

onDetach(): void

Inherited from ModelManager.onDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:21
Returns void

Protected onInsertRootModel

onInsertRootModel(rootModel: M): void

Inherited from ModelManager.onInsertRootModel
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:26
Parameters
- rootModel: M
Returns void

Protected onRemoveModelManagerObserver

onRemoveModelManagerObserver(modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void

Inherited from ModelManager.onRemoveModelManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:12
Parameters
- modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
Returns void

Protected onRemoveRootModel

onRemoveRootModel(rootModel: M): void

Inherited from ModelManager.onRemoveRootModel
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:30
Parameters
- rootModel: M
Returns void

Protected onSelect

onSelect(model: Model, index: number, options: null | SelectionOptions): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:13
Parameters
- model: Model
- index: number
- options: null | SelectionOptions
Returns void

Protected onUnselect

onUnselect(model: Model): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:17
Parameters
- model: Model
Returns void

removeModelManagerObserver

removeModelManagerObserver(modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void

Inherited from ModelManager.removeModelManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:10
Parameters
- modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
Returns void

removeRootModel

removeRootModel(rootModel: M): void

Inherited from ModelManager.removeRootModel
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:28
Parameters
- rootModel: M
Returns void

select

select(model: Model, options?: null | SelectionOptions, index?: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:11
Parameters
- model: Model
- Optional options: null | SelectionOptions
- Optional index: number
Returns void

toggle

toggle(model: Model, options?: null | SelectionOptions, index?: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:20
Parameters
- model: Model
- Optional options: null | SelectionOptions
- Optional index: number
Returns void

unselect

unselect(model: Model): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:15
Parameters
- model: Model
Returns void

unselectAll

unselectAll(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:19
Returns void

Protected willAddModelManagerObserver

willAddModelManagerObserver(modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void

Inherited from ModelManager.willAddModelManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:7
Parameters
- modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
Returns void

Protected willAttach

willAttach(): void

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

Protected willDetach

willDetach(): void

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

Protected willInsertRootModel

willInsertRootModel(rootModel: M): void

Inherited from ModelManager.willInsertRootModel
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:25
Parameters
- rootModel: M
Returns void

Protected willObserve

willObserve<T>(callback: (modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>) => void | T): undefined | T

Inherited from ModelManager.willObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:14
Type parameters
- T
Parameters
- callback: (modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>) => void | T
  - - (modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void | T
    - Parameters
      - modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
      Returns void | T
Returns undefined | T

Protected willRemoveModelManagerObserver

willRemoveModelManagerObserver(modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>): void

Inherited from ModelManager.willRemoveModelManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:11
Parameters
- modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>
Returns void

Protected willRemoveRootModel

willRemoveRootModel(rootModel: M): void

Inherited from ModelManager.willRemoveRootModel
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/manager/ModelManager.d.ts:29
Parameters
- rootModel: M
Returns void

Protected willSelect

willSelect(model: Model, index: number, options: null | SelectionOptions): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:12
Parameters
- model: Model
- index: number
- options: null | SelectionOptions
Returns void

Protected willUnselect

willUnselect(model: Model): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:16
Parameters
- model: Model
Returns void

Static global

global<M>(): SelectionManager<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/selection/SelectionManager.d.ts:22
Type parameters
- M: Model<M>
Returns SelectionManager<M>

Type parameters

M: Model = Model

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

M: Model<M> = Model

Returns SelectionManager<M>

Properties

Readonly modelManagerObservers

Readonly rootModels

Readonly selections

Methods

addModelManagerObserver

Parameters

modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>

Returns void

Protected didAddModelManagerObserver

Parameters

modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>

Returns void

Protected didAttach

Returns void

Protected didDetach

Returns void

Protected didInsertRootModel

Parameters

rootModel: M

Returns void

Protected didObserve

Type parameters

T

Parameters

callback: (modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>) => void | T

Parameters

modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>

Returns void | T

Returns undefined | T

Protected didRemoveModelManagerObserver

Parameters

modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>

Returns void

Protected didRemoveRootModel

Parameters

rootModel: M

Returns void

Protected didSelect

Parameters

model: Model

index: number

options: null | SelectionOptions

Returns void

Protected didUnselect

Parameters

model: Model

Returns void

insertRootModel

Parameters

rootModel: M

Returns void

isAttached

Returns boolean

isSelected

Parameters

model: Model

Returns boolean

Protected onAddModelManagerObserver

Parameters

modelManagerObserver: SelectionManagerObserver<Model, SelectionManager<Model>>

Returns void

Protected onAttach

Returns void

Protected onDetach

Returns void

Protected onInsertRootModel

Parameters