Interface IComposable

Represent the class can be composite

interface IComposable {
    children: IComposable[];
    parent: undefined | IComposable;
    add(item: IComposable | IComposable[]): this;
    detach(): void;
    dispose(): void;
    extractChildrenToFlatList(): IComposable[];
    remove(item: IComposable | IComposable[]): this;
}

Implemented by

Index

Properties

children parent

Methods

add detach dispose extractChildrenToFlatList remove

Properties

children

children: IComposable[]

Contains all child components

parent

parent: undefined | IComposable

The parent of this component, undefined means it's the root

Methods

add

add(item): this
Add a new child or children to the component
Parameters
- item: IComposable | IComposable[]
Returns this
- Defined in workspaces/core/src/Composite/Composite.ts:25

detach

detach(): void
Detach the component from its parent

Returns void
- Defined in workspaces/core/src/Composite/Composite.ts:36

dispose

dispose(): void
Dispose this component and all its children

Returns void
- Defined in workspaces/core/src/Composite/Composite.ts:41

extractChildrenToFlatList

extractChildrenToFlatList(): IComposable[]
Returns IComposable[]
- Defined in workspaces/core/src/Composite/Composite.ts:43

remove

remove(item): this
Remove a child or children from the component
Parameters
- item: IComposable | IComposable[]
Returns this
- Defined in workspaces/core/src/Composite/Composite.ts:31