Interface ControllerRef<R, C, I>

Type Parameters

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

Hierarchy

ControllerRelation<R, C, I>
- ControllerRef

Index

Properties

`Readonly` coherentTime

coherentTime: number

`Readonly` controller

controller: C

`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 ControllerRelation.affinity
- Defined in swim-core/swim-component/dist/swim-component.d.ts:777

binds

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

coherent

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

consumed

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

consuming

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

controllerKey

get controllerKey(): string
Returns string
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:29

controllerType

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

derived

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

descriptorType

get descriptorType(): Proto<ControllerRefDescriptor<R, C>>
Returns Proto<ControllerRefDescriptor<R, C>>
Overrides ControllerRelation.descriptorType
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:22

fastenerType

get fastenerType(): Proto<ControllerRef<any, any, any>>
Returns Proto<ControllerRef<any, any, any>>
Overrides ControllerRelation.fastenerType
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:24

inheritName

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

inherits

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

inletController

get inletController(): C
Returns C
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:27

inletKeys

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

mounted

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

observes

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

parent

get parent(): ControllerRef<any, C, any>
Returns ControllerRef<any, C, any>
Overrides ControllerRelation.parent
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:26

parentController

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

parentType

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

Methods

attachController

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

attachFastener

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

`Protected` attachInlets

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

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 ControllerRelation.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 ControllerRelation.bindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:745

consume

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

createController

createController(): C
Returns C
Inherited from ControllerRelation.createController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:67

decohere

decohere(inlet?): void
Parameters
- Optional inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.deinitController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:52

deleteController

deleteController(): C
Returns C
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:40

detachController

detachController(): C
Returns C
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:37

`Protected` detachInlets

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

detectController

detectController(controller): C
Parameters
- controller: Controller
Returns C
Overrides ControllerRelation.detectController
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:46

`Protected` didAttachController

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

`Protected` didBindInlet

didBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.didDetachController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:58

`Protected` didMount

didMount(): void
Protected
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.didSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:773

`Protected` didStartConsuming

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

`Protected` didStopConsuming

didStopConsuming(): void
Protected
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.didUnconsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:87

`Protected` didUnmount

didUnmount(): void
Protected
Returns void
Inherited from ControllerRelation.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 ControllerRelation.fromLike
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:69

get

get(): C
Returns C
Overrides ControllerRelation.get
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:30

getController

getController(): C
Returns C
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:34

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 ControllerRelation.getFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:805

getInletController

getInletController(): C
Returns C
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:28

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 ControllerRelation.getParentFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:807

`Optional` getTransition

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

hasAffinity

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

`Protected` incrementVersion

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

`Protected` init

init(): void
Protected
Returns void
Inherited from ControllerRelation.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 ControllerRelation.initController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:44

`Protected` insertChild

insertChild(parent, child, target, key): void
Protected
Parameters
- parent: Controller
- child: C
- target: Controller
- key: string
Returns void
Inherited from ControllerRelation.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
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:38

`Protected` onAttachController

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

`Protected` onBindInlet

onBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerRelation.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 ControllerRelation.onConsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:77

`Protected` onDetachController

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

`Protected` onMount

onMount(): void
Protected
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.onSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:771

`Protected` onStartConsuming

onStartConsuming(): void
Protected
Returns void
Overrides ControllerRelation.onStartConsuming
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:48

`Protected` onStopConsuming

onStopConsuming(): void
Protected
Returns void
Overrides ControllerRelation.onStopConsuming
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:50

`Protected` onUnbindInlet

onUnbindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerRelation.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 ControllerRelation.onUnconsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:85

`Protected` onUnmount

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

recohere

recohere(t): void
Parameters
- t: number
Returns void
Overrides ControllerRelation.recohere
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:52

removeController

removeController(): C
Returns C
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:39

requireRecohere

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

requireUpdate

requireUpdate(updateFlags): void
Parameters
- updateFlags: number
Returns void
Inherited from ControllerRelation.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 ControllerRelation.resolveInlets
- Defined in swim-core/swim-component/dist/swim-component.d.ts:799

set

set(controller): R
Parameters
- controller: C | Fastener<any, I[0], any> | LikeType<C>
Returns R
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:31

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.setCoherentTime
- Defined in swim-core/swim-component/dist/swim-component.d.ts:734

setController

setController(controller, target?, key?): C
Parameters
- controller: C | LikeType<C>
- Optional target: Controller
- Optional key: string
Returns C
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:35

setInherits

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

setIntrinsic

setIntrinsic(controller): R
Parameters
- controller: C | Fastener<any, I[0], any> | LikeType<C>
Returns R
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:32

toString

toString(): string
Returns string
Inherited from ControllerRelation.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 ControllerRelation.unbindInlet
- Defined in swim-core/swim-component/dist/swim-component.d.ts:754

unconsume

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

`Protected` willAttachController

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

`Protected` willBindInlet

willBindInlet(inlet): void
Protected
Parameters
- inlet: Fastener<any, any, any>
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.willDetachController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:54

`Protected` willMount

willMount(): void
Protected
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.willSetInherits
- Defined in swim-core/swim-component/dist/swim-component.d.ts:769

`Protected` willStartConsuming

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

`Protected` willStopConsuming

willStopConsuming(): void
Protected
Returns void
Inherited from ControllerRelation.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 ControllerRelation.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 ControllerRelation.willUnconsume
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:83

`Protected` willUnmount

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

Interface ControllerRef<R, C, I>

Type Parameters

R = any

C extends Controller = Controller

I extends any[] = [C | null]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly coherentTime

Readonly controller

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

controllerKey

Returns string

controllerType

Returns ControllerFactory<C>

derived

Returns boolean

descriptorType

Returns Proto<ControllerRefDescriptor<R, C>>

fastenerType

Returns Proto<ControllerRef<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletController

Returns C

inletKeys

Returns readonly PropertyKey[]

mounted

Returns boolean

observes

Returns boolean

parent

Returns ControllerRef<any, C, any>

parentController

Returns Controller

parentType

Returns Proto<any>

Methods

attachController

Parameters

Optional controller: C | LikeType<C>

Optional target: Controller

Returns C

attachFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected attachInlets

Returns void

bindInlet

Type Parameters

K extends string | number | symbol

IK

Parameters

inlet: Fastener<any, IK, any>

key: IK

Returns void

Type Parameters

I0 extends any

Parameters

`Readonly` coherentTime

`Readonly` controller

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` version

`Optional` controller: C | LikeType<C>

`Optional` target: Controller

`Protected` attachInlets

`Optional` inlet: Fastener<any, any, any>

`Protected` deinitController

`Protected` detachInlets

`Protected` didAttachController

`Protected` didBindInlet

`Protected` didConsume

`Protected` didDetachController

`Protected` didMount

`Protected` didSetAffinity

`Protected` didSetInherits

`Protected` didStartConsuming

`Protected` didStopConsuming

`Protected` didUnbindInlet

`Protected` didUnconsume