Class UmbBlockEntriesContext<BlockManagerContextTokenType, BlockManagerContextType, BlockType, BlockLayoutType, BlockOriginData>`Abstract`

This base provides the necessary for a class to become a context-api controller.

Type Parameters

BlockManagerContextTokenType extends UmbContextToken<BlockManagerContextType, BlockManagerContextType>
BlockManagerContextType extends UmbBlockManagerContext<BlockType, BlockLayoutType, BlockOriginData>
BlockType extends UmbBlockTypeBaseModel
BlockLayoutType extends UmbBlockLayoutBaseModel
BlockOriginData extends UmbBlockWorkspaceOriginData

Hierarchy (View Summary)

UmbContextBase
- UmbBlockEntriesContext
  - UmbBlockRteEntriesContext

Constructors

constructor

new UmbBlockEntriesContext<
    BlockManagerContextTokenType extends
        UmbContextToken<BlockManagerContextType, BlockManagerContextType>,
    BlockManagerContextType extends
        UmbBlockManagerContext<BlockType, BlockLayoutType, BlockOriginData>,
    BlockType extends UmbBlockTypeBaseModel,
    BlockLayoutType extends UmbBlockLayoutBaseModel,
    BlockOriginData extends UmbBlockWorkspaceOriginData,
>(
    host: UmbControllerHost,
    blockManagerContextToken: BlockManagerContextTokenType,
): UmbBlockEntriesContext<
    BlockManagerContextTokenType,
    BlockManagerContextType,
    BlockType,
    BlockLayoutType,
    BlockOriginData,
>
Type Parameters
- BlockManagerContextTokenType extends UmbContextToken<BlockManagerContextType, BlockManagerContextType>
- BlockManagerContextType extends UmbBlockManagerContext<BlockType, BlockLayoutType, BlockOriginData>
- BlockType extends UmbBlockTypeBaseModel
- BlockLayoutType extends UmbBlockLayoutBaseModel
- BlockOriginData extends UmbBlockWorkspaceOriginData
Parameters
- host: UmbControllerHost
- blockManagerContextToken: BlockManagerContextTokenType
Returns UmbBlockEntriesContext<
    BlockManagerContextTokenType,
    BlockManagerContextType,
    BlockType,
    BlockLayoutType,
    BlockOriginData,
>
Overrides UmbContextBase.constructor
- Defined in src/packages/block/block/context/block-entries.context.ts:41

Properties

`Protected`_catalogueRouteBuilderState

_catalogueRouteBuilderState: UmbBasicState<undefined | UmbModalRouteBuilder> = ...

`Protected` `Optional`_dataPath

_dataPath?: string

_host

_host: UmbControllerHost

`Protected`_layoutEntries

_layoutEntries: UmbArrayState<BlockLayoutType, unknown> = ...

`Protected` `Optional`_manager

_manager?: BlockManagerContextType

`Protected`_retrieveManager

_retrieveManager: Promise<undefined | BlockManagerContextType>

`Protected`_workspacePath

_workspacePath: UmbStringState<undefined> = ...

`Abstract` `Readonly`canCreate

canCreate: Observable<boolean>

`Readonly`catalogueRouteBuilder

catalogueRouteBuilder: Observable<undefined | UmbModalRouteBuilder> = ...

`Readonly`layoutEntries

layoutEntries: Observable<BlockLayoutType[]> = ...

`Readonly`layoutEntriesLength

layoutEntriesLength: Observable<number> = ...

workspacePath

workspacePath: Observable<undefined | string> = ...

Accessors

controllerAlias

get controllerAlias(): UmbControllerAlias
Returns UmbControllerAlias
Inherited from UmbContextBase.controllerAlias
- Defined in src/libs/controller-api/controller.interface.ts:3

Methods

`Protected` `Abstract`_gotBlockManager

_gotBlockManager(): void
Returns void
- Defined in src/packages/block/block/context/block-entries.context.ts:60

`Protected`_insertBlockFromPropertyValue

_insertBlockFromPropertyValue(
    layoutEntry: BlockLayoutType,
    value: UmbBlockValueType,
    originData: BlockOriginData,
): Promise<void>
Parameters
- layoutEntry: BlockLayoutType
- value: UmbBlockValueType
- originData: BlockOriginData
Returns Promise<void>
- Defined in src/packages/block/block/context/block-entries.context.ts:123

`Protected` `Abstract`_insertFromPropertyValue

_insertFromPropertyValue(
values: UmbBlockValueType,
originData: BlockOriginData,
): Promise<BlockOriginData>
Parameters
- values: UmbBlockValueType
- originData: BlockOriginData
Returns Promise<BlockOriginData>
- Defined in src/packages/block/block/context/block-entries.context.ts:118

`Protected`_insertFromPropertyValues

_insertFromPropertyValues(
values: UmbBlockValueType<UmbBlockLayoutBaseModel>[],
originData: BlockOriginData,
): Promise<void>
Parameters
- values: UmbBlockValueType<UmbBlockLayoutBaseModel>[]
- originData: BlockOriginData
Returns Promise<void>
- Defined in src/packages/block/block/context/block-entries.context.ts:110

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void
Inherited from UmbContextBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbContextBase.addUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:6

consumeContext

consumeContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    callback: UmbContextCallback<ResultType>,
): UmbContextConsumerController<BaseType, ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- callback: UmbContextCallback<ResultType>
  Callback method called when context is resolved.
Returns UmbContextConsumerController<BaseType, ResultType>
Reference to the created Context Consumer Controller instance

Description
Setup a subscription for a context. The callback is called when the context is resolved.

Memberof
UmbClassInterface
Inherited from UmbContextBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

`Abstract`create

create(
    contentElementTypeKey: string,
    layoutEntry?: Omit<BlockLayoutType, "contentKey">,
    originData?: BlockOriginData,
): Promise<undefined | UmbBlockDataObjectModel<BlockLayoutType>>
Parameters
- contentElementTypeKey: string
- OptionallayoutEntry: Omit<BlockLayoutType, "contentKey">
- OptionaloriginData: BlockOriginData
Returns Promise<undefined | UmbBlockDataObjectModel<BlockLayoutType>>
- Defined in src/packages/block/block/context/block-entries.context.ts:80

delete

delete(contentKey: string): Promise<void>
Parameters
- contentKey: string
Returns Promise<void>
- Defined in src/packages/block/block/context/block-entries.context.ts:93

destroy

destroy(): void
Returns void
Inherited from UmbContextBase.destroy
- Defined in src/libs/controller-api/controller.interface.ts:6

dispatchEvent

dispatchEvent(event: Event): boolean
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference
Parameters
- event: Event
Returns boolean
Inherited from UmbContextBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getContext

getContext<
    BaseType extends UmbContextMinimal = UmbContextMinimal,
    ResultType extends UmbContextMinimal = BaseType,
>(
    alias: string | UmbContextToken<BaseType, ResultType>,
    options?: UmbClassGetContextOptions,
): Promise<undefined | ResultType>
Type Parameters
- BaseType extends UmbContextMinimal = UmbContextMinimal
- ResultType extends UmbContextMinimal = BaseType
Parameters
- alias: string | UmbContextToken<BaseType, ResultType>
- Optionaloptions: UmbClassGetContextOptions
Returns Promise<undefined | ResultType>
A Promise with the reference to the Context Api Instance

Description
Retrieve a context. Notice this is a one time retrieving of a context, meaning if you expect this to be up to date with reality you should instead use the consumeContext method.

Memberof
UmbClassInterface
Inherited from UmbContextBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getHostElement

getHostElement(): Element
Returns Element
Inherited from UmbContextBase.getHostElement
- Defined in src/libs/controller-api/controller-host.interface.ts:9

getLayoutOf

getLayoutOf(contentKey: string): undefined | BlockLayoutType
Parameters
- contentKey: string
Returns undefined | BlockLayoutType
- Defined in src/packages/block/block/context/block-entries.context.ts:67

getLength

getLength(): number
Returns number
- Defined in src/packages/block/block/context/block-entries.context.ts:37

getManager

getManager(): Promise<BlockManagerContextType>
Returns Promise<BlockManagerContextType>
- Defined in src/packages/block/block/context/block-entries.context.ts:51

`Abstract`getPathForClipboard

getPathForClipboard(index: number): undefined | string
Parameters
- index: number
Returns undefined | string
- Defined in src/packages/block/block/context/block-entries.context.ts:78

`Abstract`getPathForCreateBlock

getPathForCreateBlock(index: number): undefined | string
Parameters
- index: number
Returns undefined | string
- Defined in src/packages/block/block/context/block-entries.context.ts:77

getUmbControllers

getUmbControllers(
filterMethod: (ctrl: UmbController) => boolean,
): UmbController[]
Parameters
- filterMethod: (ctrl: UmbController) => boolean
Returns UmbController[]
Inherited from UmbContextBase.getUmbControllers
- Defined in src/libs/controller-api/controller-host.interface.ts:5

`Abstract`insert

insert(
    layoutEntry: BlockLayoutType,
    content: UmbBlockDataModel,
    settings: undefined | UmbBlockDataModel,
    originData: BlockOriginData,
): Promise<boolean>
Parameters
- layoutEntry: BlockLayoutType
- content: UmbBlockDataModel
- settings: undefined | UmbBlockDataModel
- originData: BlockOriginData
Returns Promise<boolean>
- Defined in src/packages/block/block/context/block-entries.context.ts:86

layoutOf

layoutOf(contentKey: string): Observable<undefined | BlockLayoutType>
Parameters
- contentKey: string
Returns Observable<undefined | BlockLayoutType>
- Defined in src/packages/block/block/context/block-entries.context.ts:64

observe

observe<
    ObservableType extends undefined
    | Observable<T>,
    T,
    SpecificT = ObservableType extends Observable<U>
        ? ObservableType<ObservableType> extends undefined ? undefined | U : U
        : undefined,
    SpecificR = ObservableType extends undefined
        ? undefined
        | UmbObserverController<SpecificT>
        : UmbObserverController<SpecificT>,
>(
    source: ObservableType,
    callback?: ObserverCallback<SpecificT>,
    controllerAlias?: null | UmbControllerAlias,
): SpecificR
Type Parameters
- ObservableType extends undefined | Observable<T>
- T
- SpecificT = ObservableType extends Observable<U>
  ? ObservableType<ObservableType> extends undefined ? undefined | U : U
  : undefined
- SpecificR = ObservableType extends undefined
      ? undefined
      | UmbObserverController<SpecificT>
      : UmbObserverController<SpecificT>
Parameters
- source: ObservableType
  An Observable to observe from.
- Optionalcallback: ObserverCallback<SpecificT>
  Callback method called when data is changed.
- OptionalcontrollerAlias: null | UmbControllerAlias
  Define an explicit controller alias. If not defined then one will be generated based on the callback function. If null is parsed no controller alias will be given.
Returns SpecificR
Reference to the created Observer Controller instance.

Description
Observe an Observable. An Observable is a declared source of data that can be observed. An observables is declared from a UmbState.

Memberof
UmbClassInterface
Inherited from UmbContextBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

provideContext

provideContext<R extends UmbContextMinimal = UmbContextMinimal>(
alias: string | UmbContextToken<R, R>,
instance: R,
): UmbContextProviderController<R>
Type Parameters
- R extends UmbContextMinimal = UmbContextMinimal
Parameters
- alias: string | UmbContextToken<R, R>
- instance: R
  The API instance to be exposed.
Returns UmbContextProviderController<R>
Reference to the created Context Provider Controller instance

Description
Provide a context API for this or child elements.

Memberof
UmbClassInterface
Inherited from UmbContextBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void
Inherited from UmbContextBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

removeUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbContextBase.removeUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:8

removeUmbControllerByAlias

removeUmbControllerByAlias(unique: UmbControllerAlias): void
Parameters
- unique: UmbControllerAlias
Returns void
Inherited from UmbContextBase.removeUmbControllerByAlias
- Defined in src/libs/controller-api/controller-host.interface.ts:7

setDataPath

setDataPath(path: string): void
Parameters
- path: string
Returns void
- Defined in src/packages/block/block/context/block-entries.context.ts:56

setLayouts

setLayouts(layouts: BlockLayoutType[]): void
Parameters
- layouts: BlockLayoutType[]
Returns void
- Defined in src/packages/block/block/context/block-entries.context.ts:70

setOneLayout

setOneLayout(
layoutData: BlockLayoutType,
): UmbArrayState<BlockLayoutType, unknown>
Parameters
- layoutData: BlockLayoutType
Returns UmbArrayState<BlockLayoutType, unknown>
- Defined in src/packages/block/block/context/block-entries.context.ts:73

Class UmbBlockEntriesContext<BlockManagerContextTokenType, BlockManagerContextType, BlockType, BlockLayoutType, BlockOriginData>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbBlockEntriesContext< BlockManagerContextTokenType, BlockManagerContextType, BlockType, BlockLayoutType, BlockOriginData,>

Properties

Protected_catalogueRouteBuilderState

Protected Optional_dataPath

_host

Protected_layoutEntries

Protected Optional_manager

Protected_retrieveManager

Protected_workspacePath

Abstract ReadonlycanCreate

ReadonlycatalogueRouteBuilder

ReadonlylayoutEntries

ReadonlylayoutEntriesLength

workspacePath

Accessors

controllerAlias

Returns UmbControllerAlias

Methods

Protected Abstract_gotBlockManager

Returns void

Protected_insertBlockFromPropertyValue

Parameters

Returns Promise<void>

Protected Abstract_insertFromPropertyValue

Parameters

Returns Promise<BlockOriginData>

Protected_insertFromPropertyValues

Parameters

Returns Promise<void>

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

Abstractcreate

Parameters

Returns Promise<undefined | UmbBlockDataObjectModel<BlockLayoutType>>

delete

Parameters

Returns Promise<void>

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getLayoutOf

Parameters

Returns undefined | BlockLayoutType

getLength

Returns number

getManager

Returns Promise<BlockManagerContextType>

AbstractgetPathForClipboard

Class UmbBlockEntriesContext<BlockManagerContextTokenType, BlockManagerContextType, BlockType, BlockLayoutType, BlockOriginData>`Abstract`

Returns UmbBlockEntriesContext<
BlockManagerContextTokenType,
BlockManagerContextType,
BlockType,
BlockLayoutType,
BlockOriginData,
>

`Protected`_catalogueRouteBuilderState

`Protected` `Optional`_dataPath

`Protected`_layoutEntries

`Protected` `Optional`_manager

`Protected`_retrieveManager

`Protected`_workspacePath

`Abstract` `Readonly`canCreate

`Readonly`catalogueRouteBuilder

`Readonly`layoutEntries

`Readonly`layoutEntriesLength

`Protected` `Abstract`_gotBlockManager

`Protected`_insertBlockFromPropertyValue

`Protected` `Abstract`_insertFromPropertyValue

`Protected`_insertFromPropertyValues

`Abstract`create

`Abstract`getPathForClipboard

`Abstract`getPathForCreateBlock

`Abstract`insert