Class Switch

Hierarchy

Control
- Switch

Index

Constructors

Properties

#callback #container #value expectedValue

Methods

#onToggle checkExpectedValue createElement getContainer getValue hide resetExpectedValue setExpectedValue setValue show

Constructors

constructor

new Switch(ID, callback, initialValue?): Switch
Parameters
- ID: string
- callback: CallableFunction
- Optional initialValue: boolean
Returns Switch
Overrides Control.constructor
- Defined in src/controls/switch.ts:8

Properties

`Private` #callback

#callback: null | CallableFunction = null

`Private` #container

#container: null | HTMLElement

`Private` #value

#value: undefined | boolean = false

expectedValue

expectedValue: any = null

Methods

`Private` #onToggle

#onToggle(): void
Returns void
- Defined in src/controls/switch.ts:39

checkExpectedValue

checkExpectedValue(value): boolean
Parameters
- value: any
Returns boolean
Inherited from Control.checkExpectedValue
- Defined in src/controls/control.ts:34

createElement

createElement(options?): null | HTMLElement
Parameters
- Optional options: any
Returns null | HTMLElement
Inherited from Control.createElement
- Defined in src/controls/control.ts:38

getContainer

getContainer(): null | HTMLElement
Returns null | HTMLElement
Inherited from Control.getContainer
- Defined in src/controls/control.ts:22

getValue

getValue(): undefined | boolean
Returns undefined | boolean
- Defined in src/controls/switch.ts:35

hide

hide(): void
Returns void
Inherited from Control.hide
- Defined in src/controls/control.ts:17

resetExpectedValue

resetExpectedValue(): void
Returns void
Inherited from Control.resetExpectedValue
- Defined in src/controls/control.ts:30

setExpectedValue

setExpectedValue(expectedValue): void
Parameters
- expectedValue: any
Returns void
Inherited from Control.setExpectedValue
- Defined in src/controls/control.ts:26

setValue

setValue(newValue, ignoreExpectedValue?): void
Parameters
- newValue: undefined | boolean
- ignoreExpectedValue: boolean = true
Returns void
- Defined in src/controls/switch.ts:28

show

show(): void
Returns void
Inherited from Control.show
- Defined in src/controls/control.ts:12

Generated using TypeDoc