@siemens/element-ng 47.4.0 → 47.6.0

package/tree-view/si-tree-view.utils.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright Siemens 2016 - 2025.
+ * SPDX-License-Identifier: MIT
+ */
+import type { CheckboxState, TreeItem, TreeItemFolderState } from './si-tree-view.model';
+export declare const ROOT_LEVEL = -1;
+export declare const childrenLoaded: (item: TreeItem) => boolean;
+export declare const hasChildren: (item: TreeItem) => boolean;
+export declare const removeUndefinedState: (state?: TreeItemFolderState) => TreeItemFolderState;
+/**
+ * Collapses the tree item except for leaf items.
+ */
+export declare const collapse: (item: TreeItem) => void;
+/**
+ * Expands the tree item except for leaf items.
+ */
+export declare const expand: (item: TreeItem) => void;
+export declare const expandRecursive: (item: TreeItem) => void;
+export declare const boxClicked: (treeItem: TreeItem, inheritChecked: boolean) => void;
+/**
+ * Changes the folder state to a new state based on the old state.
+ * If a client calls this method, the same is responsible to load the children in case the new state is 'expanding'!!!
+ *
+ * @param deleteChildrenOnCollapse - If set to true, the children are deleted upon collapsing the item.
+ */
+export declare const doFolderStateChange: (item: TreeItem, deleteChildrenOnCollapse: boolean, newState?: string) => void;
+export declare const enableCheckboxRecursive: (item: TreeItem, enable: boolean) => void;
+export declare const enableOptionboxRecursive: (item: TreeItem, enable: boolean) => void;
+export declare const parentCountRecursive: (item: TreeItem, stackLevel: number) => number;
+export declare const selectItemsBetween: <T = any>(roots: TreeItem<T>[], start: TreeItem<T>, end: TreeItem<T>) => TreeItem<T>[] | undefined;
+export declare const selectRecursive: (item: TreeItem, select: boolean) => void;
+export declare const setBoxStateRecursive: (item: TreeItem, state: CheckboxState) => void;
+/**
+ * Sets the item to be active or not; all other items of the tree are reset.
+ */
+export declare const setActive: (item: TreeItem, active: boolean) => void;
+export declare const resetActive: (item: TreeItem) => void;
+/**
+ * Sets the treeItem as selectable or not
+ */
+export declare const setSelectable: (item: TreeItem, selectable: boolean) => void;
+export declare const deleteItem: (item: TreeItem) => void;
+export declare const addChildItem: (parent: TreeItem, child: TreeItem, position?: number, callback?: (item: TreeItem) => void) => void;
+export declare const addChildItems: (parent: TreeItem, children: TreeItem[], position?: number, callback?: (item: TreeItem) => void) => void;
+export declare const initializeTreeItemsRecursive: (items: TreeItem[], parent: TreeItem, callback?: (item: TreeItem) => void) => void;
+export declare const setTreeItemDefaults: (item: TreeItem, callback?: (item: TreeItem) => void) => void;