ng-dynamic-forms documentation
  1. Classes
  2. DynamicFormGroupModel

File

projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts

Extends

DynamicFormControlModel

Index

Properties
Methods

Constructor

constructor(config: DynamicFormGroupModelConfig, layout?: DynamicFormControlLayout)
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:19
Parameters :
Name Type Optional
config DynamicFormGroupModelConfig No
layout DynamicFormControlLayout Yes

Properties

group
Type : DynamicFormModel
Default value : []
Decorators :
@serializable()
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:16
legend
Type : string | null
Decorators :
@serializable()
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:17
Readonly type
Type : string
Default value : DYNAMIC_FORM_CONTROL_TYPE_GROUP
Decorators :
@serializable()
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:19
_disabled
Type : boolean
Decorators :
@serializable('disabled')
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:28
asyncValidators
Type : DynamicValidatorsConfig | null
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:27
controlTooltip
Type : string | null
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:34
Private Readonly disabled$
Type : BehaviorSubject<boolean>
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:42
Readonly disabledChanges
Type : Observable<boolean>
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:44
errorMessages
Type : DynamicValidatorsConfig | null
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:29
hidden
Type : boolean
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:30
id
Type : string
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:31
label
Type : string | null
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:32
labelTooltip
Type : string | null
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:33
layout
Type : DynamicFormControlLayout | null
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:35
name
Type : string
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:36
parent
Type : DynamicPathable | null
Default value : null
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:37
relations
Type : DynamicFormControlRelation[]
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:38
Abstract Readonly type
Type : string
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:46
updateOn
Type : DynamicFormHook | null
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:39
validators
Type : DynamicValidatorsConfig | null
Decorators :
@serializable()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:40

Methods

add
add(controlModel: DynamicFormControlModel)
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:37
Parameters :
Name Type Optional
controlModel DynamicFormControlModel No
Returns : void
get
get(index: number)
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:29
Parameters :
Name Type Optional
index number No
Returns : DynamicFormControlModel
insert
insert(index: number, controlModel: DynamicFormControlModel)
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:41
Parameters :
Name Type Optional
index number No
controlModel DynamicFormControlModel No
Returns : void
move
move(index: number, step: number)
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:45
Parameters :
Name Type Optional
index number No
step number No
Returns : void
remove
remove(index: number)
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:49
Parameters :
Name Type Optional
index number No
Returns : void
set
set(index: number, controlModel: DynamicFormControlModel)
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:33
Parameters :
Name Type Optional
index number No
controlModel DynamicFormControlModel No
Returns : void
size
size()
Defined in projects/ng-dynamic-forms/core/src/lib/model/form-group/dynamic-form-group.model.ts:53
Returns : number
toJSON
toJSON()
Inherited from DynamicFormControlModel
Defined in DynamicFormControlModel:80
Returns : any 
import { DynamicFormControlModel, DynamicFormControlModelConfig } from "../dynamic-form-control.model";
import { DynamicFormModel } from "../dynamic-form.model";
import { DynamicFormControlLayout } from "../misc/dynamic-form-control-layout.model";
import { serializable } from "../../decorator/serializable.decorator";

export const DYNAMIC_FORM_CONTROL_TYPE_GROUP = "GROUP";

export interface DynamicFormGroupModelConfig extends DynamicFormControlModelConfig {

    group?: DynamicFormModel;
    legend?: string;
}

export class DynamicFormGroupModel extends DynamicFormControlModel {

    @serializable() group: DynamicFormModel = [];
    @serializable() legend: string | null;

    @serializable() readonly type: string = DYNAMIC_FORM_CONTROL_TYPE_GROUP;

    constructor(config: DynamicFormGroupModelConfig, layout?: DynamicFormControlLayout) {

        super(config, layout);

        this.group = Array.isArray(config.group) ? config.group : [];
        this.legend = config.legend || null;
    }

    get(index: number): DynamicFormControlModel {
        return this.group[index];
    }

    set(index: number, controlModel: DynamicFormControlModel,): void {
        this.group[index] = controlModel;
    }

    add(controlModel: DynamicFormControlModel): void {
        this.group.push(controlModel);
    }

    insert(index: number, controlModel: DynamicFormControlModel): void {
        this.group.splice(index, 0, controlModel);
    }

    move(index: number, step: number): void {
        this.group.splice(index + step, 0, ...this.group.splice(index, 1));
    }

    remove(index: number) {
        this.group.splice(index, 1);
    }

    size(): number {
        return this.group.length;
    }
}

result-matching ""

    No results matching ""