import {StackItemContainer} from 'ug-layout/stack/StackItemContainer'

public class | source

StackItemContainer

Extends:

Renderable → StackItemContainer

Implements:

DropTarget

A renderable that is a direct child of a stack. Handles a renderable item.

Constructor Summary

Public Constructor
public	constructor(_config: StackItemContainerConfig, _container: Stack) Creates an instance of StackItemContainer.

Member Summary

Public Members
public get	closeable: *
public get	container: *
public get	controls: undefined[]
public get	draggable: *
public get	droppable: *
public get	height: *
public get	isActive: *
public get	offsetX: *
public get	offsetY: *
public get	tab: *
public get	title: *
public get	width: *

Method Summary

Public Methods
public	addControl(control: *, options: {})
public	getChildren(): undefined[]
public	getHighlightCoordinates(args: ):
public	handleDrop(item: , dropArea: , e: *)
public	initialize()
public	isDroppable(): *
public	isVisible(): *
public	makeVisible()
public	onDropHighlightExit()
public	render(): *
public	setContainer(container: *)

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.

Public Constructors

public constructor(_config: StackItemContainerConfig, _container: Stack) source

Creates an instance of StackItemContainer.

Override:

Renderable#constructor

Params:

Name	Type	Attribute	Description
_config	StackItemContainerConfig
_container	Stack

Public Members

public get closeable: * source

public get container: * source

This renderables container or null if none.

Override:

Renderable#container

public get controls: undefined[] source

public get draggable: * source

public get droppable: * source

public get height: * source

This renderables height in pixels.

Override:

Renderable#height

public get isActive: * source

public get offsetX: * source

This renderables page offset x.

Override:

Renderable#offsetX

public get offsetY: * source

This renderables page offset y.

Override:

Renderable#offsetY

public get tab: * source

public get title: * source

public get width: * source

This renderables width in pixels.

Override:

Renderable#width

Public Methods

public addControl(control: *, options: {}) source

Params:

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

public getChildren(): undefined[] source

Returns this renderables children renderables. This differs from content items as children should contain all renderables we want as part of the render cycle.

Override:

Renderable#getChildren

Return:

undefined[]

public getHighlightCoordinates(args: ): source

Params:

Name	Type	Attribute	Description
args	*

Return:

public handleDrop(item: , dropArea: , e: *) source

Params:

Name	Type	Attribute	Description
item	*
dropArea	*
e	*

public initialize() source

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

Override:

Renderable#initialize

public isDroppable(): * source

Whether this renderable can be dropped on.

Override:

Renderable#isDroppable

Return:

public isVisible(): * source

Determines whether this renderable is visible.

Override:

Renderable#isVisible

Return:

public makeVisible() source

public onDropHighlightExit() source

public render(): * source

Return:

public setContainer(container: *) source

Sets the container of this renderable.

Override:

Renderable#setContainer

Params:

Name	Type	Attribute	Description
container	*

StackItemContainer

Extends:

Implements:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(_config: StackItemContainerConfig, _container: Stack) source

Override:

Params:

Public Members

public get closeable: * source

public get container: * source

Override:

public get controls: undefined[] source

public get draggable: * source

public get droppable: * source

public get height: * source

Override:

public get isActive: * source

public get offsetX: * source

Override:

public get offsetY: * source

Override:

public get tab: * source

public get title: * source

public get width: * source

Override:

Public Methods

public addControl(control: *, options: {}) source

Params:

public getChildren(): undefined[] source

Override:

Return:

public getHighlightCoordinates(args: *): * source

Params:

Return:

public handleDrop(item: *, dropArea: *, e: *) source

Params:

public initialize() source

Override:

public isDroppable(): * source

Override:

Return:

public isVisible(): * source

Override:

Return:

public makeVisible() source

public onDropHighlightExit() source

public render(): * source

Return:

public setContainer(container: *) source

Override:

Params:

public getHighlightCoordinates(args: ): source

public handleDrop(item: , dropArea: , e: *) source