Class UmbDefaultTreeItemContext<TreeItemType, TreeRootType, ManifestTreeItemType>

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

Type Parameters

TreeItemType extends UmbTreeItemModel
TreeRootType extends UmbTreeRootModel
ManifestTreeItemType extends ManifestTreeItem = ManifestTreeItem

Hierarchy (View Summary)

UmbTreeItemContextBase<TreeItemType, TreeRootType, ManifestTreeItemType>
- UmbDefaultTreeItemContext

Constructors

constructor

new UmbDefaultTreeItemContext<
    TreeItemType extends UmbTreeItemModel,
    TreeRootType extends UmbTreeRootModel,
    ManifestTreeItemType extends ManifestTreeItem = ManifestTreeItem,
>(
    host: UmbControllerHost,
): UmbDefaultTreeItemContext<
    TreeItemType,
    TreeRootType,
    ManifestTreeItemType,
>
Type Parameters
- TreeItemType extends UmbTreeItemModel
- TreeRootType extends UmbTreeRootModel
- ManifestTreeItemType extends ManifestTreeItem = ManifestTreeItem
Parameters
- host: UmbControllerHost
Returns UmbDefaultTreeItemContext<TreeItemType, TreeRootType, ManifestTreeItemType>
Overrides UmbTreeItemContextBase.constructor
- Defined in src/packages/core/tree/tree-item/tree-item-default/tree-item-default.context.ts:10

Properties

_host

_host: UmbControllerHost

`Protected` `Readonly`_treeItem

_treeItem: UmbObjectState<undefined | TreeItemType> = ...

`Readonly`childItems

childItems: Observable<TreeItemType[]> = ...

`Optional`entityType

entityType?: string

`Readonly`foldersOnly

foldersOnly: Observable<boolean> = ...

`Readonly`hasActions

hasActions: Observable<boolean> = ...

`Readonly`hasChildren

hasChildren: Observable<boolean> = ...

`Readonly`isActive

isActive: Observable<boolean> = ...

`Readonly`isLoading

isLoading: Observable<boolean> = ...

isOpen

isOpen: Observable<boolean> = ...

`Readonly`isSelectable

isSelectable: Observable<boolean> = ...

`Readonly`isSelectableContext

isSelectableContext: Observable<boolean> = ...

`Readonly`isSelected

isSelected: Observable<boolean> = ...

`Readonly`pagination

pagination: UmbPaginationManager = ...

`Optional`parentTreeItemContext

parentTreeItemContext?: UmbTreeItemContext<TreeItemType>

`Readonly`path

path: Observable<string> = ...

`Optional`treeContext

treeContext?: UmbDefaultTreeContext<
    TreeItemType,
    TreeRootType,
    UmbTreeRootItemsRequestArgs,
>

`Readonly`treeItem

treeItem: Observable<undefined | TreeItemType> = ...

`Optional`unique

unique?: UmbEntityUnique

Accessors

controllerAlias

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

manifest

get manifest(): undefined | ManifestType
Returns undefined | ManifestType
Inherited from UmbTreeItemContextBase.manifest
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:113
set manifest(manifest: undefined | ManifestType): void
Sets the manifest
Parameters
- manifest: undefined | ManifestType
Returns void
Memberof
UmbCollectionContext
Inherited from UmbTreeItemContextBase.manifest
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:109

Methods

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

addUmbController

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

constructPath

constructPath(
    pathname: string,
    entityType: string,
    unique: null | string,
): string
Parameters
- pathname: string
- entityType: string
- unique: null | string
Returns string
Inherited from UmbTreeItemContextBase.constructPath
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:463

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 UmbTreeItemContextBase.consumeContext
- Defined in src/libs/class-api/class.interface.ts:64

deselect

deselect(): void
Deselects the tree item

Returns void
Memberof
UmbTreeItemContextBase
Inherited from UmbTreeItemContextBase.deselect
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:248

destroy

destroy(): void
Returns void
Inherited from UmbTreeItemContextBase.destroy
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:485

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

getHostElement

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

getManifest

getManifest(): undefined | ManifestTreeItemType
Returns the manifest.

Returns undefined | ManifestTreeItemType
Memberof
UmbCollectionContext

Deprecated
Use the .manifest property instead.
Inherited from UmbTreeItemContextBase.getManifest
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:123

loadChildren

loadChildren(): Promise<void>
Load children of the tree item

Returns Promise<void>
Memberof
UmbTreeItemContextBase
Inherited from UmbTreeItemContextBase.loadChildren
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:169

loadMore

loadMore(): Promise<void>
Load more children of the tree item

Returns Promise<void>
Memberof
UmbTreeItemContextBase
Inherited from UmbTreeItemContextBase.loadMore
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:175

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

removeUmbController

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

removeUmbControllerByAlias

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

select

select(): void
Selects the tree item

Returns void
Memberof
UmbTreeItemContextBase
Inherited from UmbTreeItemContextBase.select
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:238

setTreeItem

setTreeItem(treeItem: undefined | TreeItemType): void
Parameters
- treeItem: undefined | TreeItemType
Returns void
Inherited from UmbTreeItemContextBase.setTreeItem
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:132

showChildren

showChildren(): void
Returns void
Inherited from UmbTreeItemContextBase.showChildren
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:253

toggleContextMenu

toggleContextMenu(): void
Returns void
Inherited from UmbTreeItemContextBase.toggleContextMenu
- Defined in src/packages/core/tree/tree-item/tree-item-base/tree-item-context-base.ts:221

Class UmbDefaultTreeItemContext<TreeItemType, TreeRootType, ManifestTreeItemType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns UmbDefaultTreeItemContext<TreeItemType, TreeRootType, ManifestTreeItemType>

Properties

_host

Protected Readonly_treeItem

ReadonlychildItems

OptionalentityType

ReadonlyfoldersOnly

ReadonlyhasActions

ReadonlyhasChildren

ReadonlyisActive

ReadonlyisLoading

isOpen

ReadonlyisSelectable

ReadonlyisSelectableContext

ReadonlyisSelected

Readonlypagination

OptionalparentTreeItemContext

Readonlypath

OptionaltreeContext

ReadonlytreeItem

Optionalunique

Accessors

controllerAlias

Returns UmbControllerAlias

manifest

Returns undefined | ManifestType

Parameters

Returns void

Memberof

Methods

addEventListener

Parameters

Returns void

addUmbController

Parameters

Returns void

constructPath

Parameters

Returns string

consumeContext

Type Parameters

Parameters

Returns UmbContextConsumerController<BaseType, ResultType>

Description

Memberof

deselect

Returns void

Memberof

destroy

Returns void

dispatchEvent

Parameters

Returns boolean

getContext

Type Parameters

Parameters

Returns Promise<undefined | ResultType>

Description

Memberof

getHostElement

Returns Element

getManifest

Returns undefined | ManifestTreeItemType

Memberof

Deprecated

getTreeItem

Returns undefined | TreeItemType

getUmbControllers

`Protected` `Readonly`_treeItem

`Readonly`childItems

`Optional`entityType

`Readonly`foldersOnly

`Readonly`hasActions

`Readonly`hasChildren

`Readonly`isActive

`Readonly`isLoading

`Readonly`isSelectable

`Readonly`isSelectableContext

`Readonly`isSelected

`Readonly`pagination

`Optional`parentTreeItemContext

`Readonly`path

`Optional`treeContext

`Readonly`treeItem

`Optional`unique