Class DorfCheckboxComponent<T>

DORF checkbox field which consumes DorfCheckboxMetadata for rendering. One of the predefined DORF fields.

stable

Type parameters

T

Hierarchy

AbstractDorfFieldComponent<T, DorfCheckboxMetadata<T>>
- DorfCheckboxComponent

Implements

OnChanges

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DorfCheckboxComponent(config: DorfConfigService): DorfCheckboxComponent

Overrides AbstractDorfFieldComponent.constructor
- Defined in src/fields/dorf-checkbox.component.ts:33
inheritdoc

Parameters
- config: DorfConfigService
Returns DorfCheckboxComponent

Properties

checkboxValue

checkboxValue: boolean

True/false value which is seen by the end user.

config

config: DorfConfigService

injected service

metadata

metadata: DorfCheckboxMetadata<T>

Essence, needed by DORF field.

Accessors

formControl

get formControl(): FormControl

Inherited from AbstractDorfFieldComponent.formControl
- Defined in src/fields/base/abstract-dorf-field.component.ts:84
Returns FormControl

htmlFieldCss

get htmlFieldCss(): undefined | string | IDorfCommonCssClasses

Inherited from AbstractDorfFieldComponent.htmlFieldCss
- Defined in src/fields/base/abstract-dorf-field.component.ts:66
Returns undefined | string | IDorfCommonCssClasses

innerLabel

get innerLabel(): undefined | string

- Defined in src/fields/dorf-checkbox.component.ts:63
Checkbox has a label around it, which is independent from the label from wrapper.

Returns undefined | string

innerLabelCss

get innerLabelCss(): undefined | string | IDorfCommonCssClasses

- Defined in src/fields/dorf-checkbox.component.ts:64
Returns undefined | string | IDorfCommonCssClasses

invalid

get invalid(): undefined | true | false

Inherited from AbstractDorfFieldComponent.invalid
- Defined in src/fields/base/abstract-dorf-field.component.ts:82
Returns undefined | true | false

key

get key(): string

Inherited from AbstractDorfFieldComponent.key
- Defined in src/fields/base/abstract-dorf-field.component.ts:64
Returns string

label

get label(): undefined | string

Inherited from AbstractDorfFieldComponent.label
- Defined in src/fields/base/abstract-dorf-field.component.ts:65
Returns undefined | string

labelCss

get labelCss(): string

Inherited from AbstractDorfFieldComponent.labelCss
- Defined in src/fields/base/abstract-dorf-field.component.ts:67
Returns string

Methods

Protected getCss

getCss(cssClass: string): undefined | string | IDorfCommonCssClasses

Inherited from AbstractDorfFieldComponent.getCss
- Defined in src/fields/base/abstract-dorf-field.component.ts:86
Parameters
- cssClass: string
Returns undefined | string | IDorfCommonCssClasses

ngOnChanges

ngOnChanges(): void

- Defined in src/fields/dorf-checkbox.component.ts:41
inheritdoc

Returns void

setValue

setValue(value: boolean): void

- Defined in src/fields/dorf-checkbox.component.ts:52
Callback which sets the mapping value based on the state of the visible checkbox.

Parameters
- value: boolean
Returns void

Generated using TypeDoc