Winter Cardinal UI - v0.442.0 / EShapeStateSet

Interface: EShapeStateSet

Hierarchy

Implemented by

Table of contents

Properties

Methods

Properties

blinker

Readonly blinker: DBaseStateSetBlinker

Inherited from

DBaseStateSet.blinker

Defined in

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


inActivated

Readonly inActivated: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:47


inActive

Readonly inActive: boolean

Inherited from

DBaseStateSet.inActive

Defined in

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


inAlternated

Readonly inAlternated: boolean

Inherited from

DBaseStateSet.inAlternated

Defined in

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


inChanged

Readonly inChanged: boolean

Inherited from

DBaseStateSet.inChanged

Defined in

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


inClicked

Readonly inClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:5


inDblClicked

Readonly inDblClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:9


inDeactivated

Readonly inDeactivated: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:51


inDisabled

Readonly inDisabled: boolean

Inherited from

DBaseStateSet.inDisabled

Defined in

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


inDown

Readonly inDown: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:13


inEnabled

Readonly inEnabled: boolean

Inherited from

DBaseStateSet.inEnabled

Defined in

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


inFailed

Readonly inFailed: boolean

Inherited from

DBaseStateSet.inFailed

Defined in

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


inFocusReverse

Readonly inFocusReverse: boolean

Inherited from

DBaseStateSet.inFocusReverse

Defined in

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


inFocusRoot

Readonly inFocusRoot: boolean

Inherited from

DBaseStateSet.inFocusRoot

Defined in

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


inFocusable

Readonly inFocusable: boolean

Inherited from

DBaseStateSet.inFocusable

Defined in

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


inFocused

Readonly inFocused: boolean

Inherited from

DBaseStateSet.inFocused

Defined in

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


inGesturing

Readonly inGesturing: boolean

Inherited from

DBaseStateSet.inGesturing

Defined in

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


inHovered

Readonly inHovered: boolean

Inherited from

DBaseStateSet.inHovered

Defined in

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


inInvalid

Readonly inInvalid: boolean

Inherited from

DBaseStateSet.inInvalid

Defined in

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


inPressed

Readonly inPressed: boolean

Inherited from

DBaseStateSet.inPressed

Defined in

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


inProcessing

Readonly inProcessing: boolean

Inherited from

DBaseStateSet.inProcessing

Defined in

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


inReadOnly

Readonly inReadOnly: boolean

Inherited from

DBaseStateSet.inReadOnly

Defined in

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


inRightClicked

Readonly inRightClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:26


inRightDown

Readonly inRightDown: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:30


inRightPressed

Readonly inRightPressed: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:42


inRightUp

Readonly inRightUp: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:34


inRightUpOutside

Readonly inRightUpOutside: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:38


inSucceeded

Readonly inSucceeded: boolean

Inherited from

DBaseStateSet.inSucceeded

Defined in

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


inUnfocusable

Readonly inUnfocusable: boolean

Inherited from

DBaseStateSet.inUnfocusable

Defined in

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


inUp

Readonly inUp: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:17


inUpOutside

Readonly inUpOutside: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:21


inWarned

Readonly inWarned: boolean

Inherited from

DBaseStateSet.inWarned

Defined in

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


isActionable

isActionable: boolean

Inherited from

DBaseStateSet.isActionable

Defined in

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


isActivated

isActivated: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:46


isActive

isActive: boolean

Inherited from

DBaseStateSet.isActive

Defined in

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


isAlternated

isAlternated: boolean

Inherited from

DBaseStateSet.isAlternated

Defined in

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


isChanged

isChanged: boolean

Inherited from

DBaseStateSet.isChanged

Defined in

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


isClicked

isClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:4


isDblClicked

isDblClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:8


isDeactivated

isDeactivated: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:50


isDisabled

isDisabled: boolean

Inherited from

DBaseStateSet.isDisabled

Defined in

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


isDown

isDown: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:12


isEnabled

isEnabled: boolean

Inherited from

DBaseStateSet.isEnabled

Defined in

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


isFailed

isFailed: boolean

Inherited from

DBaseStateSet.isFailed

Defined in

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


isFocusReverse

isFocusReverse: boolean

Inherited from

DBaseStateSet.isFocusReverse

Defined in

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


isFocusRoot

isFocusRoot: boolean

Inherited from

DBaseStateSet.isFocusRoot

Defined in

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


isFocusable

isFocusable: boolean

Inherited from

DBaseStateSet.isFocusable

Defined in

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


isFocused

isFocused: boolean

Inherited from

DBaseStateSet.isFocused

Defined in

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


isGesturing

isGesturing: boolean

Inherited from

DBaseStateSet.isGesturing

Defined in

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


isHovered

isHovered: boolean

Inherited from

DBaseStateSet.isHovered

Defined in

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


isInvalid

isInvalid: boolean

Inherited from

DBaseStateSet.isInvalid

Defined in

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


isPressed

isPressed: boolean

Inherited from

DBaseStateSet.isPressed

Defined in

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


isProcessing

isProcessing: boolean

Inherited from

DBaseStateSet.isProcessing

Defined in

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


isReadOnly

isReadOnly: boolean

Inherited from

DBaseStateSet.isReadOnly

Defined in

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


isRightClicked

isRightClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:25


isRightDown

isRightDown: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:29


isRightPressed

isRightPressed: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:41


isRightUp

isRightUp: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:33


isRightUpOutside

isRightUpOutside: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:37


isSucceeded

isSucceeded: boolean

Inherited from

DBaseStateSet.isSucceeded

Defined in

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


isUnfocusable

isUnfocusable: boolean

Inherited from

DBaseStateSet.isUnfocusable

Defined in

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


isUp

isUp: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:16


isUpOutside

isUpOutside: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:20


isWarned

isWarned: boolean

Inherited from

DBaseStateSet.isWarned

Defined in

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


onActivated

Readonly onActivated: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:48


onActive

Readonly onActive: boolean

Inherited from

DBaseStateSet.onActive

Defined in

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


onAlternated

Readonly onAlternated: boolean

Inherited from

DBaseStateSet.onAlternated

Defined in

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


onChanged

Readonly onChanged: boolean

Inherited from

DBaseStateSet.onChanged

Defined in

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


onClicked

Readonly onClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:6


onDblClicked

Readonly onDblClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:10


onDeactivated

Readonly onDeactivated: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:52


onDisabled

Readonly onDisabled: boolean

Inherited from

DBaseStateSet.onDisabled

Defined in

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


onDown

Readonly onDown: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:14


onEnabled

Readonly onEnabled: boolean

Inherited from

DBaseStateSet.onEnabled

Defined in

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


onFailed

Readonly onFailed: boolean

Inherited from

DBaseStateSet.onFailed

Defined in

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


onFocusReverse

Readonly onFocusReverse: boolean

Inherited from

DBaseStateSet.onFocusReverse

Defined in

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


onFocusRoot

Readonly onFocusRoot: boolean

Inherited from

DBaseStateSet.onFocusRoot

Defined in

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


onFocusable

Readonly onFocusable: boolean

Inherited from

DBaseStateSet.onFocusable

Defined in

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


onFocused

Readonly onFocused: boolean

Inherited from

DBaseStateSet.onFocused

Defined in

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


onGesturing

Readonly onGesturing: boolean

Inherited from

DBaseStateSet.onGesturing

Defined in

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


onHovered

Readonly onHovered: boolean

Inherited from

DBaseStateSet.onHovered

Defined in

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


onInvalid

Readonly onInvalid: boolean

Inherited from

DBaseStateSet.onInvalid

Defined in

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


onPressed

Readonly onPressed: boolean

Inherited from

DBaseStateSet.onPressed

Defined in

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


onProcessing

Readonly onProcessing: boolean

Inherited from

DBaseStateSet.onProcessing

Defined in

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


onReadOnly

Readonly onReadOnly: boolean

Inherited from

DBaseStateSet.onReadOnly

Defined in

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


onRightClicked

Readonly onRightClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:27


onRightDown

Readonly onRightDown: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:31


onRightPressed

Readonly onRightPressed: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:43


onRightUp

Readonly onRightUp: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:35


onRightUpOutside

Readonly onRightUpOutside: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:39


onSucceeded

Readonly onSucceeded: boolean

Inherited from

DBaseStateSet.onSucceeded

Defined in

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


onUnfocusable

Readonly onUnfocusable: boolean

Inherited from

DBaseStateSet.onUnfocusable

Defined in

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


onUp

Readonly onUp: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:18


onUpOutside

Readonly onUpOutside: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:22


onWarned

Readonly onWarned: boolean

Inherited from

DBaseStateSet.onWarned

Defined in

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


parent

parent: null | DBaseStateSet

Inherited from

DBaseStateSet.parent

Defined in

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


ticker

Readonly ticker: DBaseStateSetTicker

Inherited from

DBaseStateSet.ticker

Defined in

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


underActivated

Readonly underActivated: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:49


underActive

Readonly underActive: boolean

Inherited from

DBaseStateSet.underActive

Defined in

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


underAlternated

Readonly underAlternated: boolean

Inherited from

DBaseStateSet.underAlternated

Defined in

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


underChanged

Readonly underChanged: boolean

Inherited from

DBaseStateSet.underChanged

Defined in

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


underClicked

Readonly underClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:7


underDblClicked

Readonly underDblClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:11


underDeactivated

Readonly underDeactivated: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:53


underDisabled

Readonly underDisabled: boolean

Inherited from

DBaseStateSet.underDisabled

Defined in

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


underDown

Readonly underDown: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:15


underEnabled

Readonly underEnabled: boolean

Inherited from

DBaseStateSet.underEnabled

Defined in

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


underFailed

Readonly underFailed: boolean

Inherited from

DBaseStateSet.underFailed

Defined in

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


underFocusReverse

Readonly underFocusReverse: boolean

Inherited from

DBaseStateSet.underFocusReverse

Defined in

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


underFocusRoot

Readonly underFocusRoot: boolean

Inherited from

DBaseStateSet.underFocusRoot

Defined in

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


underFocusable

Readonly underFocusable: boolean

Inherited from

DBaseStateSet.underFocusable

Defined in

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


underFocused

Readonly underFocused: boolean

Inherited from

DBaseStateSet.underFocused

Defined in

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


underGesturing

Readonly underGesturing: boolean

Inherited from

DBaseStateSet.underGesturing

Defined in

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


underHovered

Readonly underHovered: boolean

Inherited from

DBaseStateSet.underHovered

Defined in

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


underInvalid

Readonly underInvalid: boolean

Inherited from

DBaseStateSet.underInvalid

Defined in

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


underPressed

Readonly underPressed: boolean

Inherited from

DBaseStateSet.underPressed

Defined in

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


underProcessing

Readonly underProcessing: boolean

Inherited from

DBaseStateSet.underProcessing

Defined in

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


underReadOnly

Readonly underReadOnly: boolean

Inherited from

DBaseStateSet.underReadOnly

Defined in

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


underRightClicked

Readonly underRightClicked: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:28


underRightDown

Readonly underRightDown: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:32


underRightPressed

Readonly underRightPressed: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:44


underRightUp

Readonly underRightUp: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:36


underRightUpOutside

Readonly underRightUpOutside: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:40


underSucceeded

Readonly underSucceeded: boolean

Inherited from

DBaseStateSet.underSucceeded

Defined in

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


underUnfocusable

Readonly underUnfocusable: boolean

Inherited from

DBaseStateSet.underUnfocusable

Defined in

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


underUp

Readonly underUp: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:19


underUpOutside

Readonly underUpOutside: boolean

Defined in

src/main/typescript/wcardinal/ui/shape/e-shape-state-set.ts:23


underWarned

Readonly underWarned: boolean

Inherited from

DBaseStateSet.underWarned

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

Inherited from

DBaseStateSet.add

Defined in

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


addAll

addAll(states): this

Parameters

Name Type
states string[]

Returns

this

Inherited from

DBaseStateSet.addAll

Defined in

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

addAll(states): this

Parameters

Name Type
states DBaseStateAndValue[]

Returns

this

Inherited from

DBaseStateSet.addAll

Defined in

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

addAll(states): this

Parameters

Name Type
states string[] | DBaseStateAndValue[]

Returns

this

Inherited from

DBaseStateSet.addAll

Defined in

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

addAll(...states): this

Parameters

Name Type
...states string[]

Returns

this

Inherited from

DBaseStateSet.addAll

Defined in

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

addAll(...states): this

Parameters

Name Type
...states DBaseStateAndValue[]

Returns

this

Inherited from

DBaseStateSet.addAll

Defined in

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


clear

clear(): this

Returns

this

Inherited from

DBaseStateSet.clear

Defined in

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


copy

copy(state): this

Parameters

Name Type
state DBaseStateSet

Returns

this

Inherited from

DBaseStateSet.copy

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

Inherited from

DBaseStateSet.each

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.

Inherited from

DBaseStateSet.in

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

Inherited from

DBaseStateSet.is

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

Inherited from

DBaseStateSet.lock

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.

Inherited from

DBaseStateSet.on

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

Inherited from

DBaseStateSet.onParentChange

Defined in

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


remove

remove(state): this

Parameters

Name Type
state string

Returns

this

Inherited from

DBaseStateSet.remove

Defined in

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


removeAll

removeAll(states): this

Parameters

Name Type
states string[]

Returns

this

Inherited from

DBaseStateSet.removeAll

Defined in

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

removeAll(states): this

Parameters

Name Type
states DBaseStateAndValue[]

Returns

this

Inherited from

DBaseStateSet.removeAll

Defined in

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

removeAll(states): this

Parameters

Name Type
states string[] | DBaseStateAndValue[]

Returns

this

Inherited from

DBaseStateSet.removeAll

Defined in

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

removeAll(...states): this

Parameters

Name Type
...states string[]

Returns

this

Inherited from

DBaseStateSet.removeAll

Defined in

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

removeAll(...states): this

Parameters

Name Type
...states DBaseStateAndValue[]

Returns

this

Inherited from

DBaseStateSet.removeAll

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

Inherited from

DBaseStateSet.removeAll

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

Inherited from

DBaseStateSet.set

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

Inherited from

DBaseStateSet.set

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

Inherited from

DBaseStateSet.set

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

Inherited from

DBaseStateSet.set

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

Inherited from

DBaseStateSet.setAll

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

Inherited from

DBaseStateSet.setAll

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

Inherited from

DBaseStateSet.setAll

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

Inherited from

DBaseStateSet.setAll

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

Inherited from

DBaseStateSet.setAll

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

Inherited from

DBaseStateSet.setAll

Defined in

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


size

size(): number

Returns

number

Inherited from

DBaseStateSet.size

Defined in

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


toObject

toObject(): DBaseStateSetLike

Returns

DBaseStateSetLike

Inherited from

DBaseStateSet.toObject

Defined in

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


toString

toString(): string

Returns

string

Inherited from

DBaseStateSet.toString

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.

Inherited from

DBaseStateSet.under

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

Inherited from

DBaseStateSet.unlock

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

Inherited from

DBaseStateSet.valueOf

Defined in

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