C

ModelManager<T>
abstract

Show Usages
Manages the visual representations of items in a CanvasComponent.
Inheritance Hierarchy

Members

Show:

Constructors

ModelManager

()
protected
Creates a new instance.

Properties

canvasComponent

: CanvasComponent
Gets the canvas instance this instance is managing.
The canvas must be set to a non-null value in install and set back to null in uninstall.
final

enabled

: boolean
Gets or sets whether this ModelManager<T> is enabled.

If the manager is disabled, it will not install the IRenderTreeElements into the associated CanvasComponent.

The default is true, i.e. this manager is enabled by default.

final

Property Value

true if enabled; false otherwise.

Methods

addItem

(item: T): IRenderTreeElement
protected
Installs an item and adds it to this manager's set of managed items.
If enabled is set to false, the item will not be installed.
protected

Parameters

item: T
The item to add.

Return Value

IRenderTreeElement
The newly created render tree element or null if nothing was installed.

See Also

Developer's Guide

getRenderer

(item: T): IObjectRenderer<T>
protectedabstract
Called by installItem to retrieve the renderer for a given item.

Implementations may use the lookup of the item.

Returning null will cause installItem not to install anything.

protectedabstract

Parameters

item: T
The item to find a renderer for.

Return Value

IObjectRenderer<T>
A renderer or null

See Also

Developer's Guide

getRenderTreeGroup

(item: T): IRenderTreeGroup
protectedabstract
Called by installItem to retrieve the render tree group for a given item.
Returning null will cause installItem not to install anything.
protectedabstract

Parameters

item: T
The item to find a render tree group for.

Return Value

IRenderTreeGroup
An IRenderTreeGroup or null

See Also

Developer's Guide

install

(canvasComponent: CanvasComponent)
Installs this instance in the given CanvasComponent instance.

If this manager instance is set to a CanvasComponent instance using one of the properties focusIndicatorManager, selectionIndicatorManager, or highlightIndicatorManager, this method is called automatically.

In all other cases, this method must be called before using this manager instance.

Overriders must either call the base implementation or set the canvasComponent.

Parameters

canvasComponent: CanvasComponent
The CanvasComponent instance to install this manager instance in.

Throws

Exception ({ name: 'ArgumentError' })
if canvasComponent is null.

installItem

(item: T): IRenderTreeElement
protected
Installs a member of the collection into the canvas using the IObjectRenderer<T> which is returned by getRenderer.
protected

Parameters

item: T
The member to install.

Return Value

IRenderTreeElement
The new render tree element or null if the item was not installed.

onDisabled

()
protectedabstract
Called when this manager gets disabled.
protectedabstract

See Also

Developer's Guide

onEnabled

()
protectedabstract
Called when this manager gets enabled.
protectedabstract

See Also

Developer's Guide

removeItem

(item: T)
protected
Uninstalls the provided item and removes it from this manager's set of managed items.
protected

Parameters

item: T
The item to remove.

See Also

Developer's Guide

uninstall

(canvasComponent: CanvasComponent)
Uninstalls this instance from the given CanvasComponent instance.

If this manager instance has been set to a CanvasComponent instance using one of the properties focusIndicatorManager, selectionIndicatorManager, or highlightIndicatorManager, this method is called automatically when the property value is changed.

In all other cases, this method must be called when this manager instance is not used anymore.

Overriders must either call the base implementation or set the canvasComponent to null.

Parameters

canvasComponent: CanvasComponent
The CanvasComponent to remove this manager instance from.

uninstallItem

(renderTreeElement: IRenderTreeElement)
protected
Removes the given IRenderTreeElement.
protected

Parameters

renderTreeElement: IRenderTreeElement
The render tree element that has been associated with the renderer.

See Also

API
remove