UNPKG

1.9 kBTypeScriptView Raw
1import { IReferences } from './IReferences';
2/**
3 * Helper class that sets and unsets references to components.
4 *
5 * @see [[IReferenceable]]
6 * @see [[IUnreferenceable]]
7 */
8export declare class Referencer {
9 /**
10 * Sets references to specific component.
11 *
12 * To set references components must implement [[IReferenceable]] interface.
13 * If they don't the call to this method has no effect.
14 *
15 * @param references the references to be set.
16 * @param component the component to set references to.
17 *
18 * @see [[IReferenceable]]
19 */
20 static setReferencesForOne(references: IReferences, component: any): void;
21 /**
22 * Sets references to multiple components.
23 *
24 * To set references components must implement [[IReferenceable]] interface.
25 * If they don't the call to this method has no effect.
26 *
27 * @param references the references to be set.
28 * @param components a list of components to set the references to.
29 *
30 * @see [[IReferenceable]]
31 */
32 static setReferences(references: IReferences, components: any[]): void;
33 /**
34 * Unsets references in specific component.
35 *
36 * To unset references components must implement [[IUnreferenceable]] interface.
37 * If they don't the call to this method has no effect.
38 *
39 * @param component the component to unset references.
40 *
41 * @see [[IUnreferenceable]]
42 */
43 static unsetReferencesForOne(component: any): void;
44 /**
45 * Unsets references in multiple components.
46 *
47 * To unset references components must implement [[IUnreferenceable]] interface.
48 * If they don't the call to this method has no effect.
49 *
50 * @param components the list of components, whose references must be cleared.
51 *
52 * @see [[IUnreferenceable]]
53 */
54 static unsetReferences(components: any[]): void;
55}