import { UmbControllerBase } from '../../../../libs/class-api/index.js'; import { type Observable } from '../../../../libs/observable-api/index.js'; import type { UmbEntityModel } from '../../entity/index.js'; /** * Manages which tree entity is currently being viewed, and the trail of entities leading to it * @exports * @class UmbTreeItemActiveManager * @augments {UmbControllerBase} */ export declare class UmbTreeItemActiveManager extends UmbControllerBase { #private; /** * The trail of entities from the tree root down to the entity currently being viewed. */ readonly activeTrail: Observable; /** * @returns {Observable>} The active trail * @deprecated Deprecated since v17. Use `activeTrail` instead. Will be removed in v19. */ get active(): Observable>; hostConnected(): void; hostDisconnected(): void; /** * Checks if a path is the one currently open in the browser * @param {Observable} path The path to check, as it may change while the item is alive * @returns {Observable} True while the browser location points at the path * @memberof UmbTreeItemActiveManager */ isCurrentLocation(path: Observable): Observable; /** * Checks if an entity is active * @param {UmbEntityModel} entity The entity to check * @returns {Observable} True if the entity is active * @memberof UmbTreeItemActiveManager */ isActive(entity: UmbEntityModel): Observable; /** * Checks if an descendant entity is active * @param {UmbEntityModel} entity The entity to check * @returns {Observable} True if a descendant entity is active * @memberof UmbTreeItemActiveManager */ hasActiveDescendants(entity: UmbEntityModel): Observable; /** * Checks if an descendant entity is active * @param {UmbEntityModel} entity The entity to check * @returns {boolean} True if a descendant entity is active * @memberof UmbTreeItemActiveManager */ getHasActiveDescendants(entity: UmbEntityModel): boolean; /** * Sets the trail of entities from the tree root down to the entity currently being viewed * @param {Array} activeTrail The active entries, root first. * @memberof UmbTreeItemActiveManager * @returns {void} */ setActiveTrail(activeTrail: Array): void; /** * @param {Array} activeChain The active entries. * @deprecated Deprecated since v17. Use `setActiveTrail()` instead. Will be removed in v19. */ setActive(activeChain: Array): void; /** * Clears the active trail, but only when it matches the given trail * @param {Array} activeTrail The trail that must match for the state to be cleared. * @memberof UmbTreeItemActiveManager * @returns {void} */ removeActiveTrailIfMatch(activeTrail: Array): void; /** * @param {Array} activeChain The active entries. * @deprecated Deprecated since v17. Use `removeActiveTrailIfMatch()` instead. Will be removed in v19. */ removeActiveIfMatch(activeChain: Array): void; /** * Gets the trail of entities from the tree root down to the entity currently being viewed * @memberof UmbTreeItemActiveManager * @returns {Array} The active trail, root first */ getActiveTrail(): Array; /** * @returns {Array} The active trail * @deprecated Deprecated since v17. Use `getActiveTrail()` instead. Will be removed in v19. */ getActive(): Array; }