Interface ViewControllerRef<R, V, C, I>

Type Parameters

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

Hierarchy

ControllerRef<R, C, I>
- ViewControllerRef

Index

Properties

coherentTime controller inlet inletVersion name owner version view

Methods

attachController attachFastener attachInlets attachView bindInlet consume createController createView decohere decohereFastener deinitController deinitView deleteController deleteView detachController detachInlets detachView detectController detectControllerView didAttachController didAttachView didBindInlet didConsume didDetachController didDetachView didMount didSetAffinity didSetInherits didStartConsuming didStopConsuming didUnbindInlet didUnconsume didUnmount fromLike fromViewLike get getController getFastener getInletController getParentFastener getTransition? getView hasAffinity incrementVersion init initController initView insertChild insertController insertControllerView insertView onAttachController onAttachView onBindInlet onConsume onDetachController onDetachView onMount onSetAffinity onSetInherits onStartConsuming onStopConsuming onUnbindInlet onUnconsume onUnmount recohere removeController removeView requireRecohere requireUpdate resolveInlets set setAffinity setCoherent setCoherentTime setController setInherits setIntrinsic setView toString unbindInlet unconsume willAttachController willAttachView willBindInlet willConsume willDetachController willDetachView willMount willSetAffinity willSetInherits willStartConsuming willStopConsuming willUnbindInlet willUnconsume willUnmount

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

`Readonly` view

view: V

Accessors

affinity

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

binds

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

coherent

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

consumed

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

consuming

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

controllerKey

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

controllerType

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

derived

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

descriptorType

get descriptorType(): Proto<ViewControllerRefDescriptor<R, V, C>>
Returns Proto<ViewControllerRefDescriptor<R, V, C>>
Overrides ControllerRef.descriptorType
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:21

fastenerType

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

inheritName

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

inherits

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

inletController

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

inletKeys

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

mounted

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

observes

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

observesView

get observesView(): boolean
Returns boolean
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:26

parent

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

parentController

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

parentType

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

viewKey

get viewKey(): string
Returns string
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:25

viewType

get viewType(): ViewFactory<V>
Returns ViewFactory<V>
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:24

Methods

attachController

attachController(controller?, target?): C
Parameters
- Optional controller: C | LikeType<C>
- Optional target: Controller
Returns C
Inherited from ControllerRef.attachController
- 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 ControllerRef.attachFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:809

`Protected` attachInlets

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

attachView

attachView(view?, targetView?): V
Parameters
- Optional view: V | LikeType<V>
- Optional targetView: View
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:30

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

consume

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

createController

createController(view?): C
Parameters
- Optional view: V
Returns C
Overrides ControllerRef.createController
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:63

createView

createView(): V
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:51

decohere

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

`Protected` deinitView

deinitView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:41

deleteController

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

deleteView

deleteView(): V
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:50

detachController

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

`Protected` detachInlets

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

detachView

detachView(): V
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:39

detectController

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

`Protected` detectControllerView

detectControllerView(controller): V
Protected
Parameters
- controller: Controller
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:55

`Protected` didAttachController

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

`Protected` didAttachView

didAttachView(view, targetView): void
Protected
Parameters
- view: V
- targetView: View
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:38

`Protected` didBindInlet

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

`Protected` didDetachView

didDetachView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:47

`Protected` didMount

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

`Protected` didStartConsuming

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

`Protected` didStopConsuming

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

`Protected` didUnmount

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

`Protected` fromViewLike

fromViewLike(value): V
Protected
Parameters
- value: V | LikeType<V>
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:53

get

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

getController

getController(): C
Returns C
Inherited from ControllerRef.getController
- 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 ControllerRef.getFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:805

getInletController

getInletController(): C
Returns C
Inherited from ControllerRef.getInletController
- 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 ControllerRef.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 ControllerRef.getTransition
- Defined in swim-core/swim-component/dist/swim-component.d.ts:815

getView

getView(): V
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:28

hasAffinity

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

`Protected` incrementVersion

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

`Protected` init

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

`Protected` initView

initView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:32

`Protected` insertChild

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

`Protected` insertControllerView

insertControllerView(controller, view, targetView, viewKey): void
Protected
Parameters
- controller: C
- view: V
- targetView: View
- viewKey: string
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:57

insertView

insertView(controller?, view?, targetView?, controllerKey?): V
Parameters
- Optional controller: C
- Optional view: V | LikeType<V>
- Optional targetView: View
- Optional controllerKey: string
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:48

`Protected` onAttachController

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

`Protected` onAttachView

onAttachView(view, targetView): void
Protected
Parameters
- view: V
- targetView: View
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:36

`Protected` onBindInlet

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

`Protected` onDetachView

onDetachView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:45

`Protected` onMount

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

`Protected` onStartConsuming

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

`Protected` onStopConsuming

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

`Protected` onUnmount

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

recohere

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

removeController

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

removeView

removeView(): V
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:49

requireRecohere

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

requireUpdate

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

set

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

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from ControllerRef.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 ControllerRef.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 ControllerRef.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
Inherited from ControllerRef.setController
- Defined in swim-ui/swim-controller/lib/main/ControllerRef.d.ts:35

setInherits

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

setIntrinsic

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

setView

setView(view, targetView?, controllerKey?): V
Parameters
- view: V | LikeType<V>
- Optional targetView: View
- Optional controllerKey: string
Returns V
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:29

toString

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

unconsume

unconsume(consumer): void
Parameters
- consumer: unknown
Returns void
Inherited from ControllerRef.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 ControllerRef.willAttachController
- Defined in swim-ui/swim-controller/lib/main/ControllerRelation.d.ts:46

`Protected` willAttachView

willAttachView(view, targetView): void
Protected
Parameters
- view: V
- targetView: View
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:34

`Protected` willBindInlet

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

`Protected` willDetachView

willDetachView(view): void
Protected
Parameters
- view: V
Returns void
- Defined in swim-ui/swim-controller/lib/main/ViewControllerRef.d.ts:43

`Protected` willMount

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

`Protected` willStartConsuming

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

`Protected` willStopConsuming

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

`Protected` willUnmount

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

Interface ViewControllerRef<R, V, C, I>

Type Parameters

R = any

V extends View = View

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

Readonly view

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<ViewControllerRefDescriptor<R, V, 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

observesView

Returns boolean

parent

Returns ControllerRef<any, C, any>

parentController

Returns Controller

parentType

Returns Proto<any>

viewKey

Returns string

viewType

Returns ViewFactory<V>

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

attachView

Parameters

Optional view: V | LikeType<V>

`Readonly` coherentTime

`Readonly` controller

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` version

`Readonly` view

`Optional` controller: C | LikeType<C>

`Optional` target: Controller

`Protected` attachInlets

`Optional` view: V | LikeType<V>

`Optional` targetView: View

`Optional` view: V

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

`Protected` deinitController

`Protected` deinitView

`Protected` detachInlets

`Protected` detectControllerView

`Protected` didAttachController

`Protected` didAttachView

`Protected` didBindInlet