Interface ICollectionTreeFolder

Container for collection items

interface ICollectionTreeFolder {
    entryCount: number;
    expanded: boolean;
    folderCount: number;
    id: string;
    parent: ICollectionTreeFolder;
    selected: boolean;
    title: LocalizedString;
    userData: unknown;
    addEntry(options: ICollectionTreeEntryOptions): ICollectionTreeEntry;
    addFolder(options: ICollectionTreeFolderOptions): ICollectionTreeFolder;
    forEachEntry(
        callback: (entry: ICollectionTreeEntry, index: number) => boolean,
    ): void;
    forEachFolder(callback: (folder: ICollectionTreeFolder) => boolean): void;
    forEachFolder(callback: (folder: ICollectionTreeFolder) => boolean): void;
    getEntryById(id: string): ICollectionTreeEntry;
    getEntryByIndex(index: number): ICollectionTreeEntry;
    getFolder(id: string): ICollectionTreeFolder;
    removeEntryById(id: string): boolean;
    removeEntryByIndex(index: number): boolean;
    setColor(color: RGBA): void;
    setExpanded(expanded: boolean): void;
    setHeaderAction(
        actionParams: ICollectionTreeFolderHeaderActionParams,
    ): void;
    setSelected(selected: boolean): void;
    setTitle(title: LocalizedString): void;
}

Properties

`Readonly`entryCount

entryCount: number

Remarks

Count of the entries

`Readonly`expanded

expanded: boolean

Remarks

Expanded state of the folder

`Readonly`folderCount

folderCount: number

Remarks

Count of the child folders

`Readonly`id

id: string

Remarks

Unique identifier of the folder

`Readonly`parent

parent: ICollectionTreeFolder

Remarks

Parent folder

`Readonly`selected

selected: boolean

Remarks

Selected state of the folder

`Readonly`title

title: LocalizedString

Remarks

Title of the folder

`Readonly`userData

userData: unknown

Remarks

User data associated with the folder

Methods

addEntry

addEntry(options: ICollectionTreeEntryOptions): ICollectionTreeEntry
Parameters
- options: ICollectionTreeEntryOptions
  Options to create a folder
Returns ICollectionTreeEntry
Remarks
Adds a new entry to the folder

addFolder

addFolder(options: ICollectionTreeFolderOptions): ICollectionTreeFolder
Parameters
- options: ICollectionTreeFolderOptions
  Options to create a folder
Returns ICollectionTreeFolder
Remarks
Creates a new child folder

forEachEntry

forEachEntry(
callback: (entry: ICollectionTreeEntry, index: number) => boolean,
): void
Parameters
- callback: (entry: ICollectionTreeEntry, index: number) => boolean
  Returning false will stop the iteration
Returns void
Remarks
Iterates over entries within the folder

forEachFolder

forEachFolder(callback: (folder: ICollectionTreeFolder) => boolean): void
Parameters
- callback: (folder: ICollectionTreeFolder) => boolean
  Returning false will stop the iteration
Returns void
Remarks
Iterates over the first layer of folders
forEachFolder(callback: (folder: ICollectionTreeFolder) => boolean): void
Parameters
- callback: (folder: ICollectionTreeFolder) => boolean
  Returning false will stop the iteration
Returns void
Remarks
Iterates over the first layer of folders

getEntryById

getEntryById(id: string): ICollectionTreeEntry
Parameters
- id: string
  Identifier of the folder
Returns ICollectionTreeEntry
Remarks
Gets the entry by its unique identifier

getEntryByIndex

getEntryByIndex(index: number): ICollectionTreeEntry
Parameters
- index: number
  Index of the entry
Returns ICollectionTreeEntry
Remarks
Gets the entry at the index

getFolder

getFolder(id: string): ICollectionTreeFolder
Parameters
- id: string
  Identifier of the folder
Returns ICollectionTreeFolder
Remarks
Find the folder with the id if it exists

removeEntryById

removeEntryById(id: string): boolean
Parameters
- id: string
  Identifier of the folder
Returns boolean
Remarks
Removes the entry by its unique identifier if it exists

removeEntryByIndex

removeEntryByIndex(index: number): boolean
Parameters
- index: number
  Index of the entry
Returns boolean
Remarks
Removes the entry at the index if it exists

setColor

setColor(color: RGBA): void
Parameters
- color: RGBA
  New color state
Returns void
Remarks
Set color of the entry.

setExpanded

setExpanded(expanded: boolean): void
Parameters
- expanded: boolean
  New expanded state
Returns void
Remarks
Set expanded state of the entry.

setHeaderAction

setHeaderAction(actionParams: ICollectionTreeFolderHeaderActionParams): void
Parameters
- actionParams: ICollectionTreeFolderHeaderActionParams
Returns void
Remarks
Updates the header action for the folder

setSelected

setSelected(selected: boolean): void
Parameters
- selected: boolean
  New selected state
Returns void
Remarks
Set selected state of the entry.

setTitle

setTitle(title: LocalizedString): void
Parameters
- title: LocalizedString
  New title state
Returns void
Remarks
Set title of the entry.