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

public class | source

View

Extends:

Renderable → View

A renderable that renders a component.

Static Method Summary

Static Public Methods
public static	configure(config: ViewConfig): ConfiguredRenderable<View> Configures a view.

Constructor Summary

Public Constructor
public	constructor(_container: Renderable, _configuration: ViewConfig, _viewManager: ViewManager, _viewFactory: ViewFactory, _document: Document) Creates an instance of View.

Member Summary

Public Members
public get	caching: *
public get	height: *
public get	isCacheable: boolean \| null Whether this view in configured to be cacheable.
public get	lazy: boolean \| null Whether this view is configured to be lazy.
public get	ref: string \| null The 'ref' string this view is configured with.
public get	resolution: ResolverStrategy \| null The resolution strategy this view is configured with.
public	sizeChanges: Observable<{width: number, height: number}> Notifies when the dimensions of this view changes.
public get	token: any \| null The token this view is using for registration.
public	viewContainerCreated: Observable<ViewContainer<any>> Notifies when the view container is resolved.
public	visibilityChanges: Observable<boolean> Notifies when the visibility of this view changes.
public get	width: *

Method Summary

Public Methods
public	close(args: {silent?: boolean}) Closes this view.
public	destroy()
public	initialize()
public	makeVisible() Makes this view visible.
public	minimize() Minimizes this view if applicable.
public	render(): *
public	resolveConfigProperty(path: string): T \| null Resolves a views config property.

Inherited Summary

From class Renderable
public get	container: Renderable \| null This renderables container or null if none.
public get	contentItems: undefined[]
public get	height: number This renderables height in pixels.
public get	injector: Injector The injector used to create this renderable.
public get	isDestroyed: boolean Whether this renderable is destroyed.
public get	length: number The amount of content items belonging to this renderable.
public get	offsetX: number This renderables page offset x.
public get	offsetY: number This renderables page offset y.
public get	uid: number A unique identifier for this renderable.
public get	width: number This renderables width in pixels.
public	containerChange: *
public	destroyed: *
public	tags: *
public	addChild(item: Renderable, options: AddChildArgs) Adds a child item to this renderable.
public	contains(item: Renderable): boolean Whether a renderable is a descendant of this renderable.
public	createChild(renderable: RenderableArg<T>, providers: ProviderArg[]): T Creates a child renderable using this renderable as it's container.
public	destroy(): void Destroys this renderable and all it's children.
public	emit(event: T) Emits a BusEvent on this renderable.
public	emitDown(event: T) Emits a BusEvent down to all descendants recursively.
public	emitUp(event: T) Emits a BusEvent up to all parents recursively.
public	getArea(): RenderableArea Gets the renderable area of this renderable.
public	getAtIndex(index: number): Renderable \| null Gets a content renderable at an index.
public	getChildren(): Renderable[] Returns this renderables children renderables.
public	getDescendants(): Renderable[] Gets all descendants of this renderable recursively.
public	getIndexOf(item: Renderable): number Gets the index of a content renderable.
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	handleDropCleanup() Handles any cleanup from a drop.
public	initialize() Invoked when the Injector has been assigned and ready for use.
public	isContainedWithin(item: Renderable): boolean Whether this renderable is a descendant of another renderable.
public	isDroppable(target: Renderable): boolean Whether this renderable can be dropped on.
public	isVisible(): boolean Determines whether this renderable is visible.
public	remove() Removes this item from it's parent. If there is no parent then this renderable will just be destroyed.
public	removeChild(item: Renderable, options: RemoveChildArgs) Removes a content item from this renderable.
public	replaceChild(item: Renderable, withItem: Renderable, options: RemoveChildArgs) Replaces a content item on this renderable with another content item.
public	resize() Sets this components size and triggers it's childrens sizing.
public	scope(Event: Type<T>): Observable<T> Creates an Observable scoped to a specific event type.
public	setContainer(container: Renderable \| null) Sets the container of this renderable.
public	subscribe(Event: Type<T>, observer: PartialObserver<T> \| function(event: T)): Subscription Subscribes to a BusEvent.

Static Public Methods

public static configure(config: ViewConfig): ConfiguredRenderable<View> source

Configures a view.

Params:

Name	Type	Attribute	Description
config	ViewConfig

Return:

ConfiguredRenderable<View>

Public Constructors

public constructor(_container: Renderable, _configuration: ViewConfig, _viewManager: ViewManager, _viewFactory: ViewFactory, _document: Document) source

Creates an instance of View.

Override:

Renderable#constructor

Params:

Name	Type	Attribute	Description
_container	Renderable
_configuration	ViewConfig
_viewManager	ViewManager
_viewFactory	ViewFactory
_document	Document

Public Members

public get caching: * source

public get height: * source

This renderables height in pixels.

Override:

Renderable#height

public get isCacheable: boolean | null source

Whether this view in configured to be cacheable.

public get lazy: boolean | null source

Whether this view is configured to be lazy.

public get ref: string | null source

The 'ref' string this view is configured with.

public get resolution: ResolverStrategy | null source

The resolution strategy this view is configured with.

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

Notifies when the dimensions of this view changes.

public get token: any | null source

The token this view is using for registration.

public viewContainerCreated: Observable<ViewContainer<any>> source

Notifies when the view container is resolved.

public visibilityChanges: Observable<boolean> source

Notifies when the visibility of this view changes.

public get width: * source

This renderables width in pixels.

Override:

Renderable#width

Public Methods

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

Closes this view.

Params:

Name	Type	Attribute	Description
args	{silent?: boolean}	optional default: {}

Emit:

BeforeDestroyEvent

Fired when not silent.

public destroy() source

Destroys this renderable and all it's children.

Override:

Renderable#destroy

public initialize() source

Invoked when the Injector has been assigned and ready for use.

Override:

Renderable#initialize

public makeVisible() source

Makes this view visible.

Emit:

MakeVisibileCommand

public minimize() source

Minimizes this view if applicable.

Emit:

MinimizeCommand

public render(): * source

Return:

public resolveConfigProperty(path: string): T | null source

Resolves a views config property. Checks the configuration given to the view renderable first then checks the component metadata.

Params:

Name	Type	Attribute	Description
path	string

Return:

T | null