src/app/features/template-export/template-export-file-datatype/edit-template-export-file.component.ts

Description

An edit component that allows to manage template files stored in the PDF Generator API.

Extends

CustomFormControlDirective<string>

Implements

EditComponent

Example

Metadata

Relationships

Index

Properties
Methods
Inputs
Outputs

Inputs

entity
Type : Entity
formFieldConfig
Type : FormFieldConfig
aria-describedby
Type : string
disabled
Type : boolean
ngControl
Type : any
Default value : inject(NgControl, { optional: true, self: true })
placeholder
Type : string
required
Type : boolean
value
Type : T

Outputs

valueChange
Type : EventEmitter

Methods

blur
blur()
Returns : void
focus
focus()
Returns : void
onContainerClick
onContainerClick(event: MouseEvent)
Parameters :
Name Type Optional
event MouseEvent No
Returns : void
registerOnChange
registerOnChange(fn: any)
Parameters :
Name Type Optional
fn any No
Returns : void
registerOnTouched
registerOnTouched(fn: any)
Parameters :
Name Type Optional
fn any No
Returns : void
setDescribedByIds
setDescribedByIds(ids: string[])
Parameters :
Name Type Optional
ids string[] No
Returns : void
setDisabledState
setDisabledState(isDisabled: boolean)
Parameters :
Name Type Optional
isDisabled boolean No
Returns : void
writeValue
writeValue(value: T, notifyFormControl: unknown)

Implementation for Angular ControlValueAccessor interface that links the form control value to the component value

Parameters :
Name Type Optional Default value Description
value T No

The new value to set

notifyFormControl unknown No false

Whether to notify the FormControl of this change (for internal updates)

Returns : void

Properties

exportServerEnabled
Type : unknown
Default value : resource({ loader: () => this.templateExportService.isExportServerEnabled().catch(() => false), })
controlType
Type : string
Default value : "custom-control"
elementRef
Type : unknown
Default value : inject<ElementRef<HTMLElement>>(ElementRef)
Readonly enabled
Type : Signal<boolean>
Default value : computed(() => !this._disabled())

Whether the control is currently enabled, as a signal (tracks disabled).

errorStateMatcher
Type : unknown
Default value : inject(ErrorStateMatcher)
id
Type : unknown
Default value : `custom-form-control-${CustomFormControlDirective.nextId++}`
Static nextId
Type : number
Default value : 0
onChange
Type : unknown
Default value : () => {...}
onTouched
Type : unknown
Default value : () => {...}
parentForm
Type : unknown
Default value : inject(NgForm, { optional: true })
parentFormGroup
Type : unknown
Default value : inject(FormGroupDirective, { optional: true })
stateChanges
Type : unknown
Default value : new Subject<void>()
Readonly valueSignal
Type : Signal<T>
Default value : computed(() => this._value())

The current value of the control as a signal. Authoritative in both modes: it reflects the bound FormControl (synced in ngDoCheck) as well as [(value)] / writeValue updates.

import { CustomFormControlDirective } from "#src/app/core/common-components/basic-autocomplete/custom-form-control.directive";
import { FormFieldConfig } from "#src/app/core/common-components/entity-form/FormConfig";
import { EditComponent } from "#src/app/core/entity/entity-field-edit/dynamic-edit/edit-component.interface";
import { Entity } from "#src/app/core/entity/model/entity";
import { TemplateExportApiService } from "#src/app/features/template-export/template-export-api/template-export-api.service";
import {
  Component,
  ChangeDetectionStrategy,
  inject,
  input,
  resource,
} from "@angular/core";
import { ReactiveFormsModule } from "@angular/forms";
import { MatFormFieldControl } from "@angular/material/form-field";
import { FeatureDisabledInfoComponent } from "../../../core/common-components/feature-disabled-info/feature-disabled-info.component";
import { DynamicComponent } from "../../../core/config/dynamic-components/dynamic-component.decorator";
import { EditFileComponent } from "../../file/edit-file/edit-file.component";
import { FileService } from "../../file/file.service";
import { TemplateExportService } from "../template-export-service/template-export.service";

/**
 * An edit component that allows to manage template files stored in the PDF Generator API.
 */
@DynamicComponent("EditTemplateExportFile")
@Component({
  changeDetection: ChangeDetectionStrategy.OnPush,
  selector: "app-template-export-file",
  templateUrl: "./edit-template-export-file.component.html",
  styleUrls: [
    "../../file/edit-file/edit-file.component.scss",
    "./edit-template-export-file.component.scss",
  ],
  imports: [
    EditFileComponent,
    ReactiveFormsModule,
    FeatureDisabledInfoComponent,
  ],
  providers: [
    { provide: FileService, useClass: TemplateExportApiService },
    {
      provide: MatFormFieldControl,
      useExisting: EditTemplateExportFileComponent,
    },
  ],
})
export class EditTemplateExportFileComponent
  extends CustomFormControlDirective<string>
  implements EditComponent
{
  private readonly templateExportService = inject(TemplateExportService);

  entity = input<Entity>();
  formFieldConfig = input<FormFieldConfig>();

  exportServerEnabled = resource({
    loader: () =>
      this.templateExportService.isExportServerEnabled().catch(() => false),
  });
}
@if (exportServerEnabled.value() !== true) {
  <app-feature-disabled-info
    [featureEnabled]="exportServerEnabled.value()"
    [compactView]="true"
  ></app-feature-disabled-info>
}

<app-edit-file
  [formControl]="formControl"
  [entity]="entity()"
  [formFieldConfig]="formFieldConfig()"
  [style.display]="exportServerEnabled.value() ? 'initial' : 'none'"
></app-edit-file>

../../file/edit-file/edit-file.component.scss

/* let click events on disabled input be handled by parent element (because browsers completely eat them up otherwise)
 https://stackoverflow.com/a/32925830/1473411  */
input[disabled] {
  pointer-events: none;
}

.clickable,
.clickable * {
  cursor: pointer;
}

.filename {
  font-style: italic;
}

./edit-template-export-file.component.scss

Legend
Html element
Component
Html element with directive

results matching ""

    No results matching ""