Class FormStateService

Service for managing form state persistence per entity. State is stored in the User Settings entity and shared reactively across all form instances for the same entity.

Constructors

constructor

Properties

loadedEntities loadingPromises metadata saveTimeouts stateCache

Methods

collapseAllSections debouncedSave expandAllSections getCurrentState getExpandedCount getOrCreateSubject getSectionState getSectionWidthMode getSettingKey getShowEmptyFields getState$ initializeState isSectionExpanded loadState resetAllPanelWidths resetToDefaults saveState setSectionExpanded setSectionWidthMode setShowEmptyFields toggleSection toggleSectionWidthMode updateSectionState

Constructors

constructor

Properties

Private loadedEntities

loadedEntities: Set<string> = ...

Track which entities have been loaded from DB

Private loadingPromises

loadingPromises: Map<string, Promise<void>> = ...

Track loading promises to prevent duplicate loads

Private metadata

metadata: Metadata = ...

Private saveTimeouts

saveTimeouts: Map<string, Timeout> = ...

Debounce timeouts per entity name

Private stateCache

stateCache: Map<string, BehaviorSubject<FormState>> = ...

Cache of BehaviorSubjects per entity name

Methods

collapseAllSections

  • collapseAllSections(entityName, sectionKeys): void

  • Collapse all sections for an entity.

    Parameters

    • entityName: string

      The entity name

    • sectionKeys: string[]

      Array of all section keys to collapse

    Returns void

Private debouncedSave

  • debouncedSave(entityName): void

  • Debounced save to avoid too many writes.

    Parameters

    • entityName: string

    Returns void

expandAllSections

  • expandAllSections(entityName, sectionKeys): void

  • Expand all sections for an entity.

    Parameters

    • entityName: string

      The entity name

    • sectionKeys: string[]

      Array of all section keys to expand

    Returns void

getCurrentState

getExpandedCount

  • getExpandedCount(entityName, sectionKeys): number

  • Get the count of expanded sections.

    Parameters

    • entityName: string

      The entity name

    • sectionKeys: string[]

      Array of section keys to check

    Returns number

    Number of expanded sections

Private getOrCreateSubject

getSectionState

  • getSectionState(entityName, sectionKey): FormSectionState

  • Get section state, returning defaults if section doesn't exist yet.

    Parameters

    • entityName: string

      The entity name

    • sectionKey: string

      The section key

    Returns FormSectionState

    Section state with defaults applied

getSectionWidthMode

  • getSectionWidthMode(entityName, sectionKey): "normal" | "full-width"

  • Get section width mode.

    Parameters

    • entityName: string

      The entity name

    • sectionKey: string

      The section key

    Returns "normal" | "full-width"

    Width mode ('normal' or 'full-width')

Private getSettingKey

  • getSettingKey(entityName): string

  • Generate the User Settings key for an entity.

    Parameters

    • entityName: string

    Returns string

getShowEmptyFields

  • getShowEmptyFields(entityName): boolean

  • Get showEmptyFields preference for an entity.

    Parameters

    • entityName: string

      The entity name

    Returns boolean

    Whether to show empty fields

getState$

  • getState$(entityName): Observable<FormState>

  • Get the observable state for an entity. Automatically loads from User Settings on first access.

    Parameters

    • entityName: string

      The entity name

    Returns Observable<FormState>

    Observable of the form state

initializeState

  • initializeState(entityName): Promise<FormState>

  • Initialize state for an entity by loading from User Settings. Call this when a form component initializes.

    Parameters

    • entityName: string

      The entity name

    Returns Promise<FormState>

isSectionExpanded

  • isSectionExpanded(entityName, sectionKey): boolean

  • Check if a section is expanded.

    Parameters

    • entityName: string

      The entity name

    • sectionKey: string

      The section key

    Returns boolean

    True if expanded

Private loadState

  • loadState(entityName): Promise<void>

  • Load state from User Settings using UserInfoEngine for cached access.

    Parameters

    • entityName: string

    Returns Promise<void>

resetAllPanelWidths

  • resetAllPanelWidths(entityName): void

  • Reset all panel widths to normal for an entity.

    Parameters

    • entityName: string

      The entity name

    Returns void

resetToDefaults

  • resetToDefaults(entityName): void

  • Reset state to defaults for an entity.

    Parameters

    • entityName: string

      The entity name

    Returns void

Private saveState

  • saveState(entityName): Promise<void>

  • Save state to User Settings using UserInfoEngine for cached lookup.

    Parameters

    • entityName: string

    Returns Promise<void>

setSectionExpanded

  • setSectionExpanded(entityName, sectionKey, isExpanded): void

  • Set section expanded state.

    Parameters

    • entityName: string

      The entity name

    • sectionKey: string

      The section key

    • isExpanded: boolean

      Whether the section is expanded

    Returns void

setSectionWidthMode

  • setSectionWidthMode(entityName, sectionKey, widthMode): void

  • Set section width mode.

    Parameters

    • entityName: string

      The entity name

    • sectionKey: string

      The section key

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

      The width mode

    Returns void

setShowEmptyFields

  • setShowEmptyFields(entityName, show): void

  • Set showEmptyFields preference for an entity.

    Parameters

    • entityName: string

      The entity name

    • show: boolean

      Whether to show empty fields

    Returns void

toggleSection

  • toggleSection(entityName, sectionKey): void

  • Toggle section expanded state.

    Parameters

    • entityName: string

      The entity name

    • sectionKey: string

      The section key

    Returns void

toggleSectionWidthMode

  • toggleSectionWidthMode(entityName, sectionKey): void

  • Toggle section width mode between normal and full-width.

    Parameters

    • entityName: string

      The entity name

    • sectionKey: string

      The section key

    Returns void

Private updateSectionState

Settings

Member Visibility

Theme

On This Page

constructorloadedEntitiesloadingPromisesmetadatasaveTimeoutsstateCachecollapseAllSectionsdebouncedSaveexpandAllSectionsgetCurrentStategetExpandedCountgetOrCreateSubjectgetSectionStategetSectionWidthModegetSettingKeygetShowEmptyFieldsgetState$initializeStateisSectionExpandedloadStateresetAllPanelWidthsresetToDefaultssaveStatesetSectionExpandedsetSectionWidthModesetShowEmptyFieldstoggleSectiontoggleSectionWidthModeupdateSectionState