Class CheckProperty<V, O>

Type Parameters

V extends VAL = VAL
O extends CheckOptions<VAL> = CheckOptions<VAL>

Hierarchy (View Summary)

BaseProperty<VAL, CheckOptions<VAL>>
- CheckProperty

Index

Constructors

Properties

__value? _blocked _container? emitter item name options options

Accessors

Constructors

constructor

new CheckProperty<
    V extends boolean = boolean,
    O extends CheckOptions<boolean> = CheckOptions<boolean>,
>(
    name: string,
    item: Item,
    options: O,
): CheckProperty<V, O>
Type Parameters
- V extends boolean = boolean
- O extends CheckOptions<boolean> = CheckOptions<boolean>
Parameters
- name: string
- item: Item
- options: O
Returns CheckProperty<V, O>
Overrides BaseProperty.constructor
- Defined in item/src/properties/CheckProperty.ts:22

Properties

`Protected` `Optional`__value

__value?: boolean

`Protected`_blocked

_blocked: boolean = false

`Protected` `Optional`_container

_container?: HTMLElement

emitter

emitter: EventEmitter<DefaultEventMap> = ...

item

item: Item

name

name: string

options

options: CheckOptions

`Static`options

options: CheckOptions = ...

Accessors

`Protected`_value

get _value(): undefined | V
Returns undefined | V
Inherited from BaseProperty._value
- Defined in item/src/properties/BaseProperty.ts:23
set _value(v: undefined | V): void
Parameters
- v: undefined | V
Returns void
Inherited from BaseProperty._value
- Defined in item/src/properties/BaseProperty.ts:20

Methods

`Protected`_callOnSet

_callOnSet<W extends boolean = boolean>(
value?: W,
options?: CheckOptions<boolean>,
): void
Type Parameters
- W extends boolean = boolean
Parameters
- Optionalvalue: W
- Optionaloptions: CheckOptions<boolean>
Returns void
Inherited from BaseProperty._callOnSet
- Defined in item/src/properties/BaseProperty.ts:110

`Protected`_fireChangeEvent

_fireChangeEvent(value?: boolean, options?: CheckOptions<boolean>): void
Parameters
- Optionalvalue: boolean
- Optionaloptions: CheckOptions<boolean>
Returns void
Inherited from BaseProperty._fireChangeEvent
- Defined in item/src/properties/BaseProperty.ts:116

`Protected`_prepareValue

_prepareValue(value?: any): undefined | V
Parameters
- Optionalvalue: any
Returns undefined | V
Overrides BaseProperty._prepareValue
- Defined in item/src/properties/CheckProperty.ts:88

block

block(options?: O): void
Parameters
- Optionaloptions: O
Returns void
- Defined in item/src/properties/CheckProperty.ts:65

blockChild

blockChild(options?: O): void
Parameters
- Optionaloptions: O
Returns void
- Defined in item/src/properties/CheckProperty.ts:78

destroy

destroy(): void
Returns void
Inherited from BaseProperty.destroy
- Defined in item/src/properties/BaseProperty.ts:90

get

get(): undefined | boolean
Returns undefined | boolean
Inherited from BaseProperty.get
- Defined in item/src/properties/BaseProperty.ts:78

getChildren

getChildren(): Item<ItemOptions>[]
Returns Item<ItemOptions>[]
Inherited from BaseProperty.getChildren
- Defined in item/src/properties/BaseProperty.ts:51

getContainer

getContainer(): undefined | HTMLElement
Returns undefined | HTMLElement
Inherited from BaseProperty.getContainer
- Defined in item/src/properties/BaseProperty.ts:86

getHierarchyValue

getHierarchyValue(): undefined | boolean
Returns undefined | boolean
- Defined in item/src/properties/CheckProperty.ts:55

getParent

getParent(): undefined | Item<ItemOptions>
Returns undefined | Item<ItemOptions>
Inherited from BaseProperty.getParent
- Defined in item/src/properties/BaseProperty.ts:47

getParents

getParents(): Item<ItemOptions>[]
Returns Item<ItemOptions>[]
Inherited from BaseProperty.getParents
- Defined in item/src/properties/BaseProperty.ts:43

getProperty

getProperty(): undefined | boolean
Returns undefined | boolean
Inherited from BaseProperty.getProperty
- Defined in item/src/properties/BaseProperty.ts:36

getValue

getValue(): undefined | boolean
Returns undefined | boolean
Inherited from BaseProperty.getValue
- Defined in item/src/properties/BaseProperty.ts:102

isBlocked

isBlocked(): boolean
Returns boolean
Inherited from BaseProperty.isBlocked
- Defined in item/src/properties/BaseProperty.ts:60

isGroup

isGroup(): number
Returns number
Inherited from BaseProperty.isGroup
- Defined in item/src/properties/BaseProperty.ts:55

set

set(value?: boolean, options?: CheckOptions<boolean>): void
Parameters
- Optionalvalue: boolean
- Optionaloptions: CheckOptions<boolean>
Returns void
Inherited from BaseProperty.set
- Defined in item/src/properties/BaseProperty.ts:70

unBlock

unBlock(options?: O): void
Parameters
- Optionaloptions: O
Returns void
- Defined in item/src/properties/CheckProperty.ts:70

unblockChild

unblockChild(options?: O): void
Parameters
- Optionaloptions: O
Returns void
- Defined in item/src/properties/CheckProperty.ts:84

update

update(value?: V, options?: O): void
Parameters
- Optionalvalue: V
- Optionaloptions: O
Returns void
Overrides BaseProperty.update
- Defined in item/src/properties/CheckProperty.ts:27