Class UmbContentTypeContainerStructureHelper<T>

This class is a helper class for managing the structure of containers in a content type. This requires a structure manager UmbContentTypeStructureManager to manage the structure.

Type Parameters

T extends UmbContentTypeModel

Hierarchy (View Summary)

UmbControllerBase
- UmbContentTypeContainerStructureHelper

Constructors

constructor

new UmbContentTypeContainerStructureHelper<T extends UmbContentTypeModel>(
host: UmbControllerHost,
): UmbContentTypeContainerStructureHelper<T>
Type Parameters
- T extends UmbContentTypeModel
Parameters
- host: UmbControllerHost
Returns UmbContentTypeContainerStructureHelper<T>
Overrides UmbControllerBase.constructor
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:51

Properties

_host

_host: UmbControllerHost

`Readonly`childContainers

childContainers: Observable<UmbPropertyTypeContainerMergedModel[]> = ...

`Readonly`hasProperties

hasProperties: Observable<boolean> = ...

Accessors

containers

get containers(): Observable<UmbPropertyTypeContainerModel[]>
Returns Observable<UmbPropertyTypeContainerModel[]>
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:30

controllerAlias

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

mergedContainers

get mergedContainers(): Observable<UmbPropertyTypeContainerModel[]>
Returns Observable<UmbPropertyTypeContainerModel[]>
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:37

Methods

addContainer

addContainer(
parentContainerId?: null | string,
sortOrder?: number,
): Promise<void>
Manipulate methods:
Parameters
- OptionalparentContainerId: null | string
- OptionalsortOrder: number
Returns Promise<void>
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:359

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 UmbControllerBase.addEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11569

addUmbController

addUmbController(controller: UmbController): void
Parameters
- controller: UmbController
Returns void
Inherited from UmbControllerBase.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 UmbControllerBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

containersByNameAndType

containersByNameAndType(
name: string,
type: UmbPropertyContainerTypes,
): Observable<UmbPropertyTypeContainerModel[]>
Parameters
- name: string
- type: UmbPropertyContainerTypes
Returns Observable<UmbPropertyTypeContainerModel[]>
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:343

destroy

destroy(): void
Returns void
Inherited from UmbControllerBase.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 UmbControllerBase.dispatchEvent
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11575

getContainerChildType

getContainerChildType(): undefined | UmbPropertyContainerTypes
Returns undefined | UmbPropertyContainerTypes
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:121

getContainerId

getContainerId(): undefined | null | string
Returns undefined | null | string
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:111

getContentTypeOfContainer

getContentTypeOfContainer(containerId?: string): undefined | T
Parameters
- OptionalcontainerId: string
Returns undefined | T
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:338

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 UmbControllerBase.getContext
- Defined in src/libs/class-api/class.interface.ts:75

getUmbControllers

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

hasUmbController

hasUmbController(controller: UmbController): boolean
Parameters
- controller: UmbController
Returns boolean
Inherited from UmbControllerBase.hasUmbController
- Defined in src/libs/controller-api/controller-host.interface.ts:4

hostConnected

hostConnected(): void
Returns void
Inherited from UmbControllerBase.hostConnected
- Defined in src/libs/controller-api/controller.interface.ts:4

hostDisconnected

hostDisconnected(): void
Returns void
Inherited from UmbControllerBase.hostDisconnected
- Defined in src/libs/controller-api/controller.interface.ts:5

isOwnerChildContainer

isOwnerChildContainer(containerId?: string): undefined | boolean
Returns true if the container is an owner container.
Parameters
- OptionalcontainerId: string
Returns undefined | boolean
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:333

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 UmbControllerBase.observe
- Defined in src/libs/class-api/class.interface.ts:27

partialUpdateContainer

partialUpdateContainer(
containerId: string,
partialUpdate: Partial<UmbPropertyTypeContainerModel>,
): Promise<void>
Parameters
- containerId: string
- partialUpdate: Partial<UmbPropertyTypeContainerModel>
Returns Promise<void>
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:373

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 UmbControllerBase.provideContext
- Defined in src/libs/class-api/class.interface.ts:52

removeContainer

removeContainer(groupId: string): Promise<boolean>
Parameters
- groupId: string
Returns Promise<boolean>
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:365

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 UmbControllerBase.removeEventListener
- Defined in node_modules/typescript/lib/lib.dom.d.ts:11581

removeUmbController

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

removeUmbControllerByAlias

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

setContainerChildType

setContainerChildType(value?: UmbPropertyContainerTypes): void
Parameters
- Optionalvalue: UmbPropertyContainerTypes
Returns void
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:115

setContainerId

setContainerId(value: undefined | null | string): void
Parameters
- value: undefined | null | string
Returns void
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:105

setIsRoot

setIsRoot(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:96

setStructureManager

setStructureManager(
structure: undefined | UmbContentTypeStructureManager<T>,
): void
Parameters
- structure: undefined | UmbContentTypeStructureManager<T>
Returns void
- Defined in src/packages/content/content-type/structure/content-type-container-structure-helper.class.ts:74

Class UmbContentTypeContainerStructureHelper<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbContentTypeContainerStructureHelper<T>

Properties

_host

ReadonlychildContainers

ReadonlyhasProperties

Accessors

containers

Returns Observable<UmbPropertyTypeContainerModel[]>

controllerAlias

Returns UmbControllerAlias

mergedContainers

Returns Observable<UmbPropertyTypeContainerModel[]>

Methods

addContainer

Parameters

Returns Promise<void>

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

containersByNameAndType

Parameters

Returns Observable<UmbPropertyTypeContainerModel[]>

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getContainerChildType

Returns undefined | UmbPropertyContainerTypes

getContainerId

Returns undefined | null | string

getContentTypeOfContainer

Parameters

Returns undefined | T

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getIsRoot

Returns boolean

getStructureManager

Returns undefined | UmbContentTypeStructureManager<T>

getUmbControllers

Parameters

Returns UmbController[]

hasUmbController

Parameters

Returns boolean

hostConnected

Returns void

hostDisconnected

Returns void

isOwnerChildContainer

Parameters

Returns undefined | boolean

`Readonly`childContainers

`Readonly`hasProperties