Member Junction
    Preparing search index...

    Class MJListFormComponentExtended

    World-class List form component that provides a rich exploration experience for managing lists in the MemberJunction system.

    Features:

    • Overview with visual stats and entity context
    • Items grid with inline record navigation
    • Sharing management (coming soon)
    • Activity history
    • Settings and configuration

    Hierarchy

    • MJListFormComponent
      • MJListFormComponentExtended

    Implements

    • OnInit
    • OnDestroy
    Index

    Constructors

    constructor

    Properties

    activeSection addableRecords addDialogLoading addDialogSaving addFromViewProgress addFromViewTotal addProgress addRecordsSearchFilter addTotal BottomAreaSize categories cdr collapsiblePanels Config CurrentVariantID editingDescription editingName EditMode elementRef entityInfo existingListDetailIds explorerError FavoriteInitDone fetchingRecordsToSave formStateService isEditingDescription isEditingName isHistoryDialogOpen isLoadingItems isLoadingStats isSelectAllChecked IsTagsPanelOpen itemSearchTerm itemsPage itemsPageSize listItems Navigate navItems Notification OnVariantChanged Provider record RecordDeleted RecordDeleteFailed RecordReady RecordSaved RecordSaveFailed searchFilter sections selectedItems shareDialogConfig showAddFromViewDialog showAddFromViewLoader showAddRecordsDialog showAuditLogDialog showCreateDialog showDeleteDialog showEmptyFields showInvitationsDialog showShareDialog stats TagCount TopAreaHeight TopAreaSize userViews userViewsToAdd ValidationFailed Variants ɵdir ɵfac

    Accessors

    AllOrganicKeyRelatedEntities categoryName entityDisplayName entityIcon EntityInfo filteredItems formattedItemCount formattedLastUpdated formContext HasOrganicKeys HasRelatedEntities IsFavorite OrganicKeys PendingRecords ProviderToUse RunQueryToUse RunReportToUse RunViewToUse selectedAddableRecords totalPages UserCanCreate UserCanDelete UserCanEdit UserCanRead

    Methods

    BuildOrganicKeyViewParams BuildOrganicKeyViewParamsByNames BuildRelationshipViewParams BuildRelationshipViewParamsByEntityName cancelDescriptionEdit CancelEdit cancelNameEdit CheckUserPermission closeAddFromViewDialog closeAddRecordsDialog closeAuditLogDialog closeInvitationsDialog collapseAllSections confirmAddFromView confirmAddRecords deselectAllAddable EndEditMode expandAllSections FormatField FormatValue getDefaultFormWidthMode getEntityName GetEntityRelationshipByRelatedEntityName getExpandedCount getFormWidthMode GetListsCanAddTo getOwnerName GetRecordDependencies GetRelatedEntityTabDisplayName getSection getSectionDisplayOrder getSectionOrder GetSectionPanelHeight GetSectionRowCount getTotalSectionCount getVisibleSectionCount goToPage GridEditMode handleHistoryDialog HandleTagsPanel hasCustomSectionOrder initSections InternalSaveRecord isCurrentUserOwner IsSectionExpanded isViewSelected MakeFavorite NewRecordValues NewRecordValuesByEntityRelationship ngAfterViewInit ngOnDestroy ngOnInit onAddRecordsSearchChange onCategoryChange OnDeleteRequested OnFavoriteToggled onFilterChange OnFormNavigate OnHistoryRequested OnListManagementRequested onShareDialogCancel onShareDialogComplete openAddFromViewDialog openAddRecordsDialog openAuditLogDialog openInvitationsDialog openRecord openShareDialog PendingRecordsDirty PopulatePendingRecords RaiseEvent refreshItems RemoveFavorite removeSelectedItems resetSectionOrder saveDescriptionEdit saveNameEdit SaveRecord selectAllAddable setActiveSection SetFavoriteStatus setFormWidthMode SetSectionExpanded setSectionOrder SetSectionPanelHeight SetSectionRowCount ShowChanges ShowDependencies splitterLayoutChange startEditingDescription startEditingName StartEditMode toggleFormWidthMode toggleItemSelection toggleRecordSelection toggleSection toggleSelectAll toggleViewSelection Validate ValidatePendingRecords Wait

    Constructors

    Properties

    activeSection: ListSection = 'overview'
    addableRecords: AddableRecord[] = []
    addDialogLoading: boolean = false
    addDialogSaving: boolean = false
    addFromViewProgress: number = 0
    addFromViewTotal: number = 0
    addProgress: number = 0
    addRecordsSearchFilter: string = ''
    addTotal: number = 0
    BottomAreaSize: number

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

    categories: MJListCategoryEntity[] = []
    cdr: ChangeDetectorRef
    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).

    CurrentVariantID: string | null

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

    default).

    editingDescription: string = ''
    editingName: string = ''
    EditMode: boolean
    elementRef: ElementRef<any>
    entityInfo: EntityInfo | null = null
    existingListDetailIds: Set<string> = ...
    explorerError: string | null = null
    FavoriteInitDone: boolean
    fetchingRecordsToSave: boolean = false
    formStateService: FormStateService
    isEditingDescription: boolean = false
    isEditingName: boolean = false
    isHistoryDialogOpen: boolean
    isLoadingItems: boolean = false
    isLoadingStats: boolean = false
    isSelectAllChecked: boolean = false
    IsTagsPanelOpen: boolean
    itemSearchTerm: string = ''
    itemsPage: number = 0
    itemsPageSize: 100
    listItems: ListItemViewModel[] = []
    Navigate: EventEmitter<FormNavigationEvent>

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

    navItems: (
        | {
            badge?: undefined;
            disabled?: undefined;
            icon: string;
            id: ListSection;
            label: string;
        }
        | {
            badge: number;
            disabled?: undefined;
            icon: string;
            id: ListSection;
            label: string;
        }
        | {
            badge: number;
            disabled: boolean;
            icon: string;
            id: ListSection;
            label: string;
        }
    )[] = ...
    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: MJListEntity
    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>[]
    selectedItems: Set<string> = ...
    shareDialogConfig: ListShareDialogConfig | null = null
    showAddFromViewDialog: boolean = false
    showAddFromViewLoader: boolean = false
    showAddRecordsDialog: boolean = false
    showAuditLogDialog: boolean = false
    showCreateDialog: boolean
    showDeleteDialog: boolean
    showEmptyFields: boolean
    showInvitationsDialog: boolean = false
    showShareDialog: boolean = false
    stats: ListStats = ...
    TagCount: number
    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.

    userViews: MJUserViewEntityExtended[] | null = null
    userViewsToAdd: MJUserViewEntityExtended[] = []
    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

    • Component-level default width mode, used when the user has NOT explicitly chosen a width for this entity yet (first visit, nothing persisted in User Settings). Subclasses can override this — for example, custom forms with full-bleed layouts should return 'full-width' here and the container will respect it on first open.

      Once the user toggles the width via the toolbar, their choice persists via setFormWidthMode() and takes priority over this default on subsequent opens.

      Returns "centered" | "full-width"

    • 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>

    • A callback method that is invoked immediately after Angular has completed initialization of a component's view. It is invoked only once when the view is instantiated.

      Returns void

    • 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

      • StopEditModeAfterSave: boolean

      Returns Promise<boolean>

    • 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
    activeSectionaddableRecordsaddDialogLoadingaddDialogSavingaddFromViewProgressaddFromViewTotaladdProgressaddRecordsSearchFilteraddTotalBottomAreaSizecategoriescdrcollapsiblePanelsConfigCurrentVariantIDeditingDescriptioneditingNameEditModeelementRefentityInfoexistingListDetailIdsexplorerErrorFavoriteInitDonefetchingRecordsToSaveformStateServiceisEditingDescriptionisEditingNameisHistoryDialogOpenisLoadingItemsisLoadingStatsisSelectAllCheckedIsTagsPanelOpenitemSearchTermitemsPageitemsPageSizelistItemsNavigatenavItemsNotificationOnVariantChangedProviderrecordRecordDeletedRecordDeleteFailedRecordReadyRecordSavedRecordSaveFailedsearchFiltersectionsselectedItemsshareDialogConfigshowAddFromViewDialogshowAddFromViewLoadershowAddRecordsDialogshowAuditLogDialogshowCreateDialogshowDeleteDialogshowEmptyFieldsshowInvitationsDialogshowShareDialogstatsTagCountTopAreaHeightTopAreaSizeuserViewsuserViewsToAddValidationFailedVariantsɵdirɵfac
    Accessors
    Methods
    BuildOrganicKeyViewParamsBuildOrganicKeyViewParamsByNamesBuildRelationshipViewParamsBuildRelationshipViewParamsByEntityNamecancelDescriptionEditCancelEditcancelNameEditCheckUserPermissioncloseAddFromViewDialogcloseAddRecordsDialogcloseAuditLogDialogcloseInvitationsDialogcollapseAllSectionsconfirmAddFromViewconfirmAddRecordsdeselectAllAddableEndEditModeexpandAllSectionsFormatFieldFormatValuegetDefaultFormWidthModegetEntityNameGetEntityRelationshipByRelatedEntityNamegetExpandedCountgetFormWidthModeGetListsCanAddTogetOwnerNameGetRecordDependenciesGetRelatedEntityTabDisplayNamegetSectiongetSectionDisplayOrdergetSectionOrderGetSectionPanelHeightGetSectionRowCountgetTotalSectionCountgetVisibleSectionCountgoToPageGridEditModehandleHistoryDialogHandleTagsPanelhasCustomSectionOrderinitSectionsInternalSaveRecordisCurrentUserOwnerIsSectionExpandedisViewSelectedMakeFavoriteNewRecordValuesNewRecordValuesByEntityRelationshipngAfterViewInitngOnDestroyngOnInitonAddRecordsSearchChangeonCategoryChangeOnDeleteRequestedOnFavoriteToggledonFilterChangeOnFormNavigateOnHistoryRequestedOnListManagementRequestedonShareDialogCancelonShareDialogCompleteopenAddFromViewDialogopenAddRecordsDialogopenAuditLogDialogopenInvitationsDialogopenRecordopenShareDialogPendingRecordsDirtyPopulatePendingRecordsRaiseEventrefreshItemsRemoveFavoriteremoveSelectedItemsresetSectionOrdersaveDescriptionEditsaveNameEditSaveRecordselectAllAddablesetActiveSectionSetFavoriteStatussetFormWidthModeSetSectionExpandedsetSectionOrderSetSectionPanelHeightSetSectionRowCountShowChangesShowDependenciessplitterLayoutChangestartEditingDescriptionstartEditingNameStartEditModetoggleFormWidthModetoggleItemSelectiontoggleRecordSelectiontoggleSectiontoggleSelectAlltoggleViewSelectionValidateValidatePendingRecordsWait