Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataField<T> Abstract

Holds the logic common to all data field Model objects.

Type Parameters

  • T

    type of the value property of the data field

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

  • new DataField<T>(_stringId: string, _title: string, initialValue: T, _behavior: Behavior, _placeholder?: string, _description?: string, _layout?: Layout, validations?: Validation[], _component?: Component, _parentTaskId?: string, _parentCaseId?: string): DataField<T>

  • Type Parameters

    • T

    Parameters

    • _stringId: string

      ID of the data field from backend

    • _title: string

      displayed title of the data field from backend

    • initialValue: T

      initial value of the data field

    • _behavior: Behavior

      data field behavior

    • Optional _placeholder: string

      placeholder displayed in the datafield

    • Optional _description: string

      tooltip of the datafield

    • Optional _layout: Layout

      information regarding the component rendering

    • Optional validations: Validation[]
    • Optional _component: Component

      component data of datafield

    • Optional _parentTaskId: string

      stringId of parent task, only defined if field is loaded using TaskRefField

    • Optional _parentCaseId: string

      stringId of parent case, only defined if field is loaded using TaskRefField

    Returns DataField<T>

Properties

Protected _blockSubscription

_blockSubscription: Subscription

Private _componentChange$

_componentChange$: Subject<Component>

change of component

Private _formControlRef

_formControlRef: FormControl

Reference to form control

Protected _formControlValueSubscription

_formControlValueSubscription: Subscription

Protected _initializedSubscription

_initializedSubscription: Subscription

Stores the last subscription to the [_initialized$]{@link AbstractDataField#_initialized$} Stream, to prevent multiple block events from executing at the same time

Private _input

_input: ElementRef<any>

Reference to rendered element

Protected _localLayout

_localLayout: Layout

Stores a copy of the fields layout, that can be modified by the layouting algorithm as needed without affecting the base configuration.

Protected _myValueSubscription

_myValueSubscription: Subscription

Private _reverting

_reverting: boolean = false

Flag that is set during reverting

Private _sendInvalidValues

_sendInvalidValues: boolean = true

Whether invalid field values should be sent to backend.

Protected _touchSubscription

_touchSubscription: Subscription

Protected _updateSubscription

_updateSubscription: Subscription

Protected _validators

_validators: ValidatorFn[]

Validators resolved from field validations

Protected layoutSubject

layoutSubject: BehaviorSubject<Layout>

Listens for layout changes

Optional validations

validations?: Validation[]

Accessors

behavior

  • get behavior(): Behavior
  • set behavior(behavior: Behavior): void

block

  • set block(set: boolean): void

changed

  • get changed(): boolean
  • set changed(set: boolean): void

component

description

  • get description(): string
  • set description(desc: string): void

disabled

  • get disabled(): boolean

formControlRef

  • get formControlRef(): FormControl
  • set formControlRef(formControl: FormControl): void

initialized

  • get initialized(): boolean

initialized$

  • get initialized$(): Observable<boolean>

input

  • get input(): ElementRef<any>
  • set input(value: ElementRef<any>): void

layout

localLayout

parentCaseId

  • get parentCaseId(): string

parentTaskId

  • get parentTaskId(): string

placeholder

  • get placeholder(): string
  • set placeholder(placeholder: string): void

previousValue

  • get previousValue(): T
  • set previousValue(value: T): void

reverting

  • get reverting(): boolean
  • set reverting(set: boolean): void

sendInvalidValues

  • get sendInvalidValues(): boolean
  • set sendInvalidValues(value: boolean): void

stringId

  • get stringId(): string

title

  • get title(): string
  • set title(title: string): void

touch

  • set touch(set: boolean): void

touch$

  • get touch$(): Observable<boolean>

valid

  • get valid(): boolean
  • set valid(set: boolean): void

validRequired

  • get validRequired(): boolean
  • set validRequired(set: boolean): void

value

  • get value(): T
  • set value(value: T): void

waitingForResponse

  • get waitingForResponse(): boolean
  • set waitingForResponse(value: boolean): void

Methods

Protected _determineFormControlValidity

  • _determineFormControlValidity(formControl: FormControl): boolean

applyChange

  • applyChange(change: Change): void

Protected calculateValidity

  • calculateValidity(forValidRequired: boolean, formControl: FormControl): boolean

clearValidators

  • clearValidators(): void

componentChange$

destroy

  • destroy(): void

disconnectFormControl

  • disconnectFormControl(): void

focus

  • focus(): void

getComponentType

  • getComponentType(): string

Abstract getTypedComponentType

  • getTypedComponentType(): string

getUpdateOnStrategy

  • getUpdateOnStrategy(): UpdateOnStrategy

isInvalid

  • isInvalid(formControl: FormControl): boolean

registerFormControl

  • registerFormControl(formControl: FormControl): void

replaceValidations

  • replaceValidations(validations: Validation[]): void

resetLocalLayout

  • resetLocalLayout(): void

resolveAppearance

Protected resolveFormControlValidators

  • resolveFormControlValidators(): ValidatorFn[]

  • Creates Validator objects based on field behavior. Only the required behavior is resolved by default. Required is resolved as Validators.required. If you need to resolve additional Validators or need a different resolution for the required Validator override this method.

    See {@link Behavior} for information about data field behavior.

    See {@link ValidatorFn} and {@link Validators} for information about Validators.

    Alternatively see Form Validation guide from Angular.

    Returns ValidatorFn[]

resolvePrevValue

  • resolvePrevValue(value: T): void

Protected resolveValidations

  • resolveValidations(): ValidatorFn[]

revertToPreviousValue

  • revertToPreviousValue(): void

Protected subscribeToInnerSubjects

  • subscribeToInnerSubjects(formControl: FormControl): void

update

  • update(): void

Protected updateFormControlState

  • updateFormControlState(formControl: FormControl): void

valueChanges

  • valueChanges(): Observable<T>

Protected valueEquality

  • valueEquality(a: T, b: T): boolean

valueWithoutChange

  • valueWithoutChange(value: T): void

Generated using TypeDoc