Interface ComponentRelation<R, C, I>

Type Parameters

R = any
C extends Component<any> = Component
I extends any[] = [C | null]

Hierarchy

Fastener<R, C | null, I>
- ComponentRelation

Index

Properties

coherentTime inlet inletVersion name owner version

Accessors

affinity binds coherent componentType derived descriptorType fastenerType inheritName inherits inletKeys mounted observes parent parentComponent parentType

Properties

`Readonly` coherentTime

coherentTime: 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 Fastener.affinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:146

binds

get binds(): boolean
Returns boolean
Inherited from Fastener.binds
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:92

coherent

get coherent(): boolean
Returns boolean
Inherited from Fastener.coherent
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:160

componentType

get componentType(): ComponentFactory<C>
Returns ComponentFactory<C>
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:21

derived

get derived(): boolean
Returns boolean
Inherited from Fastener.derived
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:143

descriptorType

get descriptorType(): Proto<ComponentRelationDescriptor<R, C>>
Returns Proto<ComponentRelationDescriptor<R, C>>
Overrides Fastener.descriptorType
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:18

fastenerType

get fastenerType(): Proto<ComponentRelation<any, any, any>>
Returns Proto<ComponentRelation<any, any, any>>
Overrides Fastener.fastenerType
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:20

inheritName

get inheritName(): PropertyKey
Returns PropertyKey
Inherited from Fastener.inheritName
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:134

inherits

get inherits(): boolean
Returns boolean
Inherited from Fastener.inherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:135

inletKeys

get inletKeys(): readonly PropertyKey[]
Protected
Returns readonly PropertyKey[]
Inherited from Fastener.inletKeys
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:167

mounted

get mounted(): boolean
Returns boolean
Inherited from Fastener.mounted
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:189

observes

get observes(): boolean
Returns boolean
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:22

parent

get parent(): ComponentRelation<any, C, any>
Returns ComponentRelation<any, C, any>
Overrides Fastener.parent
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:24

parentComponent

get parentComponent(): Component<any>
Protected
Returns Component<any>
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:50

parentType

get parentType(): Proto<any>
Returns Proto<any>
Inherited from Fastener.parentType
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:107

Methods

attachFastener

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

`Protected` attachInlets

attachInlets(): void
Protected
Returns void
Inherited from Fastener.attachInlets
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:170

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 Fastener.bindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:113
bindInlet<I0>(inlet): void
Type Parameters
- I0 extends any
Parameters
- inlet: Fastener<any, I0, any>
Returns void
Inherited from Fastener.bindInlet
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:114

createComponent

createComponent(): C
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:58

decohere

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

decohereFastener

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

`Protected` deinitComponent

deinitComponent(component): void
Protected
Parameters
- component: C
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:42

`Protected` detachInlets

detachInlets(): void
Protected
Returns void
Inherited from Fastener.detachInlets
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:172

detectComponent

detectComponent(component): C
Parameters
- component: Component<any>
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:57

`Protected` didAttachComponent

didAttachComponent(component, target): void
Protected
Parameters
- component: C
- target: Component<any>
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:40

`Protected` didBindInlet

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

`Protected` didDetachComponent

didDetachComponent(component): void
Protected
Parameters
- component: C
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:48

`Protected` didMount

didMount(): void
Protected
Returns void
Inherited from Fastener.didMount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:197

`Protected` didSetAffinity

didSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from Fastener.didSetAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:158

`Protected` didSetInherits

didSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from Fastener.didSetInherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:142

`Protected` didUnbindInlet

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

`Protected` didUnmount

didUnmount(): void
Protected
Returns void
Inherited from Fastener.didUnmount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:205

fromLike

fromLike(value): C
Parameters
- value: C | LikeType<C>
Returns C
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:59

get

get(): C
Returns C
Inherited from Fastener.get
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:159

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 Fastener.getFastener
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:174

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 Fastener.getParentFastener
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:176

`Optional` getTransition

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

hasAffinity

hasAffinity(affinity): boolean
Parameters
- affinity: Affinity
Returns boolean
Inherited from Fastener.hasAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:147

`Protected` incrementVersion

incrementVersion(): void
Protected
Returns void
Inherited from Fastener.incrementVersion
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:106

`Protected` init

init(): void
Protected
Returns void
Inherited from Fastener.init
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:94

`Protected` initComponent

initComponent(component): void
Protected
Parameters
- component: C
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:34

`Protected` insertChild

insertChild(parent, child, target, key): void
Protected
Parameters
- parent: Component<any>
- child: C
- target: Component<any>
- key: string
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:52

`Protected` onAttachComponent

onAttachComponent(component, target): void
Protected
Parameters
- component: C
- target: Component<any>
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:38

`Protected` onBindInlet

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

`Protected` onDetachComponent

onDetachComponent(component): void
Protected
Parameters
- component: C
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:46

`Protected` onMount

onMount(): void
Protected
Returns void
Inherited from Fastener.onMount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:195

`Protected` onSetAffinity

onSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from Fastener.onSetAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:156

`Protected` onSetInherits

onSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from Fastener.onSetInherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:140

`Protected` onUnbindInlet

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

`Protected` onUnmount

onUnmount(): void
Protected
Returns void
Inherited from Fastener.onUnmount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:203

recohere

recohere(t): void
Parameters
- t: number
Returns void
Inherited from Fastener.recohere
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:165

requireRecohere

requireRecohere(): void
Returns void
Inherited from Fastener.requireRecohere
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:164

requireUpdate

requireUpdate(updateFlags): void
Parameters
- updateFlags: number
Returns void
Inherited from Fastener.requireUpdate
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:182

resolveInlets

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

setAffinity

setAffinity(affinity): void
Parameters
- affinity: Affinity
Returns void
Inherited from Fastener.setAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:152

`Protected` setCoherent

setCoherent(coherent): void
Protected
Parameters
- coherent: boolean
Returns void
Inherited from Fastener.setCoherent
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:162

`Protected` setCoherentTime

setCoherentTime(coherentTime): void
Protected
Parameters
- coherentTime: number
Returns void
Inherited from Fastener.setCoherentTime
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:103

setInherits

setInherits(inherits): void
Parameters
- inherits: boolean | PropertyKey
Returns void
Inherited from Fastener.setInherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:136

toString

toString(): string
Returns string
Inherited from Fastener.toString
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:207

unbindInlet

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

`Protected` willAttachComponent

willAttachComponent(component, target): void
Protected
Parameters
- component: C
- target: Component<any>
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:36

`Protected` willBindInlet

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

`Protected` willDetachComponent

willDetachComponent(component): void
Protected
Parameters
- component: C
Returns void
- Defined in swim-core/swim-component/lib/main/ComponentRelation.d.ts:44

`Protected` willMount

willMount(): void
Protected
Returns void
Inherited from Fastener.willMount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:193

`Protected` willSetAffinity

willSetAffinity(newAffinity, oldAffinity): void
Protected
Parameters
- newAffinity: Affinity
- oldAffinity: Affinity
Returns void
Inherited from Fastener.willSetAffinity
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:154

`Protected` willSetInherits

willSetInherits(inherits, inheritName): void
Protected
Parameters
- inherits: boolean
- inheritName: PropertyKey
Returns void
Inherited from Fastener.willSetInherits
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:138

`Protected` willUnbindInlet

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

`Protected` willUnmount

willUnmount(): void
Protected
Returns void
Inherited from Fastener.willUnmount
- Defined in swim-core/swim-component/lib/main/Fastener.d.ts:201

Interface ComponentRelation<R, C, I>

Type Parameters

R = any

C extends Component<any> = Component

I extends any[] = [C | null]

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly coherentTime

Readonly inlet

Readonly inletVersion

Readonly name

Readonly owner

Readonly version

Accessors

affinity

Returns Affinity

binds

Returns boolean

coherent

Returns boolean

componentType

Returns ComponentFactory<C>

derived

Returns boolean

descriptorType

Returns Proto<ComponentRelationDescriptor<R, C>>

fastenerType

Returns Proto<ComponentRelation<any, any, any>>

inheritName

Returns PropertyKey

inherits

Returns boolean

inletKeys

Returns readonly PropertyKey[]

mounted

Returns boolean

observes

Returns boolean

parent

Returns ComponentRelation<any, C, any>

parentComponent

Returns Component<any>

parentType

Returns Proto<any>

Methods

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

inlet: Fastener<any, I0, any>

Returns void

createComponent

Returns C

decohere

Parameters

Optional inlet: Fastener<any, any, any>

Returns void

decohereFastener

Parameters

fastener: Fastener<any, any, any>

Returns void

Protected deinitComponent

Parameters

`Readonly` coherentTime

`Readonly` inlet

`Readonly` inletVersion

`Readonly` name

`Readonly` owner

`Readonly` version

`Protected` attachInlets

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

`Protected` deinitComponent

`Protected` detachInlets

`Protected` didAttachComponent

`Protected` didBindInlet

`Protected` didDetachComponent

`Protected` didMount

`Protected` didSetAffinity

`Protected` didSetInherits

`Protected` didUnbindInlet

`Protected` didUnmount

`Optional` fastenerType: Proto<F>

`Optional` contextType: Proto<any>

`Optional` fastenerType: Proto<F>

`Optional` contextType: Proto<any>

`Optional` getTransition

`Protected` incrementVersion