Component | Swim Toolkit

Hierarchy

Component
- GenericComponent

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor

new Component(): Component

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:79
Returns Component

Properties

Readonly Abstract childComponentCount

childComponentCount: number

Readonly Abstract childComponents

childComponents: readonly Component[]

Readonly componentFlags

componentFlags: number

Readonly componentObservers

componentObservers: readonly ComponentObserver<Component>[]

Readonly executeService

executeService: ExecuteService<Component>

Readonly historyService

historyService: HistoryService<Component>

Readonly Abstract key

key: undefined | string

Readonly Abstract parentComponent

parentComponent: null | Component

Readonly storageService

storageService: StorageService<Component>

Static Readonly Extrinsic

Extrinsic: number = 1

Static Readonly Intrinsic

Intrinsic: number = 0

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 insertChildFlags

insertChildFlags: number = 0

Static Readonly mountFlags

mountFlags: number = 0

Static Readonly powerFlags

powerFlags: number = 0

Static Readonly removeChildFlags

removeChildFlags: number = 0

Accessors

componentContext

get componentContext(): ComponentContext

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:984
Returns ComponentContext

insertChildFlags

get insertChildFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:246
Returns number

mountFlags

get mountFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:345
Returns number

powerFlags

get powerFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:416
Returns number

removeChildFlags

get removeChildFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:281
Returns number

superComponentContext

get superComponentContext(): ComponentContext

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:975
Returns ComponentContext

Methods

addComponentObserver

addComponentObserver(componentObserver: ComponentObserver<Component>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:109
Parameters
- componentObserver: ComponentObserver<Component>
Returns void

Abstract appendChildComponent

appendChildComponent(childComponent: Component, key?: string): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:240
Parameters
- childComponent: Component
- Optional key: string
Returns void

Protected attachParentComponent

attachParentComponent(parentComponent: Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:173
Parameters
- parentComponent: Component
Returns void

Abstract cascadeCompile

cascadeCompile(compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:555
Parameters
- compileFlags: number
- componentContext: ComponentContext
Returns void

Abstract cascadeExecute

cascadeExecute(executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:703
Parameters
- executeFlags: number
- componentContext: ComponentContext
Returns void

Abstract cascadeInsert

cascadeInsert(updateFlags?: number, componentContext?: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:274
Parameters
- Optional updateFlags: number
- Optional componentContext: ComponentContext
Returns void

Abstract cascadeMount

cascadeMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:359
Returns void

Abstract cascadePower

cascadePower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:420
Returns void

Abstract cascadeUnmount

cascadeUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:386
Returns void

Abstract cascadeUnpower

cascadeUnpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:447
Returns void

Protected compileChildComponents

compileChildComponents(compileFlags: number, componentContext: ComponentContext, compileChildComponent: (childComponent: Component, compileFlags: number, componentContext: ComponentContext) => void): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:662
Parameters
- compileFlags: number
- componentContext: ComponentContext
- compileChildComponent: (childComponent: Component, compileFlags: number, componentContext: ComponentContext) => void
  - - (childComponent: Component, compileFlags: number, componentContext: ComponentContext): void
    - Parameters
      - childComponent: Component
      - compileFlags: number
      - componentContext: ComponentContext
      Returns void
Returns void

Protected detachParentComponent

detachParentComponent(parentComponent: Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:182
Parameters
- parentComponent: Component
Returns void

Protected didAddComponentObserver

didAddComponentObserver(componentObserver: ComponentObserver<Component>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:132
Parameters
- componentObserver: ComponentObserver<Component>
Returns void

Protected didAssemble

didAssemble(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:631
Parameters
- componentContext: ComponentContext
Returns void

Protected didCompile

didCompile(compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:565
Parameters
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected didCompileChildComponent

didCompileChildComponent(childComponent: Component, compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:691
Parameters
- childComponent: Component
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected didCompileChildComponents

didCompileChildComponents(compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:658
Parameters
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected didCompute

didCompute(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:755
Parameters
- componentContext: ComponentContext
Returns void

Protected didExecute

didExecute(executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:713
Parameters
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected didExecuteChildComponent

didExecuteChildComponent(childComponent: Component, executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:815
Parameters
- childComponent: Component
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected didExecuteChildComponents

didExecuteChildComponents(executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:782
Parameters
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected didGenerate

didGenerate(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:607
Parameters
- componentContext: ComponentContext
Returns void

Protected didInsertChildComponent

didInsertChildComponent(childComponent: Component, targetComponent: null | Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:264
Parameters
- childComponent: Component
- targetComponent: null | Component
Returns void

Protected didMount

didMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:376
Returns void

Protected didPower

didPower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:437
Returns void

Protected didRemoveChildComponent

didRemoveChildComponent(childComponent: Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:300
Parameters
- childComponent: Component
Returns void

Protected didRemoveComponentObserver

didRemoveComponentObserver(componentObserver: ComponentObserver<Component>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:159
Parameters
- componentObserver: ComponentObserver<Component>
Returns void

Protected didRequestUpdate

didRequestUpdate(targetComponent: Component, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:535
Parameters
- targetComponent: Component
- updateFlags: number
- immediate: boolean
Returns void

Protected didRequireUpdate

didRequireUpdate(updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:497
Parameters
- updateFlags: number
- immediate: boolean
Returns void

Protected didResolve

didResolve(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:583
Parameters
- componentContext: ComponentContext
Returns void

Protected didRevise

didRevise(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:731
Parameters
- componentContext: ComponentContext
Returns void

Protected didSetParentComponent

didSetParentComponent(newParentComponent: null | Component, oldParentComponent: null | Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:208
Parameters
- newParentComponent: null | Component
- oldParentComponent: null | Component
Returns void

Protected didUnmount

didUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:402
Returns void

Protected didUnpower

didUnpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:463
Returns void

Protected executeChildComponents

executeChildComponents(executeFlags: number, componentContext: ComponentContext, executeChildComponent: (childComponent: Component, executeFlags: number, componentContext: ComponentContext) => void): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:786
Parameters
- executeFlags: number
- componentContext: ComponentContext
- executeChildComponent: (childComponent: Component, executeFlags: number, componentContext: ComponentContext) => void
  - - (childComponent: Component, executeFlags: number, componentContext: ComponentContext): void
    - Parameters
      - childComponent: Component
      - executeFlags: number
      - componentContext: ComponentContext
      Returns void
Returns void

Abstract firstChildComponent

firstChildComponent(): null | Component

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:224
Returns null | Component

Abstract forEachChildComponent

forEachChildComponent<T>(callback: (childComponent: Component) => void | T): undefined | T
forEachChildComponent<T, S>(callback: (childComponent: Component) => void | T, thisArg: S): undefined | T

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:232
Type parameters
- T
Parameters
- callback: (childComponent: Component) => void | T
  - - (childComponent: Component): void | T
    - Parameters
      - childComponent: Component
      Returns void | T
Returns undefined | T
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:233
Type parameters
- T
- S
Parameters
- callback: (childComponent: Component) => void | T
  - - (childComponent: Component): void | T
    - Parameters
      - childComponent: Component
      Returns void | T
- thisArg: S
Returns undefined | T

getBaseComponent

getBaseComponent<C>(componentClass: ComponentClass<C>): null | C

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:321
Type parameters
- C: Component<C>
Parameters
- componentClass: ComponentClass<C>
Returns null | C

Abstract getChildComponent

getChildComponent(key: string): null | Component

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:236
Parameters
- key: string
Returns null | Component

Abstract getComponentFastener

getComponentFastener(fastenerName: string): null | ComponentFastener<Component, Component, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:950
Parameters
- fastenerName: string
Returns null | ComponentFastener<Component, Component, never>

Abstract getComponentModel

getComponentModel(fastenerName: string): null | ComponentModel<Component, Model, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:859
Parameters
- fastenerName: string
Returns null | ComponentModel<Component, Model, never>

Abstract getComponentProperty

getComponentProperty(propertyName: string): null | ComponentProperty<Component, unknown, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:840
Parameters
- propertyName: string
Returns null | ComponentProperty<Component, unknown, never>

Abstract getComponentService

getComponentService(serviceName: string): null | ComponentService<Component, unknown>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:821
Parameters
- serviceName: string
Returns null | ComponentService<Component, unknown>

Abstract getComponentTrait

getComponentTrait(fastenerName: string): null | ComponentTrait<Component, Trait, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:881
Parameters
- fastenerName: string
Returns null | ComponentTrait<Component, Trait, never>

Abstract getComponentView

getComponentView(fastenerName: string): null | ComponentView<Component, View, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:903
Parameters
- fastenerName: string
Returns null | ComponentView<Component, View, never>

Abstract getComponentViewTrait

getComponentViewTrait(fastenerName: string): null | ComponentViewTrait<Component, View, Trait, never, never>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:925
Parameters
- fastenerName: string
Returns null | ComponentViewTrait<Component, View, Trait, never, never>

getSuperComponent

getSuperComponent<C>(componentClass: ComponentClass<C>): null | C

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:310
Type parameters
- C: Component<C>
Parameters
- componentClass: ComponentClass<C>
Returns null | C

Abstract hasComponentFastener

hasComponentFastener(fastenerName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:948
Parameters
- fastenerName: string
Returns boolean

Abstract hasComponentModel

hasComponentModel(fastenerName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:857
Parameters
- fastenerName: string
Returns boolean

Abstract hasComponentProperty

hasComponentProperty(propertyName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:838
Parameters
- propertyName: string
Returns boolean

Abstract hasComponentService

hasComponentService(serviceName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:819
Parameters
- serviceName: string
Returns boolean

Abstract hasComponentTrait

hasComponentTrait(fastenerName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:879
Parameters
- fastenerName: string
Returns boolean

Abstract hasComponentView

hasComponentView(fastenerName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:901
Parameters
- fastenerName: string
Returns boolean

Abstract hasComponentViewTrait

hasComponentViewTrait(fastenerName: string): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:923
Parameters
- fastenerName: string
Returns boolean

initComponent

initComponent(init: ComponentInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:93
Parameters
- init: ComponentInit
Returns void

Abstract insertChildComponent

insertChildComponent(childComponent: Component, targetComponent: null | Component, key?: string): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:244
Parameters
- childComponent: Component
- targetComponent: null | Component
- Optional key: string
Returns void

isCompiling

isCompiling(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:547
Returns boolean

isExecuting

isExecuting(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:695
Returns boolean

isMounted

isMounted(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:341
Returns boolean

isPowered

isPowered(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:412
Returns boolean

isTraversing

isTraversing(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:539
Returns boolean

isUpdating

isUpdating(): boolean

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:543
Returns boolean

Abstract lastChildComponent

lastChildComponent(): null | Component

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:226
Returns null | Component

mount

mount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:349
Returns void

needsCompile

needsCompile(compileFlags: number, componentContext: ComponentContext): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:551
Parameters
- compileFlags: number
- componentContext: ComponentContext
Returns number

needsExecute

needsExecute(executeFlags: number, componentContext: ComponentContext): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:699
Parameters
- executeFlags: number
- componentContext: ComponentContext
Returns number

Abstract nextChildComponent

nextChildComponent(targetComponent: Component): null | Component

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:228
Parameters
- targetComponent: Component
Returns null | Component

Protected onAddComponentObserver

onAddComponentObserver(componentObserver: ComponentObserver<Component>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:128
Parameters
- componentObserver: ComponentObserver<Component>
Returns void

Protected onAssemble

onAssemble(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:627
Parameters
- componentContext: ComponentContext
Returns void

Protected onCompile

onCompile(compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:561
Parameters
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected onCompileChildComponent

onCompileChildComponent(childComponent: Component, compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:687
Parameters
- childComponent: Component
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected onCompileChildComponents

onCompileChildComponents(compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:654
Parameters
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected onCompute

onCompute(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:751
Parameters
- componentContext: ComponentContext
Returns void

Protected onExecute

onExecute(executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:709
Parameters
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected onExecuteChildComponent

onExecuteChildComponent(childComponent: Component, executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:811
Parameters
- childComponent: Component
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected onExecuteChildComponents

onExecuteChildComponents(executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:778
Parameters
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected onGenerate

onGenerate(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:603
Parameters
- componentContext: ComponentContext
Returns void

Protected onInsertChildComponent

onInsertChildComponent(childComponent: Component, targetComponent: null | Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:260
Parameters
- childComponent: Component
- targetComponent: null | Component
Returns void

Protected onMount

onMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:371
Returns void

Protected onPower

onPower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:432
Returns void

Protected onRemoveChildComponent

onRemoveChildComponent(childComponent: Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:296
Parameters
- childComponent: Component
Returns void

Protected onRemoveComponentObserver

onRemoveComponentObserver(componentObserver: ComponentObserver<Component>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:155
Parameters
- componentObserver: ComponentObserver<Component>
Returns void

Protected onRequestUpdate

onRequestUpdate(targetComponent: Component, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:531
Parameters
- targetComponent: Component
- updateFlags: number
- immediate: boolean
Returns void

Protected onRequireUpdate

onRequireUpdate(updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:493
Parameters
- updateFlags: number
- immediate: boolean
Returns void

Protected onResolve

onResolve(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:579
Parameters
- componentContext: ComponentContext
Returns void

Protected onRevise

onRevise(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:727
Parameters
- componentContext: ComponentContext
Returns void

Protected onSetParentComponent

onSetParentComponent(newParentComponent: null | Component, oldParentComponent: null | Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:204
Parameters
- newParentComponent: null | Component
- oldParentComponent: null | Component
Returns void

Protected onUnmount

onUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:398
Returns void

Protected onUnpower

onUnpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:459
Returns void

Abstract prependChildComponent

prependChildComponent(childComponent: Component, key?: string): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:242
Parameters
- childComponent: Component
- Optional key: string
Returns void

Abstract previousChildComponent

previousChildComponent(targetComponent: Component): null | Component

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:230
Parameters
- targetComponent: Component
Returns null | Component

Abstract remove

remove(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:218
Returns void

Abstract removeAll

removeAll(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:279
Returns void

Abstract removeChildComponent

removeChildComponent(key: string): null | Component
removeChildComponent(childComponent: Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:276
Parameters
- key: string
Returns null | Component
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:277
Parameters
- childComponent: Component
Returns void

removeComponentObserver

removeComponentObserver(componentObserver: ComponentObserver<Component>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:136
Parameters
- componentObserver: ComponentObserver<Component>
Returns void

requestUpdate

requestUpdate(targetComponent: Component, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:501
Parameters
- targetComponent: Component
- updateFlags: number
- immediate: boolean
Returns void

requireUpdate

requireUpdate(updateFlags: number, immediate?: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:473
Parameters
- updateFlags: number
- immediate: boolean = false
Returns void

Abstract setChildComponent

setChildComponent(key: string, newChildComponent: null | Component): null | Component

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:238
Parameters
- key: string
- newChildComponent: null | Component
Returns null | Component

Abstract setComponentFastener

setComponentFastener(fastenerName: string, componentFastener: null | ComponentFastener<Component, any, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:952
Parameters
- fastenerName: string
- componentFastener: null | ComponentFastener<Component, any, never>
Returns void

setComponentFlags

setComponentFlags(componentFlags: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:99
Parameters
- componentFlags: number
Returns void

Abstract setComponentModel

setComponentModel(fastenerName: string, componentModel: null | ComponentModel<Component, any, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:861
Parameters
- fastenerName: string
- componentModel: null | ComponentModel<Component, any, never>
Returns void

Abstract setComponentProperty

setComponentProperty(propertyName: string, componentProperty: null | ComponentProperty<Component, unknown, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:842
Parameters
- propertyName: string
- componentProperty: null | ComponentProperty<Component, unknown, never>
Returns void

Abstract setComponentService

setComponentService(serviceName: string, componentService: null | ComponentService<Component, unknown>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:823
Parameters
- serviceName: string
- componentService: null | ComponentService<Component, unknown>
Returns void

Abstract setComponentTrait

setComponentTrait(fastenerName: string, componentTrait: null | ComponentTrait<Component, any, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:883
Parameters
- fastenerName: string
- componentTrait: null | ComponentTrait<Component, any, never>
Returns void

Abstract setComponentView

setComponentView(fastenerName: string, componentView: null | ComponentView<Component, any, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:905
Parameters
- fastenerName: string
- componentView: null | ComponentView<Component, any, never>
Returns void

Abstract setComponentViewTrait

setComponentViewTrait(fastenerName: string, componentViewTrait: null | ComponentViewTrait<Component, any, any, never, never>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:927
Parameters
- fastenerName: string
- componentViewTrait: null | ComponentViewTrait<Component, any, any, never, never>
Returns void

Protected willAddComponentObserver

willAddComponentObserver(componentObserver: ComponentObserver<Component>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:124
Parameters
- componentObserver: ComponentObserver<Component>
Returns void

Protected willAssemble

willAssemble(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:617
Parameters
- componentContext: ComponentContext
Returns void

Protected willCompile

willCompile(compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:557
Parameters
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected willCompileChildComponent

willCompileChildComponent(childComponent: Component, compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:683
Parameters
- childComponent: Component
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected willCompileChildComponents

willCompileChildComponents(compileFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:650
Parameters
- compileFlags: number
- componentContext: ComponentContext
Returns void

Protected willCompute

willCompute(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:741
Parameters
- componentContext: ComponentContext
Returns void

Protected willExecute

willExecute(executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:705
Parameters
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected willExecuteChildComponent

willExecuteChildComponent(childComponent: Component, executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:807
Parameters
- childComponent: Component
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected willExecuteChildComponents

willExecuteChildComponents(executeFlags: number, componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:774
Parameters
- executeFlags: number
- componentContext: ComponentContext
Returns void

Protected willGenerate

willGenerate(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:593
Parameters
- componentContext: ComponentContext
Returns void

Protected willInsertChildComponent

willInsertChildComponent(childComponent: Component, targetComponent: null | Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:250
Parameters
- childComponent: Component
- targetComponent: null | Component
Returns void

Protected willMount

willMount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:361
Returns void

Protected willPower

willPower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:422
Returns void

Protected willRemoveChildComponent

willRemoveChildComponent(childComponent: Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:285
Parameters
- childComponent: Component
Returns void

Protected willRemoveComponentObserver

willRemoveComponentObserver(componentObserver: ComponentObserver<Component>): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:151
Parameters
- componentObserver: ComponentObserver<Component>
Returns void

Protected willRequestUpdate

willRequestUpdate(targetComponent: Component, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:527
Parameters
- targetComponent: Component
- updateFlags: number
- immediate: boolean
Returns void

Protected willRequireUpdate

willRequireUpdate(updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:489
Parameters
- updateFlags: number
- immediate: boolean
Returns void

Protected willResolve

willResolve(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:569
Parameters
- componentContext: ComponentContext
Returns void

Protected willRevise

willRevise(componentContext: ComponentContext): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:717
Parameters
- componentContext: ComponentContext
Returns void

Protected willSetParentComponent

willSetParentComponent(newParentComponent: null | Component, oldParentComponent: null | Component): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:194
Parameters
- newParentComponent: null | Component
- oldParentComponent: null | Component
Returns void

Protected willUnmount

willUnmount(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:388
Returns void

Protected willUnpower

willUnpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/main/Component.ts:449
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Component

Properties

Readonly Abstract childComponentCount

Readonly Abstract childComponents

Readonly componentFlags

Readonly componentObservers

Readonly executeService

Readonly historyService

Readonly Abstract key

Readonly Abstract parentComponent

Readonly storageService

Static Readonly Extrinsic

Static Readonly Intrinsic

Static Readonly NeedsAssemble

Static Readonly NeedsCompile

Static Readonly NeedsCompute

Static Readonly NeedsExecute

Static Readonly NeedsGenerate

Static Readonly NeedsResolve

Static Readonly NeedsRevise

Static Readonly insertChildFlags

Static Readonly mountFlags

Static Readonly powerFlags

Static Readonly removeChildFlags

Accessors

componentContext

Returns ComponentContext

insertChildFlags

Returns number

mountFlags

Returns number

powerFlags

Returns number

removeChildFlags

Returns number

superComponentContext

Returns ComponentContext

Methods

addComponentObserver

Parameters

componentObserver: ComponentObserver<Component>

Returns void

Abstract appendChildComponent

Parameters

childComponent: Component

Optional key: string

Returns void

Protected attachParentComponent

Parameters

parentComponent: Component

Returns void

Abstract cascadeCompile

Parameters

compileFlags: number

componentContext: ComponentContext

Returns void

Abstract cascadeExecute

Parameters

executeFlags: number

componentContext: ComponentContext

Returns void

Abstract cascadeInsert

Parameters

Optional updateFlags: number

Optional componentContext: ComponentContext

Returns void

Abstract cascadeMount

Returns void

Abstract cascadePower

Returns void

Abstract cascadeUnmount

Returns void