BooleanComponentProperty

Type parameters

C: Component

Hierarchy

ComponentProperty<C, boolean | null | undefined, boolean | string | null | undefined>
- BooleanComponentProperty

Callable

BooleanComponentProperty(): undefined | null | boolean
BooleanComponentProperty(state: undefined | null | string | boolean, precedence?: number): C

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:38
Returns undefined | null | boolean
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:39
Parameters
- state: undefined | null | string | boolean
- Optional precedence: number
Returns C

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BooleanComponentProperty<C>(owner: C, propertyName: undefined | string): BooleanComponentProperty<C>

Inherited from ComponentProperty<C, boolean | null | undefined, boolean | string | null | undefined>.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:105
Type parameters
- C: Component<C>
Parameters
- owner: C
- propertyName: undefined | string
Returns BooleanComponentProperty<C>

Properties

Readonly inherit

inherit: string | boolean

Readonly name

name: string

Readonly ownState

ownState: undefined | null | boolean

Readonly owner

owner: C

Readonly precedence

precedence: number

propertyFlags

propertyFlags: number

Readonly state

state: undefined | null | boolean

Readonly subProperties

subProperties: null | ComponentProperty<Component, undefined | null | boolean, never>[]

Readonly superName

superName: undefined | string

Readonly superProperty

superProperty: null | ComponentProperty<Component, undefined | null | boolean, never>

Readonly superState

superState: undefined | null | boolean

Optional updateFlags

updateFlags: number

Readonly updatedState

updatedState: undefined | null | boolean

Static InheritedFlag

InheritedFlag: number

Static MountedFlag

MountedFlag: number

Static OverrideFlag

OverrideFlag: number

Static UpdatedFlag

UpdatedFlag: number

Methods

addSubProperty

addSubProperty(subProperty: ComponentProperty<Component, undefined | null | boolean, never>): void

Inherited from ComponentProperty.addSubProperty
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:52
Parameters
- subProperty: ComponentProperty<Component, undefined | null | boolean, never>
Returns void

bindSuperProperty

bindSuperProperty(): void

Inherited from ComponentProperty.bindSuperProperty
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:49
Returns void

didMount

didMount(): void

Inherited from ComponentProperty.didMount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:86
Returns void

didSetPrecedence

didSetPrecedence(newPrecedence: number, oldPrecedence: number): void

Inherited from ComponentProperty.didSetPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:69
Parameters
- newPrecedence: number
- oldPrecedence: number
Returns void

didSetState

didSetState(newState: undefined | null | boolean, oldState: undefined | null | boolean): void

Inherited from ComponentProperty.didSetState
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:63
Parameters
- newState: undefined | null | boolean
- oldState: undefined | null | boolean
Returns void

didUnmount

didUnmount(): void

Inherited from ComponentProperty.didUnmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:90
Returns void

fromAny

fromAny(value: undefined | null | string | boolean): undefined | null | boolean

Overrides ComponentProperty.fromAny
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/BooleanComponentProperty.d.ts:4
Parameters
- value: undefined | null | string | boolean
Returns undefined | null | boolean

getState

getState(): boolean

Inherited from ComponentProperty.getState
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:57
Returns boolean

getStateOr

getStateOr<E>(elseState: E): boolean | E

Inherited from ComponentProperty.getStateOr
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:58
Type parameters
- E
Parameters
- elseState: E
Returns boolean | E

isInherited

isInherited(): boolean

Inherited from ComponentProperty.isInherited
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:45
Returns boolean

isMounted

isMounted(): boolean

Inherited from ComponentProperty.isMounted
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:82
Returns boolean

isUpdated

isUpdated(): boolean

Inherited from ComponentProperty.isUpdated
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:72
Returns boolean

mount

mount(): void

Inherited from ComponentProperty.mount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:83
Returns void

onMount

onMount(): void

Inherited from ComponentProperty.onMount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:85
Returns void

onRevise

onRevise(): void

Inherited from ComponentProperty.onRevise
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:77
Returns void

onReviseInherited

onReviseInherited(): void

Inherited from ComponentProperty.onReviseInherited
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:78
Returns void

onSetPrecedence

onSetPrecedence(newPrecedence: number, oldPrecedence: number): void

Inherited from ComponentProperty.onSetPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:68
Parameters
- newPrecedence: number
- oldPrecedence: number
Returns void

onSetState

onSetState(newState: undefined | null | boolean, oldState: undefined | null | boolean): void

Inherited from ComponentProperty.onSetState
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:62
Parameters
- newState: undefined | null | boolean
- oldState: undefined | null | boolean
Returns void

onUnmount

onUnmount(): void

Inherited from ComponentProperty.onUnmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:89
Returns void

removeSubProperty

removeSubProperty(subProperty: ComponentProperty<Component, undefined | null | boolean, never>): void

Inherited from ComponentProperty.removeSubProperty
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:53
Parameters
- subProperty: ComponentProperty<Component, undefined | null | boolean, never>
Returns void

revise

revise(): void

Inherited from ComponentProperty.revise
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:76
Returns void

setInherit

setInherit(inherit: string | boolean): void

Inherited from ComponentProperty.setInherit
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:44
Parameters
- inherit: string | boolean
Returns void

setInherited

setInherited(inherited: boolean): void

Inherited from ComponentProperty.setInherited
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:46
Parameters
- inherited: boolean
Returns void

setOwnState

setOwnState(state: undefined | null | string | boolean): void

Inherited from ComponentProperty.setOwnState
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:60
Parameters
- state: undefined | null | string | boolean
Returns void

setPrecedence

setPrecedence(precedence: number): void

Inherited from ComponentProperty.setPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:66
Parameters
- precedence: number
Returns void

setPropertyFlags

setPropertyFlags(propertyFlags: number): void

Inherited from ComponentProperty.setPropertyFlags
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:71
Parameters
- propertyFlags: number
Returns void

setState

setState(state: undefined | null | string | boolean, precedence?: number): void

Inherited from ComponentProperty.setState
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:59
Parameters
- state: undefined | null | string | boolean
- Optional precedence: number
Returns void

takeState

takeState(): undefined | null | boolean

Inherited from ComponentProperty.takeState
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:75
Returns undefined | null | boolean

takeUpdatedState

takeUpdatedState(): undefined | null | boolean

Inherited from ComponentProperty.takeUpdatedState
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:74
Returns undefined | null | boolean

takesPrecedence

takesPrecedence(precedence: number): boolean

Inherited from ComponentProperty.takesPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:64
Parameters
- precedence: number
Returns boolean

toString

toString(): string

Inherited from ComponentProperty.toString
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:91
Returns string

unbindSuperProperty

unbindSuperProperty(): void

Inherited from ComponentProperty.unbindSuperProperty
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:50
Returns void

unmount

unmount(): void

Inherited from ComponentProperty.unmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:87
Returns void

updateSubProperties

updateSubProperties(newState: undefined | null | boolean, oldState: undefined | null | boolean): void

Inherited from ComponentProperty.updateSubProperties
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:79
Parameters
- newState: undefined | null | boolean
- oldState: undefined | null | boolean
Returns void

willMount

willMount(): void

Inherited from ComponentProperty.willMount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:84
Returns void

willSetPrecedence

willSetPrecedence(newPrecedence: number, oldPrecedence: number): void

Inherited from ComponentProperty.willSetPrecedence
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:67
Parameters
- newPrecedence: number
- oldPrecedence: number
Returns void

willSetState

willSetState(newState: undefined | null | boolean, oldState: undefined | null | boolean): void

Inherited from ComponentProperty.willSetState
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:61
Parameters
- newState: undefined | null | boolean
- oldState: undefined | null | boolean
Returns void

willUnmount

willUnmount(): void

Inherited from ComponentProperty.willUnmount
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:88
Returns void

Static define

define<C_7, T_7, U_7, I_1>(descriptor: ComponentPropertyDescriptorExtends<C_7, T_7, U_7, I_1>): ComponentPropertyConstructor<C_7, T_7, U_7, I_1>
define<C_8, T_8, U_8>(descriptor: ComponentPropertyDescriptor<C_8, T_8, U_8, {}>): ComponentPropertyConstructor<C_8, T_8, U_8, {}>

Inherited from ComponentProperty.define
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:109
Type parameters
- C_7: Component<C_7>
- T_7
- U_7 = never
- I_1 = {}
Parameters
- descriptor: ComponentPropertyDescriptorExtends<C_7, T_7, U_7, I_1>
Returns ComponentPropertyConstructor<C_7, T_7, U_7, I_1>
Inherited from ComponentProperty.define
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:110
Type parameters
- C_8: Component<C_8>
- T_8
- U_8 = never
Parameters
- descriptor: ComponentPropertyDescriptor<C_8, T_8, U_8, {}>
Returns ComponentPropertyConstructor<C_8, T_8, U_8, {}>

Static getConstructor

getConstructor(type: unknown): null | ComponentPropertyClass

Inherited from ComponentProperty.getConstructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:108
Parameters
- type: unknown
Returns null | ComponentPropertyClass

Type parameters

C: Component

Hierarchy

Callable

Returns undefined | null | boolean

Parameters

state: undefined | null | string | boolean

Optional precedence: number

Returns C

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

C: Component<C>

Parameters

owner: C

propertyName: undefined | string

Returns BooleanComponentProperty<C>

Properties

Readonly inherit

Readonly name

Readonly ownState

Readonly owner

Readonly precedence

propertyFlags

Readonly state

Readonly subProperties

Readonly superName

Readonly superProperty

Readonly superState

Optional updateFlags

Readonly updatedState

Static InheritedFlag

Static MountedFlag

Static OverrideFlag

Static UpdatedFlag

Methods

addSubProperty

Parameters

subProperty: ComponentProperty<Component, undefined | null | boolean, never>

Returns void

bindSuperProperty

Returns void

didMount

Returns void

didSetPrecedence

Parameters

newPrecedence: number

oldPrecedence: number

Returns void

didSetState

Parameters

newState: undefined | null | boolean

oldState: undefined | null | boolean

Returns void

didUnmount

Returns void

fromAny

Parameters

value: undefined | null | string | boolean

Returns undefined | null | boolean

getState

Returns boolean

getStateOr

Type parameters

E

Parameters

elseState: E

Returns boolean | E

isInherited

Returns boolean

isMounted

Returns boolean

isUpdated

Returns boolean

mount

Returns void