CatalogWidgetStore

Index

Constructors

• constructor

Properties

• selectedCatalogId
• tableSeparatorPosition

Accessors

• settingsTabId

Methods

• applyLayoutSettings
• bindPendingCatalogId
• clearPendingRestore
• getCatalogAssociation
• getPendingDisplayConfig
• setCatalogAssociation
• setPendingDisplayConfig
• setSelectedCatalogId
• setSettingsTabId
• setTableSeparatorPosition
• takePendingDisplayConfig
• toLayoutSettings

Constructors

constructor

• CatalogWidgetStore(selectedCatalogId?: number): CatalogWidgetStore

• Parameters

  • selectedCatalogId: number = 1

  Returns CatalogWidgetStore

Properties

selectedCatalogId

selectedCatalogId: number = 1

tableSeparatorPosition

tableSeparatorPosition: string = PreferenceStore.Instance.catalogTableSeparatorPosition

Accessors

settingsTabId

• get settingsTabId(): CatalogSettingsTabs

• Returns CatalogSettingsTabs

Methods

applyLayoutSettings

• applyLayoutSettings(settings: CatalogWidgetLayoutSettings | null | undefined): void

• Parameters

  • settings: CatalogWidgetLayoutSettings | null | undefined

  Returns void

bindPendingCatalogId

• bindPendingCatalogId(catalogFileId: number): void

• Bind a pending restore while carrying its widget-scoped settings section to the resolved ID.

  ---

  Parameters

  • catalogFileId: number

  Returns void

clearPendingRestore

• clearPendingRestore(): void

• Discard restore state that could not be matched to a catalog in the current session.

  ---

  Returns void

publicgetCatalogAssociation

• getCatalogAssociation(): WorkspaceCatalogAssociation | undefined

• Returns WorkspaceCatalogAssociation | undefined

publicgetPendingDisplayConfig

• getPendingDisplayConfig(): WorkspaceCatalogConfig | undefined

• Read restored display settings without consuming them, so that they can be written back out.

  ---

  Returns WorkspaceCatalogConfig | undefined

setCatalogAssociation

• setCatalogAssociation(association: WorkspaceCatalogAssociation | undefined): void

• Parameters

  • association: WorkspaceCatalogAssociation | undefined

  Returns void

publicsetPendingDisplayConfig

• setPendingDisplayConfig(config: WorkspaceCatalogConfig): void

• Parameters

  • config: WorkspaceCatalogConfig

  Returns void

setSelectedCatalogId

• setSelectedCatalogId(catalogFileId: number): void

• Parameters

  • catalogFileId: number

  Returns void

setSettingsTabId

• setSettingsTabId(tabId: CatalogSettingsTabs): void

• Parameters

  • tabId: CatalogSettingsTabs

  Returns void

setTableSeparatorPosition

• setTableSeparatorPosition(position: string): void

• Parameters

  • position: string

  Returns void

publictakePendingDisplayConfig

• takePendingDisplayConfig(): WorkspaceCatalogConfig | undefined

• Return restored display settings exactly once, when this widget selects a real catalog.

  ---

  Returns WorkspaceCatalogConfig | undefined

publictoLayoutSettings

• toLayoutSettings(): CatalogWidgetLayoutSettings

• Returns CatalogWidgetLayoutSettings