Member Junction
    Preparing search index...

    Class MJTemplateFormComponentExtended

    Hierarchy

    • MJTemplateFormComponent
      • MJTemplateFormComponentExtended

    Implements

    • OnInit
    • OnDestroy
    • AfterViewInit
    Index

    Constructors

    constructor

    Properties

    BottomAreaSize categoryOptions cdr codeEditor collapsiblePanels Config contentTypeOptions CurrentVariantID EditMode elementRef FavoriteInitDone formStateService hasUnsavedChanges isAddingNewContent isHistoryDialogOpen isRunningTemplate IsTagsPanelOpen Navigate newTemplateContent Notification OnVariantChanged Provider record RecordDeleted RecordDeleteFailed RecordReady RecordSaved RecordSaveFailed searchFilter sections selectedContentIndex showCreateDialog showDeleteDialog showEmptyFields showParamDialog supportedLanguages TagCount templateContents templateContentsExpanded templateEditorConfig templateInfoExpanded templateTestError templateTestResult toolbarConfig TopAreaHeight TopAreaSize ValidationFailed Variants ɵdir ɵfac

    Accessors

    AllOrganicKeyRelatedEntities currentTemplateContent EntityInfo formContext hasMultipleContents HasOrganicKeys HasRelatedEntities IsFavorite OrganicKeys PendingRecords ProviderToUse RunQueryToUse RunReportToUse RunViewToUse UserCanCreate UserCanDelete UserCanEdit UserCanRead

    Methods

    addNewTemplateContent BuildOrganicKeyViewParams BuildOrganicKeyViewParamsByNames BuildRelationshipViewParams BuildRelationshipViewParamsByEntityName CancelEdit cancelNewTemplateContent CheckUserPermission collapseAllSections createDefaultTemplateContent deleteTemplateContent EndEditMode expandAllSections FormatField FormatValue getContentTypeDisplayText getContentTypeOptionsForContent getDefaultFormWidthMode getEditorLanguage getEntityName GetEntityRelationshipByRelatedEntityName getExpandedCount getFormWidthMode GetListsCanAddTo GetRecordDependencies GetRelatedEntityTabDisplayName getSection getSectionDisplayOrder getSectionOrder GetSectionPanelHeight GetSectionRowCount getTotalSectionCount getVisibleSectionCount GridEditMode handleHistoryDialog HandleTagsPanel hasCustomSectionOrder initSections InternalSaveRecord IsSectionExpanded loadCategories loadContentTypes loadTemplateContents MakeFavorite NewRecordValues NewRecordValuesByEntityRelationship ngAfterViewInit ngOnDestroy ngOnInit onCategoryChange onContentChange onContentTypeChange OnDeleteRequested OnFavoriteToggled onFilterChange OnFormNavigate OnHistoryRequested OnListManagementRequested onParamDialogClose onSharedTemplateContentChange onSharedTemplateRun onTemplateTextChange PendingRecordsDirty PopulatePendingRecords RaiseEvent RemoveFavorite resetSectionOrder runTemplate SaveRecord saveTemplateContents selectTemplateContent SetFavoriteStatus setFormWidthMode SetSectionExpanded setSectionOrder SetSectionPanelHeight SetSectionRowCount ShowChanges ShowDependencies splitterLayoutChange StartEditMode toggleFormWidthMode toggleSection Validate ValidatePendingRecords Wait

    Constructors

    Properties

    BottomAreaSize: number

    Size of the bottom area as a percentage (0-100) for angular-split. Used by CodeGen-generated templates with as-split.

    categoryOptions: { text: string; value: string }[] = ...
    cdr: ChangeDetectorRef
    codeEditor: CodeEditorComponent | null = null
    collapsiblePanels: QueryList<MjCollapsiblePanelComponent>
    Config: EntityFormConfig | null

    Per-instance presentation config (toolbar visibility, related-entity sections, collapsibility, width, in-form navigation). Set by the form host (MjEntityFormHostComponent) or any consumer that instantiates the form directly. Read back by MjRecordFormContainerComponent and the collapsible panels through the FormComponent reference, so it takes effect WITHOUT regenerating the CodeGen-produced template. Null means "use the container's own defaults" (the classic full-page tab behavior).

    contentTypeOptions: { text: string; value: string }[] = []
    CurrentVariantID: string | null

    ID of the currently-rendered variant (null when no override is active and the form is the CodeGen /

    default).

    EditMode: boolean
    elementRef: ElementRef<any>
    FavoriteInitDone: boolean
    formStateService: FormStateService
    hasUnsavedChanges: boolean = false
    isAddingNewContent: boolean = false
    isHistoryDialogOpen: boolean
    isRunningTemplate: boolean = false
    IsTagsPanelOpen: boolean
    Navigate: EventEmitter<FormNavigationEvent>

    Emitted when navigation is requested (record link, external link, email, new record, etc.)

    newTemplateContent: MJTemplateContentEntity | null = null
    Notification: EventEmitter<FormNotificationEvent>

    Emitted when a user-facing notification should be shown

    OnVariantChanged: (variantID: string | null) => void

    Hook called when the user picks a different variant from the picker. Default is a no-op; the Explorer-level single-record component replaces this on the form instance to wire FormResolverService.SetSelectedVariant and reload the record. Kept as a method (not an EventEmitter) so the host doesn't need to subscribe — assignment is enough.

    Provider: IMetadataProvider | null

    If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.

    record: MJTemplateEntity
    RecordDeleted: EventEmitter<RecordDeletedEvent>

    Emitted after a record is deleted successfully

    RecordDeleteFailed: EventEmitter<RecordDeleteFailedEvent>

    Emitted when a record delete fails

    RecordReady: EventEmitter<BaseEntity<unknown>>

    Emitted once after ngOnInit completes and the record is fully initialized (favorites loaded, form state initialized). This is the safe point for the container to start loading badge counts and other record-dependent data.

    RecordSaved: EventEmitter<RecordSavedEvent>

    Emitted after a record is saved successfully

    RecordSaveFailed: EventEmitter<RecordSaveFailedEvent>

    Emitted when a record save fails

    searchFilter: string
    sections: BaseFormSectionInfo<any>[]
    selectedContentIndex: number = 0
    showCreateDialog: boolean
    showDeleteDialog: boolean
    showEmptyFields: boolean
    showParamDialog: boolean = false
    supportedLanguages: LanguageDescription[] = languages
    TagCount: number
    templateContents: MJTemplateContentEntity[] = []
    templateContentsExpanded: boolean = true
    templateEditorConfig: TemplateEditorConfig = ...
    templateInfoExpanded: boolean = true
    templateTestError: string | null = null
    templateTestResult: string | null = null
    toolbarConfig: FormToolbarConfig = CUSTOM_LAYOUT_TOOLBAR_CONFIG
    TopAreaHeight: string

    Height of the top area when a splitter layout is used. Referenced by CodeGen-generated templates for entities with "top area" sections.

    TopAreaSize: number

    Size of the top area as a percentage (0-100) for angular-split. Used by CodeGen-generated templates with as-split.

    ValidationFailed: EventEmitter<ValidationFailedEvent>

    Emitted when validation fails before save

    Variants: {
        ID: string;
        Label: string;
        Scope: "User" | "Role" | "Global";
        Status: "Active" | "Pending" | "Inactive";
    }[]

    Variants applicable to the current (entity, user) tuple, supplied by the Explorer-level form resolver. When more than one entry is present, the record-form-container shows a picker that lets the user switch between variants. Empty / single-entry arrays hide the picker.

    The container reads this via its EffectiveVariants accessor — generated form templates do NOT need to bind it explicitly.

    "ɵdir": unknown
    "ɵfac": unknown

    Accessors

    • get EntityInfo(): EntityInfo | undefined

      Returns EntityInfo | undefined

    • get formContext(): FormContext

      Returns FormContext

    • get HasOrganicKeys(): boolean

      Whether the current entity has any active organic keys with related entities configured.

      Returns boolean

    • get HasRelatedEntities(): boolean

      Returns boolean

    • get IsFavorite(): boolean

      Returns boolean

    • get OrganicKeys(): EntityOrganicKeyInfo[]

      Returns all active organic keys for the current entity, or an empty array if none.

      Returns EntityOrganicKeyInfo[]

    • get PendingRecords(): PendingRecordItem[]

      Returns PendingRecordItem[]

    • get ProviderToUse(): IMetadataProvider

      Returns either the default Metadata provider or the one specified in the Provider property, if it was specified

      Returns IMetadataProvider

    • get RunQueryToUse(): IRunQueryProvider

      Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified

      Returns IRunQueryProvider

    • get RunReportToUse(): IRunReportProvider

      Returns either the default RunReport provider or the one specified in the Provider property, if it was specified

      Returns IRunReportProvider

    • get RunViewToUse(): IRunViewProvider

      Returns either the default RunView provider or the one specified in the Provider property, if it was specified

      Returns IRunViewProvider

    • get UserCanCreate(): boolean

      Returns boolean

    • get UserCanDelete(): boolean

      Returns boolean

    • get UserCanEdit(): boolean

      Returns boolean

    • get UserCanRead(): boolean

      Returns boolean

    Methods

    • Convenience method to build organic key view params by organic key name and related entity name.

      Parameters

      • organicKeyName: string
      • relatedEntityName: string

      Returns RunViewParams

    • Parameters

      • relatedEntityName: string
      • OptionalrelatedEntityJoinField: string

      Returns RunViewParams

    • Returns void

    • Parameters

      Returns boolean

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • entityFieldInfo: EntityFieldInfo
      • value: any
      • Optionaldecimals: number
      • Optionalcurrency: string

      Returns string

    • Parameters

      • fieldName: string
      • Optionaldecimals: number
      • Optionalcurrency: string

      Returns string

    • Returns string

    • Parameters

      • relatedEntityName: string
      • OptionalrelatedEntityJoinField: string

      Returns EntityRelationshipInfo | undefined

    • Returns number

    • Returns "centered" | "full-width"

    • Returns Promise<MJListEntity[]>

    • Returns Promise<RecordDependency[]>

    • Parameters

      • relatedEntityName: string

      Returns string

    • Parameters

      • sectionKey: string

      Returns BaseFormSectionInfo<any> | undefined

    • Parameters

      • sectionKey: string

      Returns number

    • Returns string[]

    • Parameters

      • sectionKey: string

      Returns number | undefined

    • Parameters

      • sectionKey: string

      Returns number | undefined

    • Returns number

    • Returns number

    • Returns "None" | "Save" | "Queue"

    • Returns void

    • Returns void

    • Returns boolean

    • Parameters

      • sections: (
            | BaseFormSectionInfo<any>
            | {
                isExpanded: boolean;
                metadata?: unknown;
                rowCount?: number;
                sectionKey: string;
                sectionName: string;
            }
        )[]

      Returns void

    • Returns Promise<boolean>

    • Parameters

      • sectionKey: string
      • OptionaldefaultExpanded: boolean

      Returns boolean

    • Returns Promise<void>

    • Parameters

      • relatedEntityName: string

      Returns Record<string, unknown>

    • Parameters

      Returns Record<string, unknown>

    • Handles delete requests from the form container. Emits RecordDeleted on success, RecordDeleteFailed on failure. Generated form templates bind this as: (DeleteRequested)="OnDeleteRequested()"

      Returns Promise<void>

    • Handles favorite toggle from the form container. Generated form templates bind this as: (FavoriteToggled)="OnFavoriteToggled()"

      Returns Promise<void>

    • Parameters

      • searchTerm: string

      Returns void

    • Handles navigation events from the form container and related entity grids. Relays the event upward via the Navigate

      Parameters

      Returns void

      for the host application to handle. Generated form templates bind this as: (Navigate)="OnFormNavigate($event)"

    • Handles history view requests from the form container. Generated form templates bind this as: (HistoryRequested)="OnHistoryRequested()"

      Returns void

    • Handles list management requests from the form container. Generated form templates bind this as: (ListManagementRequested)="OnListManagementRequested()"

      Returns void

    • Returns boolean

    • Returns void

    • Returns Promise<void>

    • Returns void

    • Parameters

      • isFavorite: boolean

      Returns Promise<void>

    • Parameters

      • widthMode: "centered" | "full-width"

      Returns void

    • Parameters

      • sectionKey: string
      • isExpanded: boolean

      Returns void

    • Parameters

      • sectionOrder: string[]

      Returns void

    • Parameters

      • sectionKey: string
      • height: number

      Returns void

    • Parameters

      • sectionKey: string
      • rowCount: number

      Returns void

    • Returns void

    • Returns Promise<void>

    • Called when the splitter layout changes (for entities with "top area" sections). No-op in the generic version; override in host application if splitter resizing is needed.

      Returns void

    • Returns void

    • Returns void

    • Parameters

      • sectionKey: string

      Returns void

    • Returns ValidationResult

    • Returns ValidationResult[]

    • Parameters

      • duration: number

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    addNewTemplateContentBuildOrganicKeyViewParamsBuildOrganicKeyViewParamsByNamesBuildRelationshipViewParamsBuildRelationshipViewParamsByEntityNameCancelEditcancelNewTemplateContentCheckUserPermissioncollapseAllSectionscreateDefaultTemplateContentdeleteTemplateContentEndEditModeexpandAllSectionsFormatFieldFormatValuegetContentTypeDisplayTextgetContentTypeOptionsForContentgetDefaultFormWidthModegetEditorLanguagegetEntityNameGetEntityRelationshipByRelatedEntityNamegetExpandedCountgetFormWidthModeGetListsCanAddToGetRecordDependenciesGetRelatedEntityTabDisplayNamegetSectiongetSectionDisplayOrdergetSectionOrderGetSectionPanelHeightGetSectionRowCountgetTotalSectionCountgetVisibleSectionCountGridEditModehandleHistoryDialogHandleTagsPanelhasCustomSectionOrderinitSectionsInternalSaveRecordIsSectionExpandedloadCategoriesloadContentTypesloadTemplateContentsMakeFavoriteNewRecordValuesNewRecordValuesByEntityRelationshipngAfterViewInitngOnDestroyngOnInitonCategoryChangeonContentChangeonContentTypeChangeOnDeleteRequestedOnFavoriteToggledonFilterChangeOnFormNavigateOnHistoryRequestedOnListManagementRequestedonParamDialogCloseonSharedTemplateContentChangeonSharedTemplateRunonTemplateTextChangePendingRecordsDirtyPopulatePendingRecordsRaiseEventRemoveFavoriteresetSectionOrderrunTemplateSaveRecordsaveTemplateContentsselectTemplateContentSetFavoriteStatussetFormWidthModeSetSectionExpandedsetSectionOrderSetSectionPanelHeightSetSectionRowCountShowChangesShowDependenciessplitterLayoutChangeStartEditModetoggleFormWidthModetoggleSectionValidateValidatePendingRecordsWait