Winter Cardinal UI - v0.442.0 / DBaseStateSet

Interface: DBaseStateSet

Hierarchy

Implemented by

Table of contents

Properties

Methods

Properties

blinker

• Readonly blinker: DBaseStateSetBlinker

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:13

inActive

• Readonly inActive: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:21

inAlternated

• Readonly inAlternated: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:90

inChanged

• Readonly inChanged: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:86

inDisabled

• Readonly inDisabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:37

inEnabled

• Readonly inEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:33

inFailed

• Readonly inFailed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:78

inFocusReverse

• Readonly inFocusReverse: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:62

inFocusRoot

• Readonly inFocusRoot: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:58

inFocusable

• Readonly inFocusable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:50

inFocused

• Readonly inFocused: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:46

inGesturing

• Readonly inGesturing: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:42

inHovered

• Readonly inHovered: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:17

inInvalid

• Readonly inInvalid: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:66

inPressed

• Readonly inPressed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:25

inProcessing

• Readonly inProcessing: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:70

inReadOnly

• Readonly inReadOnly: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:29

inSucceeded

• Readonly inSucceeded: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:74

inUnfocusable

• Readonly inUnfocusable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:54

inWarned

• Readonly inWarned: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:82

isActionable

• isActionable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:40

isActive

• isActive: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:20

isAlternated

• isAlternated: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:89

isChanged

• isChanged: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:85

isDisabled

• isDisabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:36

isEnabled

• isEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:32

isFailed

• isFailed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:77

isFocusReverse

• isFocusReverse: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:61

isFocusRoot

• isFocusRoot: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:57

isFocusable

• isFocusable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:49

isFocused

• isFocused: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:45

isGesturing

• isGesturing: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:41

isHovered

• isHovered: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:16

isInvalid

• isInvalid: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:65

isPressed

• isPressed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:24

isProcessing

• isProcessing: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:69

isReadOnly

• isReadOnly: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:28

isSucceeded

• isSucceeded: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:73

isUnfocusable

• isUnfocusable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:53

isWarned

• isWarned: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:81

onActive

• Readonly onActive: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:22

onAlternated

• Readonly onAlternated: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:91

onChanged

• Readonly onChanged: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:87

onDisabled

• Readonly onDisabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:38

onEnabled

• Readonly onEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:34

onFailed

• Readonly onFailed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:79

onFocusReverse

• Readonly onFocusReverse: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:63

onFocusRoot

• Readonly onFocusRoot: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:59

onFocusable

• Readonly onFocusable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:51

onFocused

• Readonly onFocused: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:47

onGesturing

• Readonly onGesturing: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:43

onHovered

• Readonly onHovered: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:18

onInvalid

• Readonly onInvalid: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:67

onPressed

• Readonly onPressed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:26

onProcessing

• Readonly onProcessing: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:71

onReadOnly

• Readonly onReadOnly: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:30

onSucceeded

• Readonly onSucceeded: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:75

onUnfocusable

• Readonly onUnfocusable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:55

onWarned

• Readonly onWarned: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:83

parent

• parent: null | DBaseStateSet

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:12

ticker

• Readonly ticker: DBaseStateSetTicker

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:14

underActive

• Readonly underActive: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:23

underAlternated

• Readonly underAlternated: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:92

underChanged

• Readonly underChanged: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:88

underDisabled

• Readonly underDisabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:39

underEnabled

• Readonly underEnabled: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:35

underFailed

• Readonly underFailed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:80

underFocusReverse

• Readonly underFocusReverse: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:64

underFocusRoot

• Readonly underFocusRoot: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:60

underFocusable

• Readonly underFocusable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:52

underFocused

• Readonly underFocused: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:48

underGesturing

• Readonly underGesturing: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:44

underHovered

• Readonly underHovered: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:19

underInvalid

• Readonly underInvalid: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:68

underPressed

• Readonly underPressed: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:27

underProcessing

• Readonly underProcessing: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:72

underReadOnly

• Readonly underReadOnly: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:31

underSucceeded

• Readonly underSucceeded: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:76

underUnfocusable

• Readonly underUnfocusable: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:56

underWarned

• Readonly underWarned: boolean

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:84

Methods

add

▸ add(state, value?): this

Parameters

Name Type
state string
value? null | number

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:155

addAll

▸ addAll(states): this

Parameters

Name Type
states string[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:157

▸ addAll(states): this

Parameters

Name Type
states DBaseStateAndValue[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:158

▸ addAll(states): this

Parameters

Name Type
states string[] | DBaseStateAndValue[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:159

▸ addAll(...states): this

Parameters

Name Type
...states string[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:161

▸ addAll(...states): this

Parameters

Name Type
...states DBaseStateAndValue[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:162

clear

▸ clear(): this

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:189

copy

▸ copy(state): this

Parameters

Name Type
state DBaseStateSet

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:195

each

▸ each(iteratee): this

Parameters

Name Type
iteratee (state: string, value: null | number) => void

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:193

in

▸ in(state, value?): boolean

Returns true if the given state is on or if one of the parents has the given state. If the given value is undefined, values assigned to states are ignored. If the given value is not undefined, values assigned to states are taken into account.

Parameters

Name Type Description
state string a state
value? null | number a state value

Returns

boolean

true if the given state is on or if one of the parents has the given state.

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:114

is

▸ is(state, value?): boolean

Returns true if the given state is on. If the given value is undefined, values assigned to states are ignored. If the given value is not undefined, values assigned to states are taken into account.

Parameters

Name Type Description
state string a state
value? null | number a state value

Returns

boolean

true if the given state is on

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:103

lock

▸ lock(callOnChange?): this

Locks this state set. The locked state set delays calling the change event handler.

Parameters

Name Type Description
callOnChange? boolean false to stop calling the change event handler when unlocked

Returns

this

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:145

on

▸ on(state, value?): boolean

Returns true if the direct parent has the given state. If the given value is undefined, values assigned to states are ignored. If the given value is not undefined, values assigned to states are taken into account.

Parameters

Name Type Description
state string a state
value? null | number a state value

Returns

boolean

true if the direct parent has the given state.

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:125

onParentChange

▸ onParentChange(newState, oldState): void

Parameters

Name Type
newState DBaseStateSet
oldState DBaseStateSet

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:197

remove

▸ remove(state): this

Parameters

Name Type
state string

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:164

removeAll

▸ removeAll(states): this

Parameters

Name Type
states string[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:166

▸ removeAll(states): this

Parameters

Name Type
states DBaseStateAndValue[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:167

▸ removeAll(states): this

Parameters

Name Type
states string[] | DBaseStateAndValue[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:168

▸ removeAll(...states): this

Parameters

Name Type
...states string[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:170

▸ removeAll(...states): this

Parameters

Name Type
...states DBaseStateAndValue[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:171

▸ removeAll(matcher): this

Parameters

Name Type
matcher (state: string) => boolean | void

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:173

set

▸ set(state, on): this

Parameters

Name Type
state string
on boolean

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:175

▸ set(state, value, on): this

Parameters

Name Type
state string
value null | number
on boolean

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:176

▸ set(added, removed): this

Parameters

Name Type
added null | string
removed null | string

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:178

▸ set(added, value, removed): this

Parameters

Name Type
added null | string
value null | number
removed null | string

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:179

setAll

▸ setAll(states, on): this

Parameters

Name Type
states string[]
on boolean

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:181

▸ setAll(states, on): this

Parameters

Name Type
states DBaseStateAndValue[]
on boolean

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:182

▸ setAll(states, on): this

Parameters

Name Type
states string[] | DBaseStateAndValue[]
on boolean

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:183

▸ setAll(addeds, removeds): this

Parameters

Name Type
addeds null | string[]
removeds null | string[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:185

▸ setAll(addeds, removeds): this

Parameters

Name Type
addeds null | DBaseStateAndValue[]
removeds null | string[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:186

▸ setAll(addeds, removeds): this

Parameters

Name Type
addeds null | string[] | DBaseStateAndValue[]
removeds null | string[]

Returns

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:187

size

▸ size(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:194

toObject

▸ toObject(): DBaseStateSetLike

Returns

DBaseStateSetLike

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:199

toString

▸ toString(): string

Returns

string

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:200

under

▸ under(state, value?): boolean

Returns true if one of the parents has the given state. If the given value is undefined, values assigned to states are ignored. If the given value is not undefined, values assigned to states are taken into account.

Parameters

Name Type Description
state string a state
value? null | number a state value

Returns

boolean

true if one of the parents has the given state.

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:136

unlock

▸ unlock(): this

Unlocks this state set and calls the change event handler if this state set has changed. However, if this state set is locked with the callOnChange of false, the change event handler is not called.

Returns

this

this

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:153

valueOf

▸ valueOf(state, def?): undefined | null | number

Parameters

Name Type
state string
def? null | number

Returns

undefined | null | number

Defined in

src/main/typescript/wcardinal/ui/d-base-state-set.ts:191

Edit this page.