Class CheckProperty<V, O>

Type Parameters

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

Hierarchy

BaseProperty<VAL, CheckOptions<VAL>>
- CheckProperty

Index

Constructors

Properties

_blocked _container? _value? emitter item name options options

Constructors

constructor

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

Properties

`Protected` _blocked

_blocked: boolean = false

`Protected` `Optional` _container

_container?: HTMLElement

`Protected` `Optional` _value

_value?: boolean

emitter

emitter: EventEmitter = ...

item

item: Item<ItemOptions>

name

name: string

options

options: CheckOptions<boolean>

`Static` options

options: CheckOptions<boolean> = ...

Methods

`Protected` _callOnSet

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

`Protected` _fireChangeEvent

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

`Protected` _prepareValue

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

block

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

blockChild

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

destroy

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

get

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

getChildren

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

getContainer

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

getHierarchyValue

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

getParent

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

getParents

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

getProperty

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

getValue

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

isBlocked

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

isGroup

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

set

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

unBlock

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

unblockChild

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

update

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

Generated using TypeDoc