Class Controller

Hierarchy

Component<Controller>
- Controller

Implements

Consumable
WarpRef

Index

Constructors

Accessors

compiling componentType consuming executing hostUri insertChildFlags inserting laneUri mountFlags mounted nodeUri reinsertChildFlags removeChildFlags removing startConsumingFlags stopConsumingFlags updateTime updating warpRef

Methods

appendChild attachFastener authenticate bindFastener callObservers cascadeCompile cascadeExecute command commonAncestor compileChild compileChildren consume decohereFastener didAssemble didAttachParent didCompile didCompute didConsume didDetachParent didExecute didGenerate didInsertChild didMount didObserve didReinsertChild didRemoveChild didResolve didRevise didStartConsuming didStopConsuming didUnconsume didUnmount didUnobserve downlink downlinkList downlinkMap downlinkValue equals executeChildren forEachChild getAncestor getChild getFastener getFirstChild getLastChild getNextSibling getParentFastener getPreviousSibling getRoot getTargetChild hashCode hostRef insertChild isAncestorOf laneRef likeType? mount needsCompile needsExecute needsUpdate nodeRef observe onAssemble onAttachParent onCompile onCompute onConsume onDetachParent onExecute onGenerate onInsertChild onMount onObserve onReinsertChild onRemoveChild onResolve onRevise onStartConsuming onStopConsuming onUnconsume onUnmount onUnobserve prependChild reinsertChild remove removeChild removeChildren replaceChild requestUpdate requireUpdate set setChild setIntrinsic sortChildren startConsuming stopConsuming tryFastener unconsume unmount unobserve willAssemble willAttachParent willCompile willCompute willConsume willDetachParent willExecute willGenerate willInsertChild willMount willObserve willReinsertChild willRemoveChild willResolve willRevise willStartConsuming willStopConsuming willUnconsume willUnmount willUnobserve create fromLike

Constructors

constructor

new Controller(): Controller
Returns Controller
Overrides Component<Controller>.constructor
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:70

Properties

`Readonly` firstChild

firstChild: Controller

`Readonly` key

key: string

`Readonly` lastChild

lastChild: Controller

`Readonly` nextSibling

nextSibling: Controller

`Optional` `Readonly` observerType

observerType?: Class<ControllerObserver<Controller>>

`Readonly` parent

parent: Controller

`Readonly` previousSibling

previousSibling: Controller

`Readonly` updater

updater: Provider<Controller, ExecutorService>

`Static` `Readonly` InsertChildFlags

InsertChildFlags: number

`Static` `Readonly` MountFlags

MountFlags: number

`Static` `Readonly` NeedsAssemble

NeedsAssemble: number

`Static` `Readonly` NeedsCompile

NeedsCompile: number

`Static` `Readonly` NeedsCompute

NeedsCompute: number

`Static` `Readonly` NeedsExecute

NeedsExecute: number

`Static` `Readonly` NeedsGenerate

NeedsGenerate: number

`Static` `Readonly` NeedsResolve

NeedsResolve: number

`Static` `Readonly` NeedsRevise

NeedsRevise: number

`Static` `Readonly` ReinsertChildFlags

ReinsertChildFlags: number

`Static` `Readonly` RemoveChildFlags

RemoveChildFlags: number

`Static` `Readonly` StartConsumingFlags

StartConsumingFlags: number

`Static` `Readonly` StopConsumingFlags

StopConsumingFlags: number

Accessors

compiling

get compiling(): boolean
Returns boolean
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:99

componentType

get componentType(): Class<Controller>
Returns Class<Controller>
Overrides Component.componentType
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:73

consuming

get consuming(): boolean
Returns boolean
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:152

executing

get executing(): boolean
Returns boolean
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:116

hostUri

get hostUri(): Property<this, Uri, [Uri]>
Returns Property<this, Uri, [Uri]>
Implementation of WarpRef.hostUri
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:170

insertChildFlags

get insertChildFlags(): number
Returns number
Inherited from Component.insertChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:198

inserting

get inserting(): boolean
Returns boolean
Inherited from Component.inserting
- Defined in swim-core/swim-component/dist/swim-component.d.ts:199

laneUri

get laneUri(): Property<this, Uri, [Uri]>
Returns Property<this, Uri, [Uri]>
Implementation of WarpRef.laneUri
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:174

mountFlags

get mountFlags(): number
Returns number
Inherited from Component.mountFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:229

mounted

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

nodeUri

get nodeUri(): Property<this, Uri, [Uri]>
Returns Property<this, Uri, [Uri]>
Implementation of WarpRef.nodeUri
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:172

reinsertChildFlags

get reinsertChildFlags(): number
Returns number
Inherited from Component.reinsertChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:215

removeChildFlags

get removeChildFlags(): number
Returns number
Inherited from Component.removeChildFlags
- Defined in swim-core/swim-component/dist/swim-component.d.ts:208

removing

get removing(): boolean
Returns boolean
Inherited from Component.removing
- Defined in swim-core/swim-component/dist/swim-component.d.ts:209

startConsumingFlags

get startConsumingFlags(): number
Returns number
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:153

stopConsumingFlags

get stopConsumingFlags(): number
Returns number
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:158

updateTime

get updateTime(): number
Returns number
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:167

updating

get updating(): boolean
Returns boolean
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:98

warpRef

get warpRef(): Property<this, WarpRef, [WarpRef]>
Returns Property<this, WarpRef, [WarpRef]>
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:211

Methods

appendChild

appendChild<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Controller>> & Creatable<Instance<F, Controller>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
Inherited from Component.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:186
appendChild<Child>(child, key?): Child
Type Parameters
- Child extends Controller
Parameters
- child: Child | LikeType<Child>
- Optional key: string
Returns Child
Inherited from Component.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:187
appendChild(child, key?): Controller
Parameters
- child: Controller | {
  create?() => Controller;
  }
- Optional key: string
Returns Controller
Inherited from Component.appendChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:188

attachFastener

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

authenticate

authenticate(hostUri, credentials): void
Parameters
- hostUri: UriLike
- credentials: ValueLike
Returns void
Implementation of WarpRef.authenticate
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:192
authenticate(credentials): void
Parameters
- credentials: ValueLike
Returns void
Implementation of WarpRef.authenticate
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:194

`Protected` bindFastener

bindFastener(fastener): void
Parameters
- fastener: Fastener<any, any, [any]>
Returns void
Overrides Component.bindFastener
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:131

callObservers

callObservers<O, K>(this, key, ...args): void
Type Parameters
- O
- K extends string | number | symbol
Parameters
- this: {
  observerType?: Class<O>;
  }
  - Optional Readonly observerType?: Class<O>
- key: K
- Rest ...args: ObserverParameters<O, K>
Returns void
Inherited from Component.callObservers
- Defined in swim-core/swim-component/dist/swim-component.d.ts:302

cascadeCompile

cascadeCompile(compileFlags): void
Parameters
- compileFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:101

cascadeExecute

cascadeExecute(executeFlags): void
Parameters
- executeFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:118

command

command(hostUri, nodeUri, laneUri, body): void
Parameters
- hostUri: UriLike
- nodeUri: UriLike
- laneUri: UriLike
- body: ValueLike
Returns void
Implementation of WarpRef.command
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:184
command(nodeUri, laneUri, body): void
Parameters
- nodeUri: UriLike
- laneUri: UriLike
- body: ValueLike
Returns void
Implementation of WarpRef.command
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:186
command(laneUri, body): void
Parameters
- laneUri: UriLike
- body: ValueLike
Returns void
Implementation of WarpRef.command
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:188
command(body): void
Parameters
- body: ValueLike
Returns void
Implementation of WarpRef.command
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:190

commonAncestor

commonAncestor(relative): Controller
Parameters
- relative: Controller
Returns Controller
Inherited from Component.commonAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:227

`Protected` compileChild

compileChild(child, compileFlags): void
Parameters
- child: Controller
- compileFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:115

`Protected` compileChildren

compileChildren(compileFlags, compileChild): void
Parameters
- compileFlags: number
- compileChild: ((this, child, compileFlags) => void)
  - - (this, child, compileFlags): void
    - Parameters
      
      this: Controller
      
      child: Controller
      
      compileFlags: number
      
      Returns void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:114

consume

consume(consumer): void
Parameters
- consumer: unknown
Returns void
Implementation of Consumable.consume
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:143

decohereFastener

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

`Protected` didAssemble

didAssemble(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:113

`Protected` didAttachParent

didAttachParent(parent): void
Parameters
- parent: Controller
Returns void
Overrides Component.didAttachParent
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:76

`Protected` didCompile

didCompile(compileFlags): void
Parameters
- compileFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:104

`Protected` didCompute

didCompute(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:127

`Protected` didConsume

didConsume(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:146

`Protected` didDetachParent

didDetachParent(parent): void
Parameters
- parent: Controller
Returns void
Overrides Component.didDetachParent
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:79

`Protected` didExecute

didExecute(executeFlags): void
Parameters
- executeFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:121

`Protected` didGenerate

didGenerate(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:110

`Protected` didInsertChild

didInsertChild(child, target): void
Parameters
- child: Controller
- target: Controller
Returns void
Overrides Component.didInsertChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:82

`Protected` didMount

didMount(): void
Returns void
Overrides Component.didMount
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:92

`Protected` didObserve

didObserve(observer): void
Parameters
- observer: ControllerObserver<Controller>
Returns void
Inherited from Component.didObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:296

`Protected` didReinsertChild

didReinsertChild(child, target): void
Parameters
- child: Controller
- target: Controller
Returns void
Overrides Component.didReinsertChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:90

`Protected` didRemoveChild

didRemoveChild(child): void
Parameters
- child: Controller
Returns void
Overrides Component.didRemoveChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:87

`Protected` didResolve

didResolve(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:107

`Protected` didRevise

didRevise(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:124

`Protected` didStartConsuming

didStartConsuming(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:157

`Protected` didStopConsuming

didStopConsuming(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:162

`Protected` didUnconsume

didUnconsume(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:151

`Protected` didUnmount

didUnmount(): void
Returns void
Overrides Component.didUnmount
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:94

`Protected` didUnobserve

didUnobserve(observer): void
Parameters
- observer: ControllerObserver<Controller>
Returns void
Inherited from Component.didUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:301

downlink

downlink(template?): EventDownlink<WarpRef, any, [any]>
Parameters
- Optional template: ThisType<EventDownlink<WarpRef, any, [any]>> & EventDownlinkDescriptor<WarpRef> & Partial<Omit<EventDownlink<WarpRef, any, [any]>, keyof EventDownlinkDescriptor<WarpRef>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns EventDownlink<WarpRef, any, [any]>
Implementation of WarpRef.downlink
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:176

downlinkList

downlinkList<V>(template?): ListDownlink<WarpRef, V, [Iterable<V>]>
Type Parameters
- V = Value
Parameters
- Optional template: ThisType<ListDownlink<WarpRef, V, [Iterable<V>]>> & ListDownlinkDescriptor<WarpRef, V> & Partial<Omit<ListDownlink<WarpRef, V, [Iterable<V>]>, keyof ListDownlinkDescriptor<WarpRef, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns ListDownlink<WarpRef, V, [Iterable<V>]>
Implementation of WarpRef.downlinkList
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:180

downlinkMap

downlinkMap<K, V>(template?): MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>
Type Parameters
- K = Value
- V = Value
Parameters
- Optional template: ThisType<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>> & MapDownlinkDescriptor<WarpRef, K, V> & Partial<Omit<MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>, keyof MapDownlinkDescriptor<WarpRef, K, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>
Implementation of WarpRef.downlinkMap
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:182

downlinkValue

downlinkValue<V>(template?): ValueDownlink<WarpRef, V, [V]>
Type Parameters
- V = Value
Parameters
- Optional template: ThisType<ValueDownlink<WarpRef, V, [V]>> & ValueDownlinkDescriptor<WarpRef, V> & Partial<Omit<ValueDownlink<WarpRef, V, [V]>, keyof ValueDownlinkDescriptor<WarpRef, V>>> & {
  inletKeys?: readonly (keyof WarpRef)[];
  }
Returns ValueDownlink<WarpRef, V, [V]>
Implementation of WarpRef.downlinkValue
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:178

equals

equals(that): boolean
Parameters
- that: unknown
Returns boolean
Inherited from Component.equals
- Defined in swim-core/swim-component/dist/swim-component.d.ts:306

`Protected` executeChildren

executeChildren(executeFlags, executeChild): void
Parameters
- executeFlags: number
- executeChild: ((this, child, executeFlags) => void)
  - - (this, child, executeFlags): void
    - Parameters
      
      this: Controller
      
      child: Controller
      
      executeFlags: number
      
      Returns void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:128

forEachChild

forEachChild<T>(callback): T
Type Parameters
- T
Parameters
- callback: ((child) => void | T)
  - - (child): void | T
    - Parameters
      
      child: Controller
      
      Returns void | T
Returns T
Inherited from Component.forEachChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:174
forEachChild<T, S>(callback, thisArg): T
Type Parameters
- T
- S
Parameters
- callback: ((this, child) => void | T)
  - - (this, child): void | T
    - Parameters
      
      this: S
      
      child: Controller
      
      Returns void | T
- thisArg: S
Returns T
Inherited from Component.forEachChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:175

getAncestor

getAncestor<F>(ancestorType): InstanceType<F>
Type Parameters
- F extends Class<Controller>
Parameters
- ancestorType: F
Returns InstanceType<F>
Inherited from Component.getAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:222
getAncestor(ancestorType): Controller
Parameters
- ancestorType: Class<Controller>
Returns Controller
Inherited from Component.getAncestor
- Defined in swim-core/swim-component/dist/swim-component.d.ts:223

getChild

getChild<F>(key, childType): InstanceType<F>
Type Parameters
- F extends Class<Controller>
Parameters
- key: string
- childType: F
Returns InstanceType<F>
Inherited from Component.getChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:182
getChild(key, childType?): Controller
Parameters
- key: string
- Optional childType: Class<Controller>
Returns Controller
Inherited from Component.getChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:183

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

getFirstChild

getFirstChild<F>(childType): InstanceType<F>
Type Parameters
- F extends Class<Controller>
Parameters
- childType: F
Returns InstanceType<F>
Inherited from Component.getFirstChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:165
getFirstChild(childType): Controller
Parameters
- childType: Class<Controller>
Returns Controller
Inherited from Component.getFirstChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:166

getLastChild

getLastChild<F>(childType): InstanceType<F>
Type Parameters
- F extends Class<Controller>
Parameters
- childType: F
Returns InstanceType<F>
Inherited from Component.getLastChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:170
getLastChild(childType): Controller
Parameters
- childType: Class<Controller>
Returns Controller
Inherited from Component.getLastChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:171

getNextSibling

getNextSibling<F>(siblingType): InstanceType<F>
Type Parameters
- F extends Class<Controller>
Parameters
- siblingType: F
Returns InstanceType<F>
Inherited from Component.getNextSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:155
getNextSibling(siblingType): Controller
Parameters
- siblingType: Class<Controller>
Returns Controller
Inherited from Component.getNextSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:156

getParentFastener

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

getPreviousSibling

getPreviousSibling<F>(siblingType): InstanceType<F>
Type Parameters
- F extends Class<Controller>
Parameters
- siblingType: F
Returns InstanceType<F>
Inherited from Component.getPreviousSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:160
getPreviousSibling(siblingType): Controller
Parameters
- siblingType: Class<Controller>
Returns Controller
Inherited from Component.getPreviousSibling
- Defined in swim-core/swim-component/dist/swim-component.d.ts:161

getRoot

getRoot<F>(rootType): InstanceType<F>
Type Parameters
- F extends Class<Controller>
Parameters
- rootType: F
Returns InstanceType<F>
Inherited from Component.getRoot
- Defined in swim-core/swim-component/dist/swim-component.d.ts:224
getRoot(rootType): Controller
Parameters
- rootType: Class<Controller>
Returns Controller
Inherited from Component.getRoot
- Defined in swim-core/swim-component/dist/swim-component.d.ts:225

getTargetChild

getTargetChild(child, comparator): Controller
Parameters
- child: Controller
- comparator: Comparator<Controller>
Returns Controller
Inherited from Component.getTargetChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:221

hashCode

hashCode(): number
Returns number
Inherited from Component.hashCode
- Defined in swim-core/swim-component/dist/swim-component.d.ts:308

hostRef

hostRef(hostUri): WarpRef
Parameters
- hostUri: UriLike
Returns WarpRef
Implementation of WarpRef.hostRef
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:196

insertChild

insertChild<F>(childFactory, target, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Controller>> & Creatable<Instance<F, Controller>>
Parameters
- childFactory: F
- target: Controller
- Optional key: string
Returns InstanceType<F>
Inherited from Component.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:192
insertChild<Child>(child, target, key?): Child
Type Parameters
- Child extends Controller
Parameters
- child: Child | LikeType<Child>
- target: Controller
- Optional key: string
Returns Child
Inherited from Component.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:193
insertChild(child, target, key?): Controller
Parameters
- child: Controller | {
  create?() => Controller;
  }
- target: Controller
- Optional key: string
Returns Controller
Inherited from Component.insertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:194

isAncestorOf

isAncestorOf(descendant): boolean
Parameters
- descendant: Controller
Returns boolean
Inherited from Component.isAncestorOf
- Defined in swim-core/swim-component/dist/swim-component.d.ts:226

laneRef

laneRef(hostUri, nodeUri, laneUri): WarpRef
Parameters
- hostUri: UriLike
- nodeUri: UriLike
- laneUri: UriLike
Returns WarpRef
Implementation of WarpRef.laneRef
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:202
laneRef(nodeUri, laneUri): WarpRef
Parameters
- nodeUri: UriLike
- laneUri: UriLike
Returns WarpRef
Implementation of WarpRef.laneRef
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:204
laneRef(laneUri): WarpRef
Parameters
- laneUri: UriLike
Returns WarpRef
Implementation of WarpRef.laneRef
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:206

`Optional` likeType

likeType(like): void
Parameters
- like: {
  create?() => Controller;
  }
  - create?:function
    - create(): Controller
    - Returns Controller
      
      Defined in swim-core/swim-component/dist/swim-component.d.ts:127
Returns void
Inherited from Component.likeType
- Defined in swim-core/swim-component/dist/swim-component.d.ts:126

mount

mount(): void
Returns void
Inherited from Component.mount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:230

`Protected` needsCompile

needsCompile(compileFlags): number
Parameters
- compileFlags: number
Returns number
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:100

`Protected` needsExecute

needsExecute(executeFlags): number
Parameters
- executeFlags: number
Returns number
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:117

`Protected` needsUpdate

needsUpdate(updateFlags, immediate): number
Parameters
- updateFlags: number
- immediate: boolean
Returns number
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:96

nodeRef

nodeRef(hostUri, nodeUri): WarpRef
Parameters
- hostUri: UriLike
- nodeUri: UriLike
Returns WarpRef
Implementation of WarpRef.nodeRef
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:198
nodeRef(nodeUri): WarpRef
Parameters
- nodeUri: UriLike
Returns WarpRef
Implementation of WarpRef.nodeRef
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:200

observe

observe(observer): void
Parameters
- observer: ControllerObserver<Controller>
Returns void
Inherited from Component.observe
- Defined in swim-core/swim-component/dist/swim-component.d.ts:293

`Protected` onAssemble

onAssemble(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:112

`Protected` onAttachParent

onAttachParent(parent): void
Parameters
- parent: Controller
Returns void
Overrides Component.onAttachParent
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:75

`Protected` onCompile

onCompile(compileFlags): void
Parameters
- compileFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:103

`Protected` onCompute

onCompute(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:126

`Protected` onConsume

onConsume(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:145

`Protected` onDetachParent

onDetachParent(parent): void
Parameters
- parent: Controller
Returns void
Overrides Component.onDetachParent
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:78

`Protected` onExecute

onExecute(executeFlags): void
Parameters
- executeFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:120

`Protected` onGenerate

onGenerate(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:109

`Protected` onInsertChild

onInsertChild(child, target): void
Parameters
- child: Controller
- target: Controller
Returns void
Overrides Component.onInsertChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:81

`Protected` onMount

onMount(): void
Returns void
Inherited from Component.onMount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:234

`Protected` onObserve

onObserve(observer): void
Parameters
- observer: ControllerObserver<Controller>
Returns void
Inherited from Component.onObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:295

`Protected` onReinsertChild

onReinsertChild(child, target): void
Parameters
- child: Controller
- target: Controller
Returns void
Overrides Component.onReinsertChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:89

`Protected` onRemoveChild

onRemoveChild(child): void
Parameters
- child: Controller
Returns void
Overrides Component.onRemoveChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:86

`Protected` onResolve

onResolve(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:106

`Protected` onRevise

onRevise(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:123

`Protected` onStartConsuming

onStartConsuming(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:156

`Protected` onStopConsuming

onStopConsuming(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:161

`Protected` onUnconsume

onUnconsume(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:150

`Protected` onUnmount

onUnmount(): void
Returns void
Inherited from Component.onUnmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:242

`Protected` onUnobserve

onUnobserve(observer): void
Parameters
- observer: ControllerObserver<Controller>
Returns void
Inherited from Component.onUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:300

prependChild

prependChild<F>(childFactory, key?): InstanceType<F>
Type Parameters
- F extends Class<Instance<F, Controller>> & Creatable<Instance<F, Controller>>
Parameters
- childFactory: F
- Optional key: string
Returns InstanceType<F>
Inherited from Component.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:189
prependChild<Child>(child, key?): Child
Type Parameters
- Child extends Controller
Parameters
- child: Child | LikeType<Child>
- Optional key: string
Returns Child
Inherited from Component.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:190
prependChild(child, key?): Controller
Parameters
- child: Controller | {
  create?() => Controller;
  }
- Optional key: string
Returns Controller
Inherited from Component.prependChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:191

reinsertChild

reinsertChild(child, target): void
Parameters
- child: Controller
- target: Controller
Returns void
Inherited from Component.reinsertChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:216

remove

remove(): void
Returns void
Inherited from Component.remove
- Defined in swim-core/swim-component/dist/swim-component.d.ts:214

removeChild

removeChild<Child>(child): Child
Type Parameters
- Child extends Controller
Parameters
- child: Child
Returns Child
Inherited from Component.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:205
removeChild(child): Controller
Parameters
- child: Controller
Returns Controller
Inherited from Component.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:206
removeChild(key): Controller
Parameters
- key: string | Controller
Returns Controller
Inherited from Component.removeChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:207

removeChildren

removeChildren(): void
Returns void
Inherited from Component.removeChildren
- Defined in swim-core/swim-component/dist/swim-component.d.ts:213

replaceChild

replaceChild<F>(newChildFactory, oldChild): Controller
Type Parameters
- F extends Class<Instance<F, Controller>> & Creatable<Instance<F, Controller>>
Parameters
- newChildFactory: F
- oldChild: Controller
Returns Controller
Inherited from Component.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:195
replaceChild<Child>(newChild, oldChild): Child
Type Parameters
- Child extends Controller
Parameters
- newChild: Controller | {
  create?() => Controller;
  }
- oldChild: Child
Returns Child
Inherited from Component.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:196
replaceChild(newChild, oldChild): Controller
Parameters
- newChild: Controller | {
  create?() => Controller;
  }
- oldChild: Controller
Returns Controller
Inherited from Component.replaceChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:197

requestUpdate

requestUpdate(target, updateFlags, immediate): void
Parameters
- target: Controller
- updateFlags: number
- immediate: boolean
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:97

requireUpdate

requireUpdate(updateFlags, immediate?): void
Parameters
- updateFlags: number
- Optional immediate: boolean
Returns void
Overrides Component.requireUpdate
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:95

set

set<S>(this, properties, timing?): Controller
Type Parameters
- S
Parameters
- this: S
- properties: {
      [K in string | number | symbol as S[K] extends {
              set(value) => any;
          }
          ? K
          : never]?: S[K] extends {
              set(value) => any;
          }
          ? T
          : never
  }
- Optional timing: boolean | TimingLike
Returns Controller
Inherited from Component.set
- Defined in swim-core/swim-component/dist/swim-component.d.ts:266

setChild

setChild<F>(key, newChildFactory): Controller
Type Parameters
- F extends Class<Instance<F, Controller>> & Creatable<Instance<F, Controller>>
Parameters
- key: string
- newChildFactory: F
Returns Controller
Inherited from Component.setChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:184
setChild(key, newChild): Controller
Parameters
- key: string
- newChild: Controller | {
  create?() => Controller;
  }
Returns Controller
Inherited from Component.setChild
- Defined in swim-core/swim-component/dist/swim-component.d.ts:185

setIntrinsic

setIntrinsic<S>(this, properties, timing?): Controller
Type Parameters
- S
Parameters
- this: S
- properties: {
      [K in string | number | symbol as S[K] extends {
              setIntrinsic(value) => any;
          }
          ? K
          : never]?: S[K] extends {
              setIntrinsic(value) => any;
          }
          ? T
          : never
  }
- Optional timing: boolean | TimingLike
Returns Controller
Inherited from Component.setIntrinsic
- Defined in swim-core/swim-component/dist/swim-component.d.ts:273

sortChildren

sortChildren(comparator): void
Parameters
- comparator: Comparator<Controller>
Returns void
Inherited from Component.sortChildren
- Defined in swim-core/swim-component/dist/swim-component.d.ts:220

`Protected` startConsuming

startConsuming(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:154

`Protected` stopConsuming

stopConsuming(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:159

tryFastener

tryFastener<K, F>(fastenerName): F extends Fastener<any, any, any>
? F
: never
Type Parameters
- K extends keyof Controller
- F extends string | number | boolean | readonly Fastener<any, any, any>[] | {} | {} | (() => void) | (() => void) | (() => void) | {} | (() => void) | {} | (<F>(fastenerName, fastenerType?, contextType?) => F) | (<F>(fastenerName, fastenerType?, contextType?) => F) | ((fastener) => void) | ((fastener) => void) | (<O, K>(this, key, ...args) => void) | ((that) => boolean) | (() => number) | ReadonlySet<unknown> | Controller | ((like) => void) | Class<ControllerObserver<Controller>> | Class<Controller> | {} | {} | {} | {
      <F>(siblingType): InstanceType<F>;
      (siblingType): Controller;
  } | {} | {
      <F>(siblingType): InstanceType<F>;
      (siblingType): Controller;
  } | {} | {
      <F>(childType): InstanceType<F>;
      (childType): Controller;
  } | {} | {
      <F>(childType): InstanceType<F>;
      (childType): Controller;
  } | {} | {
      <T>(callback): T;
      <T, S>(callback, thisArg): T;
  } | Dictionary<Controller> | {
      <F>(key, childType): InstanceType<F>;
      (key, childType?): Controller;
  } | {
      <F>(key, newChildFactory): Controller;
      (key, newChild): Controller;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <Child>(child, key?): Child;
      (child, key?): Controller;
  } | {
      <F>(childFactory, key?): InstanceType<F>;
      <Child>(child, key?): Child;
      (child, key?): Controller;
  } | {
      <F>(childFactory, target, key?): InstanceType<F>;
      <Child>(child, target, key?): Child;
      (child, target, key?): Controller;
  } | {
      <F>(newChildFactory, oldChild): Controller;
      <Child>(newChild, oldChild): Child;
      (newChild, oldChild): Controller;
  } | {} | {
      <Child>(child): Child;
      (child): Controller;
      (key): Controller;
  } | ((child, target) => void) | ((comparator) => void) | ((child, comparator) => Controller) | {
      <F>(ancestorType): InstanceType<F>;
      (ancestorType): Controller;
  } | {
      <F>(rootType): InstanceType<F>;
      (rootType): Controller;
  } | ((descendant) => boolean) | ((relative) => Controller) | ((updateFlags, immediate?) => void) | (<K, F>(fastenerName) => F extends Fastener<any, any, any>
      ? F
      : never) | (<S>(this, properties, timing?) => Controller) | (<S>(this, properties, timing?) => Controller) | {} | ReadonlySet<ControllerObserver<Controller>> | ((observer) => void) | ((observer) => void) | ((consumer) => void) | ((consumer) => void) | ((template?) => EventDownlink<WarpRef, any, [any]>) | (<V>(template?) => ValueDownlink<WarpRef, V, [V]>) | (<V>(template?) => ListDownlink<WarpRef, V, [Iterable<V>]>) | (<K, V>(template?) => MapDownlink<WarpRef, K, V, [Iterable<[K, V]>]>) | {
      (hostUri, nodeUri, laneUri, body): void;
      (nodeUri, laneUri, body): void;
      (laneUri, body): void;
      (body): void;
  } | {
      (hostUri, credentials): void;
      (credentials): void;
  } | ((hostUri) => WarpRef) | {
      (hostUri, nodeUri): WarpRef;
      (nodeUri): WarpRef;
  } | {
      (hostUri, nodeUri, laneUri): WarpRef;
      (nodeUri, laneUri): WarpRef;
      (laneUri): WarpRef;
  } | {} | {} | ((target, updateFlags, immediate) => void) | ((compileFlags) => void) | ((executeFlags) => void) | Provider<Controller, ExecutorService> | Property<Controller, Uri, [Uri]> | Property<Controller, WarpRef, [WarpRef]> = Controller[K]
Parameters
- fastenerName: K
Returns F extends Fastener<any, any, any>
? F
: never
Inherited from Component.tryFastener
- Defined in swim-core/swim-component/dist/swim-component.d.ts:247

unconsume

unconsume(consumer): void
Parameters
- consumer: unknown
Returns void
Implementation of Consumable.unconsume
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:148

unmount

unmount(): void
Returns void
Inherited from Component.unmount
- Defined in swim-core/swim-component/dist/swim-component.d.ts:238

unobserve

unobserve(observer): void
Parameters
- observer: ControllerObserver<Controller>
Returns void
Inherited from Component.unobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:298

`Protected` willAssemble

willAssemble(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:111

`Protected` willAttachParent

willAttachParent(parent): void
Parameters
- parent: Controller
Returns void
Overrides Component.willAttachParent
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:74

`Protected` willCompile

willCompile(compileFlags): void
Parameters
- compileFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:102

`Protected` willCompute

willCompute(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:125

`Protected` willConsume

willConsume(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:144

`Protected` willDetachParent

willDetachParent(parent): void
Parameters
- parent: Controller
Returns void
Overrides Component.willDetachParent
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:77

`Protected` willExecute

willExecute(executeFlags): void
Parameters
- executeFlags: number
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:119

`Protected` willGenerate

willGenerate(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:108

`Protected` willInsertChild

willInsertChild(child, target): void
Parameters
- child: Controller
- target: Controller
Returns void
Overrides Component.willInsertChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:80

`Protected` willMount

willMount(): void
Returns void
Overrides Component.willMount
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:91

`Protected` willObserve

willObserve(observer): void
Parameters
- observer: ControllerObserver<Controller>
Returns void
Inherited from Component.willObserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:294

`Protected` willReinsertChild

willReinsertChild(child, target): void
Parameters
- child: Controller
- target: Controller
Returns void
Overrides Component.willReinsertChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:88

`Protected` willRemoveChild

willRemoveChild(child): void
Parameters
- child: Controller
Returns void
Overrides Component.willRemoveChild
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:85

`Protected` willResolve

willResolve(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:105

`Protected` willRevise

willRevise(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:122

`Protected` willStartConsuming

willStartConsuming(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:155

`Protected` willStopConsuming

willStopConsuming(): void
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:160

`Protected` willUnconsume

willUnconsume(consumer): void
Parameters
- consumer: unknown
Returns void
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:149

`Protected` willUnmount

willUnmount(): void
Returns void
Overrides Component.willUnmount
- Defined in swim-ui/swim-controller/lib/main/Controller.d.ts:93

`Protected` willUnobserve

willUnobserve(observer): void
Parameters
- observer: ControllerObserver<Controller>
Returns void
Inherited from Component.willUnobserve
- Defined in swim-core/swim-component/dist/swim-component.d.ts:299

`Static` create

create<S>(this): InstanceType<S>
Type Parameters
- S extends (new () => InstanceType<S>)
Parameters
- this: S
Returns InstanceType<S>
Inherited from Component.create
- Defined in swim-core/swim-component/dist/swim-component.d.ts:309

`Static` fromLike

fromLike<S>(this, value): InstanceType<S>
Type Parameters
- S extends Class<Instance<S, Component<Component<any>>>>
Parameters
- this: S
- value: InstanceType<S> | LikeType<InstanceType<S>>
Returns InstanceType<S>
Inherited from Component.fromLike
- Defined in swim-core/swim-component/dist/swim-component.d.ts:310

Class Controller

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Controller

Properties

Readonly firstChild

Readonly key

Readonly lastChild

Readonly nextSibling

Optional Readonly observerType

Readonly parent

Readonly previousSibling

Readonly updater

Static Readonly InsertChildFlags

Static Readonly MountFlags

Static Readonly NeedsAssemble

Static Readonly NeedsCompile

Static Readonly NeedsCompute

Static Readonly NeedsExecute

Static Readonly NeedsGenerate

Static Readonly NeedsResolve

Static Readonly NeedsRevise

Static Readonly ReinsertChildFlags

Static Readonly RemoveChildFlags

Static Readonly StartConsumingFlags

Static Readonly StopConsumingFlags

Accessors

compiling

Returns boolean

componentType

Returns Class<Controller>

consuming

Returns boolean

executing

Returns boolean

hostUri

Returns Property<this, Uri, [Uri]>

insertChildFlags

Returns number

inserting

Returns boolean

laneUri

Returns Property<this, Uri, [Uri]>

mountFlags

Returns number

mounted

Returns boolean

nodeUri

Returns Property<this, Uri, [Uri]>

reinsertChildFlags

Returns number

removeChildFlags

Returns number

removing

Returns boolean

startConsumingFlags

Returns number

stopConsumingFlags

Returns number

updateTime

Returns number

updating

Returns boolean

warpRef

Returns Property<this, WarpRef, [WarpRef]>

Methods

appendChild

Type Parameters

F extends Class<Instance<F, Controller>> & Creatable<Instance<F, Controller>>

Parameters

childFactory: F

Optional key: string

Returns InstanceType<F>

`Readonly` firstChild

`Readonly` key

`Readonly` lastChild

`Readonly` nextSibling

`Optional` `Readonly` observerType

`Readonly` parent

`Readonly` previousSibling

`Readonly` updater

`Static` `Readonly` InsertChildFlags

`Static` `Readonly` MountFlags

`Static` `Readonly` NeedsAssemble

`Static` `Readonly` NeedsCompile

`Static` `Readonly` NeedsCompute

`Static` `Readonly` NeedsExecute

`Static` `Readonly` NeedsGenerate

`Static` `Readonly` NeedsResolve

`Static` `Readonly` NeedsRevise

`Static` `Readonly` ReinsertChildFlags

`Static` `Readonly` RemoveChildFlags

`Static` `Readonly` StartConsumingFlags

`Static` `Readonly` StopConsumingFlags

`Optional` key: string

`Optional` key: string

child: Controller | {
create?() => Controller;
}

`Optional` key: string

`Protected` bindFastener

this: {
observerType?: Class<O>;
}

`Optional` `Readonly` observerType?: Class<O>

`Rest` ...args: ObserverParameters<O, K>

`Protected` compileChild