Interface TraitControllerSet<R, T, C, I>

Type Parameters

R = any
T extends Trait = Trait
C extends Controller = Controller
I extends any[] = [C | null]

Hierarchy

ControllerSet<R, C, I>
- TraitControllerSet

Index

Properties

coherentTime controllerCount inlet inletVersion name owner version

Methods

addController addControllers addTrait addTraits attachController attachControllers attachFastener attachInlets attachTrait attachTraits bindInlet compare consume consumeControllers consumeTraits createController createTrait decohere decohereFastener deinitController deinitTrait deleteController deleteControllers deleteTrait deleteTraits detachController detachControllers detachInlets detachTrait detachTraits detectController didAttachController didAttachTrait didBindInlet didConsume didDetachController didDetachTrait didMount didSetAffinity didSetInherits didSort didStartConsuming didStopConsuming didUnbindInlet didUnconsume didUnmount fromLike fromTraitLike get getFastener getParentFastener getTraitRef getTransition? hasAffinity hasController hasTrait incrementVersion init initController initTrait insertChild insertController insertControllers insertTrait insertTraits onAttachController onAttachTrait onBindInlet onConsume onDetachController onDetachTrait onMount onSetAffinity onSetInherits onSort onStartConsuming onStopConsuming onUnbindInlet onUnconsume onUnmount order recohere reinsertController reinsertTrait removeController removeControllers removeTrait removeTraits requireRecohere requireUpdate resolveInlets setAffinity setCoherent setCoherentTime setControllers setInherits setTraits sort toString unbindInlet unconsume unconsumeControllers unconsumeTraits willAttachController willAttachTrait willBindInlet willConsume willDetachController willDetachTrait willMount willSetAffinity willSetInherits willSort willStartConsuming willStopConsuming willUnbindInlet willUnconsume willUnmount

Properties

`Readonly` coherentTime

coherentTime: number

`Readonly` controllerCount

controllerCount: number

`Readonly` inlet

inlet: Fastener<any, any, any> | readonly Fastener<any, any, any>[]

`Readonly` inletVersion

inletVersion: number | readonly number[]

`Readonly` name

name: PropertyKey

`Readonly` owner

owner: R

`Readonly` version

version: number

Accessors

affinity

get affinity(): Affinity
Returns Affinity
Inherited from ControllerSet.affinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:777

binds

get binds(): boolean
Returns boolean
Inherited from ControllerSet.binds
- Defined in swim-core/swim-component/dist/swim-component.d.ts:723

coherent

get coherent(): boolean
Returns boolean
Inherited from ControllerSet.coherent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:791

consumed

get consumed(): boolean
Returns boolean
Inherited from ControllerSet.consumed
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:30

consuming

get consuming(): boolean
Returns boolean
Inherited from ControllerSet.consuming
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:88

controllerType

get controllerType(): ControllerFactory<C>
Returns ControllerFactory<C>
Inherited from ControllerSet.controllerType
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:31

derived

get derived(): boolean
Returns boolean
Inherited from ControllerSet.derived
- Defined in swim-core/swim-component/dist/swim-component.d.ts:774

descriptorType

get descriptorType(): Proto<TraitControllerSetDescriptor<R, T, C>>
Returns Proto<TraitControllerSetDescriptor<R, T, C>>
Overrides ControllerSet.descriptorType
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:21

fastenerType

get fastenerType(): Proto<ControllerSet<any, any, any>>
Returns Proto<ControllerSet<any, any, any>>
Inherited from ControllerSet.fastenerType
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:32

inheritName

get inheritName(): PropertyKey
Returns PropertyKey
Inherited from ControllerSet.inheritName
- Defined in swim-core/swim-component/dist/swim-component.d.ts:765

inherits

get inherits(): boolean
Returns boolean
Inherited from ControllerSet.inherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:766

inletKeys

get inletKeys(): readonly PropertyKey[]
Protected
Returns readonly PropertyKey[]
Inherited from ControllerSet.inletKeys
- Defined in swim-core/swim-component/dist/swim-component.d.ts:798

mounted

get mounted(): boolean
Returns boolean
Inherited from ControllerSet.mounted
- Defined in swim-core/swim-component/dist/swim-component.d.ts:820

observes

get observes(): boolean
Returns boolean
Inherited from ControllerSet.observes
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:32

ordered

get ordered(): boolean
Returns boolean
Inherited from ControllerSet.ordered
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:89

parent

get parent(): ControllerSet<any, C, any>
Returns ControllerSet<any, C, any>
Inherited from ControllerSet.parent
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:34

parentController

get parentController(): Controller
Returns Controller
Inherited from ControllerSet.parentController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:59

parentType

get parentType(): Proto<any>
Returns Proto<any>
Inherited from ControllerSet.parentType
- Defined in swim-core/swim-component/dist/swim-component.d.ts:738

sorted

get sorted(): boolean
Returns boolean
Inherited from ControllerSet.sorted
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:91

traitType

get traitType(): TraitFactory<T>
Returns TraitFactory<T>
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:22

Methods

addController

addController(controller?, target?, key?): C
Parameters
- Optional controller: C | LikeType<C>
- Optional target: Controller
- Optional key: string
Returns C
Inherited from ControllerSet.addController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:47

addControllers

addControllers(controllers, target?): void
Parameters
- controllers: {
  [controllerId: string]: C | undefined;
  }
  - [controllerId: string]: C | undefined
- Optional target: Controller
Returns void
Inherited from ControllerSet.addControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:48

addTrait

addTrait(trait, targetTrait?, key?): C
Parameters
- trait: T | LikeType<T>
- Optional targetTrait: Trait
- Optional key: string
Returns C
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:29

addTraits

addTraits(traits, targetTrait?): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
- Optional targetTrait: Trait
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:30

attachController

attachController(controller?, target?): C
Parameters
- Optional controller: C | LikeType<C>
- Optional target: Controller
Returns C
Inherited from ControllerSet.attachController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:54

attachControllers

attachControllers(controllers, target?): void
Parameters
- controllers: {
  [controllerId: string]: C | undefined;
  }
  - [controllerId: string]: C | undefined
- Optional target: Controller
Returns void
Inherited from ControllerSet.attachControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:55

attachFastener

attachFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.attachFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:809

`Protected` attachInlets

attachInlets(): void
Protected
Returns void
Inherited from ControllerSet.attachInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:801

attachTrait

attachTrait(trait, targetTrait?, controller?): C
Parameters
- trait: T | LikeType<T>
- Optional targetTrait: Trait
- Optional controller: C
Returns C
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:36

attachTraits

attachTraits(traits, targetTrait?): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
- Optional targetTrait: Trait
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:45

bindInlet

bindInlet<K, IK>(inlet, key): void
Type Parameters
- K extends string | number | symbol
- IK
Parameters
- inlet: Fastener<any, IK, any>
- key: IK
Returns void
Inherited from ControllerSet.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:744
bindInlet<I0>(inlet): void
Type Parameters
- I0 extends any
Parameters
- inlet: Fastener<any, I0, any>
Returns void
Inherited from ControllerSet.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:745

`Protected` compare

compare(a, b): number
Protected
Parameters
- a: C
- b: C
Returns number
Inherited from ControllerSet.compare
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:108

consume

consume(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.consume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:73

consumeControllers

consumeControllers(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.consumeControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:81

consumeTraits

consumeTraits(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:73

createController

createController(trait?): C
Parameters
- Optional trait: T
Returns C
Overrides ControllerSet.createController
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:83

createTrait

createTrait(): T
Returns T
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:75

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.decohere
- Defined in swim-core/swim-component/dist/swim-component.d.ts:794

decohereFastener

decohereFastener(fastener): void
Parameters
- fastener: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.decohereFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:811

`Protected` deinitController

deinitController(controller): void
Protected
Parameters
- controller: C
Returns void
Inherited from ControllerSet.deinitController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:52

`Protected` deinitTrait

deinitTrait(trait, controller): void
Protected
Parameters
- trait: T
- controller: C
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:50

deleteController

deleteController(controller): C
Parameters
- controller: C
Returns C
Inherited from ControllerSet.deleteController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:70

deleteControllers

deleteControllers(controllers?): void
Parameters
- Optional controllers: {
  [controllerId: string]: C | undefined;
  }
  - [controllerId: string]: C | undefined
Returns void
Inherited from ControllerSet.deleteControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:71

deleteTrait

deleteTrait(trait): C
Parameters
- trait: T
Returns C
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:68

deleteTraits

deleteTraits(traits): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:69

detachController

detachController(controller): C
Parameters
- controller: C
Returns C
Inherited from ControllerSet.detachController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:58

detachControllers

detachControllers(controllers?): void
Parameters
- Optional controllers: {
  [controllerId: string]: C | undefined;
  }
  - [controllerId: string]: C | undefined
Returns void
Inherited from ControllerSet.detachControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:59

`Protected` detachInlets

detachInlets(): void
Protected
Returns void
Inherited from ControllerSet.detachInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:803

detachTrait

detachTrait(trait): C
Parameters
- trait: T
Returns C
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:48

detachTraits

detachTraits(traits): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:57

detectController

detectController(controller): C
Parameters
- controller: Controller
Returns C
Inherited from ControllerSet.detectController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:80

`Protected` didAttachController

didAttachController(controller, target): void
Protected
Parameters
- controller: C
- target: Controller
Returns void
Inherited from ControllerSet.didAttachController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:50

`Protected` didAttachTrait

didAttachTrait(trait, targetTrait, controller): void
Protected
Parameters
- trait: T
- targetTrait: Trait
- controller: C
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:44

`Protected` didBindInlet

didBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.didBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:751

`Protected` didConsume

didConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.didConsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:79

`Protected` didDetachController

didDetachController(controller): void
Protected
Parameters
- controller: C
Returns void
Inherited from ControllerSet.didDetachController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:58

`Protected` didDetachTrait

didDetachTrait(trait, controller): void
Protected
Parameters
- trait: T
- controller: C
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:56

`Protected` didMount

didMount(): void
Protected
Returns void
Inherited from ControllerSet.didMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:828

`Protected` didSetAffinity

didSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ControllerSet.didSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:789

`Protected` didSetInherits

didSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ControllerSet.didSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:773

`Protected` didSort

didSort(parent): void
Protected
Parameters
- parent: Controller
Returns void
Inherited from ControllerSet.didSort
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:98

`Protected` didStartConsuming

didStartConsuming(): void
Protected
Returns void
Inherited from ControllerSet.didStartConsuming
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:96

`Protected` didStopConsuming

didStopConsuming(): void
Protected
Returns void
Inherited from ControllerSet.didStopConsuming
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:104

`Protected` didUnbindInlet

didUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.didUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:760

`Protected` didUnconsume

didUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.didUnconsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:87

`Protected` didUnmount

didUnmount(): void
Protected
Returns void
Inherited from ControllerSet.didUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:836

`Protected` fromLike

fromLike(value): C
Protected
Parameters
- value: C | LikeType<C>
Returns C
Inherited from ControllerSet.fromLike
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:69

`Protected` fromTraitLike

fromTraitLike(value): T
Protected
Parameters
- value: T | LikeType<T>
Returns T
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:77

get

get(): C
Returns C
Inherited from ControllerSet.get
- Defined in swim-core/swim-component/dist/swim-component.d.ts:790

getFastener

getFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, [any]>
Parameters
- fastenerName: PropertyKey
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from ControllerSet.getFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:805

getParentFastener

getParentFastener<F>(fastenerName, fastenerType?, contextType?): F
Type Parameters
- F extends Fastener<any, any, [any]>
Parameters
- fastenerName: string
- Optional fastenerType: Proto<F>
- Optional contextType: Proto<any>
Returns F
Inherited from ControllerSet.getParentFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:807

getTraitRef

getTraitRef(controller): TraitRef<any, T, [T]>
Parameters
- controller: C
Returns TraitRef<any, T, [T]>
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:23

`Optional` getTransition

getTransition(fastener): Timing
Parameters
- fastener: Fastener<any, any, any>
Returns Timing
Inherited from ControllerSet.getTransition
- Defined in swim-core/swim-component/dist/swim-component.d.ts:815

hasAffinity

hasAffinity(affinity): boolean
Parameters
- affinity: Affinity
Returns boolean
Inherited from ControllerSet.hasAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:778

hasController

hasController(controller): boolean
Parameters
- controller: Controller
Returns boolean
Inherited from ControllerSet.hasController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:46

hasTrait

hasTrait(trait): boolean
Parameters
- trait: Trait
Returns boolean
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:28

`Protected` incrementVersion

incrementVersion(): void
Protected
Returns void
Inherited from ControllerSet.incrementVersion
- Defined in swim-core/swim-component/dist/swim-component.d.ts:737

`Protected` init

init(): void
Protected
Returns void
Inherited from ControllerSet.init
- Defined in swim-core/swim-component/dist/swim-component.d.ts:725

`Protected` initController

initController(controller): void
Protected
Parameters
- controller: C
Returns void
Inherited from ControllerSet.initController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:44

`Protected` initTrait

initTrait(trait, controller): void
Protected
Parameters
- trait: T
- controller: C
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:38

`Protected` insertChild

insertChild(parent, child, target, key): void
Protected
Parameters
- parent: Controller
- child: C
- target: Controller
- key: string
Returns void
Inherited from ControllerSet.insertChild
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:61

insertController

insertController(parent?, controller?, target?, key?): C
Parameters
- Optional parent: Controller
- Optional controller: C | LikeType<C>
- Optional target: Controller
- Optional key: string
Returns C
Inherited from ControllerSet.insertController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:62

insertControllers

insertControllers(parent, controllers, target?): void
Parameters
- parent: Controller
- controllers: {
  [controllerId: string]: C | undefined;
  }
  - [controllerId: string]: C | undefined
- Optional target: Controller
Returns void
Inherited from ControllerSet.insertControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:63

insertTrait

insertTrait(parent, trait, targetTrait?, key?): C
Parameters
- parent: Controller
- trait: T | LikeType<T>
- Optional targetTrait: Trait
- Optional key: string
Returns C
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:60

insertTraits

insertTraits(parent, traits, targetTrait?, key?): void
Parameters
- parent: Controller
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
- Optional targetTrait: Trait
- Optional key: string
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:61

`Protected` onAttachController

onAttachController(controller, targetController): void
Protected
Parameters
- controller: C
- targetController: Controller
Returns void
Overrides ControllerSet.onAttachController
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:79

`Protected` onAttachTrait

onAttachTrait(trait, targetTrait, controller): void
Protected
Parameters
- trait: T
- targetTrait: Trait
- controller: C
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:42

`Protected` onBindInlet

onBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.onBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:749

`Protected` onConsume

onConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.onConsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:77

`Protected` onDetachController

onDetachController(controller): void
Protected
Parameters
- controller: C
Returns void
Overrides ControllerSet.onDetachController
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:81

`Protected` onDetachTrait

onDetachTrait(trait, controller): void
Protected
Parameters
- trait: T
- controller: C
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:54

`Protected` onMount

onMount(): void
Protected
Returns void
Inherited from ControllerSet.onMount
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:106

`Protected` onSetAffinity

onSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ControllerSet.onSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:787

`Protected` onSetInherits

onSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ControllerSet.onSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:771

`Protected` onSort

onSort(parent): void
Protected
Parameters
- parent: Controller
Returns void
Inherited from ControllerSet.onSort
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:96

`Protected` onStartConsuming

onStartConsuming(): void
Protected
Returns void
Inherited from ControllerSet.onStartConsuming
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:84

`Protected` onStopConsuming

onStopConsuming(): void
Protected
Returns void
Inherited from ControllerSet.onStopConsuming
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:86

`Protected` onUnbindInlet

onUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.onUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:758

`Protected` onUnconsume

onUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.onUnconsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:85

`Protected` onUnmount

onUnmount(): void
Protected
Returns void
Inherited from ControllerSet.onUnmount
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:108

order

order(ordered?): TraitControllerSet<R, T, C, I>
Parameters
- Optional ordered: boolean
Returns TraitControllerSet<R, T, C, I>
Inherited from ControllerSet.order
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:90

recohere

recohere(t): void
Parameters
- t: number
Returns void
Inherited from ControllerSet.recohere
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:88

reinsertController

reinsertController(controller, target?): void
Parameters
- controller: C
- Optional target: Controller
Returns void
Inherited from ControllerSet.reinsertController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:74

reinsertTrait

reinsertTrait(trait, targetTrait?): void
Parameters
- trait: T
- Optional targetTrait: T
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:72

removeController

removeController(controller): C
Parameters
- controller: C
Returns C
Inherited from ControllerSet.removeController
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:66

removeControllers

removeControllers(controllers?): void
Parameters
- Optional controllers: {
  [controllerId: string]: C | undefined;
  }
  - [controllerId: string]: C | undefined
Returns void
Inherited from ControllerSet.removeControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:67

removeTrait

removeTrait(trait): C
Parameters
- trait: T
Returns C
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:64

removeTraits

removeTraits(traits): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:65

requireRecohere

requireRecohere(): void
Returns void
Inherited from ControllerSet.requireRecohere
- Defined in swim-core/swim-component/dist/swim-component.d.ts:795

requireUpdate

requireUpdate(updateFlags): void
Parameters
- updateFlags: number
Returns void
Inherited from ControllerSet.requireUpdate
- Defined in swim-core/swim-component/dist/swim-component.d.ts:813

resolveInlets

resolveInlets(): readonly Fastener<any, any, any>[]
Returns readonly Fastener<any, any, any>[]
Inherited from ControllerSet.resolveInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:799

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from ControllerSet.setAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:783

`Protected` setCoherent

setCoherent(coherent): void
Protected
Parameters
- coherent: boolean
Returns void
Inherited from ControllerSet.setCoherent
- Defined in swim-core/swim-component/dist/swim-component.d.ts:793

`Protected` setCoherentTime

setCoherentTime(coherentTime): void
Protected
Parameters
- coherentTime: number
Returns void
Inherited from ControllerSet.setCoherentTime
- Defined in swim-core/swim-component/dist/swim-component.d.ts:734

setControllers

setControllers(controllers, target?): void
Parameters
- controllers: {
  [controllerId: string]: C | undefined;
  }
  - [controllerId: string]: C | undefined
- Optional target: Controller
Returns void
Inherited from ControllerSet.setControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:51

setInherits

setInherits(inherits): void
Parameters
- inherits: boolean | PropertyKey
Returns void
Inherited from ControllerSet.setInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:767

setTraits

setTraits(traits, targetTrait?): void
Parameters
- traits: {
  [traitId: string]: T | undefined;
  }
  - [traitId: string]: T | undefined
- Optional targetTrait: Trait
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:33

sort

sort(sorted?): TraitControllerSet<R, T, C, I>
Parameters
- Optional sorted: boolean
Returns TraitControllerSet<R, T, C, I>
Inherited from ControllerSet.sort
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:92

toString

toString(): string
Returns string
Inherited from ControllerSet.toString
- Defined in swim-core/swim-component/dist/swim-component.d.ts:838

unbindInlet

unbindInlet(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.unbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:754

unconsume

unconsume(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.unconsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:81

unconsumeControllers

unconsumeControllers(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.unconsumeControllers
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:82

unconsumeTraits

unconsumeTraits(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:74

`Protected` willAttachController

willAttachController(controller, target): void
Protected
Parameters
- controller: C
- target: Controller
Returns void
Inherited from ControllerSet.willAttachController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:46

`Protected` willAttachTrait

willAttachTrait(trait, targetTrait, controller): void
Protected
Parameters
- trait: T
- targetTrait: Trait
- controller: C
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:40

`Protected` willBindInlet

willBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.willBindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:747

`Protected` willConsume

willConsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.willConsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:75

`Protected` willDetachController

willDetachController(controller): void
Protected
Parameters
- controller: C
Returns void
Inherited from ControllerSet.willDetachController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:54

`Protected` willDetachTrait

willDetachTrait(trait, controller): void
Protected
Parameters
- trait: T
- controller: C
Returns void
- Defined in swim-ui/swim-controller/lib/main/TraitControllerSet.d.ts:52

`Protected` willMount

willMount(): void
Protected
Returns void
Inherited from ControllerSet.willMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:824

`Protected` willSetAffinity

willSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from ControllerSet.willSetAffinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:785

`Protected` willSetInherits

willSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from ControllerSet.willSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:769

`Protected` willSort

willSort(parent): void
Protected
Parameters
- parent: Controller
Returns void
Inherited from ControllerSet.willSort
- Defined in swim-ui/swim-controller/lib/main/ControllerSet.d.ts:94

`Protected` willStartConsuming

willStartConsuming(): void
Protected
Returns void
Inherited from ControllerSet.willStartConsuming
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:92

`Protected` willStopConsuming

willStopConsuming(): void
Protected
Returns void
Inherited from ControllerSet.willStopConsuming
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:100

`Protected` willUnbindInlet

willUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerSet.willUnbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:756

`Protected` willUnconsume

willUnconsume(consumer): void
Protected
Parameters
- consumer: unknown
Returns void
Inherited from ControllerSet.willUnconsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:83

`Protected` willUnmount

willUnmount(): void
Protected
Returns void
Inherited from ControllerSet.willUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:832

Interface TraitControllerSet<R, T, C, I>

Type Parameters

R = any

T extends Trait = Trait

C extends Controller = Controller

I extends any[] = [C | null]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly coherentTime

Readonly controllerCount

Readonly inlet

Readonly inletVersion

Readonly name

Readonly owner

Readonly version

Accessors

affinity

Returns Affinity

binds

Returns boolean

coherent

Returns boolean

consumed

Returns boolean

consuming

Returns boolean

controllerType

Returns ControllerFactory<C>

derived

Returns boolean

descriptorType

Returns Proto<TraitControllerSetDescriptor<R, T, C>>

fastenerType

Returns Proto<ControllerSet<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

mounted

Returns boolean

observes

Returns boolean

ordered

Returns boolean

parent

Returns ControllerSet<any, C, any>

parentController

Returns Controller

parentType

Returns Proto<any>

sorted

Returns boolean

traitType

Returns TraitFactory<T>

Methods

addController

Parameters

Optional controller: C | LikeType<C>

Optional target: Controller

Optional key: string

Returns C

addControllers

Parameters

controllers: { [controllerId: string]: C | undefined; }

[controllerId: string]: C | undefined

Optional target: Controller

Returns void

addTrait

Parameters

trait: T | LikeType<T>

Optional targetTrait: Trait

Optional key: string

Returns C

addTraits

`Readonly` coherentTime

`Readonly` controllerCount

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` version

`Optional` controller: C | LikeType<C>

`Optional` target: Controller

`Optional` key: string

controllers: {
[controllerId: string]: C | undefined;
}

`Optional` target: Controller

`Optional` targetTrait: Trait

`Optional` key: string

traits: {
[traitId: string]: T | undefined;
}

`Optional` targetTrait: Trait

`Optional` controller: C | LikeType<C>

`Optional` target: Controller

controllers: {
[controllerId: string]: C | undefined;
}

`Optional` target: Controller

`Protected` attachInlets

`Optional` targetTrait: Trait

`Optional` controller: C

traits: {
[traitId: string]: T | undefined;
}

`Optional` targetTrait: Trait

`Protected` compare

`Optional` trait: T