RunReferencesDecorator

References decorator that automatically opens to newly added components that implement the IOpenable interface and closes removed components that implement the IClosable interface.

Extends: ReferencesDecorator

Implements: IOpenable

Description

The RunReferencesDecorator class allows you to create a references decorator that automatically opens to newly added components that implement the IOpenable interface and closes removed components that implement the IClosable interface.

Constructors

Creates a new instance of the decorator.

public constructor(nextReferences: IReferences, topReferences: IReferences)

  • nextReferences: IReferences - next references or decorator in the chain.
  • topReferences: IReferences - decorator at the top of the chain.

Fields

_opened

Flag of the component state

public _opened: boolean = false

Instance methods

put

Puts a new reference into the reference map.

public put(locator: any, component: any): void

  • locator: any - locator to find the reference by.
  • reference: any - component reference to be added.

remove

Removes a previously added component that matches the specified locator. If many references match the locator, it removes only the first one. When all references shall be removed, use the removeAll method instead.

public remove(locator: any): any

  • locator: any - locator to remove component
  • returns: any - removed component.

removeAll

Removes all component references that match the specified locator.

public removeAll(locator: any): any[]

  • locator: any - locator to remove references by.
  • returns: any[] - list containing all removed references.

See also