import {ViewContainer} from 'ug-layout/view/ViewContainer'

public class | source

ViewContainer

A container that holds a 1 to 1 relationship with a component instance. This instance is the main API for a component to interact with the layout framework.

Constructor Summary

Public Constructor
public	constructor(_document: Document, _injector: Injector) Creates an instance of ViewContainer.

Member Summary

Public Members
public	attached: Observable<boolean> Notifies when the view has become attached.
public	beforeDestroy: Observable<BeforeDestroyEvent<Renderable>> Notifies that the view is being destroyed.
public get	component: T \| null The component instance associated with this container.
public	componentInitialized: Observable<boolean> Notifies when the component is initialized.
public	componentReady: Observable<boolean> Notifies when the component is assigned to the container and ready for access.
public	containerChange: Observable<View \| null> Notifies when this container has changed the View it is associated with.
public	destroyed: Observable<ViewContainer<T>> Notifies when the view is destroyed.
public	detached: Observable<boolean> Notifies when the view has become detached.
public get	element: HTMLElement The HTML element for this container.
public get	hasComponent: *
public get	height: number Current height in pixels.
public	id: number A unique identifier for this instance.
public	initialized: Observable<boolean> Contains the state of ths views initialized state.
public get	isCacheable: boolean Whether the container is cacheable.
public get	isLazy: *
public	sizeChanges: Observable<{width: number, height: number}> Notifies when the dimensions of this views container has changed.
public	status: Observable<ViewContainerStatus> Notifies when the status of this component changes.
public get	view: *
public	visibilityChanges: Observable<boolean> Notifies when the visibility of this view changes.
public get	width: number Current width in pixels.

Method Summary

Public Methods
public	close(args: {silent?: boolean}) Closes this view.
public	destroy() Destroys the container.
public	detach() Detaches this container from it's view.
public	fail(retry: *)
public	get(token: *): U \| null Get's a token from this containers injector. Note, this should not be used to grab parent renderables or any item that can be changed.
public	getParent(Ctor: Type<T>): T \| null Gets this renderables parent or any parent that is an instance of the passed in constructor.
public	getParents(Ctor: Type<T>): T \| null Gets this renderables parents or any parents that are an instance of the passed in constructor.
public	initialize() Initializes the component.
public	isVisible(): boolean Determines whether this renderable is visible.
public	makeVisible() Signals up the tree to make this View visible.
public	mount(element: HTMLElement) Mounts an element to this containers element.
public	mountHTML(html: string) Sets all the content of this containers element to the given HTML string.
public	mountTo(element: HTMLElement) Mounts this containers element to the given element.
public	ready(options: {init?: boolean}): Promise<ViewContainer<T>> Waits for the component to be ready.
public	resolve(options: {}): *
public	retry()
public	setView(container: View \| null): void Sets the containing View for this container.

Public Constructors

public constructor(_document: Document, _injector: Injector) source

Creates an instance of ViewContainer.

Params:

Name	Type	Attribute	Description
_document	Document
_injector	Injector

Public Members

public attached: Observable<boolean> source

Notifies when the view has become attached.

public beforeDestroy: Observable<BeforeDestroyEvent<Renderable>> source

Notifies that the view is being destroyed. This action is cancellable or can be halted until an async action is complete.

See:

Cancellable

public get component: T | null source

The component instance associated with this container.

public componentInitialized: Observable<boolean> source

Notifies when the component is initialized.

public componentReady: Observable<boolean> source

Notifies when the component is assigned to the container and ready for access.

public containerChange: Observable<View | null> source

Notifies when this container has changed the View it is associated with.

public destroyed: Observable<ViewContainer<T>> source

Notifies when the view is destroyed.

public detached: Observable<boolean> source

Notifies when the view has become detached.

public get element: HTMLElement source

The HTML element for this container.

public get hasComponent: * source

public get height: number source

Current height in pixels.

public id: number source

A unique identifier for this instance.

public initialized: Observable<boolean> source

Contains the state of ths views initialized state.

public get isCacheable: boolean source

Whether the container is cacheable.

public get isLazy: * source

public sizeChanges: Observable<{width: number, height: number}> source

Notifies when the dimensions of this views container has changed.

public status: Observable<ViewContainerStatus> source

Notifies when the status of this component changes.

public get view: * source

public visibilityChanges: Observable<boolean> source

Notifies when the visibility of this view changes.

public get width: number source

Current width in pixels.

Public Methods

public close(args: {silent?: boolean}) source

Closes this view.

Params:

Name	Type	Attribute	Description
args	{silent?: boolean}

public destroy() source

Destroys the container.

public detach() source

Detaches this container from it's view.

public fail(retry: *) source

Params:

Name	Type	Attribute	Description
retry	*

public get(token: *): U | null source

Get's a token from this containers injector. Note, this should not be used to grab parent renderables or any item that can be changed.

Params:

Name	Type	Attribute	Description
token	*

Return:

U | null

public getParent(Ctor: Type<T>): T | null source

Gets this renderables parent or any parent that is an instance of the passed in constructor. If non is found then null is returned.

Params:

Name	Type	Attribute	Description
Ctor	Type<T>	optional

Return:

T | null

public getParents(Ctor: Type<T>): T | null source

Gets this renderables parents or any parents that are an instance of the passed in constructor.

Params:

Name	Type	Attribute	Description
Ctor	Type<T>	optional

Return:

T | null

public initialize() source

Initializes the component. This creates the component.

public isVisible(): boolean source

Determines whether this renderable is visible.

Return:

boolean

public makeVisible() source

Signals up the tree to make this View visible.

public mount(element: HTMLElement) source

Mounts an element to this containers element.

Params:

Name	Type	Attribute	Description
element	HTMLElement

public mountHTML(html: string) source

Sets all the content of this containers element to the given HTML string.

Params:

Name	Type	Attribute	Description
html	string

public mountTo(element: HTMLElement) source

Mounts this containers element to the given element.

Params:

Name	Type	Attribute	Description
element	HTMLElement

public ready(options: {init?: boolean}): Promise<ViewContainer<T>> source

Waits for the component to be ready. If the component is not initialized it will be initialized. This is important when the view is lazy and hasn't been shown yet but we need to interact with the component.

Params:

Name	Type	Attribute	Description
options	{init?: boolean}	optional default: {}

Return:

Promise<ViewContainer<T>>

public resolve(options: {}): * source

Params:

Name	Type	Attribute	Description
options	{}	optional default: {}

Return:

public retry() source

public setView(container: View | null): void source

Sets the containing View for this container.

Params:

Name	Type	Attribute	Description
container	View \| null

Return:

void